You need to enable JavaScript to run this app.
云手机

云手机

请输入
  • 文档首页
    • 云手机云手机-iPaaS服务端 OpenAPI 参考实例管理获取实例详情 DetailInstance
复制全文
我的收藏
实例管理
获取实例详情 DetailInstance
复制全文
我的收藏
获取实例详情 DetailInstance

获取指定实例的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考 公共请求参数。

字段
位置
类型
必填
说明
值
ActionQueryString是公共参数，OpenAPI 接口名称DetailInstance
VersionQueryString是公共参数，OpenAPI 接口版本2020-10-25
instance_idQueryString是筛选条件，实例 ID可通过调用 ListInstance 接口获取

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段
类型
说明
product_idString实例所属业务 ID
instance_idString实例 ID
instance_nameString实例名称
host_idString云机 ID
snString实例物理序列号

region

String

实例所在区域：

  • cn-north => 华北

  • cn-south => 华南

  • cn-east => 华东

  • cn-middle => 华中

  • cn-southwest => 西南

isp

Integer

运营商：

  • 1 => 移动

  • 2 => 联通

  • 4 => 电信

  • 7 => 三线

  • 8 => BGP

dcString机房 ID
dc_nameString机房名称
image_idString实例镜像 ID
configurationArray of objects实例套餐信息，参考以下 Configuration 结构说明
statusInteger实例当前所处状态，参考以下 Status 具体定义

status_str

String

实例当前所处状态说明：

  • Running => 运行中

  • Shutdown => 已关机

  • Fault => 异常状态

  • InitFailed => 初始化失败

  • Initializing => 初始化中

  • ShuttingDown => 关机中

  • Booting => 开机中

  • Rebooting => 重启中

  • ColdRebooting => 冷重启中

  • Upgrading => 升级中

  • Resetting => 重置中

  • ResetToFactoryHandling => 恢复出厂设置中

security_groupObject与实例绑定的安全组信息（未绑定则不返回），参考以下 SecurityGroup 结构说明

sg_bound_st

Integer

安全组绑定状态码：

  • 1 => 空闲

  • 2 => 绑定完成

  • 11 => 绑定变更中

  • 12 => 解绑中

  • -1 => 绑定异常

  • -2 => 解绑异常

sg_bound_st_str

String

安全组绑定状态说明：

  • Idle => 空闲

  • BindCompleted => 绑定完成

  • BindAltering => 绑定变更中

  • Unbinding => 解绑中

  • BindAbnormal => 绑定异常

  • UnbindAbnormal => 解绑异常

adb_keyObject与实例绑定的密钥对信息（未绑定则不返回），参考以下 AdbKey 结构说明
tagObject实例标签信息（未绑定则不返回），参考以下 Tag 结构说明
create_atInteger实例创建时间，Unix 时间戳

Status 具体定义

状态码（status）状态说明（status_str）含义
256Running运行中
259Shutdown已关机
1024Fault异常状态
1025InitFailed初始化失败
261Initializing初始化中
513ShuttingDown关机中
515Booting开机中
514Rebooting重启中
519ColdRebooting强制重启中
516Upgrading升级中
517Resetting重置中
518ResetToFactoryHandling恢复出厂设置中

Configuration 结构说明

字段
类型
说明
configuration_codeString实例资源套餐 ID
configuration_nameString实例资源套餐名称
cpu_coreIntegerCPU 核心数
memoryFloat内存，单位MB

SecurityGroup 结构说明

字段
类型
说明
product_idString安全组所属业务 ID
security_group_idInteger安全组 ID
security_group_nameString安全组名称
security_group_descString安全组描述
security_rule_listArray of Object安全组规则列表，参考以下 SecurityRuleList 结构说明
bind_instance_numInteger安全组绑定实例数
create_atInteger创建时间，秒级时间戳
update_atInteger更新时间，秒级时间戳

SecurityRuleList 结构说明

字段
类型
说明
rule_idInteger安全组规则 ID
source_portInteger源端口

protocol

Integer

协议类型：

  • 1 => UDP

  • 2 => TCP

  • 3 => ALL（源端口号同时支持 TCP 和 UDP 协议）

expose

Integer

访问规则（仅白名单用户可见）：

  • 1（仅开放内网，不开放公网）

  • 3（开放公网，默认）

AdbKey 结构说明

字段
类型
说明
product_idString密钥对所属业务 ID
key_idInteger密钥对 ID

key_name

String

密钥对名称

auth_type

Integer

权限类型：

  • 1 => root

  • 2 => user

fingerprintString公钥指纹
bind_host_numInteger密钥对绑定的云机数量
bind_instance_numInteger密钥对绑定的实例数量
create_atInteger创建时间，秒级时间戳
key_descString密钥对描述

Tag 结构说明

字段
类型
说明
product_idString业务 ID
tag_idString标签 ID
tag_nameString标签名称
tag_descString标签描述
related_instance_numInteger与标签绑定的实例数量

示例

请求示例

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
        }
    }
}
最近更新时间：2024.05.09 17:19:39
这个页面对您有帮助吗？
有用
有用
无用
无用