1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
提供查询用户所创建的项目列表查询功能。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetProjectList。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Offset | 否 | Integer | 偏移量 示例值:0 |
Limit | 否 | Integer | 个数限制 示例值:0 |
InstanceId | 否 | String | 实例ID 示例值:ins-fdaf1231 |
ProjectId | 否 | String | 按项目ID搜索 示例值:prj-fda123f |
ProductId | 否 | String | 按产品ID搜索 示例值:TOIDHQ3AOQ |
Includes.N | 否 | Array of String | 加载 ProductCount、DeviceCount、ApplicationCount,可选值:ProductCount、DeviceCount、ApplicationCount,可多选 示例值:["ProductCount","DeviceCount"] |
ProjectName | 否 | String | 按项目名称搜索 示例值:测试项目 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Projects | Array of ProjectEntryEx | 项目列表 注意:此字段可能返回 null,表示取不到有效值。 |
Total | Integer | 列表项个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:9 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询项目列表
当用户在自己的业务系统中想进行产品管理时,可以通过查询项目列表接口查询用户在物联网开发平台创建的项目。
输入示例
https://iotexplorer.tencentcloudapi.com/?Action=GetProjectList
&Offset=0
&Limit=0
&<公共请求参数>
输出示例
{
"Response": {
"Projects": [
{
"ProjectId": "prj-***2v",
"ProjectName": "name",
"ProjectDesc": "",
"CreateTime": 1657334314,
"UpdateTime": 1685669118,
"ProductCount": 1,
"ApplicationCount": 1,
"DeviceCount": 2,
"NativeAppCount": 0,
"WebAppCount": 0,
"InstanceId": "ins-V**A",
"EnableOpenState": 1
}
],
"Total": 1,
"RequestId": "8525aa8d-6820-4977-b64c-1f3370919a9e"
}
}
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.InternalRPCError | 内部RPC错误。 |
InternalError.InternalServerExceptionDB | 内部DB错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound.InstanceNotExist | 实例未创建或是已删除。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NoPermissionToInstance | 实例ACL错误。 |
UnauthorizedOperation.NoVerified | 您的账号未实名认证,请登录腾讯云进行实名认证 |
UnsupportedOperation.InstanceIsolated | 由于实例到期已被禁用,请续费后使用。 |
UnsupportedOperation.UnpaidOrder | 账户有未支付订单。 |