RenewInstance

Updated at:

Renews an instance manually. You can also enable monthly auto-renewal during the renewal.

Operation description

Warning This API operation incurs fees. Make sure that you fully understand the billing methods and pricing of Hologres before you call this operation.
  • 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

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 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:

  • true: enables monthly auto-renewal.

  • false: does not enable monthly auto-renewal.

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: The renewal was 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 was successful. This parameter indicates whether an exception occurred during the request and is unrelated to the business logic.

false

Note
  • 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.