1. API Description
Domain name for API request: trtc.intl.tencentcloudapi.com.
This API is used to query the status of a recording task after it starts. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned.
If a recording file is being uploaded to VOD, the response parameter StorageFileList will not contain the information of the recording file. Please listen for the recording file callback to get the information.
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.
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: DescribeCloudRecording. |
| 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-beijing, ap-guangzhou, ap-mumbai, ap-shanghai, ap-singapore. |
| SdkAppId |
Yes |
Integer |
The SDKAppID of the room whose streams are recorded. |
| TaskId |
Yes |
String |
The unique ID of the recording task, which is returned after recording starts successfully. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TaskId |
String |
The unique ID of the recording task. |
| Status |
String |
The status of the on-cloud recording task.
Idle: The task is idle.
InProgress: The task is in progress.
Exited: The task is being ended. |
| StorageFileList |
Array of StorageFile |
The information of the recording files.
Note: This field may return null, indicating that no valid values can be obtained. |
| 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 the status of the task whose task ID is xx under the application whose SDKAppID is 1234
POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudRecording
<Common request parameters>
{
"TaskId": "xx",
"SdkAppId": 1234
}
Output Example
{
"Response": {
"Status": "InProgress",
"StorageFileList": [],
"RequestId": "xx",
"TaskId": "xx"
}
}
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
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.CRUnsupportMethod |
Unsupported on-cloud recording method. |
| InternalError.CRInternalError |
On-cloud recording internal error. |
| 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. |