Domain name for API request: trtc.tencentcloudapi.com.
Stop a Pull stream Relay task.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: StopStreamIngest. |
Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-jakarta, ap-mumbai, ap-singapore. |
SdkAppId | Yes | Integer | The SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the task's room. |
TaskId | Yes | String | The unique Task ID, which will be returned after the task is successfully started. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
将SdkAppId为1234567890下的任务1234停止
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StopStreamIngest
<common request parameters>
{
"SdkAppId": 1234567890,
"TaskId": "1234"
}
{
"Response": {
"RequestId": "71993312-6ab8-4768-9124-118e0a20c45f"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.TaskFinished | Task has ended when calling the interface. |
InvalidParameter.BodyParamsError | Failed to parse body parameters. |
InvalidParameter.SdkAppId | SdkAppId is incorrect. |
InvalidParameter.TaskId | TaskId parameter error. |
本页内容是否解决了您的问题?