查询云机列表 ListHost--云手机-火山引擎

文档中心

立即注册

导航

查询云机列表 ListHost

最近更新时间：2025.11.03 17:18:49首次发布时间：2024.03.04 19:40:01

此接口用于查询当前业务下的云机列表。

注意事项

在调用本接口前，请先确认当前业务类型是否为本地存储。“云机”是本地存储业务的资源订购单位，因此，本接口仅适用于本地存储业务。对于采用云盘存储方案的业务，本接口不适用，请勿尝试调用。
本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListHost&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListHost`	接口名称。当前 API 的名称为 `ListHost`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1749281594201xxxxxx`	业务 ID。可在云手机控制台 > 业务管理 > 业务详情中获取。
HostId	String	否	`7337159054625xxxxxx`	云机 ID。指定单个云机查询时使用，如需查询多个云机详情请使用 `HostIdList`参数。
HostIdList	String	否	`7337159054625xxxxxx,7337159054626xxxxxx`	云机 ID 列表。指定多个云机查询时使用，多个 ID 请使用英文逗号 `,`分隔。
PodId	String	否	`7332828319227xxxxxx`	实例 ID。可通过指定单个实例 ID，查询其所在云机的详情。如需通过多个实例 ID 查询多个云机详情，请使用 `PodIdList`参数。
PodIdList	String	否	`7337159054625xxxxxx,7337159054626xxxxxx`	实例 ID 列表。可通过指定过个实例 ID，查询各实例所在云机的详情。多个实例 ID 请使用英文逗号 `,`分隔。
StatusList	String	否	`1,2,3`	云机状态列表。可通过指定一个或多个状态，筛选云机进行查询。多个云机状态请使用英文逗号 `,` 分隔。取值如下： `0`：初始化 `1`：正常 `2`：退订中 `3`：异常 `4`：重置中 `5`：重启中
Dc	String	否	`tjtj-ctcucm-02-xxxxxxxx`	机房 ID。可通过指定机房 ID，查询该机房内的云机详情。
Region	String	否	`cn-north`	云机所在的大区 ID。可通过指定大区 ID，查询该大区内的云机详情。当资源所在区域选择中国大陆，即 `VolcRegion` 设置为 `inner` 时，该参数可选值包含： `cn-north`：华北 `cn-south`：华南 `cn-east`：华东 `cn-middle`：华中 `cn-southwest`：西南当资源所在区域选择中国香港，即 `VolcRegion` 设置为 `cn-hongkong-pop` 时，该参数可选值为 `cn-hongkong-pop`。
ConfigurationCode	String	否	`ultimate`	实例规格 ID。可通过指定一种实例规格，查询业务下所有包含该实例规格的云机的详情。更多规格信息参看本地存储实例规格列表。
VolcRegion	String	否	`inner`	云机所在的物理区域，包含以下选项： `inner`：中国大陆（默认值） `cn-hongkong-pop`：中国香港
ResourceSetId	String	否	`Android_cloudxxxxx`	资源 ID。
AuthorityStatus	Integer	否	`1`	云机运维授权状态。可通过指定一种运维授权状态，筛选云机进行查询。包含以下取值： `1`：未授权； `2`：已授权。
Offset	Long	否	`0`	查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 `Offset` 为 10，则表示从第 11 条记录开始。默认值为 0。说明可与 `Count` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。
Count	Long	否	`10`	单次查询返回的最大记录数，用于控制每次查询返回的数据量。例如，若 `Count` 为 100，则表示在查询数据时，系统将每次返回 100 条记录。说明可与 `Offset` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Row	Array of Host	`-`	列表行信息。
Total	Long	`1`	总数。

Host

参数	类型	示例值	描述
Dc	String	`tjtj-xxxxxx`	云机所在机房。
HostId	String	`7332685607262xxxxxx`	云机 ID。
Region	String	`cn-north`	云机所在区域。包含以下取值： `cn-north`：中国大陆华北 `cn-south`：中国大陆华南 `cn-east`：中国大陆华东 `cn-middle`：中国大陆华中 `cn-southwest`：中国大陆西南 `cn-hongkong-pop`：中国香港
Status	Integer	`1`	云机状态。取值如下： `0`：初始化 `1`：正常 `2`：退订中 `3`：异常 `4`：重置中 `5`：重启中
CreateAt	Long	`1707278000`	云机的创建时间，Unix 时间戳，单位为秒。
ExpireAt	Long	`1707278000`	云机的到期时间，Unix 时间戳，单位为秒。
AccountId	String	`2100xxxxxx`	云机所属账号 ID。
PodIdList	Array of String	`["7337159054625xxxxxx","7337159054626xxxxxx"]`	云机上的实例 ID 列表。
ProductId	String	`1749281594201xxxxxx`	云机所属业务 ID。
ChargeType	String	`node_pre_monthly`	云机的计费类型。取值如下： `pod_pre_monthly`：实例预付费月结 `pod_post_daily`：实例后付费日结 `host_pre_monthly`：云机预付费月结
VolcRegion	String	`inner`	资源所在的物理区域，包含以下值： `inner`：中国大陆 `cn-hongkong-pop`：中国香港
PodNumOnHost	Integer	`5`	云机上已创建的实例数量。
ResourceSetId	String	`Android_cloud7332703111729xxxxxx`	云机绑定的资源组 ID。
ServerTypeCode	String	`g2.8c12g`	云机规格，详情参看本地存储云机规格列表。
PodNumAvailable	Integer	`6`	云机上总共可以创建的实例数量。
ConfigurationCode	String	`elementary`	运行在云机上的实例规格 ID。
ConfigurationName	String	`低配型`	运行在云机上的实例规格名称。
AuthorityStatus	Integer	`1`	云机运维授权状态： `1`：未授权； `2`：已授权。
AuthorityExpireTime	Long	`0`	云机运维授权过期时间，unix 时间戳，若为 0 则代表未授权。

请求示例

GET https://open.volcengineapi.com?Action=ListHost&Version=2023-10-30&ProductId=1749281594201xxxxxx&HostId=7337159054625xxxxxx&HostIdList=7337159054625xxxxxx,7337159054626xxxxxx&PodId=7332828319227xxxxxx&StatusList=1,2,3&Dc=tjtj-ctcucm-02-xxxxxxxx&Region=cn-north&ConfigurationCode=ultimate&VolcRegion=inner&ResourceSetId=Android_cloudxxxxx&AuthorityStatus=1&Offset=0&Count=10

返回示例

{
    "ResponseMetadata": {
        "Action": "ListHost",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Row": [
            {
                "Dc": "tjtj-xxxxxx",
                "HostId": "7332685607262xxxxxx",
                "Region": "cn-north",
                "VolcRegion": "inner",
                "Status": 1,
                "CreateAt": 1707278000,
                "ExpireAt": 1707278000,
                "AccountId": "2100xxxxxx",
                "PodIdList": [
                    "7337159054625xxxxxx",
                    "7337159054626xxxxxx"
                ],
                "ProductId": "1749281594201xxxxxx",
                "ChargeType": "node_pre_monthly",
                "PodNumOnHost": 5,
                "ResourceSetId": "Android_cloud7332703111729xxxxxx",
                "ServerTypeCode": "g2.8c12g",
                "PodNumAvailable": 6,
                "ConfigurationCode": "elementary",
                "ConfigurationName": "低配型",
                "AuthorityStatus": 1,
                "AuthorityExpireTime": 0
            }
        ],
        "Total": 1
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。