You need to enable JavaScript to run this app.
导航
云手机
  • 文档首页
    • /云手机/云手机-iPaaS/服务端 OpenAPI 参考/实例管理/获取实例列表
获取实例列表
最近更新时间：2024.05.09 19:48:44首次发布时间：2021.10.18 18:27:22
我的收藏

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

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
值
ActionQueryString是公共参数，OpenAPI 接口名称ListInstance
VersionQueryString是公共参数，OpenAPI 接口版本2020-10-25

product_id

Query

String

是

筛选条件，实例所属业务 ID

可在「云手机控制台-业务管理-业务详情」中获取

host_idQueryString否筛选条件，实例所属的云机 ID可通过调用 ListHost 接口获取

instance_id

Query

String

否

筛选条件，实例 ID

可在「云手机控制台-业务管理-实例管理」中获取

instance_id_in

Query

String

否

筛选条件，实例 ID 列表，多个 ID 使用英文逗号分隔

可在「云手机控制台-业务管理-实例管理」中获取

instance_id_like

Query

String

否

模糊查询，实例 ID

instance_name_like

Query

String

否

模糊查询，实例名称

tag_idQueryString否筛选条件，标签 ID
tag_id_inQueryString否筛选条件，标签 ID 列表，多个 ID 使用英文逗号分隔

isp

Query

Integer

否

筛选条件，运营商

可选项：

  • 1 => 移动

  • 2 => 联通

  • 4 => 电信

  • 7 => 三线

  • 8 => BGP

dcQueryString否筛选条件，机房 ID
statusQueryInteger否筛选条件，实例状态可选枚举值，参考以下 Status 具体定义
status_inQueryInteger否筛选条件，实例状态列表，多个状态值使用英文逗号分隔可选枚举值，参考以下 Status 具体定义
package_idQueryString否筛选条件，云机资源套餐 ID
security_group_idQueryInteger否筛选条件，实例绑定的安全组 ID

sg_bound_st

Query

Integer

否

筛选条件，安全组绑定状态

可选项：

  • 1 => 空闲

  • 2 => 绑定完成

  • 11 => 绑定变更中

  • 12 => 解绑中

  • -1 => 绑定异常

  • -2 => 解绑异常

adb_key_idQueryInteger否筛选条件，实例绑定的密钥对 ID
detailQueryBoolean否是否返回实例详细参数默认：false

order_by

Query

String

否

返回结果排序方式

枚举值：

  • instance_id（按实例 ID 排序）

  • sn（按实例物理序列号排序）

is_order_ascQueryBoolean否是否升序排列默认：false
offsetQueryInteger否分页偏移量例：0
countQueryInteger否单页数量例：10

Status 具体定义

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

返回结果

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

Result 字段包含以下参数：

字段
类型
说明
totalInteger查询结果总量
rowArray of objects查询到的实例信息列表，参考以下 List<Instance> 结构说明

List<Instance> 结构说明

字段
类型
说明
product_idString实例所属业务 ID
host_idString云机 ID
instance_idString实例 ID
instance_nameString实例名称
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 时间戳

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公钥指纹
public_keyString公钥
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=ListInstance
&Version=2020-10-25
&product_id=14677396781xxxxxxxx
&status=256
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListInstance",
        "Region": "cn-north-1",
        "RequestId": "202112271833340102120631661E004383",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "row": [
            {
                "product_id": "14677396781xxxxxxxx",
                "instance_id": "i-1724163532xxxxxx",
                "host_id": "h-1726334685xxxxxx",
                "sn": "FY7SHAWSBEXXXXXX",
                "region": "cn-south",
                "isp": 2,
                "dc": "xxxx-xxxxxx",
                "dc_name": "机房02",
                "configuration": {
                    "configuration_code": "CloudHost_ARMNode_xcxg_monthly",
                    "configuration_name": "加强型",
                    "cpu_core": 4,
                    "memory": 4096
                },
                "status": 256
            },
            {
                "product_id": "14677396781xxxxxxxx",
                "instance_id": "i-1724163533xxxxxx",
                "host_id": "h-1726334685xxxxxx",
                "sn": "6POVZPFQUCXXXXXX",
                "region": "cn-south",
                "isp": 2,
                "dc": "xxxx-xxxxxx",
                "dc_name": "机房02",
                "configuration": {
                    "configuration_code": "CloudHost_ARMNode_xcxg_monthly",
                    "configuration_name": "加强型",
                    "cpu_core": 4,
                    "memory": 4096
                },
                "status": 256
            }
        ],
        "total": 2
    }
}