获取实例详情

最近更新时间:2024-03-12 01:34:21

我的收藏

1. 接口描述

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

公共实例过期时间 0001-01-01T00:00:00Z,公共实例是永久有效

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstance。
Version String 公共参数,本接口取值:2019-04-23。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:ins-46mU9M9oLd9
Include.N Array of String 附加查询返回包含字段值,不传返回0,有效值 ProductNum、ProjectNum、UsedDeviceNum、TotalDevice、ActivateDevice
示例值:["ProjectNum","ProductNum"]
ProjectId String 项目ID
示例值:test
ProductId String 产品ID,-1 代表全部产品
示例值:test

3. 输出参数

参数名称 类型 描述
Data InstanceDetail 实例信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 实例详情

输入示例

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

{
    "ProjectId": "prj-1aoioii9",
    "InstanceId": "ins-BoSq3gRJ27",
    "ProductId": "-1"
}

输出示例

{
    "Response": {
        "Data": {
            "InstanceId": "ins-BoSq3gRJ27",
            "InstanceType": 0,
            "Region": "ap-guangzhou",
            "ZoneId": "",
            "TotalDeviceNum": 1000,
            "ProjectNum": 0,
            "ProductNum": 0,
            "UsedDeviceNum": 15,
            "CreateTime": "2021-05-26T10:57:52+08:00",
            "UpdateTime": "2021-07-20T14:52:16+08:00",
            "ExpireTime": "0001-01-01T00:00:00Z",
            "TotalDevice": 15,
            "ActivateDevice": 0,
            "Description": "",
            "Status": 0
        },
        "RequestId": "8bbbaa15-9918-4fd9-a70c-dbb47dwac0ca"
    }
}

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.InternalRPCError 内部RPC错误。
InternalError.InternalServerExceptionDB 内部DB错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound.InstanceNotExist 实例未创建或是已删除。
UnauthorizedOperation.NoPermissionToInstance 实例ACL错误。
UnauthorizedOperation.NoPermissionToStudioInstance 实例ACL错误。
UnsupportedOperation.InstanceIsolated 由于实例到期已被禁用,请续费后使用。
UnsupportedOperation.UnpaidOrder 账户有未支付订单。