All Products
Search
Document Center

Global Accelerator:UpdateAcceleratorCrossBorderStatus

Last Updated:Sep 09, 2024

Enables cross-border data transmission for a Global Accelerator (GA) instance.

Operation description

You can call this operation to enable or disable cross-border data transmission for basic or standard GA instances that use Cloud Data Transfer (CDT) to bill data transfers.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the GA instance. 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
AcceleratorIdstringYes

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
CrossBorderStatusbooleanYes

Specifies whether to enable the cross-border acceleration feature for the GA instance. Valid values:

  • true
  • false
true

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status codeError codeError messageDescription
400CrossBorderStatusUnsupported.AcceleratorThe current instance does not support enabling or disabling the cross-border switch.You cannot enable or disable cross-border acceleration for the current instance.
400CrossBorderStatusTurnOffInvalid.AcceleratorIf there are any cross-border lines, it is not allowed to turn off the cross-border switch.Cross-border acceleration cannot be disabled because cross-border connections are used.
400Error.ComplianceIssueThe current instance is not allowed to use the cross-border special line before obtaining cross-border qualification.You cannot enable cross-border Express Connect circuits for the current instance before your application is approved.
400StateError.AcceleratorThe state of the accelerated instance is invalid.The status of the GA instance is invalid.
400NotOpen.CrossBorderStatusCross-border acceleration has not been enabled for the instance.Cross-border acceleration is disabled for the current instance.
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