【旧版】自动下单订购实例 SubscribeResourceAuto--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】自动下单订购实例 SubscribeResourceAuto

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

自动下单订购并发实例。

注：首次下单订购实例需要在云手机控制台操作。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	string	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
pre_order_list	`list<SubscribePreorder>`	是	订购配置单列表，详细信息，参考 SubscribePreorder 定义
auto_renew	boolean	否	是否开启自动续费： true（开启自动续费） false（不开启自动续费，默认）
round_id	string	是	订购请求的唯一标识，防止由于网络等原因造成重复请求，同一 round_id 在1天内只可使用一次

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
Result	string	实例资源订购成功，返回订单 ID

示例

请求示例

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

{
    "product_id":"1591495366954xxxxxx",
    "pre_order_list":[
        {
        "configuration_code":"basic",
        "dc":"tjtj-ctcucm-02-84xxxxxx",
        "region":"cn-north",
        "apply_num":1,
        "term":1
        }
    ],
    "auto_renew":false,
    "round_id":"01"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "SubscribeResourceAuto",
        "Region": "cn-north-1",
        "RequestId": "2023110111131260F37065A31E08F84D20",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": "Order7296326284334xxxxxx"
}

错误码

错误码	说明
2000000	业务 ID 不存在或错误	检查指定的业务 ID 是否正确
4000000	交易相关错误	检查火山引擎账户余额等交易相关信息
4000001	火山侧 SDK 未启用	联系火山引擎云手机技术支持
4000002	Volc SDK 调用错误	联系火山引擎云手机技术支持
4100003	当前此机房已有对应规格的资源组，请前往修改资源组的实例数量	当前业务已订购指定规格的资源组，无需重复订购，修改对应资源组的实例数量即可完成实例订购
4100004	机房资源不足，请联系管理员	当前机房已无可用资源，请联系火山引擎云手机技术支持