All Products
Search
Document Center

Global Accelerator:DescribeBandwidthPackageAutoRenewAttribute

Last Updated:Jul 31, 2024

Queries the auto-renewal status of a bandwidth plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ga:DescribeBandwidthPackageAutoRenewAttributeget
  • BandwidthPackage
    acs:ga:{#regionId}:{#accountId}:ga/{#BandwidthPackageId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
InstanceIdstringYes

The ID of the bandwidth plan.

gbwp-bp1iquvlp8khla5emb3ia

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

InstanceIdstring

The ID of the bandwidth plan.

gbwp-bp1iquvlp8khla5emb3ia
AutoRenewboolean

Indicates whether auto-renewal is enabled.

  • true
  • false (default)
false
AutoRenewDurationinteger

The auto-renewal duration. Unit: month. Valid values: 1 to 12.

Note This parameter is returned only if the value of AutoRenew is true.
1
RenewalStatusstring

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 it expires. The system sends a non-renewal reminder three days before the expiration date but no longer sends reminders to renew the bandwidth plan. You can change the auto-renewal status of a bandwidth plan from NotRenewal to Normal or AutoRenewal.
Note RenewalStatus takes precedence over AutoRenew. If you do not specify RenewalStatus, AutoRenew is automatically used.
Normal
RequestIdstring

The ID of the request.

B820E9F9-D459-5AE7-8F08-A368B53C1AC3

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
500UnknownErrorAn 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.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history