获取云机列表 ListHost--云手机-火山引擎

文档中心

立即注册

导航

获取云机列表 ListHost

最近更新时间：2024.05.09 10:30:30首次发布时间：2021.10.18 18:27:22

查询指定业务内已购买云机的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListHost
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25
product_id	Query	String	是	筛选条件，云机所属业务 ID	可在「云手机控制台-业务管理-业务详情」中获取
security_group_id	Query	String	否	筛选条件，安全组 ID，用于筛选该安全组绑定的云机列表	可在「云手机控制台-业务管理-安全组」中获取
region	Query	String	否	筛选条件，云机所在区域	可选枚举值： cn-north => 华北 cn-south => 华南 cn-east => 华东 cn-middle => 华中 cn-southwest => 西南
host_id_in	Query	String	否	筛选条件，云机 ID 列表，多个 ID 使用英文逗号分隔	可在「云手机控制台-业务管理-云机管理」中获取
package_id	Query	String	否	筛选条件，云机资源套餐 ID
dc_in	Query	String	否	筛选条件，机房 ID 列表，多个 ID 使用英文逗号分隔
host_create_after	Query	String	否	筛选条件，在指定时间后订购的云机	Unix 时间戳，例：1677552038
detail	Query	Boolean	否	是否返回云机详细参数	默认：false
order_by	Query	String	否	返回结果排序方式	枚举值： host_create_at（按云机订购时间排序）
is_desc	Query	Boolean	否	是否降序排列	默认：false
offset	Query	Int64	否	分页偏移量	例：0
count	Query	Int64	否	单页数量	例：10

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
total	Int64	查询结果总量
row	Array of objects	查询到的云机信息列表，参考以下 `List<Host>` 结构说明

List<Host> 结构说明

字段	类型	说明
host_id	String	云机 ID
product_id	String	云机所属业务 ID
package_id	String	云机资源套餐 ID
package_spec	String	云机资源套餐规格
package_name	String	云机资源套餐名称
region	String	云机所在区域名称： cn-north => 华北 cn-south => 华南 cn-east => 华东 cn-middle => 华中 cn-southwest => 西南
isp	Int32	运营商： 1 => 移动 2 => 联通 4 => 电信 8 => BGP
idc	String	机房 ID
status	Integer	云机状态： 100 => 初始化中 200 => 初始化完成 500 => 初始化失败
bandwidth	Integer	平均到每个实例的带宽，例：2（单位Mbps）
public_ip	String	公网 IP
security_group_status	Integer	安全组配置状态： 0 => 空闲，即无配置，此状态下允许绑定 1 => 配置中，即中间状态，不允许任何操作 2 => 配置成功，云机所有实例都符合配置预期 3 => 配置异常，至少有一路实例不符合配置预期，允许解绑操作 4 => 解除配置中
adb_key_status	Integer	密钥对配置状态： 0 => 空闲，即无配置 1 => 配置中，即中间状态，不允许任何操作 2 => 配置成功，云机所有实例都符合配置预期 3 => 配置异常，至少有一路实例不符合配置预期，允许解绑操作 4 => 解除配置中
host_create_at	Integer	云机订购时间，秒级时间戳，例：1676275431
expire_at	Integer	云机租期到期时间，秒级时间戳，例：1676275431
host_pay_mode	String	付费模式： pre（预付费模式） post（后付费模式）
created_at	String	创建时间（当指定 `detail=true` 时返回），例：2023-02-13T16:03:51.325+08:00
updated_at	String	更新时间（当指定 `detail=true` 时返回），例：2023-02-13T16:03:51.325+08:00

示例

请求示例

GET https://open.volcengineapi.com?Action=ListHost
&Version=2020-10-25
&product_id=1471432326763xxxxxx
&host_id_in= h-1719373075xxxxxx,h-1719373076xxxxxx
&package_id=pack-1750270317xxxxxx
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListHost",
        "Region": "cn-north-1",
        "RequestId": "202305061608245F7C606B27C436FDEDD0",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "row": [
            {
                "host_id": "h-1719373075xxxxxx",
                "product_id": "1625003308995xxxxxx",
                "package_id": "pack-1750270317xxxxxx",
                "package_spec": "test_spec-2",
                "package_name": "H1B3-8B0-XX",
                "region": "cn-north",
                "isp": 1,
                "idc": "hbhxxx",
                "status": 100,
                "bandwidth": 2,
                "public_ip": "",
                "security_group_status": 0,
                "adb_key_status": 0,
                "host_create_at": 1676275431,
                "expire_at": 1676275431,
                "host_pay_mode": "post",
                "created_at": "2023-02-13T16:03:51.325+08:00",
                "updated_at": "2023-02-13T16:03:51.325+08:00"
            },
            {
                "host_id": "h-1719373076xxxxxx",
                "product_id": "1625003308995xxxxxx",
                "package_id": "pack-1750270317xxxxxx",
                "package_spec": "test_spec-2",
                "package_name": "H1B3-8B0-XX",
                "region": "cn-north",
                "isp": 1,
                "idc": "hbhxxx",
                "status": 100,
                "bandwidth": 2,
                "public_ip": "",
                "security_group_status": 0,
                "adb_key_status": 0,
                "host_create_at": 1676447170,
                "expire_at": 1676447170,
                "host_pay_mode": "post",
                "created_at": "2023-02-15T15:46:10.823+08:00",
                "updated_at": "2023-02-15T15:46:10.823+08:00"
            }
        ],
        "total": 2
    }
}