All Products
Search
Document Center

Global Accelerator:API overview

Last Updated:Jul 15, 2026

API standards and multilingual preset SDKs

The OpenAPI of this product (Ga/2019-11-20) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Regions and zones

API

Title

Description

ListAccelerateAreas ListAccelerateAreas Queries available acceleration areas and regions.
ListBusiRegions ListBusiRegions Queries the acceleration regions that are supported by Global Accelerator (GA).
DescribeRegions DescribeRegions Queries the regions where Global Accelerator (GA) instances are deployed.
ListAvailableBusiRegions ListAvailableBusiRegions Queries the available acceleration regions of a Global Accelerator (GA) instance.
ListCommonAreas Query regions supported by acceleration services Queries the available acceleration areas and regions by calling the ListCommonAreas operation.

Resource groups

API

Title

Description

DescribeCommodity DescribeCommodity Queries the pricing and specification details of Global Accelerator commodity options available for purchase.
DescribeCommodityPrice DescribeCommodityPrice Queries the prices of commodities.

Tags

API

Title

Description

DescribeBandwidthPackage Query a bandwidth plan Queries the details of a bandwidth plan by calling the DescribeBandwidthPackage operation.
UpdateBandwidthPackage UpdateBandwidthPackage You can call the UpdateBandwidthPackage operation to modify the configuration of a bandwidth plan.
CreateBandwidthPackage CreateBandwidthPackage Creates a bandwidth plan.
ListBandwidthackages ListBandwidthackages Queries a list of bandwidth plans.

Pricing

API

Title

Description

UpdateAcceleratorCrossBorderMode UpdateAcceleratorCrossBorderMode Changes the type of transmission network for a Global Accelerator (GA) instance.
UpdateAcceleratorCrossBorderStatus UpdateAcceleratorCrossBorderStatus Enables cross-border data transmission for a Global Accelerator (GA) instance.

Bandwidth plans

API

Title

Description

CreateAccelerator CreateAccelerator Global Accelerator (GA) is a network acceleration service that provides coverage across the globe. It uses Alibaba Cloud's high-quality Border Gateway Protocol (BGP) bandwidth and global transmission network to provide low-latency access from nearby locations. This reduces the impact of network issues, such as latency, jitter, and packet loss, on your service quality. GA provides a high-availability and high-performance network acceleration service for users worldwide. You can call the CreateAccelerator operation to create a Global Accelerator instance.
DescribeAccelerator DescribeAccelerator You can call the DescribeAccelerator operation to query information about a specified Global Accelerator instance.
ListAccelerators ListAccelerators Queries a list of Global Accelerator instances.
UpdateAccelerator UpdateAccelerator Use the UpdateAccelerator operation to modify a Global Accelerator instance.
DeleteAccelerator DeleteAccelerator Deletes a Global Accelerator (GA) instance.
AttachDdosToAccelerator Associate an Anti-DDoS Pro or Anti-DDoS Premium instance with a Global Accelerator instance If you want to protect your Global Accelerator (GA) applications from large-scale DDoS attacks and ensure service stability and availability, you can call the AttachDdosToAccelerator operation to associate an Anti-DDoS Pro or Anti-DDoS Premium instance with a GA instance.
DetachDdosFromAccelerator DetachDdosFromAccelerator Call the DetachDdosFromAccelerator operation to detach an Anti-DDoS Pro or Anti-DDoS Premium instance from a Global Accelerator instance.
UpdateAcceleratorAutoRenewAttribute UpdateAcceleratorAutoRenewAttribute You can call the UpdateAcceleratorAutoRenewAttribute operation to modify the auto-renewal property of a Global Accelerator instance.

Public network line types and transmission network quality types

API

Title

Description

DescribeIpSet DescribeIpSet Returns the configuration of a specified acceleration region, including its accelerated IP addresses.
ListAvailableAccelerateAreas ListAvailableAccelerateAreas You can call the ListAvailableAccelerateAreas operation to query available acceleration areas.

Global accelerator instances

API

Title

Description

