Use DescribeBandwidthPackageAutoRenewAttribute to query the auto-renewal status of a bandwidth plan - Global Accelerator - Alibaba Cloud - Global Accelerator

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

get

*BandwidthPackage

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
InstanceId	string	Yes	The ID of the bandwidth plan.	gbwp-bp1iquvlp8khla5emb3ia

Response elements

Element	Type	Description	Example
	object	The response parameters.
InstanceId	string	The ID of the bandwidth plan.	gbwp-bp1iquvlp8khla5emb3ia
AutoRenew	boolean	Whether auto-renewal is enabled. true false (default)	false
AutoRenewDuration	integer	The auto-renewal duration. Unit: month. Valid values: 1 to 12. Note Returned only when AutoRenew is true.	1
RenewalStatus	string	The auto-renewal status of the bandwidth plan. AutoRenewal: The bandwidth plan is automatically renewed. Normal: You must manually renew the bandwidth plan. NotRenewal: The bandwidth plan is not renewed after expiration. A non-renewal reminder is sent three days before the expiration date, and no further renewal reminders are sent. You can change the status to Normal or AutoRenewal. Note RenewalStatus takes precedence over AutoRenew. If RenewalStatus is not specified, AutoRenew is used.	Normal
RequestId	string	The ID of the request.	B820E9F9-D459-5AE7-8F08-A368B53C1AC3

Examples

Success response

JSON format

{
  "InstanceId": "gbwp-bp1iquvlp8khla5emb3ia",
  "AutoRenew": false,
  "AutoRenewDuration": 1,
  "RenewalStatus": "Normal",
  "RequestId": "B820E9F9-D459-5AE7-8F08-A368B53C1AC3"
}

Error codes

HTTP status code	Error code	Error message	Description
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.