Domain name for API request: iss.intl.tencentcloudapi.com.
Used to add a recording cloud migration plan (currently applicable only to devices/video channels connected via the GB28181 protocol and gateway).
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: AddRecordBackupPlan. |
| Version | Yes | String | Common Params. The value used for this API: 2023-05-17. |
| Region | No | String | Common Params. This parameter is not required. |
| TemplateId | Yes | String | Recording template ID (template ID associated with the recording schedule, obtained from the ListRecordBackupTemplates API for querying the video cloud template list) |
| PlanName | Yes | String | Recording schedule name (supports Chinese, English, digits, _ and -. The length cannot exceed 32 characters. The plan name must be globally unique and cannot be empty or duplicated.) |
| Describe | Yes | String | Video recording plan description (only supports Chinese, English, digits, _, -, length not exceeding 128 characters) |
| LifeCycle | Yes | LifeCycleData | Lifecycle (video recording file lifecycle settings, the time when cold and hot storage is managed for files) |
| Channels.N | No | Array of ChannelInfo | Channel and the device to which the channel belongs (channel information of the device to which a video recording is added. Add no more than 5,000 channels at a time, including the number of channels under the organizational unit directory). |
| OrganizationId.N | No | Array of String | Add all device channels under the organizational unit directory (Json array, can be empty, total number of channels no more than 5000, including the number of Channel fields) |
| Parameter Name | Type | Description |
|---|---|---|
| Data | AddRecordBackupPlanData | Returned data. |
| 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: AddRecordBackupPlan
<Common request parameters>
{
"TemplateId": "abcdefgh-1234-5678-ijkl-1234567890ab",
"PlanName": "test-plan-1",
"Describe": "test1",
"LifeCycle": {
"Transition": 7,
"Expiration": 0
},
"OrganizationId": [
"191"
]
}{
"Response": {
"Data": {
"ChannelCount": 0,
"CreateAt": "2023-06-05 15:11:43",
"Describe": "test1",
"LifeCycle": {
"Expiration": 0,
"Transition": 7
},
"PlanId": "hijklmno-efgh-5678-ijkl-1234567890ab",
"PlanName": "test-plan-1",
"Status": 0,
"TemplateId": "abcdefgh-1234-5678-ijkl-1234567890ab",
"UpdateAt": "2023-06-05 15:11:43"
},
"RequestId": "b00b406c-b891-4ef0-9169-16dc4c51e8a9"
}
}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 |
| InvalidParameterValue.InvalidChannelId | Invalid channel ID |
| InvalidParameterValue.InvalidDescription | Incorrect description. |
| InvalidParameterValue.InvalidDeviceId | Invalid device ID |
| InvalidParameterValue.InvalidName | Name is empty or incorrect. |
| InvalidParameterValue.InvalidOrganizationId | Invalid organization ID |
| InvalidParameterValue.InvalidTemplateId | Invalid template ID |
| InvalidParameterValue.PlanNameRepeat | Plan name must be unique |
| ResourceInUse.PlanNameRepeat | Plan name must be unique |
| ResourceNotFound | Resource does not exist. |
文档反馈