Domain name for API request: iss.intl.tencentcloudapi.com.
This API is used to query the device cloud recording timeline information, which is the cloud storage video recording after setting a recording schedule for video upload to cloud.
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: DescribeRecordFile. |
| 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. |
| DeviceId | Yes | String | Device ID to which the channel belongs |
| ChannelId | Yes | String | Channel ID |
| StartTime | Yes | Integer | Search start time 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 | Search end time, UTC seconds. Example: 1662114246. The longest period between the start and end times is one day, and cannot span multiple days. |
| WithUrl | No | Boolean | Whether to carry the playback url for each time period |
| Parameter Name | Type | Description |
|---|---|---|
| Data | DescribeRecordFileData | Returned result |
| 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: DescribeRecordFile
<Common request parameters>
{
"DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
"ChannelId": "32525dd7-c3fc-****-****-d5beb4acd1e1",
"StartTime": 1687622400,
"EndTime": 1687708799
}{
"Response": {
"Data": {
"List": null,
"Tips": 0
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRecordFile
<Common request parameters>
{
"DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
"ChannelId": "32525dd7-c3fc-****-****-d5beb4acd1e1",
"StartTime": 1687622400,
"EndTime": 1687708799
}{
"Response": {
"Data": {
"Tips": 0,
"List": [
{
"Begin": 1687651516,
"End": 1687653336
},
{
"Begin": 1687653336,
"End": 1687655156
},
{
"Begin": 1687655156,
"End": 1687656976
},
{
"Begin": 1687656976,
"End": 1687658796
}
]
},
"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.InvalidParameter | Invalid input parameter |
| InvalidParameterValue.IllegalChannelId | Channel ID contains illegal characters |
| InvalidParameterValue.IllegalDeviceId | Device ID contains illegal characters |
| InvalidParameterValue.InvalidChannelId | Invalid channel ID |
| InvalidParameterValue.InvalidDeviceId | Invalid device ID |
| InvalidParameterValue.InvalidStartTimeOrEndTime | Invalid start or end time |
| InvalidParameterValue.NonSameDay | Time cannot span across days. |
| InvalidParameterValue.StartTimeGreaterThanOrEqualEndTime | Start time cannot be greater than or equal to end time. |
| ResourceNotFound.DeviceNotExist | Device does not exist |
文档反馈