All Products
Search
Document Center

Global Accelerator:ListBasicAccelerateIpEndpointRelations

Last Updated:Jul 08, 2024

Queries whether the accelerated IP address of a basic Global Accelerator (GA) instance is associated with an endpoint.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the GA instance is deployed. 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 basic GA instance.

ga-bp17frjjh0udz4qz****
EndpointIdstringNo

The ID of the endpoint.

ep-bp14sz7ftcwwjgrdm****
AccelerateIpIdstringNo

The ID of the accelerated IP address.

gaip-bp1****
NextTokenstringNo

The token that determines the start point of the query. Valid values:

  • If this is your first query or no next query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object

A list of response parameters.

RequestIdstring

The ID of the request.

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

The total number of entries returned.

1
NextTokenstring

The token that determines the start point of the query. Valid values:

  • If NextToken is not returned, it indicates that no additional results exist.
  • If a value is returned for NextToken, the value is the token that determines the start point of the next query.
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsstring

The number of entries returned per page.

10
AccelerateIpEndpointRelationsarray<object>

A list of accelerated IP addresses and the endpoints with which the accelerated IP addresses are associated.

object

A list of accelerated IP addresses and the endpoints with which the accelerated IP addresses are associated.

AccelerateIpIdstring

The ID of the accelerated IP address.

gaip-bp1****
IpAddressstring

The accelerated IP address of the basic GA instance.

116.132.XX.XX
EndpointIdstring

The ID of the endpoint.

ep-bp14sz7ftcwwjgrdm****
EndpointNamestring

The name of the endpoint.

ep01
EndpointTypestring

The type of endpoint. Valid values:

  • ENI: elastic network interface (ENI).
  • SLB: Classic Load Balancer (CLB) instance.
  • ECS: Elastic Compute Service (ECS) instance.
  • NLB: Network Load Balancer (NLB) instance.
NLB
EndpointAddressstring

The address of the endpoint.

eni-bp1a05txelswuj8g****
EndpointSubAddressstring

The secondary address of the endpoint.

This parameter is returned if the endpoint type is ECS, ENI, or NLB.

  • If the endpoint type is ECS, EndpointSubAddress returns the primary or secondary private IP address of the primary ENI.
  • If the endpoint type is ENI, EndpointSubAddress returns the primary or secondary private IP address of the secondary ENI.
  • If the endpoint type is NLB, EndpointSubAddress returns the primary private IP address of the NLB backend server.
172.16.XX.XX
EndpointSubAddressTypestring

The type of the secondary address of the endpoint.

  • primary: a primary private IP address.
  • secondary: a secondary private IP address.

This parameter is returned if the endpoint type is ECS, ENI, or NLB. If the endpoint type is set to NLB, primary is returned.

primary
EndpointZoneIdstring

The ID of the zone where the endpoint is created.

This parameter is returned only when the endpoint type is NLB.

cn-hangzhou-g
Statestring

The association status between the accelerated IP address and endpoint.

A value of active indicates that the accelerated IP address is associated with the endpoint.

active
AcceleratorIdstring

The ID of the basic GA instance.

ga-bp1miyl2kn2racucvegr5

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": "1",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": "10",
  "AccelerateIpEndpointRelations": [
    {
      "AccelerateIpId": "gaip-bp1****",
      "IpAddress": "116.132.XX.XX",
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "EndpointName": "ep01",
      "EndpointType": "NLB",
      "EndpointAddress": "eni-bp1a05txelswuj8g****",
      "EndpointSubAddress": "172.16.XX.XX",
      "EndpointSubAddressType": "primary",
      "EndpointZoneId": "cn-hangzhou-g",
      "State": "active",
      "AcceleratorId": "ga-bp1miyl2kn2racucvegr5"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history