All Products
Search

This Product

    Global Accelerator:UpdateAccelerator

    Document Center

    Global Accelerator:UpdateAccelerator

    Last Updated:Apr 10, 2024

    Modifies a Global Accelerator (GA) instance.

    Operation description

    • UpdateAccelerator is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the DescribeAccelerator operation to query the status of a GA instance.

      • If the GA instance is in the configuring state, the GA instance is being modified. In this case, you can perform only query operations.
      • If the GA instance is in the active state, the GA instance is modified.

    • The UpdateAccelerator 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.

    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:UpdateAcceleratorWrite
    • Accelerator
      acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The region where the 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****
    NamestringNo

    The name of the GA instance.

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

    		Accelerator
    DescriptionstringNo

    The description of the GA instance. The description can be up to 200 characters in length.

    		Accelerator
    AcceleratorIdstringYes

    The ID of the GA instance.

    		ga-bp1odcab8tmno0hdq****
    SpecstringNo

    The specification of the GA instance. Valid values:

    • 1: Small Ⅰ
    • 2: Small Ⅱ
    • 3: Small Ⅲ
    • 5: Medium Ⅰ
    • 8: Medium Ⅱ
    • 10: Medium Ⅲ
    • 20: Large Ⅰ
    • 30: Large Ⅱ
    • 40: Large Ⅲ
    • 50: Large Ⅳ
    • 60: Large Ⅴ
    • 70: Large Ⅵ
    • 80: Large VⅡ
    • 90: Large VⅢ
    • 100: Super Large Ⅰ
    • 200: Super Large Ⅱ
    Note The Large Ⅲ specification and higher specifications are available only for accounts that are added to the whitelist. To use these specifications, contact your Alibaba Cloud account manager.

    Different specifications provide different capabilities. For more information, see Instance specifications.

    		1
    AutoPaybooleanNo

    Specifies whether to enable automatic payment. Valid values:

    • false: disables automatic payment. This is the default value. After an order is generated, you must go to the Order Center to complete the payment.
    • true: enables automatic payment. Payments are automatically completed.
    Note This parameter takes effect only if you call the operation to upgrade a GA instance.
    		false
    AutoUseCouponbooleanNo

    Specifies whether to automatically pay bills by using coupons. Default value: false. Valid values:

    • true: automatically pays bills by using coupons.
    • false: does not automatically pay bills by using coupons.
    Note This parameter takes effect only if the AutoPay parameter is set to true.
    		false

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned data.

    RequestIdstring

    The ID of the request.

    		6FEA0CF3-D3B9-43E5-A304-D217037876A8

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400NotExist.AcceleratorThe accelerated instance does not exist.The GA instance does not exist.
    400IllegalParameter.SpecThe specified Spec is invalid.The specified Spec is invalid.
    400StateError.AcceleratorThe state of the accelerated instance is invalid.The status of the GA instance is invalid.
    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