Modifies the auto-renewal settings of a Global Accelerator (GA) instance.

Description

The UpdateAcceleratorAutoRenewAttribute operation cannot be repeatedly called for the same GA instance within a specific period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateAcceleratorAutoRenewAttribute

The operation that you want to perform. Set the value to UpdateAcceleratorAutoRenewAttribute.

RegionId String No cn-hangzhou

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

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request.

You can use the client to generate a token, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each API request.
Name String No test

The name of the GA instance.

The name must be 2 to 128 characters in length and can contain digits, underscores (_), and hyphens (-). It must start with a letter.

AcceleratorId String Yes ga-bp17frjjh0udz4qz****

The ID of the GA instance.

AutoRenew Boolean No false

Specifies whether to enable auto-renewal for the GA instance. Default value: false. Valid values:

  • true: enables auto-renewal for the GA instance.
  • false: does not enable auto-renewal for the GA instance.
RenewalStatus String No Normal

Specifies how to renew the GA instance. Valid values:

  • AutoRenewal: The GA instance is automatically renewed.
  • Normal: You must manually renew the GA instance.
  • NotRenewal: Choose this option if you do not want to renew the GA instance after the instance expires. The system sends only a non-renewal reminder three days before the expiration date. The system no longer sends notifications to remind you to renew the GA instance. You can change the value of this parameter from NotRenewal to Normal for a GA instance, and then manually renew the instance. You can also set the RenewalStatus parameter to AutoRenewal.
Note RenewalStatus takes precedence over AutoRenew. If you do not specify RenewalStatus, the AutoRenew parameter is used by default.
AutoRenewDuration Integer No 1

The auto-renewal period. Unit: months.

Valid values: 1 to 12.

Note This parameter is required only if AutoRenew is set to true.

Response parameters

Parameter Type Example Description
RequestId String F591955F-5CB5-4CCE-A75D-17CF2085CE22

The ID of the request.

AcceleratorId String ga-bp17frjjh0udz4qz****

The ID of the GA instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateAcceleratorAutoRenewAttribute
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&Name=test
&AcceleratorId=ga-bp17frjjh0udz4qz****
&AutoRenew=false
&RenewalStatus=Normal
&AutoRenewDuration=1
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateAcceleratorAutoRenewAttributeResponse>
    <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>
    <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>
</UpdateAcceleratorAutoRenewAttributeResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "F591955F-5CB5-4CCE-A75D-17CF2085CE22",
  "AcceleratorId" : "ga-bp17frjjh0udz4qz****"
}

Error codes

HTTP status code Error code Error message Description
400 NotExist.Accelerator The accelerated instance does not exist. The error message returned because the specified GA instance does not exist.

For a list of error codes, visit the API Error Center.