All Products
Search

This Product

    Global Accelerator:GetBasicAccelerateIpEndpointRelation

    Document Center

    Global Accelerator:GetBasicAccelerateIpEndpointRelation

    Last Updated:Sep 17, 2026

    Queries the attachment information between an accelerated IP address and an endpoint of a basic Global Accelerator (GA) instance.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ga:GetBasicAccelerateIpEndpointRelation

    get

    BasicAccelerateIpEndpointRelation

    acs:ga:{#regionId}:{#accountId}:basicendpoint/{#basicendpointId}

    BasicAccelerateIp

    acs:ga:{#regionId}:{#accountId}:basicgaip/{#basicgaipId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID of the Global Accelerator instance. Set the value to cn-hangzhou.

    cn-hangzhou
    ClientToken

    string

    No

    The client token that is used to ensure the idempotence of a request.

    Generate a parameter value from your client to ensure that the value is unique among different requests. ClientToken supports only ASCII characters.

    Note

    If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.

    123e4567-e89b-12d3-a456-426655440000
    AcceleratorId

    string

    Yes

    The instance ID of the basic Global Accelerator (GA) instance.

    ga-bp17frjjh0udz4qz****
    EndpointId

    string

    No

    The endpoint ID of the basic Global Accelerator (GA) instance.

    Note

    EndpointId and AccelerateIpId cannot both be empty.

    ep-bp14sz7ftcwwjgrdm****
    AccelerateIpId

    string

    No

    The accelerated IP address instance ID of the basic Global Accelerator (GA) instance.

    Note

    EndpointId and AccelerateIpId cannot both be empty.

    gaip-bp1****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    EndpointId

    string

    The endpoint ID of the basic Global Accelerator (GA) instance.

    ep-bp14sz7ftcwwjgrdm****
    EndpointName

    string

    The name of the endpoint of the basic Global Accelerator (GA) instance.

    ep01
    EndpointType

    string

    The endpoint type. Valid values:

    • ENI: Alibaba Cloud elastic network interface controller (NIC).

    • SLB: Alibaba Cloud Classic Load Balancer (CLB) instance.

    • ECS: Alibaba Cloud ECS instance.

    • NLB: Alibaba Cloud Network Load Balancer (NLB) instance.

    ENI
    EndpointAddress

    string

    The address of the endpoint.

    eni-bp1a05txelswuj8g****
    EndpointSubAddress

    string

    The secondary address of the endpoint.

    This parameter is returned when the endpoint type attached to the accelerated IP address is ECS, ENI, or NLB.

    • When the endpoint type is ECS, EndpointSubAddress is the secondary private IP or the primary private IP of the primary network interface controller (NIC).

    • When the endpoint type is ENI, EndpointSubAddress is the secondary private IP or the primary private IP of the secondary network interface controller (NIC).

    • When the endpoint type is NLB, EndpointSubAddress is the primary private IP of the NLB backend server.

    172.16.XX.XX
    EndpointSubAddressType

    string

    The type of the secondary address of the endpoint. Valid values:

    • primary: The secondary address type is the primary private IP address.

    • secondary: The secondary address type is the secondary private IP address.

    This parameter is returned when the endpoint type bound to the accelerated IP address is ECS, ENI, or NLB. When the endpoint type is NLB, only the primary type is returned.

    primary
    EndpointZoneId

    string

    The zone ID of the endpoint.

    Currently, this parameter is returned only when the endpoint type bound to the accelerated IP address is NLB.

    cn-hangzhou-g
    AccelerateIpId

    string

    The accelerated IP address instance ID of the basic Global Accelerator (GA) instance.

    gaip-bp1****
    IpAddress

    string

    The accelerated IP address of the basic Global Accelerator (GA) instance.

    116.132.XX.XX
    State

    string

    The attachment status between the accelerated IP address and the endpoint of the basic Global Accelerator (GA) instance.

    The value active indicates that the attachment is established.

    active
    RequestId

    string

    The request ID.

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

    string

    The instance ID of the basic Global Accelerator (GA) instance.

    ga-bp11v53zfftax68b0daws

    Examples

    Success response

    JSON format

    {
  "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
  "EndpointName": "ep01",
  "EndpointType": "ENI",
  "EndpointAddress": "eni-bp1a05txelswuj8g****",
  "EndpointSubAddress": "172.16.XX.XX",
  "EndpointSubAddressType": "primary",
  "EndpointZoneId": "cn-hangzhou-g",
  "AccelerateIpId": "gaip-bp1****",
  "IpAddress": "116.132.XX.XX",
  "State": "active",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId": " ga-bp11v53zfftax68b0daws"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.