有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: mna.tencentcloudapi.com 。

获取厂商硬件设备列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetVendorHardware。
Version String 公共参数,本接口取值:2021-01-19。
Region String 公共参数,详见产品支持的 地域列表
PageNumber Integer 页码
示例值:1
PageSize Integer 页面数量
示例值:10
Keyword String 关键字
示例值:mna-xxx
Status Integer 激活状态,
空:全部;
1:待激活;
2:已激活;
示例值:1

3. 输出参数

参数名称 类型 描述
VendorHardware Array of VendorHardware 硬件信息列表
Length Integer 设备总数
示例值:10
TotalPage Integer 总页数
示例值:3
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 厂商查看设备

厂商查看设备

输入示例

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

{
    "PageNumber": 1,
    "PageSize": 11
}

输出示例

{
    "Response": {
        "Length": 11,
        "RequestId": "728a4c82-b31c-4b32-9cee-3ba1fdd1903c",
        "TotalPage": 2,
        "VendorHardware": [
            {
                "CreateTime": "1685591205",
                "Description": "",
                "DeviceId": "",
                "HardwareId": "cpe-5n9n3o63t2",
                "LicenseChargingMode": 2,
                "SN": "cloud-sn",
                "Status": 1
            },
            {
                "CreateTime": "1685430273",
                "Description": "Description",
                "DeviceId": "",
                "HardwareId": "cpe-3lk7lfbsyu",
                "LicenseChargingMode": 1,
                "SN": "cpe-sn",
                "Status": 1
            },
            {
                "CreateTime": "1685447830",
                "Description": "test",
                "DeviceId": "",
                "HardwareId": "cpe-aypx5a3crh",
                "LicenseChargingMode": 1,
                "SN": "cpe-sn -5",
                "Status": 1
            },
            {
                "CreateTime": "1685449404",
                "Description": "",
                "DeviceId": "",
                "HardwareId": "cpe-2ycsnymh2u",
                "LicenseChargingMode": 1,
                "SN": "cpe-sn-04",
                "Status": 1
            },
            {
                "CreateTime": "1685449404",
                "Description": "",
                "DeviceId": "",
                "HardwareId": "cpe-z6sm6srvbm",
                "LicenseChargingMode": 2,
                "SN": "cpe-sn-05",
                "Status": 1
            },
            {
                "CreateTime": "1685509926",
                "Description": "",
                "DeviceId": "",
                "HardwareId": "cpe-r6739p8h1t",
                "LicenseChargingMode": 1,
                "SN": "cpe-sn-06",
                "Status": 1
            },
            {
                "CreateTime": "1685509926",
                "Description": "",
                "DeviceId": "",
                "HardwareId": "cpe-pjugv0zyan",
                "LicenseChargingMode": 2,
                "SN": "cpe-sn-07",
                "Status": 1
            },
            {
                "ActiveTime": "1685514528",
                "CreateTime": "1685510058",
                "Description": "",
                "DeviceId": "mna-fsap0nz6lp",
                "HardwareId": "cpe-9gi3engwpb",
                "LicenseChargingMode": 1,
                "SN": "cpe-sn-08",
                "Status": 2
            },
            {
                "CreateTime": "1685514559",
                "Description": "",
                "DeviceId": "",
                "HardwareId": "cpe-n17ndxng5p",
                "LicenseChargingMode": 1,
                "SN": "cpe-sn-09",
                "Status": 1
            },
            {
                "CreateTime": "1685430552",
                "Description": "",
                "DeviceId": "",
                "HardwareId": "cpe-5hgb388vw2",
                "LicenseChargingMode": 1,
                "SN": "cpe-sn-1",
                "Status": 1
            },
            {
                "CreateTime": "1685514559",
                "Description": "",
                "DeviceId": "",
                "HardwareId": "cpe-do4t0e8uaw",
                "LicenseChargingMode": 1,
                "SN": "cpe-sn-10",
                "Status": 1
            }
        ]
    }
}

示例2 获取厂商设备列表

获取厂商设备列表

输入示例

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

{
    "PageNumber": 1,
    "PageSize": 10,
    "Keyword": "abc",
    "Status": 0
}

输出示例

{
    "Response": {
        "VendorHardware": [
            {
                "HardwareId": "abc",
                "SN": "abc",
                "CreateTime": "abc",
                "Status": 0,
                "ActiveTime": "abc",
                "Description": "abc",
                "DeviceId": "abc",
                "LicenseChargingMode": 0,
                "LastOnlineTime": "abc"
            }
        ],
        "Length": 0,
        "TotalPage": 0,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.ControlRequestError 请求控制器发生错误。
InvalidParameterValue 参数取值错误。
OperationDenied.VendorNotRegister 当前账号尚未注册为厂商。