查询实时上云计划下的设备通道列表

最近更新时间：2024-04-22 01:19:11

我的收藏

本页目录：

1. 接口描述

接口请求域名： iss.tencentcloudapi.com 。

用于查询实时上云计划下的设备通道列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListRecordPlanDevices。
Version	是	String	公共参数，本接口取值：2023-05-17。
Region	否	String	公共参数，此参数为可选参数。
PlanId	是	String	上云计划ID 示例值：88ac5ea6c1f**24671d0f94f
PageSize	是	Integer	每页最大数量示例值：10
PageNumber	是	Integer	第几页示例值：1
DeviceName	否	String	按照设备名称查询，为空时，不参考该参数通道名称、设备名称、组织名称同时只有一个有效，如果同时多个字段有值，按照通道名称、设备名称、组织名称的优先级顺序查询，如果都为空，则全量查询。长度不超过32字节示例值：某店
ChannelName	否	String	按照通道名称查询，为空时，不参考该参数通道名称、设备名称、组织名称同时只有一个有效，如果同时多个字段有值，按照通道名称、设备名称、组织名称的优先级顺序查询，如果都为空，则全量查询。长度不超过32字节示例值：大门口
OrganizationName	否	String	按照组织名称查询\|，为空时，不参考该参数通道名称、设备名称、组织名称同时只有一个有效，如果同时多个字段有值，按照通道名称、设备名称、组织名称的优先级顺序查询，如果都为空，则全量查询。长度不超过32字节示例值：上海地区

3. 输出参数

参数名称	类型	描述
Data	ListRecordPlanDevicesData	返回结果
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 无查询条件

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListRecordPlanDevices
<公共请求参数>

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

输出示例

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

示例2 按照组织名称查询

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListRecordPlanDevices
<公共请求参数>

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

输出示例

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

示例3 按照设备名称查询

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListRecordPlanDevices
<公共请求参数>

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

输出示例

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

示例4 按照通道名称查询

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListRecordPlanDevices
<公共请求参数>

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败
InvalidParameter.InvalidBodyFormat	无效的消息体格式
InvalidParameterValue.EmptyName	名称不能为空
InvalidParameterValue.IllegalName	名称中包含不符合要求的字符(仅支持中文、英文、数字、_、-)
InvalidParameterValue.InvalidPageNumber	无效的PageNumber
InvalidParameterValue.InvalidPageSize	无效的PageSize
InvalidParameterValue.InvalidPlanId	无效的计划ID
InvalidParameterValue.TooLongName	名称过长
ResourceNotFound.PlanNotExist	计划不存在

上一篇: 查询实时上云计划详情下一篇: 查询用户下所有实时上云计划中的通道列表