自动下单复购资源 SubscribeResourceAuto--云手机-火山引擎

文档中心

立即注册

云手机

资源管理

自动下单复购资源 SubscribeResourceAuto

本接口用于同规格资源的复购操作。若您此前已通过控制台购买过某规格的资源，可使用本接口再次订购相同规格的资源。适用的计费类型包括：

云盘存储业务：支持复购预付费实例资源
本地存储业务：支持复购预付费和后付费云机资源。

注意事项

首次订购同一机房（DC）内的资源，以及预付费资源的退订操作，需在云手机控制台完成。
如需增订云盘存储业务后付费实例资源，请使用 UpdatePodResourceApplyNum 接口。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`SubscribeResourceAuto`	接口名称。当前 API 的名称为 `SubscribeResourceAuto`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1749281594201xxxxxx`	业务 ID。您可在云手机控制台 > 业务管理 > 业务详情中获取。
PreOrderList	Array of PreOrder	是	`-`	订购配置单列表。
AutoRenew	Boolean	否	`true`	是否开启自动续费。取值如下： `true`：开启自动续费。 `false`：（默认）不开启自动续费。
RoundId	String	是	`r1234`	订购请求的唯一标识。您可根据自身业务需求，自定义设置订购请求的唯一标识。说明防止由于网络等原因造成重复请求，同一 `RoundId` 在 1 天内只可使用一次。

PreOrder

参数	类型	是否必选	示例值	描述
Dc	String	否	`tjtj-xxxxxx`	实例所属机房。如果指定，则在订购指定机房中的实例。注意 `Dc` 和 `Region` 至少需要指定一个值，`Dc` 优先级高于 `Region`。
Term	Integer	否	`1`	订购实例的租期，单位为月，默认值为 1。例如：“1.10 - 2.10” 为 1 个月租期。对于资源计费方式为“包年包月”的业务，本参数必填。
Region	String	否	`cn-north`	实例所属机房所在的大区 ID。如果指定，则在指定大区内随机分配机房进行实例订购。当资源所在区域选择中国大陆，即 `VolcRegion` 设置为 `inner` 时，该参数可选值包含： `cn-north`：华北 `cn-south`：华南 `cn-east`：华东 `cn-middle`：华中 `cn-southwest`：西南当资源所在区域选择中国香港，即 `VolcRegion` 设置为 `cn-hongkong-pop` 时，该参数可选值为 `cn-hongkong-pop`。注意 `Dc` 和 `Region` 至少需要指定一个值，`Dc` 优先级高于 `Region`。
ImageId	String	否	`img-xxxxxx`	自定义镜像 ID，如不指定，则默认使用平台提供的官方标准镜像。
ApplyNum	Long	是	`1`	本次订购期望增加的资源数量。对于云盘存储方案，本参数指实例资源；对于本地存储方案，本参数指云机资源。
VolcRegion	String	否	`inner`	资源所在的物理区域，包含以下选项： `inner`：中国大陆（默认值） `cn-hongkong-pop`：中国香港
AutoCreatePod	Boolean	否	`false`	是否自动创建实例，取值如下： `true`：是 `false`：（默认）否
ServerTypeCode	String	否	`g2.8c12g`	期望复购的云机规格 ID。可使用 ListConfiguration 接口查询当前业务可以订购的资源套餐。更多云机规格详情参看本地存储云机规格列表。注意对于本地存储方案的业务，本参数必填，云盘存储业务无需关注。
DisplayLayoutId	String	否	`single-display-portrait`	屏幕布局，全局屏幕配置；可通过调用 ListDisplayLayoutMini 接口获取；可选的系统屏幕布局 ID 包括： `single-display-landscape` `single-display-portrait` `single-display-portrait-720p` 说明如未指定屏幕布局 ID，当运行资源套餐 `ConfigurationCode` 为入门型 `sample` ，云手机实例将会使用 720P 和 30fps 的默认配置。该参数适用于本地存储方案，云盘存储无需关注。
ConfigurationCode	String	是	`ultimate`	期望复购的实例资源规格 ID，当前业务下已订购的实例规格可以通过 ListPodResource 接口查询。更多规格信息参看本地存储实例规格列表或云盘存储实例规格列表。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

参数	类型	示例	说明
Result	String	`Order733***6411607084`	实例资源订购成功，返回订单 ID。

请求示例

POST https://open.volcengineapi.com?Action=SubscribeResourceAuto&Version=2023-10-30
{
    "ProductId": "1749281594201xxxxxx",
    "PreOrderList": [
        {
            "Dc": "tjtj-xxxxxx",
            "Term": 1,
            "Region": "cn-north",
            "VolcRegion": "inner",
            "ImageId": "img-xxxxxx",
            "ApplyNum": 1,
            "AutoCreatePod": true,
            "ServerTypeCode": "g2.8c12g",
            "DisplayLayoutId": "single-display-portrait",
            "ConfigurationCode": "ultimate"
        }
    ],
    "AutoRenew": true,
    "RoundId": "r1234"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "SubscribeResourceAuto",
        "Region": "cn-north-1",
        "RequestId": "2024022119***A15F07F3B186C590",
        "Service": "ACEP",
        "Version": "2023-10-30"
    },
    "Result": "Order733***6411607084"
}

错误码

下表列举了本接口特有的错误码。您可访问公共错误码，获取更多错误码信息。

状态码	错误码	错误信息	说明
400	InvalidParameter.RequestInvalidParameter	请求参数非法	数字错误码：1000007
400	InternalError.ProductError	业务错误	数字错误码：2000000
500	InternalError.OrderError	交易相关错误	数字错误码：4000000
400	InternalError.VolcSDKNotVerifiedAccount	火山侧 SDK 未启用	数字错误码：4000001
400	InternalError.VolcSDKCallError	Volc SDK 调用错误，联系火山引擎云手机技术支持	数字错误码：4000002
400	ResourceUnavailable.NewPreorderUnavailable	新购配置单错误	数字错误码：4100000
400	ResourceUnavailable.NewPreorderDuplicateForPostPaid	当前此机房已有对应规格的资源组，请前往修改资源组的实例数量	数字错误码：4100003
400	ResourceInsufficient.NewPreorderCapacityInsufficient	机房资源不足，请联系管理员	数字错误码：4100004
400	ResourceUnavailable.PackageNotFound	套餐不存在	数字错误码：600002

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

这个页面对您有帮助吗？

有用

无用