All Products
Search
Document Center

Global Accelerator:UpdateBandwidthPackagaAutoRenewAttribute

Last Updated:Jul 31, 2024

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

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:UpdateBandwidthPackagaAutoRenewAttributeupdate
  • BandwidthPackage
    acs:ga:{#regionId}:{#accountId}:ga/{#BandwidthPackageId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

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

cn-hangzhou
ClientTokenstringNo

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
NamestringNo

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
InstanceIdstringYes

The ID of the bandwidth plan.

gbwp-bp1sgzldyj6b4q7cx****
AutoRenewbooleanNo

Specifies whether to enable auto-renewal. Valid values:

  • true
  • false (default)
Note You must specify AutoRenew or RenewalStatus.
false
RenewalStatusstringNo

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
    AutoRenewDurationintegerNo

    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

    ParameterTypeDescriptionExample
    object

    A list of response parameters.

    RequestIdstring

    The ID of the request.

    F591955F-5CB5-4CCE-A75D-17CF2085CE22
    InstanceIdstring

    The ID of the bandwidth plan.

    gbwp-bp1sgzldyj6b4q7cx****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400NotExist.BandwidthPackageThe bandwidth package does not exist.The bandwidth package does not exist.
    400ParamIllegal.SpInstanceAutoRenewThe param AutoRenew and RenewalStatus cannot be empty at the same time.The AutoRenew and RenewalStatus parameters cannot be left empty at the same time.
    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