CreateListener CreateListener Create a listener for your GA instance.
DescribeListener DescribeListener Describes the configurations of a specific listener.
ListListeners ListListeners Retrieves a list of listeners.
UpdateListener UpdateListener Updates the configurations of a listener for a Global Accelerator (GA) instance.
GetHealthStatus GetHealthStatus Queries the health status of the endpoints and endpoint groups of a listener.

Acceleration areas

API

Title

Description

CreateEndpointGroup CreateEndpointGroup Creates an endpoint group.
DescribeEndpointGroup DescribeEndpointGroup Queries a specified endpoint group.
ListEndpointGroups ListEndpointGroups Lists endpoint groups.
UpdateEndpointGroup UpdateEndpointGroup Updates the configuration of an endpoint group.
CreateEndpointGroups CreateEndpointGroups Creates endpoint groups in batches.
UpdateEndpointGroups UpdateEndpointGroups Modifies endpoint groups for a listener in a batch.

Listeners

API

Title

Description

CreateCustomRoutingEndpointGroups Create endpoint groups for a custom routing type listener in batches Invokes the CreateCustomRoutingEndpointGroups operation to create endpoint groups for a custom routing type listener in batches.
UpdateCustomRoutingEndpointGroupAttribute UpdateCustomRoutingEndpointGroupAttribute You can call the UpdateCustomRoutingEndpointGroupAttribute operation to modify the name and description of an endpoint group associated with a custom routing listener.

Endpoint groups (intelligent routing listeners)

API

Title

Description

CreateCustomRoutingEndpointGroupDestinations Create mapping configurations for a custom routing listener endpoint group Invokes the CreateCustomRoutingEndpointGroupDestinations operation to create mapping configurations for an endpoint group that is associated with a custom route listener.

Endpoint groups (custom routing listeners)

API

Title

Description

CreateCustomRoutingEndpoints Create endpoints for a custom routing listener Invokes the CreateCustomRoutingEndpoints operation to create endpoints for a custom route type listener.

Endpoint group mapping information (custom routing listeners)

API

Title

Description

ListCustomRoutingPortMappings ListCustomRoutingPortMappings Queries the port mapping table of a custom routing listener.
ListCustomRoutingPortMappingsByDestination ListCustomRoutingPortMappingsByDestination Call the ListCustomRoutingPortMappingsByDestination operation to query the port mappings of a specified backend instance for a custom route listener.

Endpoints (custom routing listeners)

API

Title

Description

CreateForwardingRules Create forwarding rules Creates forwarding rules for a listener. If your business needs to distribute and process traffic based on request attributes (such as domain names and paths) or data contained in requests (such as HTTP headers and cookies), you can customize forwarding rules for a listener. The listener performs different forwarding actions on access requests based on the forwarding rules.
UpdateForwardingRules Update forwarding rules Calls the UpdateForwardingRules operation to update a forwarding rule.
ListForwardingRules ListForwardingRules Queries forwarding rules.

Endpoint traffic destinations (custom routing listeners)

API

Title

Description

ListApplicationMonitor ListApplicationMonitor Queries origin probing tasks.
DescribeApplicationMonitor DescribeApplicationMonitor Queries the detailed information about an origin probing task.

Port mapping tables (custom routing listeners)

API

Title

Description

CreateDomain CreateDomain Creates an accelerated domain name and associates it with one or more GA instances.
UpdateDomainState UpdateDomainState Queries and updates the ICP filing status of an accelerated domain name.
UpdateDomain Update an accelerated domain name Calls the UpdateDomain operation to update a domain name.

Forwarding rules

API

Title

Description

UpdateBasicEndpointGroup UpdateBasicEndpointGroup Updates the configurations of an endpoint group that is associated with a basic Global Accelerator (GA) instance.

Access control

API

Title

Description

UpdateLogStoreConfig Modify access log configuration Modify Simple Log Service log configuration
GetGlobalAcceleratorResources Query peripheral resources associated with a Global Accelerator (GA) instance Obtain the cloud products associated with a Global Accelerator (GA) instance
DisassociateResources Detach peripheral resource from Alibaba Cloud Global Accelerator (GA) instance Detach integrated cloud product from GA
AssociateResources Attach peripheral resources to an Alibaba Cloud Global Accelerator (GA) instance Alibaba Cloud Global Accelerator (GA) Integration with Cloud Products
AddEntriesToAcl Add IP entries to an access control policy group Adds IP entries to an access control policy group and allows or restricts the forwarding of access requests to listeners for these IP entries by using Settings such as whitelists or blacklists, enabling precise control over client requests. You can call the AddEntriesToAcl operation to add IP entries to an access control policy group.
AssociateAclsWithListener Associate aCLs with a listener Invokes the AssociateAclsWithListener operation to associate access control policy groups with a listener.
AssociateAdditionalCertificatesWithListener Bind additional certificates to an HTTPS listener Binds multiple certificates to an HTTPS listener of a Global Accelerator instance. Combined with virtual endpoint groups and forwarding rules, this enables accelerated access to multiple HTTPS domain names. You can call the AssociateAdditionalCertificatesWithListener operation to bind additional certificates to an HTTPS listener.
AttachLogStoreToEndpointGroup Associate an SLS logstore with an endpoint group Associates a Simple Log Service (SLS) Logstore with an endpoint group.
BandwidthPackageAddAccelerator Attach a bandwidth plan to a Global Accelerator instance Invokes the BandwidthPackageAddAccelerator operation to attach a bandwidth plan to an Alibaba Cloud Global Accelerator (GA) instance.
BandwidthPackageRemoveAccelerator Disassociate a bandwidth plan from a global accelerator instance Invokes the BandwidthPackageRemoveAccelerator operation to disassociate a bandwidth plan from an Alibaba Cloud Global Accelerator (GA) instance.
ChangeResourceGroup Modify the resource group of a global accelerator resource Modifies the resource group to which a Global Accelerator resource belongs by calling the ChangeResourceGroup operation.
ConfigEndpointProbe ConfigEndpointProbe Configures latency monitoring for an endpoint.
CreateAcl Create an access control policy group Invokes the CreateAcl operation to create an access control policy group.
CreateApplicationMonitor Create an origin probing task Creates an origin probing task by calling the CreateApplicationMonitor operation.
CreateBasicAccelerateIp CreateBasicAccelerateIp Creates an accelerated IP address for a basic Global Accelerator (GA) instance.
CreateBasicAccelerateIpEndpointRelation CreateBasicAccelerateIpEndpointRelation Creates a mapping between an accelerated IP address and an endpoint for a basic Global Accelerator (GA) instance.
CreateBasicAccelerateIpEndpointRelations Batch attach accelerated IP addresses to endpoints for a basic Global Accelerator instance Calls the CreateBasicAccelerateIpEndpointRelations operation to batch attach accelerated IP addresses to endpoints for a basic Global Accelerator instance.
CreateBasicAccelerator Create a basic global accelerator instance Basic Alibaba Cloud Global Accelerator (GA) instances leverage Alibaba Cloud's premium global the Internet bandwidth and high-quality transmission network to provide users with point-to-point acceleration. Basic Alibaba Cloud Global Accelerator (GA) instances are primarily used for Layer 3 (IP protocol) network acceleration. You can invoke the CreateBasicAccelerator operation to create a basic Alibaba Cloud Global Accelerator (GA) instance.
CreateBasicEndpoint Create an endpoint for a basic global accelerator instance Invokes the CreateBasicEndpoint operation to create an endpoint for a basic Alibaba Cloud Global Accelerator (GA) instance.
CreateBasicEndpointGroup Create an endpoint group for a basic global accelerator instance Invokes the CreateBasicEndpointGroup operation to create an endpoint group for a basic Alibaba Cloud Global Accelerator (GA) instance.
CreateBasicEndpoints CreateBasicEndpoints Creates multiple endpoints for a basic Global Accelerator (GA) instance.
CreateBasicIpSet Create an acceleration region for a basic global accelerator instance Invokes the CreateBasicIpSet operation to create an acceleration region for a basic Alibaba Cloud Global Accelerator (GA) instance.
CreateCustomRoutingEndpointTrafficPolicies Create endpoint traffic policies for a custom routing listener Invokes the CreateCustomRoutingEndpointTrafficPolicies operation to create an endpoint traffic policy (custom route type listener).
CreateIpSets CreateIpSets Creates acceleration regions.
CreateSpareIps CreateSpareIps Creates secondary IP addresses for a CNAME that is assigned to a Global Accelerator (GA) instance. If an acceleration area of the GA instance becomes unavailable, access traffic is redirected to the secondary IP addresses.
DeleteAcl Delete an ACL Invokes the DeleteAcl operation to delete an access control policy group.
DeleteApplicationMonitor Delete an origin probing task Calls the DeleteApplicationMonitor operation to delete an origin probing task.
DeleteBandwidthPackage DeleteBandwidthPackage Deletes a bandwidth plan.
DeleteBasicAccelerateIp DeleteBasicAccelerateIp Deletes an accelerated IP address of a basic Global Accelerator (GA) instance.
DeleteBasicAccelerateIpEndpointRelation Delete the attach relationship between an accelerated IP address and an endpoint of a basic Global Accelerator instance Deletes the attach relationship between an accelerated IP address and an endpoint of a basic Global Accelerator (GA) instance.
DeleteBasicAccelerator Delete a basic global accelerator instance Invokes the DeleteBasicAccelerator operation to delete a specified basic Alibaba Cloud Global Accelerator (GA) instance.
DeleteBasicEndpoint Delete an endpoint of a basic global accelerator instance Invokes the DeleteBasicEndpoint operation to delete an endpoint of a basic Alibaba Cloud Global Accelerator (GA) instance.
DeleteBasicEndpointGroup DeleteBasicEndpointGroup Deletes an endpoint group that is associated with a basic Global Accelerator (GA) instance.
DeleteBasicIpSet DeleteBasicIpSet Deletes the acceleration region of a basic Global Accelerator (GA) instance.
DeleteCustomRoutingEndpointGroupDestinations DeleteCustomRoutingEndpointGroupDestinations Deletes mappings from an endpoint group that is associated with a custom routing listener.
DeleteCustomRoutingEndpointGroups DeleteCustomRoutingEndpointGroups Deletes multiple endpoint groups that are associated with a custom routing listener.
DeleteCustomRoutingEndpointTrafficPolicies DeleteCustomRoutingEndpointTrafficPolicies Deletes traffic destinations from an endpoint.
DeleteCustomRoutingEndpoints DeleteCustomRoutingEndpoints Deletes endpoints from a custom routing listener.
DeleteDomainAcceleratorRelation DeleteDomainAcceleratorRelation Disassociates a domain name from Global Accelerator (GA) instances.
DeleteEndpointGroup DeleteEndpointGroup Deletes an endpoint group.
DeleteEndpointGroups DeleteEndpointGroups Deletes endpoint groups.
DeleteForwardingRules DeleteForwardingRules Deletes forwarding rules.
DeleteIpSet DeleteIpSet Deletes an acceleration region.
DeleteIpSets DeleteIpSets Deletes acceleration regions.
DeleteListener DeleteListener Deletes a listener.
DeleteSpareIps DeleteSpareIps Deletes the secondary IP addresses that are associated with a CNAME.
DescribeAcceleratorAutoRenewAttribute DescribeAcceleratorAutoRenewAttribute Queries the auto-renewal status of a Global Accelerator (GA) instance.
DescribeAcceleratorServiceStatus DescribeAcceleratorServiceStatus Queries the status of a pay-as-you-go Global Accelerator (GA) instance.
DescribeBandwidthPackageAutoRenewAttribute DescribeBandwidthPackageAutoRenewAttribute Queries the auto-renewal status of a bandwidth plan.
DescribeCustomRoutingEndPointTrafficPolicy DescribeCustomRoutingEndPointTrafficPolicy Queries a traffic destination of an endpoint.
DescribeCustomRoutingEndpoint DescribeCustomRoutingEndpoint Queries a specified endpoint that is associated with a custom routing listener.
DescribeCustomRoutingEndpointGroup DescribeCustomRoutingEndpointGroup Queries the information about a specific endpoint group that is associated with a custom routing listener.
DescribeCustomRoutingEndpointGroupDestinations DescribeCustomRoutingEndpointGroupDestinations Queries the mapping configuration of a specified endpoint group that is associated with a custom routing listener.
DescribeLogStoreOfEndpointGroup DescribeLogStoreOfEndpointGroup Queries the Simple Log Service project and Logstore associated with an endpoint group.
DetachLogStoreFromEndpointGroup DetachLogStoreFromEndpointGroup Disassociates a Log Service Logstore from an endpoint group.
DetectApplicationMonitor DetectApplicationMonitor Enables the diagnostic feature for an origin probing task.
DisableApplicationMonitor DisableApplicationMonitor Disables an origin probing task.
DissociateAclsFromListener DissociateAclsFromListener Disassociates access control lists (ACLs) from a listener.
DissociateAdditionalCertificatesFromListener DissociateAdditionalCertificatesFromListener Disassociates an additional certificate from an HTTPS listener.
EnableApplicationMonitor EnableApplicationMonitor Enables an origin probing task.
GetAcl GetAcl Queries an access control list (ACL).
GetBasicAccelerateIp GetBasicAccelerateIp Queries the status of an accelerated IP address of a basic Global Accelerator (GA) instance.
GetBasicAccelerateIpEndpointRelation Query the attachment information of an accelerated IP address or endpoint of a basic global accelerator instance Queries the attachment information of an accelerated IP address or endpoint of a basic Global Accelerator (GA) instance.
GetBasicAccelerateIpIdleCount Query the number of idle accelerated IP addresses of a basic global accelerator instance Invokes the GetBasicAccelerateIpIdleCount operation to query the number of idle accelerated IP addresses of a basic Alibaba Cloud Global Accelerator (GA) instance.
GetBasicAccelerator GetBasicAccelerator Queries the information about a basic Global Accelerator (GA) instance.
GetBasicEndpoint GetBasicEndpoint Queries detailed information about an endpoint that is associated with a basic Global Accelerator (GA) instance.
GetBasicEndpointGroup GetBasicEndpointGroup Queries the information about the endpoint group of a basic GA instance.
GetBasicIpSet GetBasicIpSet Queries the information about the acceleration region of a basic Global Accelerator (GA) instance.
GetInvalidDomainCount Retrieve the total number of invalid domain names Calls the GetInvalidDomainCount operation to retrieve the total number of invalid domain names.
GetIpsetsBandwidthLimit GetIpsetsBandwidthLimit Queries the maximum bandwidth of an acceleration area.
GetSpareIp Query the status of a CNAME spare IP address Queries the status of a CNAME spare IP address.
ListAcls ListAcls Queries a list of access control lists (ACLs).
ListApplicationMonitorDetectResult ListApplicationMonitorDetectResult Queries the diagnostic results of origin probing tasks.
ListBandwidthPackages ListBandwidthPackages Queries bandwidth plans.
ListBasicAccelerateIpEndpointRelations ListBasicAccelerateIpEndpointRelations Queries whether the accelerated IP address of a basic Global Accelerator (GA) instance is associated with an endpoint.
ListBasicAccelerateIps ListBasicAccelerateIps Queries the accelerated IP addresses in the acceleration region of a basic Global Accelerator (GA) instance.
ListBasicAccelerators ListBasicAccelerators Queries basic Global Accelerator (GA) instances.
ListBasicEndpoints ListBasicEndpoints Queries the endpoints that are associated with a basic Global Accelerator (GA) instance.
ListCustomRoutingEndpointGroupDestinations Query destination configurations of an endpoint group Invokes the ListCustomRoutingEndpointGroupDestinations operation to query the destination configurations of an endpoint group for a custom route listener.
ListCustomRoutingEndpointGroups ListCustomRoutingEndpointGroups Queries the endpoint groups that are associated with a custom routing listener.
ListCustomRoutingEndpointTrafficPolicies Query endpoint traffic policies Invokes the ListCustomRoutingEndpointTrafficPolicies operation to query the list of endpoint traffic policies for a custom routing type listener.
ListCustomRoutingEndpoints ListCustomRoutingEndpoints Queries the configurations of an endpoint.
ListDomains ListDomains Queries accelerated domain names.
ListEndpointGroupIpAddressCidrBlocks ListEndpointGroupIpAddressCidrBlocks Queries the public CIDR blocks to which the endpoint group IP addresses belong. The CIDR blocks can be used to configure ACLs in terminals.
ListIpSets ListIpSets Queries acceleration regions.
ListIspTypes ListIspTypes Queries the line types of elastic IP addresses (EIPs) that are supported in an acceleration region.
ListListenerCertificates ListListenerCertificates Queries the certificates associated with a listener.
ListSpareIps ListSpareIps Queries the information about the secondary IP addresses that are associated with a CNAME.
ListSystemSecurityPolicies ListSystemSecurityPolicies Queries the TLS security policies that are supported by HTTPS listeners.
ListTagResources ListTagResources Queries the tags that are added to Global Accelerator (GA) resources.
OpenAcceleratorService OpenAcceleratorService Activates the pay-as-you-go Global Accelerator (GA) service. If you want to use pay-as-you-go GA instances, you must activate the pay-as-you-go GA service first.
QueryCrossBorderApprovalStatus QueryCrossBorderApprovalStatus Queries the approval status of cross-border permissions for an Alibaba Cloud account (main account).
RemoveEntriesFromAcl RemoveEntriesFromAcl Deletes IP entries from an access control list (ACL).
ReplaceBandwidthPackage ReplaceBandwidthPackage Replaces the bandwidth plans of Global Accelerator (GA) instances.
TagResources TagResources Adds tags to Global Accelerator (GA) resources.
UntagResources UntagResources Removes tags from Global Accelerator (GA) resources.
UpdateAcceleratorConfirm UpdateAcceleratorConfirm Confirms the updated specification of a Global Accelerator (GA) instance.
UpdateAclAttribute UpdateAclAttribute Modifies the attributes of an access control list (ACL) of a Global Accelerator (GA) instance.
UpdateAdditionalCertificateWithListener UpdateAdditionalCertificateWithListener Replaces an expired additional certificate for an HTTPS listener.
UpdateApplicationMonitor Modify origin probing task configuration Modifies the configuration of an origin probing task by calling the UpdateApplicationMonitor operation.
UpdateBandwidthPackagaAutoRenewAttribute UpdateBandwidthPackagaAutoRenewAttribute Changes the auto-renewal status of a bandwidth plan.
UpdateBasicAccelerator UpdateBasicAccelerator Modifies the name and description of a basic Global Accelerator (GA) instance.
UpdateBasicEndpoint UpdateBasicEndpoint Modifies the name of an endpoint that is associated with a basic Global Accelerator (GA) instance.
UpdateBasicIpSet UpdateBasicIpSet Modifies the bandwidth of an acceleration region of a basic Global Accelerator (GA) instance.
UpdateCustomRoutingEndpointGroupDestinations UpdateCustomRoutingEndpointGroupDestinations Modifies the mapping configurations of an endpoint group that is associated with a custom routing listener.
UpdateCustomRoutingEndpointTrafficPolicies UpdateCustomRoutingEndpointTrafficPolicies Modifies the traffic policies for an endpoint that is associated with a custom routing listener.
UpdateCustomRoutingEndpoints UpdateCustomRoutingEndpoints Modifies the endpoints of a custom routing listener.
UpdateEndpointGroupAttribute UpdateEndpointGroupAttribute Modifies the name and description of an endpoint group.
UpdateIpSet UpdateIpSet Modifies the attributes of an acceleration region in an acceleration area for a Global Accelerator (GA) instance.
UpdateIpSets UpdateIpSets Modifies the attributes of acceleration regions in an acceleration area for a Global Accelerator (GA) instance.
UpdateServiceManagedControl UpdateServiceManagedControl Changes the control mode of a resource from managed mode to unmanaged mode.