RenewInstance
Renews an instance manually. You can also enable monthly auto-renewal during the renewal.
Operation description
For more information about Hologres billing, see Billing overview.
For more information about Hologres renewal, see Renewal management.
Renewal applies only to subscription (PrePaid) instances.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hologram:RenewInstance |
update |
*All Resource
|
None | None |
Request syntax
POST /api/v1/instances/{instanceId}/renew HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
Yes |
The instance ID. |
hgprecn-cn-i7m2v08uu00a |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
The request body. |
|
| duration |
integer |
Yes |
The renewal period. Unit: months. |
2 |
| autoRenew |
boolean |
No |
Specifies whether to enable monthly auto-renewal. By default, monthly auto-renewal is disabled. Valid values:
Note
If you enable auto-renewal for an instance that already has auto-renewal enabled, an error is reported. |
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70 |
| Data |
object |
The returned result. |
|
| Code |
string |
The error code. |
InvalidChargeType.UnRenewable |
| Message |
string |
The detailed error message. |
Invalid charge type |
| OrderId |
string |
The order ID. |
221625608580893 |
| Success |
boolean |
Indicates whether the renewal was successful. Valid values:
|
true |
| ErrorCode |
string |
The error code. |
null |
| ErrorMessage |
string |
The error message. |
null |
| HttpStatusCode |
string |
The HTTP status code. |
200 |
| Success |
string |
Indicates whether the request was successful. This parameter indicates whether an exception occurred during the request and is unrelated to the business logic. |
false |
If a parameter validation error occurs, a normal Data object is still returned, Success is set to false, and Code and Message are included. Unless an exception is thrown, the success of the request is determined by Data.Success.
When you use the latest SDK to call this operation, a request timeout error may be returned because the default timeout period of the client in the SDK is inconsistent with that of the server. However, the operation is actually called successfully. To avoid this issue, set the ReadTimeout parameter to 20000 before you call the operation.

Examples
Success response
JSON format
{
"RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
"Data": {
"Code": "InvalidChargeType.UnRenewable",
"Message": "Invalid charge type",
"OrderId": "221625608580893",
"Success": true
},
"ErrorCode": "null",
"ErrorMessage": "null",
"HttpStatusCode": "200",
"Success": "false"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.