【旧版】资源列表 ListPodResource--云手机-火山引擎

文档中心

立即注册

导航

【旧版】资源列表 ListPodResource

最近更新时间：2024.06.17 19:36:19首次发布时间：2023.06.14 12:45:16

查询当前业务已订购的实例资源信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	ListPodResource
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01
product_id	Query	string	是	业务 ID	可在「云手机控制台-业务管理-业务详情」中获取
configuration_code	Query	string	否	筛选条件，套餐 ID，精确搜索	可选项： ultimate（旗舰型） enhanced（加强型） common（通用型） sample（入门型） basic（基础型） elementary（低配型）
dc	Query	string	否	筛选条件，机房 ID，精确搜索
image_id	Query	string	否	筛选条件，返回已预热该镜像的资源数量	例：img-68902402
offset	Query	int64	否	分页偏移量	例：0
count	Query	int64	否	单页数量	例：10

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
total	int32	查询结果总量
row	`List<PodResource>`	查询到的实例资源组信息列表，详细信息，参考 PodResource 定义

示例

请求示例

GET https://open.volcengineapi.com?Action=ListPodResource
&Version=2022-08-01
&product_id=1591495366954xxxxxx
&image_id=img-68902402
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListPodResource",
        "Region": "cn-north-1",
        "RequestId": "202311021445202993FF315E70FCD96E90",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "row": [
            {
                "product_id": "1591495366954xxxxxx",
                "configuration_code": "basic",
                "dc": "gdsz-ctcucm-01-xxxxxxxx",
                "region": "cn-south",
                "apply_num": 0,
                "ready_num": 0,
                "online_num": 0,
                "total_num": 2,
                "total_data_size": 12,
                "expire_at": 0
            },
            {
                "product_id": "1591495366954xxxxxx",
                "configuration_code": "common",
                "dc": "gdsz-ctcucm-01-xxxxxxxx",
                "region": "cn-south",
                "apply_num": 1,
                "ready_num": 1,
                "online_num": 1,
                "total_num": 1,
                "total_data_size": 16,
                "expire_at": 1702915199
            },
            {
                "product_id": "1591495366954xxxxxx",
                "configuration_code": "elementary",
                "dc": "gdsz-ctcucm-01-xxxxxxxx",
                "region": "cn-south",
                "apply_num": 0,
                "ready_num": 0,
                "online_num": 0,
                "total_num": 0,
                "total_data_size": 0,
                "expire_at": 0
            },
            {
                "product_id": "1591495366954xxxxxx",
                "configuration_code": "ultimate",
                "dc": "tjtj-ctcucm-02-xxxxxxxx",
                "region": "cn-north",
                "apply_num": 0,
                "ready_num": 0,
                "online_num": 0,
                "total_num": 0,
                "total_data_size": 0,
                "expire_at": 0
            }
        ],
        "total": 4
    }
}