DescribeIpSet - Global Accelerator - Alibaba Cloud Documentation Center

Queries information about an acceleration region.

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:DescribeIpSet	get	IpSet acs:ga:{#regionId}:{#accountId}:ipset/{#ipSetId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
IpSetId	string	Yes	The ID of the acceleration region. You can call the ListIpSets operation to query the IDs of acceleration regions of a specific GA instance.	ips-bp11ilwqjdkjeg9r7****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
IpSetId	string	The ID of the acceleration region.	ips-bp11ilwqjdkjeg9r7****
RequestId	string	The ID of the request.	6D2BFF54-6AF2-4679-88C4-2F2E187F16CB
IpVersion	string	The IP version. Valid values: IPv4 IPv6 DUAL_STACK	IPv4
State	string	The status of the acceleration region. Valid values: init: The acceleration region is being initialized. active: The acceleration region is in the running state. updating: The acceleration region is being configured. deleting: The GA instance is being deleted.	active
Bandwidth	integer	The bandwidth that is allocated to the acceleration region. Unit: Mbit/s.	3
IspType	string	The line type of the elastic IP address (EIP) in the acceleration region. Valid values: BGP: BGP (Multi-ISP) lines. This is the default value. BGP_PRO: BGP (Multi-ISP) Pro lines.	BGP
IpAddressList	array	The list of accelerated IP addresses in the acceleration region.
	string	The list of accelerated IP addresses in the acceleration region.	121.43.XX.XX
AccelerateRegionId	string	The ID of the acceleration region.	cn-hangzhou
AcceleratorId	string	The ID of the GA instance.	ga-bp1yeeq8yfoyszmqy****
ServiceId	string	The ID of the service that manages the 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	array<object>	The actions that users can perform on the managed instance. Note This parameter is returned only if the value of ServiceManaged is true. Users can perform only specific actions on a managed instance.
	object	A list of action policies that users can execute on this managed instance.
Action	string	The name of the action on the managed instance. Valid values: Create Update Delete Associate UserUnmanaged CreateChild	Update
ChildType	string	The type of the child resource. Valid values: Listener: listener. IpSet: acceleration region. EndpointGroup: endpoint group. ForwardingRule: forwarding rule. Endpoint: endpoint. EndpointGroupDestination: protocol mapping of an endpoint group associated with a custom routing listener. EndpointPolicy: traffic policy of an endpoint associated with a custom routing listener. Note This parameter takes effect only if Action is set to CreateChild.	Listener
IsManaged	boolean	Indicates whether the specified actions are managed. true: The specified actions are managed, and users cannot perform the actions on the managed instance. false: The specified actions are not managed, and users can perform the actions on the managed instance.	false

Examples

Sample success responses

JSONformat

{
  "IpSetId": "ips-bp11ilwqjdkjeg9r7****",
  "RequestId": "6D2BFF54-6AF2-4679-88C4-2F2E187F16CB",
  "IpVersion": "IPv4",
  "State": "active",
  "Bandwidth": 3,
  "IspType": "BGP",
  "IpAddressList": [
    "121.43.XX.XX"
  ],
  "AccelerateRegionId": "cn-hangzhou",
  "AcceleratorId": "ga-bp1yeeq8yfoyszmqy****",
  "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	View Change Details