UpdateAccelerator - Global Accelerator - Alibaba Cloud Documentation Center

Operation description

UpdateAccelerator is an asynchronous operation. After you send a request, the system returns a request ID and performs the modification in the background. You can call the DescribeAccelerator operation to query the state of a Global Accelerator (GA) instance:
- If the GA instance is in the configuring state, the instance is being modified. In this state, you can only perform query operations.
- If the GA instance is in the active state, the modification is complete.
You cannot call the UpdateAccelerator operation concurrently on the same GA 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 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

ga:UpdateAccelerator

update

*Accelerator

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId `deprecated`	string	No	The region ID of the GA 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. Generate a parameter value from your client to make sure that the value is unique among different requests. The client 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 of each API request may be different.	123e4567****
Name	string	No	The name of the GA instance. The name must be 1 to 128 characters in length, start with a letter or a Chinese character, and can contain digits, periods (.), underscores (_), and hyphens (-).	Accelerator
Description	string	No	The description of the GA instance. The description can be up to 200 characters in length.	Accelerator
AcceleratorId	string	Yes	The ID of the GA instance.	ga-bp1odcab8tmno0hdq****
Spec	string	No	The specification of the GA instance. Valid values: 1: Small I 2: Small II 3: Small III 5: Medium I 8: Medium II 10: Medium III 20: Large I 30: Large II 40: Large III 50: Large IV 60: Large V 70: Large VI 80: Large VII 90: Large VIII 100: Ultra-large I 200: Ultra-large II Note Large III and higher specifications are available only to whitelisted users. To use these specifications, contact your account manager. The definitions of instance types vary. For more information, see Instance types.	1
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: false (default): Disables automatic payment. After an order is generated, you must go to the Order Hub to complete the payment. true: Enables automatic payment. The system automatically pays the bill. Note This parameter is valid only for upgrade orders.	false
AutoUseCoupon	boolean	No	Specifies whether to automatically use a coupon to pay for the bill. Valid values: true: Use a coupon. false (default): Do not use a coupon. Note This parameter is valid only if AutoPay is set to true.	false
Bandwidth	integer	No	The bandwidth of the standard GA instance. Unit: Mbps. Valid values: 200 to 5000. Note This parameter is valid only when the access mode of the acceleration area is Anycast.	200

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	6FEA0CF3-D3B9-43E5-A304-D217037876A8

Examples

Success response

JSON format

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

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.
400	IllegalParameter.Spec	The specified Spec is invalid.	The specified Spec is invalid.
400	StateError.Accelerator	The state of the accelerated instance is invalid.	The status of the GA instance is invalid.
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.