当前内容仅提供英语版本，中文版我们将尽快补充，感谢您的理解。

DescribeCloudModeration

1. API Description

Domain name for API request: trtc.intl.tencentcloudapi.com.

This API is used to query the status of the moderation task and information about the subscription blocklist and allowlist after the task is started, which is valid only when the task is in progress. An error will be returned if the task is exited.

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: DescribeCloudModeration.
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.
SdkAppId	Yes	Integer	SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the recording room.
TaskId	Yes	String	Unique ID of the cloud moderation task, which is returned after the task is started.

3. Output Parameters

Parameter Name	Type	Description
TaskId	String	Unique ID of the moderation task, which is returned after the task is started.
Status	String	Information about the status of the cloud moderation task. Idle: indicates the current task is idle; InProgress: indicates the current task is in progress; Exited: indicates the current task is being exited.
SubscribeStreamUserIds	SubscribeModerationUserIds	Subscription blocklist and allowlist.
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 Querying Information About Cloud Moderation Tasks

Input Example

POST / HTTP/1.1
Host: xxx.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudModeration
<Common request parameters>

{
    "SdkAppId": 20010806,
    "TaskId": "-nHwQ8NU7t7Ps1bc3MXN7wTw1-BZVg7bbhyXLoK-mumNM6KipeAYnB3iUGIpBL-ajrCF-pd2AQ.."
}

Output Example

{
    "Response": {
        "TaskId": "-npVoIhU7nVF+0aF9cAU08H4y253LKPbBX+UIoK-4pycoZWQndibGOPu9klhRT7bEDv5XoewCQE.",
        "Status": "InProgress",
        "RequestId": "uis_mock",
        "SubscribeStreamUserIds": {
            "SubscribeAudioUserIds": [],
            "UnSubscribeAudioUserIds": [],
            "SubscribeVideoUserIds": [],
            "UnSubscribeVideoUserIds": []
        }
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.
InvalidParameter.SdkAppId	`SdkAppId` is incorrect.
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.