tencent cloud

APIs

ListRecordBackupPlanDevices

下载
聚焦模式
字号
最后更新时间: 2026-10-26 11:48:40

1. API Description

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

This API is used to query the device channel list under a recording cloud migration plan.

A maximum of 5 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: ListRecordBackupPlanDevices.
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.
PlanId Yes String Recording schedule ID (obtain from the ListRecordBackupPlans API for querying the recording cloud migration plan list)
DeviceName No String Query by device name (if empty, this parameter is not used for reference)
ChannelName No String Query by channel name (if empty, ignore this parameter)
OrganizationName No String Query by organization name (if empty, this parameter is not used for reference)
PageSize No Integer Maximum number of items per page
PageNumber No Integer Page number

3. Output Parameters

Parameter Name Type Description
Data ListRecordBackupPlanDevicesData 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.

4. Example

Example1 Success

Input Example

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

{
    "PlanId": "12345678-abcd-efgh-ijkl-1234567890abcd"
}

Output Example

{
    "Response": {
        "Data": {
            "List": null,
            "PageNumber": 0,
            "PageSize": 20,
            "TotalCount": 0
        },
        "RequestId": "f6951e81-bde0-4e2a-9bf2-203f8416eec0"
    }
}

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
FailedOperation Operation failed
InvalidParameterValue.InvalidChannelName Channel name is empty or incorrect.
InvalidParameterValue.InvalidDeviceName Device name is empty or incorrect.
InvalidParameterValue.InvalidOrgName Organization name is empty or incorrect.
InvalidParameterValue.InvalidPlanId Invalid plan ID

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