1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
提供根据产品名称查找产品的能力
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SearchStudioProduct。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。 |
ProjectId | 否 | String | 项目ID 示例值:prj-zunfat46 |
ProductName | 否 | String | 产品名称 示例值:testtproduct |
Limit | 否 | Integer | 列表Limit 示例值:0 |
Offset | 否 | Integer | 列表Offset 示例值:0 |
DevStatus | 否 | String | 产品Status 示例值:dev |
ProductId | 否 | String | 产品ID 示例值:FSDA213D |
Filters.N | 否 | Array of Filter | 每次请求的Filters的上限为10,Filter.Values的上限为1。 示例值:NA |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Products | Array of ProductEntry | 产品列表 |
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: SearchStudioProduct
<公共请求参数>
{
"ProjectId": "prj-zunfat46",
"DevStatus": "dev",
"Offset": "0",
"Limit": "0",
"ProductName": "testtproduct"
}
输出示例
{
"Response": {
"Total": 1,
"Products": [
{
"ProductId": "productId",
"ProductName": "name",
"CategoryId": 593,
"ProductType": 0,
"EncryptionType": "2",
"NetType": "wifi",
"DataProtocol": 1,
"ProductDesc": "",
"ProjectId": "prj-wg9**b2",
"DevStatus": "dev",
"CreateTime": 1686100765,
"UpdateTime": 1686100802,
"Region": "gz",
"ModuleId": 0,
"EnableProductScript": "",
"CreatorNickName": "name",
"CreateUserId": 1,
"BindStrategy": 0
}
],
"RequestId": "0935a11f-a172-4bd8-8bae-f143444aaff3"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.DBOpertaionError | DB操作错误。 |
InvalidParameterValue.ProductParmsError | 产品参数错误。 |
UnauthorizedOperation | 未授权操作。 |
UnsupportedOperation.InstanceIsolated | 由于实例到期已被禁用,请续费后使用。 |