订购预付费资源--云游戏-火山引擎

文档中心

立即注册

导航

订购预付费资源

最近更新时间：2025.01.20 15:42:49首次发布时间：2023.10.25 14:15:02

订购预付费实例资源（可按需选择一键下单订购资源）。调用说明如下：

说明

需确保在订购资源时主账号余额充足。详细信息，参考产品计费说明。
资源订购成功会生成资源组；后续退订和续费资源都需要以资源组为单位进行操作。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	CreatePrePaidOrder
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-02-10

Body 参数

字段	类型	必填	说明
product_id	String	是	云游戏业务 ID，可在「云游戏控制台-云游戏手游-业务管理」中获取
preorder_list	`List<SubscribePreorder>`	是	资源订购配置单列表，参考以下 SubscribePreorder 订购配置单结构说明
one_step	Boolean	否	是否开启一键下单订购资源： true（订购资源后直接支付订单） false（默认，订购资源后返回订单号，再通过订单号支付）

字段

类型

必填

说明

product_id String 是云游戏业务 ID，可在「云游戏控制台-云游戏手游-业务管理」中获取

preorder_list List<SubscribePreorder> 是资源订购配置单列表，参考以下 SubscribePreorder 订购配置单 结构说明

one_step

Boolean

否

是否开启一键下单订购资源：

true（订购资源后直接支付订单）
false（默认，订购资源后返回订单号，再通过订单号支付）

SubscribePreorder 订购配置单

字段	类型	必填	说明
configuration_code	String	是	实例资源套餐 ID，可选枚举值包括： ARMSoC_Standard（基础型） ARMSoC_Standard_Freetrial（基础型-免费） ARMSoC_General（通用型） ARMSoC_General_Freetrial（通用型-免费） ARMSoC_Enhanced（加强型） ARMSoC_Enhanced_Freetrial（加强型-免费） ARMSoC_Advanced（旗舰型） ARMSoC_Advanced_Freetrial（旗舰型-免费）
apply_num	Int32	否	订购的实例数量；如不指定，默认订购1路实例（如订购实例数量大于资源余量，可联系火山引擎云游戏技术支持）
term	Int32	否	订购实例的租期（单位：月，例如：“1.10 - 2.10” 为 1 个月租期）；如不指定，默认租期为1个月
renew_type	Int32	否	续费类型： 1：手动续费 2：自动续费 3：到期不续费（默认）
purchase_times	Int32	否	单次自动续费的续费周期，单位：月，默认值：0（如果 renew_type 设置为自动续费，则 purchase_times 必须设置为大于0的值）

返回结果

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

字段	类型	说明
Result	`List<String>`	返回资源订购结果：当指定 `one_step=false`，返回资源订单号列表（通过拼接订单号可进入付款页面）当指定 `one_step=true`，资源直接订购成功

字段

类型

说明

Result

List<String>

返回资源订购结果：

当指定 one_step=false，返回资源订单号列表（通过拼接订单号可进入付款页面）
当指定 one_step=true，资源直接订购成功

示例

请求示例

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

{
    "product_id": "1493071161301xxxxxx",
    "preorder_list": [
        {
            "configuration_code": "ARMSoC_General",
            "apply_num": 1,
            "term": 1,
            "renew_type": 2,
            "purchase_times": 1
        },
        {
            "configuration_code": "ARMSoC_Enhanced",
            "apply_num": 2,
            "term": 1,
            "renew_type": 2,
            "purchase_times": 1
        }
    ],
    "one_step": true
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CreatePrePaidOrder",
        "Region": "cn-north-1",
        "RequestId": "202202151959080102251100110423F557",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": "success"
}