Changes the auto-renewal status of a bandwidth plan.
Operation description
You cannot repeatedly call the UpdateBandwidthPackagaAutoRenewAttribute operation to modify the auto-renewal settings of a bandwidth plan.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ga:UpdateBandwidthPackagaAutoRenewAttribute | Write |
|
| 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 that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must 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 | Specifies whether to enable auto-renewal. Valid values:
Note
You must specify AutoRenew or RenewalStatus.
| false |
| RenewalStatus | string | No | The auto-renewal status of the bandwidth plan. Valid values:
Note
| 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 parameters
Examples
Sample success responses
JSONformat
{
"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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|