RenewInstance - Hologres - Alibaba Cloud Documentation Center

Call this operation to manually renew an instance. You can also enable monthly auto-renewal.

Operation description

Warning

This is a paid operation. Before you call this operation, make sure that you understand the billing methods and pricing of Hologres.

For more information about Hologres billing, see Billing overview.
For more information about Hologres renewal, see Manage renewals.
Renewal is available only for subscription (PrePaid) instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hologram:RenewInstance

update

*All Resource

*

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, in months.	2
autoRenew	boolean	No	Specifies whether to enable monthly auto-renewal. Valid values: true: Enabled. false (default): Disabled. Note Enabling auto-renewal on an instance where it is already enabled causes an error.	true

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
Data	object	The returned data.
Code	string	The error code.	InvalidChargeType.UnRenewable
Message	string	The error details.	不支持续费的付费类型
OrderId	string	The order ID.	221625608580893
Success	boolean	Indicates whether the renewal is successful. true: The renewal is successful. false: The renewal failed.	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 is successful. This parameter is not related to the business result.	false

Note

If parameter verification fails, a Data object is still returned. The Success parameter is false, and the response includes the Code and Message parameters. The Data.Success parameter indicates whether the operation is successful.
A request timeout error may be returned even if the operation is successful when you use a later version of the software development kit (SDK). This is because the default client timeout period in the SDK may differ from the server-side timeout period. To prevent this issue, set the ReadTimeout parameter to 20000 before you make the call.

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.