Domain name for API request: iss.intl.tencentcloudapi.com.
This API is used to create a retrieval task.
A maximum of 5 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: AddRecordRetrieveTask. |
| Version | Yes | String | Common Params. The value used for this API: 2023-05-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| TaskName | Yes | String | Task name. It supports Chinese, English, digits, _, and -, with a length not exceeding 32 characters. The name must be globally unique and cannot be empty or repeated. |
| StartTime | Yes | Integer | Start time for retrieving the video recording in UTC seconds, for example: 1662114146. The longest period between the start and end times is one day and cannot span multiple days. |
| EndTime | Yes | Integer | End time for retrieving the video recording, in UTC seconds, for example: 1662114146. The period between the start and end times can be up to one day and cannot span multiple days. |
| Mode | Yes | Integer | Retrieval mode. 1: ultrafast mode. Others not supported currently. |
| Expiration | Yes | Integer | Retrieval replica validity period of the video recording. Minimum: 1 day. Maximum: 365 days. |
| Channels.N | Yes | Array of ChannelInfo | Device channel. A task can contain up to 32 device channels. |
| Describe | No | String | Retrieve the task description |
| Parameter Name | Type | Description |
|---|---|---|
| Data | AddRecordRetrieveTaskData | Returned results |
| 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. |
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddRecordRetrieveTask
<Common request parameters>
{
"TaskName": "name",
"Describe": "Retrieve a channel"
"StartTime": 1687688595,
"EndTime": 1687692195,
"Mode": 1,
"Expiration": 3,
"Channels": [
{
"DeviceId": "64505f15-67b1-****-****-0ad6c8ce6aef",
"ChannelId": "0001a415-b9c1-****-****-b13cfb96c778"
}
]
}{
"Response": {
"Data": {
"TaskId": "1133f5f9c3**********1c3389527532",
"TaskName": "name",
"StartTime": 1687688595,
"EndTime": 1687692195,
"Mode": 1,
"Expiration": 3,
"Status": 2,
"Capacity": 0,
"Describe": ""
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}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 | Operation failed |
| InvalidParameter.InvalidBodyFormat | Invalid message body format |
| InvalidParameter.InvalidChannels | Invalid channel parameters |
| InvalidParameter.InvalidLifeRuleParam | Invalid lifecycle parameter |
| InvalidParameterValue.EmptyChannelId | Channel ID cannot be empty. |
| InvalidParameterValue.EmptyDeviceId | Device ID cannot be empty. |
| InvalidParameterValue.EmptyName | Name cannot be empty |
| InvalidParameterValue.IllegalDescribe | Description contains non-compliant characters (only Chinese, English, digits, _, and - are supported) |
| InvalidParameterValue.IllegalName | Name contains non-compliant characters (only Chinese, English, digits, _, and - are supported) |
| InvalidParameterValue.InvalidChannelIdOrDeviceId | Contains an invalid channel ID or device ID |
| InvalidParameterValue.InvalidExpiration | Invalid replica validity period. Valid values: 1-365 days |
| InvalidParameterValue.InvalidRetrievalMode | Invalid retrieval mode |
| InvalidParameterValue.InvalidStartTimeOrEndTime | Invalid start or end time |
| InvalidParameterValue.NonSameDay | Time cannot span across days. |
| InvalidParameterValue.RetrieveTaskChannelsExceedsRange | Add up to 32 device channels to a retrieval task. |
| InvalidParameterValue.StartTimeGreaterThanOrEqualEndTime | Start time cannot be greater than or equal to end time. |
| InvalidParameterValue.TooLongDescribe | Description field too long |
| InvalidParameterValue.TooLongName | Name is too long |
| MissingParameter.MissingRetrieveTaskParam | Lack of retrieval task parameter |
| ResourceInUse.RetrieveTaskNameRepeat | Retrieval task names cannot be duplicated. |
フィードバック