查询当前账号下正在生效的资源组列表,用于资源订购、退订、续费等操作。
使用 GET 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
---|---|---|---|---|---|
Action | Query | String | 是 | 代表请求的 Action | ListResourceSet |
Version | Query | String | 是 | 代表请求的 Version | 2022-02-10 |
product_id | Query | String | 否 | 筛选条件,业务 ID | 例:client-demo |
resource_set_id | Query | Int64 | 否 | 资源组 ID | 例:1001 |
configuration_code | Query | String | 否 | 筛选条件,火山侧套餐码 | 例:ARMSoC_General |
offset | Query | Int64 | 否 | 分页偏移量 | 例:0 |
count | Query | Int64 | 否 | 单页数量 | 默认值:10 |
通用返回参数,参考 ResponseMetadata 结构说明。
Result 字段包含以下参数:
字段 | 类型 | 说明 |
---|---|---|
total | Int64 | 查询到的资源组总数 |
row | List<ResourceSet> | 资源组列表,参考以下 ResourceSet 结构说明 |
ResourceSet 结构说明
字段 | 类型 | 说明 |
---|---|---|
resource_set_id | Int64 | 资源组 ID,资源操作的最小粒度,由资源订购产生,退订和续费都需要以此为单位 |
product_id | String | 业务 ID |
configuration_code | String | 火山侧套餐 ID:
|
configuration_type | Int64 | 套餐类型:
|
configuration_name | String | 套餐名称:
|
apply_num | Int64 | 该套餐订购的实例路数 |
create_at | Int64 | 资源组创建时间 |
update_at | Int64 | 资源组更新时间(退订、续费时间) |
expire_at | Int64 | 资源组到期时间 |
GET https://open.volcengineapi.com?Action=ListResourceSet &Version=2022-02-10 &product_id=1493071161301xxxxxx &<通过header传入的公共请求参数>
{ "ResponseMetadata": { "Action": "ListResourceSet", "Region": "cn-north-1", "RequestId": "20220215183323010225243153051ABF29", "Service": "veGame", "Version": "2022-02-10" }, "Result": { "row": [ { "resource_set_id": 1055, "product_id": "1493071161301xxxxxx", "configuration_code": "ARMSoC_Standard", "configuration_type": 1, "configuration_name": "基础型", "apply_num": 1, "create_at": 1644823633, "update_at": 1644824015, "expire_at": 1649951999 }, { "resource_set_id": 1055, "product_id": "1493071161301xxxxxx", "configuration_code": "ARMSoC_General", "configuration_type": 1, "configuration_name": "通用型", "apply_num": 1, "create_at": 1644823633, "update_at": 1644824015, "expire_at": 1649951999 }, { "resource_set_id": 1058, "product_id": "1493071161301xxxxxx", "configuration_code": "ARMSoC_Enhanced", "configuration_type": 1, "configuration_name": "加强型", "apply_num": 2, "create_at": 1644831179, "update_at": 1644831179, "expire_at": 1647273599 }, { "resource_set_id": 1059, "product_id": "1493071161301xxxxxx", "configuration_code": "ARMSoC_Advanced", "configuration_type": 1, "configuration_name": "旗舰型", "apply_num": 2, "create_at": 1644919692, "update_at": 1644919692, "expire_at": 1647359999 } ], "total": 4 } }