Modifying a Relay Task
Function
This API is used to modify a relay task. The modifications take effect only when source_type is set to PullVodPushLive for the 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, no identity policy-based permission required for calling this API.
URI
PUT /v1/{project_id}/pull/stream/task
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Request 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
| Parameter | Type | Description |
|---|---|---|
| task_id | String | Definition Task ID. Range N/A |
| request_id | String | Definition Request ID. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
| request_id | String | Request ID. |
Example Requests
PUT https://{endpoint}/v1/{project_id}/pull/stream/task
{
"task_id" : "xxxxxxxxxx",
"status" : "pause",
"source_urls" : [ "rtmp://play.example.huawei.com/live/stream1" ],
"start_time" : "2018-05-19T18:00:00Z",
"end_time" : "2018-05-19T21:00:00Z",
"vod_loop_time" : "-1",
"vod_refresh_type" : "immediate_new_source",
"vod_start_video_index" : 0,
"vod_start_video_time" : 0,
"callback_events" : [ "TaskStart", "VodSourceFileStart", "VodSourceFileFinish", "ResetTaskConfig", "TaskExit", "TaskAlarm" ]
} Example Responses
Status code: 200
Modifying a relay task succeeded.
{
"task_id" : "7864b3dc-e92f-42db-a754-08e627b6d8dd",
"request_id" : "85968475-e92f-42db-a754-08e627b6d8dd"
} Status code: 400
Modifying a relay task failed.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal",
"request_id" : "85968475-e92f-42db-a754-08e627b6d8dd"
} SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.live.v1.region.LiveRegion; import com.huaweicloud.sdk.live.v1.*; import com.huaweicloud.sdk.live.v1.model.*; import java.time.OffsetDateTime; import java.time.format.DateTimeFormatter; import java.util.List; import java.util.ArrayList; public class ModifyPullTaskSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); ModifyPullTaskRequest request = new ModifyPullTaskRequest(); ModifyLivePullStreamTask body = new ModifyLivePullStreamTask(); List<ModifyLivePullStreamTask.CallbackEventsEnum> listbodyCallbackEvents = new ArrayList<>(); listbodyCallbackEvents.add(ModifyLivePullStreamTask.CallbackEventsEnum.fromValue("TaskStart")); listbodyCallbackEvents.add(ModifyLivePullStreamTask.CallbackEventsEnum.fromValue("VodSourceFileStart")); listbodyCallbackEvents.add(ModifyLivePullStreamTask.CallbackEventsEnum.fromValue("VodSourceFileFinish")); listbodyCallbackEvents.add(ModifyLivePullStreamTask.CallbackEventsEnum.fromValue("ResetTaskConfig")); listbodyCallbackEvents.add(ModifyLivePullStreamTask.CallbackEventsEnum.fromValue("TaskExit")); listbodyCallbackEvents.add(ModifyLivePullStreamTask.CallbackEventsEnum.fromValue("TaskAlarm")); List<String> listbodySourceUrls = new ArrayList<>(); listbodySourceUrls.add("rtmp://play.example.huawei.com/live/stream1"); body.withCallbackEvents(listbodyCallbackEvents); body.withVodStartVideoTime(0); body.withEndTime(OffsetDateTime.parse("2018-05-19T21:00:00Z", DateTimeFormatter.ISO_OFFSET_DATE_TIME)); body.withStartTime(OffsetDateTime.parse("2018-05-19T18:00:00Z", DateTimeFormatter.ISO_OFFSET_DATE_TIME)); body.withVodStartVideoIndex(0); body.withVodRefreshType(ModifyLivePullStreamTask.ModifyLivePullStreamTask.fromValue("immediate_new_source")); body.withVodLoopTime("-1"); body.withSourceUrls(listbodySourceUrls); body.withStatus(ModifyLivePullStreamTask.ModifyLivePullStreamTask.fromValue("pause")); body.withTaskId("xxxxxxxxxx"); request.withBody(body); try { ModifyPullTaskResponse response = client.modifyPullTask(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklive.v1.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = ModifyPullTaskRequest() listCallbackEventsbody = [ "TaskStart", "VodSourceFileStart", "VodSourceFileFinish", "ResetTaskConfig", "TaskExit", "TaskAlarm" ] listSourceUrlsbody = [ "rtmp://play.example.huawei.com/live/stream1" ] request.body = ModifyLivePullStreamTask( callback_events=listCallbackEventsbody, vod_start_video_time=0, end_time="2018-05-19T21:00:00Z", start_time="2018-05-19T18:00:00Z", vod_start_video_index=0, vod_refresh_type="immediate_new_source", vod_loop_time="-1", source_urls=listSourceUrlsbody, status="pause", task_id="xxxxxxxxxx" ) response = client.modify_pull_task(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | package main import ( "fmt" "time" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/sdktime" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := live.NewLiveClient(hcClient) request := &model.ModifyPullTaskRequest{} var listCallbackEventsbody = []model.ModifyLivePullStreamTaskCallbackEvents{ model.GetModifyLivePullStreamTaskCallbackEventsEnum().TASK_START, model.GetModifyLivePullStreamTaskCallbackEventsEnum().VOD_SOURCE_FILE_START, model.GetModifyLivePullStreamTaskCallbackEventsEnum().VOD_SOURCE_FILE_FINISH, model.GetModifyLivePullStreamTaskCallbackEventsEnum().RESET_TASK_CONFIG, model.GetModifyLivePullStreamTaskCallbackEventsEnum().TASK_EXIT, model.GetModifyLivePullStreamTaskCallbackEventsEnum().TASK_ALARM, } var listSourceUrlsbody = []string{ "rtmp://play.example.huawei.com/live/stream1", } vodStartVideoTimeModifyLivePullStreamTask:= int32(0) dateTimeEndTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2018-05-19T21:00:00Z", time.UTC) endTimeModifyLivePullStreamTask:= sdktime.SdkTime(dateTimeEndTime) dateTimeStartTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "2018-05-19T18:00:00Z", time.UTC) startTimeModifyLivePullStreamTask:= sdktime.SdkTime(dateTimeStartTime) vodStartVideoIndexModifyLivePullStreamTask:= int32(0) vodRefreshTypeModifyLivePullStreamTask:= model.GetModifyLivePullStreamTaskVodRefreshTypeEnum().IMMEDIATE_NEW_SOURCE vodLoopTimeModifyLivePullStreamTask:= "-1" statusModifyLivePullStreamTask:= model.GetModifyLivePullStreamTaskStatusEnum().PAUSE request.Body = &model.ModifyLivePullStreamTask{ CallbackEvents: &listCallbackEventsbody, VodStartVideoTime: &vodStartVideoTimeModifyLivePullStreamTask, EndTime: &endTimeModifyLivePullStreamTask, StartTime: &startTimeModifyLivePullStreamTask, VodStartVideoIndex: &vodStartVideoIndexModifyLivePullStreamTask, VodRefreshType: &vodRefreshTypeModifyLivePullStreamTask, VodLoopTime: &vodLoopTimeModifyLivePullStreamTask, SourceUrls: &listSourceUrlsbody, Status: &statusModifyLivePullStreamTask, TaskId: "xxxxxxxxxx", } response, err := client.ModifyPullTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Modifying a relay task succeeded. |
| 400 | Modifying a relay task failed. |
Error Codes
See Error Codes.
What is your overall rating for this page?
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.
For any further questions, feel free to contact us through the chatbot.
Chatbot