查询实例资源列表 ListPodResource--云手机-火山引擎

文档中心

立即注册

导航

查询实例资源列表 ListPodResource

最近更新时间：2025.11.03 17:18:49首次发布时间：2024.05.08 16:08:11

查询当前业务订购过的实例资源信息，查询结果包含已退订和未退订的实例。

注意事项

本接口的单用户 QPS 限制为 200 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListPodResource`	接口名称。当前 API 的名称为 `ListPodResource`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1591495366954xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
ConfigurationCode	String	否	`ultimate`	云手机实例规格 ID，可指定一种规格进行筛选查询。更多规格信息参看本地存储实例规格列表或云盘存储实例规格列表。
Dc	String	否	`gdsz-ctcucm-01-xxxxxxxx`	实例所属机房的 ID。可通过「云手机控制台-实例管理-实例列表」中获取。
ImageId	String	否	`img-6890xxxx`	根据镜像 ID，查询预热完成的实例数量。
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 PodResource	`-`	查询到的实例资源组信息列表，详请参看 `PodResource`定义。
Total	Integer	`4`	查询结果总量。

PodResource

参数	类型	示例值	描述
Dc	String	`gdsz-ctcucm-01-xxxxxxxx`	机房 ID。
Region	String	`cn-south`	实例所属机房所在的大区 ID。如果指定，则在指定大区内随机分配机房进行实例订购。当资源所在区域选择中国大陆，即 `VolcRegion` 设置为 `inner` 时，该参数可选值包含： `cn-north`：华北 `cn-south`：华南 `cn-east`：华东 `cn-middle`：华中 `cn-southwest`：西南当资源所在区域选择中国香港，即 `VolcRegion` 设置为 `cn-hongkong-pop` 时，该参数可选值为 `cn-hongkong-pop`。
ApplyNum	Integer	`0`	已订购实例总数。
ExpireAt	Long	`0`	实例资源到期时间。预付费模式：该资源组最早到期时间，unix 时间戳后付费模式：0
ReadyNum	Integer	`0`	已预热完成实例总数。需在请求参数中指定 ImageId。
TotalNum	Integer	`2`	已创建实例总数。注意查询结果存在延迟，最长约为 7min 左右。返回结果为调用接口前最后一次数据库刷新的数据，而非实时数据。如果在最后一次数据库刷新之后至本次接口调用期间有新的实例被创建，这些新实例将不会被包含在返回的结果中。
OnlineNum	Integer	`0`	云盘存储：已开机的实例总数。本地存储：已创建的实例总数。
ProductId	String	`1591495366954xxxxxx`	实例所归属的业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
VolcRegion	String	`inner`	资源所在的物理区域，包含以下值： `inner`：中国大陆（默认值） `cn-hongkong-pop`：中国香港
TotalDataSize	Integer	`12`	已创建实例数据分区总容量，单位 GB。注意查询结果存在延迟，最长约为 7min 左右。返回结果为调用接口前最后一次数据库刷新的数据，而非实时数据。如果在最后一次数据库刷新之后至本次接口调用期间有新的实例被创建，这些新实例的数据将不会被包含在返回的结果中。
ConfigurationCode	String	`common`	实例资源套餐 ID。
ZoneId	String	`jsnt-ctcucm-01`	机房所属的区域 ID。
StreamingNum	Integer	`1`	正在推流中的实例数量。注意查询结果存在延迟，最长约为 7min 左右。返回结果为调用接口前最后一次数据库刷新的数据，而非实时数据。如果在最后一次数据库刷新之后至本次接口调用期间有新的实例发起推流，这些新推流实例的数据将不会被包含在返回的结果中。

请求示例

GET https://open.volcengineapi.com?Action=ListPodResource&Version=2023-10-30&ProductId=1591495366954xxxxxx&ConfigurationCode=ultimate&Dc=gdsz-ctcucm-01-xxxxxxxx&ImageId=img-6890xxxx&Offset=0&Count=10

返回示例

{
    "ResponseMetadata": {
        "Action": "ListPodResource",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Row": [
            {
                "Dc": "gdsz-ctcucm-01-xxxxxxxx",
                "Region": "cn-south",
                "VolcRegion": "inner",
                "ApplyNum": 0,
                "ExpireAt": 0,
                "ReadyNum": 0,
                "TotalNum": 2,
                "OnlineNum": 0,
                "ProductId": "1591495366954xxxxxx",
                "TotalDataSize": 12,
                "ConfigurationCode": "common",
                "ZoneId": "jsnt-ctcucm-01",
                "StreamingNum": "0"
            },
            {
                "Dc": "gdsz-ctcucm-01-xxxxxxxx",
                "Region": "cn-south",
                "ApplyNum": 1,
                "ExpireAt": 1702915199,
                "ReadyNum": 1,
                "TotalNum": 1,
                "OnlineNum": 1,
                "ProductId": "1591495366954xxxxxx",
                "TotalDataSize": 16,
                "ConfigurationCode": "basic",
                "ZoneId": "jsnt-ctcucm-01",
                "StreamingNum": "1"
            },
            {
                "Dc": "gdsz-ctcucm-01-xxxxxxxx",
                "Region": "cn-south",
                "ApplyNum": 0,
                "ExpireAt": 0,
                "ReadyNum": 0,
                "TotalNum": 0,
                "OnlineNum": 0,
                "ProductId": "1591495366954xxxxxx",
                "TotalDataSize": 0,
                "ConfigurationCode": "elementary",
                "ZoneId": "jsnt-ctcucm-01",
                "StreamingNum": "0"
            },
            {
                "Dc": "tjtj-ctcucm-02-xxxxxxxx",
                "Region": "cn-north",
                "ApplyNum": 0,
                "ExpireAt": 0,
                "ReadyNum": 0,
                "TotalNum": 0,
                "OnlineNum": 0,
                "ProductId": "1591495366954xxxxxx",
                "TotalDataSize": 0,
                "ConfigurationCode": "ultimate",
                "ZoneId": "tjtj-ctcucm-01",
                "StreamingNum": "0"
            }
        ],
        "Total": 4
    }
}

错误码

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