Querying Virtual Avatar Video Subtitle File Details

Function

Queries virtual avatar video subtitle file details.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/subtitle-files/{job_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
job_id	Yes	String	Task ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. You can obtain the token by calling the IAM API used to obtain a user token. Value of X-Subject-Token in the response header.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication. The format is YYYYMMDD'T'HHMMSS'Z'.
X-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.
X-App-UserId	No	String	Third-party user ID, which does not allow Chinese characters.

Response Parameters

Status code: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 4** Response body parameters
Parameter	Type	Description
job_state	String	All task statuses of a subtitle file. GENERATING: subtitle file being generated GENERATED: subtitle file generated
subtitle_file_info	Array of SubtitleFileDetail objects	Subtitle files.

**Table 5** SubtitleFileDetail
Parameter	Type	Description
sequence_no	Integer	Script No. Value range: 0~2147483647
subtitle_file_state	String	Status of subtitle file generation. GENERATING: subtitle file being generated GENERATE_SUCCEED: subtitle file generated **GENERATE_FAILED: subtitle file generation failed
subtitle_file_download_url	String	URL for downloading subtitle files.
subtitle_file_upload_url	String	URL for uploading subtitle files.
generate_time	String	Subtitle file generation time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
error_info	ErrorResponse object	Error message.

**Table 6** ErrorResponse
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-video-tran/26f06524-4f75-4b3a-a853-b649a21aaf66

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "subtitle_file_info" : [ {
    "subtitle_file_state" : "GENERATE_SUCCEED"
  } ]
}

Status code: 400

Parameters error, including the error code and its description.

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status code: 401

Authentication is not performed or fails.

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

Status code: 404

No content.

{
  "error_code" : "MSS.00000002",
  "error_msg" : "Not Found"
}

Status code: 500

Internal service error.

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code	Description
200	Returned when the request succeeded.
400	Parameters error, including the error code and its description.
401	Authentication is not performed or fails.
404	No content.
500	Internal service error.