QueryTraceM3u8Job - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Queries video tracing watermark M3U8 jobs.

Operation description

Currently, API operations related to digital watermarking are supported only in the China (Shanghai) and China (Beijing) regions.
The signature authentication for the absolute path of the M3U8 file generated by a video tracing watermark M3U8 job is valid for 24 hours starting from the completion of the job. Query the result promptly. After the signature authentication expires, the watermark information of the job cannot be queried. To obtain the information after expiration, recommit the video tracing watermark M3U8 job.
The maximum time range for querying historical data (job information) is six months.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mts:QueryTraceM3u8Job

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CreateTimeStart	integer	No	The start of the creation time range. The value is a UNIX timestamp.	1527441300
CreateTimeEnd	integer	No	The end of the creation time range. The value is a UNIX timestamp.	1527441303
JobId	string	No	The job ID. You can obtain the job ID from the response parameters of the API operation used to submit a video tracing watermark M3U8 job.	88c6ca184c0e47098a5b665e2a12****
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	5CA6E020-4102-4FFF-AA56-5ED7ECD8****
Message	string	The returned message.	ok
Data	array<object>	The returned data.
	object	The returned data.
GmtCreate	integer	The creation time.	1627357322
GmtModified	integer	The update time.	1627357327
MediaId	string	The media ID.	437bd2b516ffda105d07b12a9a82****
JobId	string	The job ID.	88c6ca184c0e47098a5b665e2a12****
Trace	string	The watermark information.	T-Head Semiconductor(Shanghai)
Output	string	The watermarked video output.	{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}
Status	string	The status.	success
UserData	string	The user data.	123
UserId	integer	The user ID.	13466****
StatusCode	integer	The status code.	200

Examples

Success response

JSON format

{
  "RequestId": "5CA6E020-4102-4FFF-AA56-5ED7ECD8****",
  "Message": "ok",
  "Data": [
    {
      "GmtCreate": 1627357322,
      "GmtModified": 1627357327,
      "MediaId": "437bd2b516ffda105d07b12a9a82****",
      "JobId": "88c6ca184c0e47098a5b665e2a12****\n",
      "Trace": "T-Head Semiconductor(Shanghai)",
      "Output": "{\"Bucket\":\"ivison-test\",\"Location\":\"oss-cn-shanghai\",\"Object\":\"out.mp4\"}",
      "Status": "success",
      "UserData": "123",
      "UserId": 0
    }
  ],
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.