物联网开发平台获取网关可操作的子产品-API 文档-文档中心-腾讯云

1. 接口描述

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

用于获取网关可绑定或解绑的子产品

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeGatewaySubProducts。
Version	是	String	公共参数，本接口取值：2019-04-23。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。
GatewayProductId	是	String	网关产品ID 示例值：gatewayProductId
Offset	否	Integer	分页的偏移量示例值：1
Limit	否	Integer	分页的大小示例值：10
ProjectId	否	String	项目Id 示例值：pri_1233545
ProductSource	否	Integer	是否跨账号产品示例值：1

3. 输出参数

参数名称	类型	描述
Products	Array of BindProductInfo	当前分页的可绑定或解绑的产品信息。
Total	Integer	可绑定或解绑的产品总数示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 用于获取网关可绑定或解绑的子产品

输入示例

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

{
    "GatewayProductId": "M5QJPYQ",
    "ProjectId": "pri_211",
    "Limit": "10",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "Total": 1,
        "Products": [
            {
                "DevStatus": "1",
                "NetType": "wifi",
                "DataProtocol": 1,
                "ProjectId": "pro-jed",
                "ProductName": "名称",
                "ProductType": 0,
                "CategoryId": 0,
                "ProductId": "p_34rd",
                "ProductOwnerName": ""
            }
        ],
        "RequestId": "ed3-5tgbth565-678g"
    }
}

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. 错误码

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

错误码	描述
InternalError	内部错误。
InternalError.InternalRPCError	内部RPC错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
ResourceNotFound.StudioProductNotExist	产品不存在。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.NoPermissionToStudioProduct	产品ACL错误。
UnsupportedOperation.StaffPoolDupNameExist	人员库名称已存在。

获取网关可操作的子产品

本页目录：