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

文档中心

立即注册

导航

查询实例资源组列表 ListPodResourceSet

最近更新时间：2025.03.21 16:22:51首次发布时间：2024.03.04 19:40:02

本接口用于查询当前云盘存储业务下已订购的实例资源组信息。

注意事项

注意

本接口仅适用于云盘存储业务，对于采用本地存储方案的业务，本接口不适用，请勿尝试调用。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListPodResourceSet`	接口名称。当前 API 的名称为 `ListPodResourceSet`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1591495366954xxxxxx`	业务 ID，可在云手机控制台 > 业务管理 > 业务详情中获取。
ResourceSetId	String	否	`Android_cloud728306995xxxxxxxxxx`	资源组 ID，精确搜索。
ConfigurationCode	String	否	`ultimate`	云手机实例规格 ID。可指定某一种规格的实例，查询与之关联的资源组信息。实例规格信息参看云盘存储实例规格列表。
Dc	String	否	`gdsz-ctcucm-01-xxxxxxxx`	机房 ID，精确搜索。可通过 ListDc 接口获取。
VolcRegion	String	否	`inner`	资源所在的物理区域，包含以下选项： `inner`：中国大陆（默认值） `cn-hongkong-pop`：中国香港
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 PodResourceSet	`-`	查询到的信息列表。
Total	Long	`1`	查询总数。

PodResourceSet

参数	类型	示例值	描述
Dc	String	`gdsz-ctcucm-01-xxxxxxxx`	机房，资源不分机房时为空。
Term	Integer	`2`	订购实例的租期：预付费模式：租期数，单位：月后付费模式：0
Region	String	`cn-south`	资源所在大区，资源不分大区时为空。包含以下取值： `cn-north`：中国大陆华北 `cn-south`：中国大陆华南 `cn-east`：中国大陆华东 `cn-middle`：中国大陆华中 `cn-southwest`：中国大陆西南 `cn-hongkong-pop`：中国香港
ApplyNum	Long	`4`	已订购实例总数。
ExpireAt	Long	`1701100799`	到期时间。
ProductId	String	`1591495366954xxxxxx`	业务 ID。
ChargeType	String	`pod_pre_monthly`	资源计费模式，取值如下： `pod_pre_monthly`：实例预付费月结 `pod_post_daily`：实例后付费日结 `host_pre_monthly`：云机预付费月结
VolcRegion	String	`inner`	资源所在的物理区域，包含以下值： `inner`：中国大陆 `cn-hongkong-pop`：中国香港
ResourceSetId	String	`Android_cloud728306995xxxxxxxxxx`	资源组 ID，对应交易子订单号。
ConfigurationCode	String	`enhanced`	实例规格 ID。

请求示例

GET https://open.volcengineapi.com?Action=ListPodResourceSet&Version=2023-10-30&ProductId=1591495366954xxxxxx&ResourceSetId=Android_cloud728306995xxxxxxxxxx&ConfigurationCode=ultimate&Dc=gdsz-ctcucm-01-xxxxxxxx&VolcRegion=inner&Offset=0&Count=10

返回示例

{
    "ResponseMetadata": {
        "Action": "ListPodResourceSet",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Row": [
            {
                "Dc": "gdsz-ctcucm-01-xxxxxxxx",
                "Term": 2,
                "Region": "cn-south",
                "VolcRegion": "inner",
                "ApplyNum": 4,
                "ExpireAt": 1701100799,
                "ProductId": "1591495366954xxxxxx",
                "ChargeType": "pod_pre_monthly",
                "ResourceSetId": "Android_cloud728306995xxxxxxxxxx",
                "ConfigurationCode": "enhanced"
            }
        ],
        "Total": 1
    }
}

错误码

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