tencent cloud

APIs

文档APIsIntelligent Surveillance StorageRecording Schedule APIsListRecordPlanDevices

ListRecordPlanDevices

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

1. API Description

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

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

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.

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: ListRecordPlanDevices.
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 Cloud migration plan ID
PageSize Yes Integer Maximum number of items per page.
PageNumber Yes Integer Which page.
DeviceName No String Query by device name. If it is empty, ignore this parameter.
Only one of the channel name, device name, and organization name is valid at the same time. If multiple fields have values at the same time, query by the priority order of channel name, device name, and organization name. If all are empty, perform a full query. The length cannot exceed 32 bytes.
ChannelName No String Query by channel name. If it is empty, ignore this parameter.
Only one of the channel name, device name, and organization name is valid at the same time. If multiple fields have values at the same time, query by the priority order of channel name, device name, and organization name. If all are empty, perform a full query. The length cannot exceed 32 bytes.
OrganizationName No String Query by organization name. If it is empty, ignore this parameter.
Only one of the channel name, device name, and organization name is valid at the same time. If multiple fields have values at the same time, query by the priority order of channel name, device name, and organization name. If all are empty, perform a full query. The length cannot exceed 32 bytes.

3. Output Parameters

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

4. Example

Example1 No query condition

Input Example

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

{
    "PlanId": "88ac5ea6c1f**********24671d0f94f",
    "PageSize": 5,
    "PageNumber": 1
}

Output Example

{
    "Response": {
        "Data": {
            "List": [
                {
                    "ChannelId": "000fb77b-****-****-****-d4aff5503d70",
                    "ChannelName": "dev_1",
                    "DeviceId": "81b14b2d-****-****-****-3d1a3c3f630f",
                    "DeviceName": "gb-device11814",
                    "OrganizationName": "Organization 1",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "0020a697-****-****-****-c836d9f95075",
                    "ChannelName": "dev_1",
                    "DeviceId": "c94a9cc1-****-****-****-c87b6065893d",
                    "DeviceName": "gb-device11820",
                    "OrganizationName": "Organization 2",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "002b99cb-****-****-****-fb573cc57ab8",
                    "ChannelName": "dev_1",
                    "DeviceId": "a7718b36-****-****-****-b417bd2aa809",
                    "DeviceName": "gb-device3633",
                    "OrganizationName": "Organization 2",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "15daac41-****-****-****-0cadab7a6256",
                    "ChannelName": "PTZ03",
                    "DeviceId": "cae2132a-****-****-****-19cc90a61f06",
                    "DeviceName": "NVR-04",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "222c9da5-****-****-****-107c013b95a7",
                    "ChannelName": "PTZ09",
                    "DeviceId": "389708b2-****-****-****-a61f528b2a15",
                    "DeviceName": "SDK-NVR05",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                }
            ],
            "PageNumber": 1,
            "PageSize": 5,
            "TotalCount": 15
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

Example2 Query by organization name

Input Example

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

{
    "PlanId": "88ac5ea6c1f**********24671d0f94f",
    "OrganizationName": "201",
    "PageSize": 5,
    "PageNumber": 1
}

Output Example

{
    "Response": {
        "Data": {
            "List": [
                {
                    "ChannelId": "15daac41-f309-****-****-0cadab7a6256",
                    "ChannelName": "PTZ03",
                    "DeviceId": "cae2132a-7edc-****-****-19cc90a61f06",
                    "DeviceName": "NVR-04",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "222c9da5-3e06-****-****-107c013b95a7",
                    "ChannelName": "DaHua-PTZ 09",
                    "DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
                    "DeviceName": "SDK-NVR05",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "32525dd7-c3fc-****-****-d5beb4acd1e1",
                    "ChannelName": "11",
                    "DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
                    "DeviceName": "SDK-NVR05",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "53ca64d3-9627-****-****-cea5122f6977",
                    "ChannelName": "PTZ03",
                    "DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
                    "DeviceName": "SDK-NVR05",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "60a645e8-3140-****-****-98a62528232b",
                    "ChannelName": "IPDome",
                    "DeviceId": "3f6c847f-b6ea-****-****-2bfc8208d97e",
                    "DeviceName": "onvif03",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                }
            ],
            "PageNumber": 1,
            "PageSize": 5,
            "TotalCount": 12
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

Example3 Query by device name

Input Example

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

{
    "PlanId": "88ac5ea6c1f**********24671d0f94f",
    "DeviceName": "NVR05",
    "PageSize": 5,
    "PageNumber": 1
}

Output Example

{
    "Response": {
        "Data": {
            "List": [
                {
                    "ChannelId": "222c9da5-3e06-****-****-107c013b95a7",
                    "ChannelName": "PTZ09",
                    "DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
                    "DeviceName": "SDK-NVR05",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "32525dd7-c3fc-****-****-d5beb4acd1e1",
                    "ChannelName": "11",
                    "DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
                    "DeviceName": "SDK-NVR05",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "53ca64d3-9627-****-****-cea5122f6977",
                    "ChannelName": "PTZ03",
                    "DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
                    "DeviceName": "SDK-NVR05",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                },
                {
                    "ChannelId": "c80a0ebf-10ac-****-****-8083f18df240",
                    "ChannelName": "PTZ17",
                    "DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
                    "DeviceName": "SDK-NVR05",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                }
            ],
            "PageNumber": 1,
            "PageSize": 4,
            "TotalCount": 4
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

Example4 Query by channel name

Input Example

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

{
    "PlanId": "88ac5ea6c1f**********24671d0f94f",
    "ChannelName": "11",
    "PageSize": 5,
    "PageNumber": 1
}

Output Example

{
    "Response": {
        "Data": {
            "List": [
                {
                    "ChannelId": "32525dd7-c3fc-****-****-d5beb4acd1e1",
                    "ChannelName": "11",
                    "DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
                    "DeviceName": "SDK-NVR05",
                    "OrganizationName": "201",
                    "AccessProtocol": 2
                }
            ],
            "PageNumber": 1,
            "PageSize": 1,
            "TotalCount": 1
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

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
InvalidParameter.InvalidBodyFormat Invalid message body format
InvalidParameterValue.EmptyName Name cannot be empty
InvalidParameterValue.IllegalName Name contains non-compliant characters (only Chinese, English, digits, _, and - are supported)
InvalidParameterValue.InvalidPageNumber Invalid PageNumber
InvalidParameterValue.InvalidPageSize Invalid PageSize
InvalidParameterValue.InvalidPlanId Invalid plan ID
InvalidParameterValue.TooLongName Name is too long
ResourceNotFound.PlanNotExist Plan not found
上一篇: DescribeRecordPlan下一篇: ListRecordPlans

帮助和支持

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

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

文档反馈

搜索
    请输入关键词搜索文档