该接口用于为Hologres实例手动续费。可以在续费的同时开启按月自动续费。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hologram:RenewInstance | update | *全部资源 * |
| 无 |
请求语法
POST /api/v1/instances/{instanceId}/renew HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 id。 | hgprecn-cn-i7m2v08uu00a |
| body | object | 否 | 请求体。 | |
| duration | integer | 是 | 续费周期。单位：月。 | 2 |
| autoRenew | boolean | 否 | 是否开启按月自动续费，默认不开启。取值：
说明
已开启自动续费的实例，再次开启会报错。
| true |
返回参数
说明
参数校验错误，仍然会返回正常的 Data，Success 为 false，并包含 Code 和 Message。除非抛出异常，否则成功与否由 Data.Success 来判断。
使用新版 SDK 包调用本接口时，由于 SDK 内部的客户端默认超时时间和服务端的不一致，因此可能返回请求超时的错误，但实际上接口已调用成功。如需避免这个问题，您可以在调用前设置 ReadTimeout 参数为 20000。
示例
正常返回示例
JSON格式
{
"RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
"Data": {
"Code": "InvalidChargeType.UnRenewable",
"Message": "不支持续费的付费类型",
"OrderId": "221625608580893",
"Success": true
},
"ErrorCode": "null",
"ErrorMessage": "null",
"HttpStatusCode": "200",
"Success": "false"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-06 | API 内部配置变更，不影响调用 | 查看变更详情 |