查询套餐列表 ListConfiguration--云手机-火山引擎

文档中心

立即注册

云手机

资源管理

查询套餐列表 ListConfiguration

查询当前业务可以订购的资源套餐列表。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListConfiguration`	接口名称。当前 API 的名称为 `ListConfiguration`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1591495366954xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
ResourceClass	Integer	否	`1`	资源类型： 1：计算资源。本地存储业务指云机，云盘存储业务指实例。 2：存储资源。 3：带宽资源。
ConfigurationCode	String	否	`ultimate`	实例规格套餐 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 Configuration	`-`	资源套餐信息，详请参考 `Configuration` 定义。
Total	Long	`3`	查询到的套餐信息总量。

Configuration

参数	类型	示例值	描述
ServerTypeCode	String	`g2.8c12g`	云机类型。详情参看本地存储云机规格列表。
ConfigurationCode	String	`basic`	套餐规格 ID。
ConfigurationName	String	`基础型`	套餐规格名称。
ConfigurationType	Integer	`1`	资源使用模式。取值如下： `1`：正式资源。 `2`：试用资源。

请求示例

GET https://open.volcengineapi.com?Action=ListConfiguration&Version=2023-10-30&ProductId=`1591495366954xxxxxx`&ResourceClass=1&ConfigurationCode=`ultimate`&Offset=`0`&Count=10
{}

返回示例

{
    "ResponseMetadata": {
        "Action": "ListConfiguration",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Total": 11,
        "Row": [
            {
                "ConfigurationCode": "ultimate",
                "ConfigurationName": "旗舰型",
                "ConfigurationType": 1,
                "ServerTypeCode": "g2.8c12g"
            },
            {
                "ConfigurationCode": "enhanced",
                "ConfigurationName": "加强型",
                "ConfigurationType": 1,
                "ServerTypeCode": "g2.8c12g"
            },
            {
                "ConfigurationCode": "common",
                "ConfigurationName": "通用型",
                "ConfigurationType": 1,
                "ServerTypeCode": "g2.8c12g"
            },
            {
                "ConfigurationCode": "sample",
                "ConfigurationName": "入门型",
                "ConfigurationType": 1,
                "ServerTypeCode": "g2.8c12g"
            },
            {
                "ConfigurationCode": "basic",
                "ConfigurationName": "基础型",
                "ConfigurationType": 1,
                "ServerTypeCode": "g2.8c12g"
            },
            {
                "ConfigurationCode": "elementary",
                "ConfigurationName": "低配型",
                "ConfigurationType": 1,
                "ServerTypeCode": "g2.8c12g"
            },
            {
                "ConfigurationCode": "storage_data",
                "ConfigurationName": "通用存储",
                "ConfigurationType": 1,
                "ServerTypeCode": ""
            },
            {
                "ConfigurationCode": "storage_data",
                "ConfigurationName": "通用存储",
                "ConfigurationType": 1,
                "ServerTypeCode": ""
            },
            {
                "ConfigurationCode": "network_bandwidth",
                "ConfigurationName": "公网流量",
                "ConfigurationType": 1,
                "ServerTypeCode": ""
            },
            {
                "ConfigurationCode": "network_bandwidth",
                "ConfigurationName": "公网带宽",
                "ConfigurationType": 1,
                "ServerTypeCode": ""
            },
            {
                "ConfigurationCode": "network_bandwidth",
                "ConfigurationName": "公网带宽",
                "ConfigurationType": 1,
                "ServerTypeCode": ""
            }
        ]
    }
}

错误码

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

最近更新时间：2025.03.21 16:22:51

这个页面对您有帮助吗？

有用

无用