All Products
Search
Document Center

Global Accelerator:DescribeIpSet

Last Updated:Mar 03, 2024

Queries information about an acceleration region.

Operation description

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
IpSetIdstringYes

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

ParameterTypeDescriptionExample
object

The response parameters.

IpSetIdstring

The ID of the acceleration region.

ips-bp11ilwqjdkjeg9r7****
RequestIdstring

The ID of the request.

6D2BFF54-6AF2-4679-88C4-2F2E187F16CB
IpVersionstring

The version of the IP protocol. Valid values:

  • IPv4
  • IPv6
  • DUAL_STACK
IPv4
Statestring

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
Bandwidthinteger

The bandwidth that is allocated to the acceleration region. Unit: Mbit/s.

3
IspTypestring

The line type of the elastic IP address (EIP) in the acceleration region. Valid values:

  • BGP: BGP (Multi-ISP) lines.
  • BGP_PRO: BGP (Multi-ISP) Pro lines.
BGP
IpAddressListarray

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
AccelerateRegionIdstring

The ID of the acceleration region.

cn-hangzhou
AcceleratorIdstring

The ID of the GA instance.

ga-bp1yeeq8yfoyszmqy****
ServiceIdstring

The ID of the service that manages the instance.

Note This parameter is returned only if the value of ServiceManaged is true.
ALB
ServiceManagedboolean

Indicates whether the GA instance is managed. Valid values:

  • true
  • false
true
ServiceManagedInfosobject []

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.
  • Actionstring

    The name of the action performed on the managed instance. Valid values:

    • Create
    • Update
    • Delete
    • Associate
    • UserUnmanaged
    • CreateChild
    Update
    ChildTypestring

    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 is returned only if the value of Action is CreateChild.
    Listener
    IsManagedboolean

    Indicates whether the specified actions are managed. Valid values:

    • true: The specified actions are managed, and users cannot perform the specified actions on the managed instance.****
    • false: The specified actions are not managed, and users can perform the specified 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 codeError codeError messageDescription
    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
    2023-08-15The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 500
    Output ParametersThe response structure of the API has changed.