QueryTraceM3u8JobList

更新时间:
复制 MD 格式

Queries jobs for generating M3U8 files containing specific trace watermark information.

Operation description

  • This operation is supported only in the China (Shanghai) and China (Beijing) regions.

  • The M3U8 file with absolute paths generated by the SubmitTraceM3u8Job API has a signed URL with an authentication validity period of 24 hours, starting from the moment the job is completed. After the signature expires, the M3U8 file will become inaccessible. You must submit a new M3U8 generation job.

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

ice:QueryTraceM3u8JobList

none

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

CreateTimeStart

integer

No

The start of the creation time range for the query, in UNIX timestamp format.

1627357322

CreateTimeEnd

integer

No

The end of the creation time range for the query, in UNIX timestamp format.

1627357325

JobId

string

No

The job ID. You can obtain the value of this parameter from the response of the SubmitTraceM3u8Job operation.

****20b48fb04483915d4f2cd8ac****

PageNumber

integer

No

The page number.

0

PageSize

integer

No

The number of entries to return on each page.

10

Response elements

Element

Type

Description

Example

object

Schema of Response

Data

array<object>

The data returned.

array<object>

The data returned.

GmtCreate

integer

The creation time of the job.

1627357322

GmtModified

integer

The last modification time of the job.

1627357322

JobId

string

The job ID.

****d718e2ff4f018ccf419a7b71****

TraceMediaId

string

The media ID for the trace watermark.

****437bd2b105d07b12a9a82****

Output

object

The output video.

Type

string

The type of the output file. Valid values:

  • OSS: an OSS object.

  • Media: a media asset.

OSS

Media

string

The specific output information.

oss://bucket/object

Status

string

The current status of the job.

success

Trace

string

The watermark information.

test

UserData

string

The user-defined data.

112

UserId

integer

The ID of the user who initiated the job.

1346693276****

Message

string

The message returned.

ok

StatusCode

integer

The status code.

200

RequestId

string

The ID of the request.

******11-DB8D-4A9A-875B-275798******

Examples

Success response

JSON format

{
  "Data": [
    {
      "GmtCreate": 1627357322,
      "GmtModified": 1627357322,
      "JobId": "****d718e2ff4f018ccf419a7b71****",
      "TraceMediaId": "****437bd2b105d07b12a9a82****",
      "Output": {
        "Type": "OSS",
        "Media": "oss://bucket/object"
      },
      "Status": "success",
      "Trace": "test",
      "UserData": "112",
      "UserId": 0
    }
  ],
  "Message": "ok",
  "StatusCode": 200,
  "RequestId": "******11-DB8D-4A9A-875B-275798******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.