All Products
Search
Document Center

Global Accelerator:UpdateAcceleratorAutoRenewAttribute

Last Updated:Aug 04, 2025

You can call the UpdateAcceleratorAutoRenewAttribute operation to modify the auto-renewal property of a Global Accelerator instance.

Operation description

The UpdateAcceleratorAutoRenewAttribute operation does not support concurrent modifications to the auto-renewal property of the same Global Accelerator instance.

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

ga:UpdateAcceleratorAutoRenewAttribute

update

*Accelerator

acs:ga:{#regionId}:{#accountId}:ga/{#gaId}

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID of the Global Accelerator instance. Set the value to cn-hangzhou.

cn-hangzhou

ClientToken

string

No

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

Note

If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId may be different for each request.

123e4567-e89b-12d3-a456-426655440000

Name

string

No

The name of the Global Accelerator instance.

The name must be 1 to 128 characters in length, start with a letter or a Chinese character, and can contain letters, digits, underscores (_), and hyphens (-).

test

AcceleratorId

string

Yes

The ID of the Global Accelerator instance.

ga-bp17frjjh0udz4qz****

AutoRenew

boolean

No

Specifies whether to enable auto-renewal for the instance. Valid values:

  • true: Auto-renewal is enabled.

  • false (default): Auto-renewal is disabled.

Note

You must specify at least one of AutoRenew and RenewalStatus.

false

RenewalStatus

string

No

The auto-renewal status of the Global Accelerator instance. Valid values:

  • AutoRenewal: The instance is configured for auto-renewal.

  • Normal: The instance is configured for manual renewal.

  • NotRenewal: The instance is not renewed. The system does not send expiration reminders, but sends a non-renewal reminder three days before the expiration date. You can change the renewal status from NotRenewal to Normal to manually renew the instance, or change the renewal status to AutoRenewal.

Note
  • You must specify at least one of AutoRenew and RenewalStatus.

  • The RenewalStatus parameter takes precedence over the AutoRenew parameter. If you do not specify RenewalStatus, the value of AutoRenew is used.

Normal

AutoRenewDuration

integer

No

The auto-renewal duration. Unit: month.

Valid values: 1 to 12.

Note

This parameter takes effect only when AutoRenew is set to true.

1

Response parameters

Parameter

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

F591955F-5CB5-4CCE-A75D-17CF2085CE22

AcceleratorId

string

The ID of the Global Accelerator instance.

ga-bp17frjjh0udz4qz****

Examples

Success response

JSON format

{
  "RequestId": "F591955F-5CB5-4CCE-A75D-17CF2085CE22",
  "AcceleratorId": "ga-bp17frjjh0udz4qz****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 NotExist.Accelerator The accelerated instance does not exist. The GA instance does not exist.
500 UnknownError An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. An error occurred while the request was being processed. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.