Use UpdateBandwidthPackagaAutoRenewAttribute to change bandwidth plan auto-renewal status - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

Do not repeatedly call this operation to modify the auto-renewal settings of a bandwidth plan.

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

update

*BandwidthPackage

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the Global Accelerator (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 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 request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
Name	string	No	The name of the bandwidth plan. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.	test
InstanceId	string	Yes	The ID of the bandwidth plan.	gbwp-bp1sgzldyj6b4q7cx****
AutoRenew	boolean	No	Whether to enable auto-renewal. Valid values: true false (default) Note You must specify AutoRenew or RenewalStatus.	false
RenewalStatus	string	No	The auto-renewal status of the bandwidth plan. Valid values: AutoRenewal: The bandwidth plan is automatically renewed. Normal: You must manually renew the bandwidth plan. NotRenewal: The bandwidth plan is not renewed after it expires. The system sends only a non-renewal reminder three days before the expiration date. To renew a bandwidth plan for which you set RenewalStatus to NotRenewal, you can change the value of RenewalStatus from NotRenewal to Normal, and then manually renew the bandwidth plan. You can also set RenewalStatus to AutoRenewal. Note You must specify AutoRenew or RenewalStatus. RenewalStatus takes precedence over AutoRenew. If you do not specify RenewalStatus, AutoRenew is used.	Normal
AutoRenewDuration	integer	No	The auto-renewal duration. Unit: months. Valid values: 1 to 12. Note This parameter takes effect only if AutoRenew is set to true.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	F591955F-5CB5-4CCE-A75D-17CF2085CE22
InstanceId	string	The ID of the bandwidth plan.	gbwp-bp1sgzldyj6b4q7cx****

Examples

Success response

JSON format

{
  "RequestId": "F591955F-5CB5-4CCE-A75D-17CF2085CE22",
  "InstanceId": "gbwp-bp1sgzldyj6b4q7cx****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotExist.BandwidthPackage	The bandwidth package does not exist.	The bandwidth package does not exist.
400	ParamIllegal.SpInstanceAutoRenew	The param AutoRenew and RenewalStatus cannot be empty at the same time.	The AutoRenew and RenewalStatus parameters cannot be left empty at the same time.
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.