自动下单续订实例 RenewResourceAuto--云手机-火山引擎

文档中心

立即注册

导航

云手机

自动下单续订实例 RenewResourceAuto

最近更新时间：2024.05.08 16:08:09首次发布时间：2024.03.04 19:40:02

此接口用于自动下单续订并发实例。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1749281594201xxxxxx`	业务 ID。您可在云手机控制台 > 业务管理 > 业务详情中获取。
RoundId	String	是	`r1234`	订购请求的唯一标识。说明防止由于网络等原因造成重复请求，同一 `RoundId` 在 1 天内只可使用一次。
PreOrderList	Array of RenewResourcePreorder	是	`-`	并发实例资源续订配置列表。

RenewResourcePreorder

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Term	Integer	是	`1`	续订实例的租期，单位为月。预付费模式：租期数，正整数。后付费模式：0。注意不是更改后的租期，是增加的租期。
HostId	String	否	`7332710366444xxxxxx`	云机 ID。说明 `ResourceSetId` 资源组 ID 和 `HostId` 云机 ID 对于节点售卖方式可以二选一。
ResourceSetId	String	否	`Android_cloud7332710234413xxxxxx`	资源组 ID。您可通过 ListPodResourceSet 接口获取。

Term

Integer

是

1

续订实例的租期，单位为月。

预付费模式：租期数，正整数。
后付费模式：0。

注意

不是更改后的租期，是增加的租期。

HostId

String

否

7332710366444xxxxxx

云机 ID。

说明

ResourceSetId 资源组 ID 和 HostId 云机 ID 对于节点售卖方式可以二选一。

ResourceSetId String 否 Android_cloud7332710234413xxxxxx 资源组 ID。您可通过 ListPodResourceSet 接口获取。

返回参数

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

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

请求示例

POST https://open.volcengineapi.com?Action=RenewResourceAuto&Version=2023-10-30
{
	"ProductId": "1749281594201xxxxxxx",
	"RoundId": "test-1",
	"PreOrderList": [{
		"HostId": "7332747535309xxxxxxx",
		"Term": 1
	}]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "RenewResourceAuto",
        "Region": "cn-north-1",
        "RequestId": "20240221***C7F7D2FA12644C78E",
        "Service": "ACEP",
        "Version": "2023-10-30"
    },
    "Result": "Order7338***38856738860"
}

错误码

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