【旧版】套餐列表 ListConfiguration--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】套餐列表 ListConfiguration

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

查询业务下已订购的资源套餐列表。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListConfiguration
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-08-01
product_id	Query	string	是	业务 ID
configuration_code	Query	String	否	筛选条件，套餐配置 ID	可选项为： ultimate（旗舰型） enhanced（加强型） common（通用型） sample（入门型） basic（基础型） elementary（低配型）
offset	Query	Int64	否	分页偏移量	例：0
count	Query	Int64	否	单页数量	例：10

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
total	int64	查询到的套餐信息总量
row	`List<Configuration>`	资源套餐信息，详细信息，参考 Configuration 定义

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "Action": "ListConfiguration",
        "Region": "cn-north-1",
        "RequestId": "20231101092954AD60AB50616C85F63CEC",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "row": [
            {
                "configuration_code": "ultimate",
                "configuration_name": "旗舰型",
                "configuration_type": 1
            },
            {
                "configuration_code": "enhanced",
                "configuration_name": "加强型",
                "configuration_type": 1
            },
            {
                "configuration_code": "common",
                "configuration_name": "通用型",
                "configuration_type": 1
            }
        ],
        "total": 3
    }
}