修改后付费实例数量 UpdateAppliedResource--云游戏-火山引擎

文档中心

立即注册

导航

修改后付费实例数量 UpdateAppliedResource

最近更新时间：2025.01.20 15:42:49首次发布时间：2024.04.19 13:53:04

在后付费计费模式下，修改已订购资源套餐的实例数量。

注意事项

如果修改的资源套餐已配置游戏部署策略，则不能将订购数量修改为 0。如需修改，可在云游戏控制台 > 云游戏手游 > 业务管理 > 进入业务 > 游戏管理中取消游戏已配置的部署策略。
如果修改的实例数量大于可分配资源量，订购数量修改会失败。如需订购需要的实例数量，可联系火山引擎云游戏技术支持。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateAppliedResource&Version=2023-03-18

请求参数

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

Query

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

Body

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

ProductId String 是 1493570375567xxxxxx 云游戏业务 ID，您可在控制台 > 云游戏手游 > 业务管理或通过调用 GetProductList 接口获取。

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1493570375567xxxxxx`	云游戏业务 ID，您可在控制台 > 云游戏手游 > 业务管理或通过调用 GetProductList 接口获取。
ConfigurationCode	String	是	`General_Postpaid`	后付费实例套餐 ID，取值如下所示： `Standard_Postpaid`：基础型 `General_Postpaid`：通用型 `Enhanced_Postpaid`：加强型 `Advanced_Postpaid`：旗舰型
ApplyNum	Long	是	`10`	需订购的实例数量。必须为大于等于 0 的整数；设置为 0 时，需确保实例资源未被配置游戏部署策略，否则会请求失败。

ConfigurationCode

String

是

General_Postpaid

后付费实例套餐 ID，取值如下所示：

Standard_Postpaid：基础型
General_Postpaid：通用型
Enhanced_Postpaid：加强型
Advanced_Postpaid：旗舰型

ApplyNum Long 是 10 需订购的实例数量。必须为大于等于 0 的整数；设置为 0 时，需确保实例资源未被配置游戏部署策略，否则会请求失败。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
Result	String	`success`	订购实例数量修改成功，返回 `success`。否则返回错误。

请求示例

POST https://open.volcengineapi.com?Action=UpdateAppliedResource&Version=2023-03-18
{
    "ProductId": "1493570375567xxxxxx",
    "ConfigurationCode": "General_Postpaid",
    "ApplyNum": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UpdateAppliedResource",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "Result": "success"
    }
}

错误码

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