RenewInstance - Hologres - Alibaba Cloud Documentation Center

Manually renews a Hologres instance. You can enable monthly auto-renewal when you renew a Hologres instance.

Operation description

Note Before you call this operation, make sure that you understand the billing method and pricing of Hologres because this operation is charged.

For more information about billing details of Hologres, see Pricing .
For more information about how to renew a Hologres instance, see Manage renewals.
You can renew only subscription instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /api/v1/instances/{instanceId}/renew

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance.	hgprecn-cn-i7m2v08uu00a
body	object	No	The request body.
duration	integer	Yes	The renewal duration. Unit: month.	2
autoRenew	boolean	No	Specifies whether to enable monthly auto-renewal. The default value is false. Valid values: true false Note If you enable auto-renewal for an instance for which auto-renewal is enabled, an error is reported.	true

Response parameters

Parameter	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
Data	object	The returned data.
Code	string	The error code returned.	InvalidChargeType.UnRenewable
Message	string	The error details.
OrderId	string	The ID of the order.	221625608580893
Success	boolean	Indicates whether the renewal was successful. true false	true
ErrorCode	string	The error code returned.	null
ErrorMessage	string	The error message returned.	null
HttpStatusCode	string	The HTTP status code.	200
Success	string	The request result, which indicates whether the request was successful.	false

If parameter verification fails, data is returned. In the returned data, Success is set to false, and the Code and Message parameters are included. The value of HttpStatusCode is 200.

Examples

Sample success responses

JSONformat

{
  "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
  "Data": {
    "Code": "InvalidChargeType.UnRenewable",
    "Message": "",
    "OrderId": "221625608580893",
    "Success": true
  },
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200",
  "Success": "false"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history