资源列表 ListResource--云游戏-火山引擎

文档中心

立即注册

导航

资源列表 ListResource

最近更新时间：2025.09.15 16:05:13首次发布时间：2022.03.01 17:31:35

查询当前账号下以套餐为维度的资源总览。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListResource&Version=2022-02-10

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	代表请求的 Action	ListResource
Version	Query	String	是	代表请求的 Version	2022-02-10
product_id	Query	String	否	筛选条件，业务 ID	例：client-demo

返回结果

通用返回参数，参考 ResponseMetadata 结构说明。
Result 字段包含以下参数：

字段	类型	说明
total	Int64	查询到的资源套餐类型总数
row	`List<Resource>`	资源列表，参考以下 Resource 结构说明

Resource 结构说明

字段	类型	说明
product_id	String	业务 ID
configuration_code	String	火山侧套餐 ID： ARMSoC_Standard ARMSoC_General ARMSoC_Enhanced ARMSoC_Advanced
configuration_name	String	套餐名称：基础型通用型加强型旗舰型
configuration_info	String	套餐信息
apply_num	Int64	该套餐订购的实例路数
expire_at_min	Int64	该套餐下子资源组最早到期时间，unix时间戳

示例

请求示例

GET https://open.volcengineapi.com?Action=ListResource
&Version=2022-02-10
&product_id=1493071161301xxxxxx
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListResource",
        "Region": "cn-north-1",
        "RequestId": "2022022512010601019409903513084428",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": {
        "row": [
            {
                "product_id": "1496747245104xxxxxx",
                "configuration_code": "ARMSoC_Advanced",
                "configuration_name": "旗舰型",
                "configuration_info": "支持大型重度网络游戏",
                "apply_num": 2,
                "expire_at_min": 1648223999
            },
            {
                "product_id": "1496747245104xxxxxx",
                "configuration_code": "ARMSoC_Enhanced",
                "configuration_name": "加强型",
                "configuration_info": "支持中大型网络游戏",
                "apply_num": 2,
                "expire_at_min": 1648223999
            }
        ],
        "total": 2
    }
}