Querying a Relay Task

Function

This API is used to query a relay task.

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.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

live:stream:listPullTask

Read

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
live:stream:listPullTask	Read	-	-	-	-

URI

GET /v1/{project_id}/pull/stream/task

**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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
region	No	String	Definition Task region. Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition Offset. Constraints N/A Default Value N/A Value range: 0~2147483647
limit	No	Integer	Definition Number of records on each page. Constraints N/A Default Value N/A Value range: 1~100
task_id	No	String	Definition Task ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
task_infos	Array of LivePullTaskInfo objects	Definition Stream replay task list.
request_id	String	Definition Request ID. Range N/A
total	Integer	Definition Total number of records. Value range: 0~10000

**Table 5** LivePullTaskInfo
Parameter	Type	Description
task_id	String	Definition Task ID. Range N/A
status	String	Definition Task status. Range N/A
create_time	String	Definition Creation time. Range N/A
region	String	Definition Task execution region. Range N/A
source_type	String	Definition Source stream type. Range PullLivePushLive: livestreaming PullVodPushLive: video path
source_urls	Array of strings	Definition Source stream URL.
domain	String	Definition Ingest domain name. Range Length: 1 to 255 characters
app_name	String	Definition Application name. Range Length: 1 to 128 characters
stream_name	String	Definition Stream name. Range Length: 1 to 512 characters
push_args	String	Definition Stream push parameters. Range N/A
destination_url	String	Definition Complete target URL. Range Length: 0 to 2,048 characters If this parameter is specified, domain, app_name, and stream_name must be empty or not be transferred.
start_time	String	Definition Task start time in the format of 2006-01-02T15:04:05Z. Range N/A
end_time	String	Definition Task end time in the format of 2006-01-02T15:04:05Z. Range N/A
callback_events	Array of strings	Definition List of callback events. If this parameter is left blank, callbacks are sent for all events. TaskStart: task start callback TaskExit: task stop callback VodSourceFileStart: file switchover callback (available only for PullVodPushLive tasks) VodSourceFileFinish: file playback completion callback (available only for PullVodPushLive tasks) ResetTaskConfig: task update callback (available only for PullVodPushLive tasks) TaskAlarm: alarm event notification
callback_url	String	Definition Callback URL. Range N/A
backup_source_type	String	Definition Type of the standby source. This parameter is valid only when source_type is set to PullVodPushLive. When the primary source stream is interrupted, the system automatically switches to the standby source stream. Range PullLivePushLive: livestreaming
backup_source_urls	Array of strings	Definition Standby source URL. The array length is [0,30], and this parameter is valid only when source_type is set to PullVodPushLive.
vod_loop_time	String	Definition Number of playback rounds. This parameter is valid only when source_type is set to PullVodPushLive. Range -1: loops continuously until the specified end time. N: plays the file list for N rounds. Playback stops when the round count is exhausted or the end time is reached, whichever comes first. If this parameter is not transferred or is left empty (""), the default value takes effect.
vod_start_video_index	Integer	Definition Index of the file to be played. The value starts from 0, indicating the first file. The maximum value is len(source_urls) – 1. This parameter is valid only when source_type is set to PullVodPushLive. Value range: 0~8192
vod_start_video_time	Integer	Definition Second from which the specified file is played. This parameter is valid only when source_type is set to PullVodPushLive. Value range: 0~2100000000
vod_refresh_type	String	Definition File switching mode configured during task modifications. Range immediate_new_source: plays the content from the new source immediately. continue_from_file_start: resumes streaming from the beginning of the last interrupted URL/file. continue_from_break_point: resumes streaming from the exact breakpoint of the last interrupted URL/file (seamless continuation).

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
request_id	String	Request ID.

Status code: 404

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

Example Requests

GET https://{endpoint}/v1/{project_id}/pull/stream/task?region=cn-north-4&task_id=xxxxxx

Example Responses

Status code: 200

The relay task was queried.

{
  "request_id" : "85968475-e92f-42db-a754-08e627b6d8dd",
  "total" : 1,
  "task_infos" : [ {
    "task_id" : "7864b3dc-e92f-42db-a754-08e627b6d8dd",
    "status" : "suspend",
    "create_time" : "2018-05-19T10:00:00Z",
    "region" : "cn-north-4",
    "source_type" : "PullLivePushLive",
    "source_urls" : [ "rtmp://play.example.huawei.com/live/stream1" ],
    "domain" : "publish.example.huawei.com",
    "app_name" : "live",
    "stream_name" : "test",
    "start_time" : "2018-05-19T18:00:00Z",
    "end_time" : "2018-05-19T21:00:00Z",
    "push_args" : "arg1=value1",
    "destination_url" : "",
    "callback_events" : [ "TaskStart", "TaskExit", "TaskAlarm" ],
    "callback_url" : "callback.example.com",
    "backup_source_type" : "PullLivePushLive",
    "backup_source_urls" : [ "rtmp://play.example.huawei.com/live/stream1_bak" ]
  } ]
}

Status code: 400

Querying a relay task failed.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal",
  "request_id" : "85968475-e92f-42db-a754-08e627b6d8dd"
}

Status code: 404

The task was not found.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal",
  "request_id" : "85968475-e92f-42db-a754-08e627b6d8dd"
}

Status Codes

Status Code	Description
200	The relay task was queried.
400	Querying a relay task failed.
404	The task was not found.

Error Codes

See Error Codes.

Parent Topic: Stream Relay Management

Previous topic: Deleting a Relay Task

Next topic: Modifying a Relay Task

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot