DescribeAccelerator - Global Accelerator - Alibaba Cloud Documentation Center

Queries information about a Global Accelerator (GA) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ga:DescribeAccelerator	Read	Accelerator acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the GA instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
AcceleratorId	string	Yes	The ID of the GA instance that you want to query.	ga-bp1odcab8tmno0hdq****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
DdosId	string	The ID of the Anti-DDoS Pro/Premium instance that is associated with the GA instance.	ddoscoo-cn-zz11vq7j****
DnsName	string	The canonical name (CNAME) that is assigned to the GA instance.	ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com
Description	string	The description of the GA instance.	Accelerator
RequestId	string	The ID of the request.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
InstanceChargeType	string	The billing method of the GA instance.	PREPAY
CreateTime	long	The timestamp that indicates when the GA instance is created.	1650643200
CrossDomainBandwidthPackage	object	The details about the cross-border acceleration bandwidth plan that is associated with the GA instance. This array is returned only for GA instances that are created on the international site (alibabacloud.com).
Bandwidth	integer	The bandwidth that is provided by the cross-border acceleration bandwidth plan. Unit: Mbit/s.	2
InstanceId	string	The ID of the cross-border acceleration bandwidth plan.	gbwp-bp1d8xk8bg139j0fw****
SecondDnsName	string	The CNAME that is used to integrate the GA instance with the Anti-DDoS service.	ga-bp1f609c76zg6zuna****-1.aliyunga0047.com
Name	string	The name of the GA instance.	Accelerator
BasicBandwidthPackage	object	The details about the basic bandwidth plan that is associated with the GA instance.
Bandwidth	integer	The bandwidth value of the basic bandwidth plan. Unit: Mbit/s.	2
BandwidthType	string	The type of the bandwidth that is provided by the basic bandwidth plan. Valid values: Basic: basic Enhanced: enhanced Advanced: premium	Basic
InstanceId	string	The ID of the basic bandwidth plan.	gbwp-bp1d8xk8bg139j0fw****
State	string	The status of the GA instance. Valid values: init: The GA instance is being initialized. active: The GA instance is available. configuring: The GA instance is being configured. binding: The GA instance is being associated. unbinding: The GA instance is being disassociated. deleting: The GA instance is being deleted. finacialLocked: The GA instance is locked due to overdue payments.	active
ExpiredTime	long	The timestamp that indicates when the GA instance expires.	1653235200
CenId	string	The ID of the Cloud Enterprise Network (CEN) instance with which the GA instance is associated.	cen-hjkduu767hc****
RegionId	string	The region ID of the GA instance.	cn-hangzhou
Spec	string	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 to users 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
AcceleratorId	string	The ID of the GA instance.	ga-bp1odcab8tmno0hdq****
BandwidthBillingType	string	The bandwidth metering method. Valid values: BandwidthPackage: billed based on bandwidth plans. CDT: billed based on data transfer.	CDT
IpSetConfig	object	The configurations of the acceleration area.
AccessMode	string	The access mode of the acceleration area. Valid values: UserDefine: custom nearby access mode. You can select acceleration areas and regions based on your business requirements. GA allocates a separate elastic IP address (EIP) to each acceleration region. Anycast: automatic nearby access mode. You do not need to specify an acceleration area. GA allocates an Anycast EIP to multiple regions across the globe. Users can connect to the nearest access point of the Alibaba Cloud global transmission network by sending requests to the Anycast EIP.	UserDefine
CrossPrivateState	string	Indicates whether cross-border acceleration is enabled. true: yes false: no	false
ResourceGroupId	string	The ID of the resource group.	rg-acfmw2vwdbujqbq
Tags	object []	The tags of the GA instance.
Key	string	The key of tag N that is added to the GA instance.	tag-key
Value	string	The value of tag N that is added to the GA instance.	tag-value
CrossBorderMode	string	The type of cross-border acceleration. This parameter is returned for GA instances whose bandwidth metering method is pay-by-data-transfer (CDT). Only bpgPro may be returned, which indicates BGP (Multi-ISP) Pro lines.	bpgPro
CrossBorderStatus	boolean	Indicates whether cross-border acceleration is enabled. true: yes false: no	false
UpgradableStatus	string	Indicates whether the GA instance can be upgraded. Valid values: notUpgradable: The GA instance does not need to be upgraded. upgradable: The GA instance can be upgraded to the latest version. upgradeFailed: The GA instance failed to be upgraded.	notUpgradable
ServiceId	string	The ID of the service that manages the GA instance. Note This parameter is returned only if the value of ServiceManaged is true.	ALB
ServiceManaged	boolean	Indicates whether the GA instance is managed. Valid values: true false	true
ServiceManagedInfos	object []	The actions that you can perform on the managed instance. Note This parameter is returned only if the value of ServiceManaged is true. You can perform only specific actions on a managed instance.
Action	string	The name of the action performed on the managed instance. Valid values: Create Update Delete Associate UserUnmanaged CreateChild	Update
ChildType	string	The type of the child resource. Valid values: Listener: a listener. IpSet: an acceleration region. EndpointGroup: an endpoint group. ForwardingRule: a forwarding rule. Endpoint: an endpoint. EndpointGroupDestination: a protocol mapping of an endpoint group associated with a custom routing listener. EndpointPolicy: a traffic policy of an endpoint associated with a custom routing listener. Note This parameter is returned only if the value of Action is CreateChild.	Listener
IsManaged	boolean	Indicates whether the specified actions are managed. Valid values: true: The specified actions are managed, and you cannot perform the specified actions on the managed instance. false: The specified actions are not managed, and you can perform the specified actions on the managed instance.	false

Examples

Sample success responses

JSONformat

{
  "DdosId": "ddoscoo-cn-zz11vq7j****",
  "DnsName": "ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com",
  "Description": "Accelerator",
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "InstanceChargeType": "PREPAY",
  "CreateTime": 1650643200,
  "CrossDomainBandwidthPackage": {
    "Bandwidth": 2,
    "InstanceId": "gbwp-bp1d8xk8bg139j0fw****"
  },
  "SecondDnsName": "ga-bp1f609c76zg6zuna****-1.aliyunga0047.com",
  "Name": "Accelerator",
  "BasicBandwidthPackage": {
    "Bandwidth": 2,
    "BandwidthType": "Basic",
    "InstanceId": "gbwp-bp1d8xk8bg139j0fw****"
  },
  "State": "active",
  "ExpiredTime": 1653235200,
  "CenId": "cen-hjkduu767hc****",
  "RegionId": "cn-hangzhou",
  "Spec": "1",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "BandwidthBillingType": "CDT",
  "IpSetConfig": {
    "AccessMode": "UserDefine"
  },
  "CrossPrivateState": "false",
  "ResourceGroupId": "rg-acfmw2vwdbujqbq",
  "Tags": [
    {
      "Key": "tag-key",
      "Value": "tag-value"
    }
  ],
  "CrossBorderMode": "bpgPro",
  "CrossBorderStatus": false,
  "UpgradableStatus": "notUpgradable",
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	UnknownError	An 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 time

Summary of changes

Operation

2023-08-15

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.

2023-06-14

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.

2023-04-06

API Description Update. The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
API Description	API Description Update.
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.

2023-04-06

API Description Update. The Error code has changed

see changesets

Change item	Change content
API Description	API Description Update.
Error Codes	The Error code has changed.
	delete Error Codes: 500
	Added Error Codes: 400