获取指定实例的详细信息。
使用 GET 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
|---|---|---|---|---|---|
| Action | Query | String | 是 | 公共参数，OpenAPI 接口名称 | DetailInstance |
| Version | Query | String | 是 | 公共参数，OpenAPI 接口版本 | 2020-10-25 |
| instance_id | Query | String | 是 | 筛选条件，实例 ID | 可通过调用 ListInstance 接口获取 |
通用返回参数，请参考 ResponseMetadata 结构说明。
Result 字段包含以下参数：
字段 | 类型 | 说明 |
|---|---|---|
| product_id | String | 实例所属业务 ID |
| instance_id | String | 实例 ID |
| instance_name | String | 实例名称 |
| host_id | String | 云机 ID |
| sn | String | 实例物理序列号 |
region | String | 实例所在区域：
|
isp | Integer | 运营商：
|
| dc | String | 机房 ID |
| dc_name | String | 机房名称 |
| image_id | String | 实例镜像 ID |
| configuration | Array of objects | 实例套餐信息，参考以下 Configuration 结构说明 |
| status | Integer | 实例当前所处状态，参考以下 Status 具体定义 |
status_str | String | 实例当前所处状态说明：
|
| security_group | Object | 与实例绑定的安全组信息（未绑定则不返回），参考以下 SecurityGroup 结构说明 |
sg_bound_st | Integer | 安全组绑定状态码：
|
sg_bound_st_str | String | 安全组绑定状态说明：
|
| adb_key | Object | 与实例绑定的密钥对信息（未绑定则不返回），参考以下 AdbKey 结构说明 |
| tag | Object | 实例标签信息（未绑定则不返回），参考以下 Tag 结构说明 |
| create_at | Integer | 实例创建时间，Unix 时间戳 |
Status 具体定义
| 状态码（status） | 状态说明（status_str） | 含义 |
|---|---|---|
| 256 | Running | 运行中 |
| 259 | Shutdown | 已关机 |
| 1024 | Fault | 异常状态 |
| 1025 | InitFailed | 初始化失败 |
| 261 | Initializing | 初始化中 |
| 513 | ShuttingDown | 关机中 |
| 515 | Booting | 开机中 |
| 514 | Rebooting | 重启中 |
| 519 | ColdRebooting | 强制重启中 |
| 516 | Upgrading | 升级中 |
| 517 | Resetting | 重置中 |
| 518 | ResetToFactoryHandling | 恢复出厂设置中 |
Configuration 结构说明
字段 | 类型 | 说明 |
|---|---|---|
| configuration_code | String | 实例资源套餐 ID |
| configuration_name | String | 实例资源套餐名称 |
| cpu_core | Integer | CPU 核心数 |
| memory | Float | 内存，单位MB |
SecurityGroup 结构说明
字段 | 类型 | 说明 |
|---|---|---|
| product_id | String | 安全组所属业务 ID |
| security_group_id | Integer | 安全组 ID |
| security_group_name | String | 安全组名称 |
| security_group_desc | String | 安全组描述 |
| security_rule_list | Array of Object | 安全组规则列表，参考以下 SecurityRuleList 结构说明 |
| bind_instance_num | Integer | 安全组绑定实例数 |
| create_at | Integer | 创建时间，秒级时间戳 |
| update_at | Integer | 更新时间，秒级时间戳 |
SecurityRuleList 结构说明
字段 | 类型 | 说明 |
|---|---|---|
| rule_id | Integer | 安全组规则 ID |
| source_port | Integer | 源端口 |
protocol | Integer | 协议类型：
|
expose | Integer | 访问规则（仅白名单用户可见）：
|
AdbKey 结构说明
字段 | 类型 | 说明 |
|---|---|---|
| product_id | String | 密钥对所属业务 ID |
| key_id | Integer | 密钥对 ID |
key_name | String | 密钥对名称 |
auth_type | Integer | 权限类型：
|
| fingerprint | String | 公钥指纹 |
| bind_host_num | Integer | 密钥对绑定的云机数量 |
| bind_instance_num | Integer | 密钥对绑定的实例数量 |
| create_at | Integer | 创建时间，秒级时间戳 |
| key_desc | String | 密钥对描述 |
Tag 结构说明
字段 | 类型 | 说明 |
|---|---|---|
| product_id | String | 业务 ID |
| tag_id | String | 标签 ID |
| tag_name | String | 标签名称 |
| tag_desc | String | 标签描述 |
| related_instance_num | Integer | 与标签绑定的实例数量 |
GET https://open.volcengineapi.com?Action=DetailInstance &Version=2020-10-25 &instance_id=i-1774482652xxxxxx &<通过header传入的公共请求参数>
{ "ResponseMetadata": { "Action": "DetailInstance", "Region": "cn-north-1", "RequestId": "2023080311340868B232141E4245353599", "Service": "iPaaS", "Version": "2020-10-25" }, "Result": { "product_id": "1686568680864xxxxxx", "instance_id": "i-1774482652xxxxxx", "instance_name": "", "host_id": "h-1773083627xxxxxx", "sn": "i-1773083627xxxxxx", "region": "cn-north", "isp": 7, "dc": "xxxx-ctcucm-02", "dc_name": "机房02(IPv4)", "status": 256, "status_str": "Running", "create_at": 1692278530, "security_group": { "product_id": "1686568680864xxxxxx", "security_group_id": 1576, "security_group_name": "开启5555", "security_rule_list": [ { "rule_id": 2097, "source_port": 5555, "protocol": 2, "expose": 3 } ], "create_at": 1690960994, "update_at": 0 }, "adb_key": { "product_id": "1686568680864xxxxxx", "key_id": 7309, "key_name": "ADB连接", "auth_type": 1, "fingerprint": "xx:xx:xx:xx:3d:7d:15:3c:f3:39:a0:19:xx:xx:xx:xx\n", "create_at": 1690961279, "key_desc": "" }, "tag": { "product_id": "1686568680864xxxxxx", "tag_id": "CPL-1772571072xxxxxx", "tag_name": "实例分组01", "tag_desc": "实例分组标签", "related_instance_num": 2 } } }