ModifyCloudSliceTask
1. API Description
Domain name for API request: trtc.intl.tencentcloudapi.com.
This API is used to update the slicing task after it is started. It can be used to update the allowlist or blocklist for the specified subscription stream.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: ModifyCloudSliceTask. |
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-singapore, eu-frankfurt. |
SdkAppId | Yes | Integer | SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the TRTC room. |
TaskId | Yes | String | Unique ID of the slicing task, which is returned after the task is started. |
SubscribeStreamUserIds | No | SubscribeStreamUserIds | Specifies the allowlist or blocklist for the subscription stream. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
TaskId | String | Unique ID of the slicing task, which is returned after the task is started. |
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. |
4. Example
Example1 Modifying a Cloud Slicing Task
Input Example
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCloudSliceTask
<Common request parameters>
{
"SdkAppId": 20010806,
"TaskId": "-nHwQ8NU7t7Ps1bc3MXN7wTw1-BZVg7bbhyXLoK-mumNM6KipeAYnB3iUGIpBL-ajrCF-pd2AQ..",
"SubscribeStreamUserIds": {
"SubscribeAudioUserIds": [
"555"
]
}
}
Output Example
{
"Response": {
"RequestId": "b4d09681-4413-4f21-972d-bba98422aa30",
"TaskId": "-nHwQ8NU7t7Ps1bc3MXN7wTw1-BZVg7bbhyXLoK-mumNM6KipeAYnB3iUGIpBL-ajrCF-pd2AQ.."
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
AuthFailure | CAM signature/authentication error. |
AuthFailure.UnRealNameAuthenticated | Identity verification has not been completed, so this operation is not allowed. |
AuthFailure.UnauthorizedOperation | CAM authentication failed. |
AuthFailure.UnsupportedOperation | Unsupported operation. |
FailedOperation | Operation failed. |
FailedOperation.CSUnsupportMethod | The cloud slicing method is not supported. |
InternalError.CSInternalError | Internal service error of cloud slicing occurs. |
InvalidParameter.OutOfRange | Parameter value is out of range. |
MissingParameter.RoomId | RoomId is missing. |
MissingParameter.SdkAppId | SdkAppId is missing. |
MissingParameter.TaskId | TaskId parameter missing. |
MissingParameter.UserId | Missing UserId parameter. |
ResourceNotFound | The resource does not exist. |