Use UpdateBasicIpSet to modify the bandwidth of an acceleration region for a basic instance - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

Before you call this operation, take note of the following limits:

You can modify the bandwidth of an acceleration region only if the bandwidth metering method of the basic GA instance is pay-by-data-transfer.
UpdateBasicIpSet is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetBasicIpSet operation to query the task status.
- If the acceleration region is in the updating state, the bandwidth is being modified. In this case, you can perform only query operations.
- If the acceleration region is in the active state, the bandwidth has been modified.
You cannot repeatedly call the UpdateBasicIpSet operation for the same basic GA instance within a specific period of time.

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

update

*BasicIpSet

acs:ga:{#regionId}:{#accountId}:ipset/{#ipsetId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the basic GA instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can use the client to generate the token, but you must ensure 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 request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
IpSetId	string	Yes	The ID of the acceleration region of the basic GA instance.	ips-bp11r5jb8ogp122xl****
Bandwidth	integer	Yes	The bandwidth of the acceleration region. Unit: Mbit/s. The minimum bandwidth is 2 Mbit/s.	2

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	6D2BFF54-6AF2-4679-88C4-2F2E187F16CB

Examples

Success response

JSON format

{
  "RequestId": "6D2BFF54-6AF2-4679-88C4-2F2E187F16CB"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Resource.QuotaFull	The resource quota is exceeded.	The number of resources has reached the upper limit.
400	NotExist.IpSet	The IpSet does not exist.	The acceleration region does not exist.
400	StateError.IpSet	The state of IpSet is invalid.	The acceleration region is in an invalid state.
400	NotExist.Accelerator	The accelerated instance does not exist.	The GA instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.	The status of the GA instance is invalid.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	You must specify the basic bandwidth package.
400	GreaterThanGa.IpSetBandwidth	The total bandwidth for IpSet exceeds the total bandwidth of the GA instance.	The total bandwidth for IpSet exceeds the total bandwidth of the GA instance.
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.
403	Forbbiden.SubUser	You are not authorized to operate on the specified resource because your account was created by another user.	The current account is a RAM user and does not have permissions to manage the specified resources.
403	Forbidden	The user is not authorized to operate on the specified resource.	The current account does not have permissions to manage the specified resources.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.