Use GetBasicEndpoint to query endpoint details of a basic Global Accelerator instance - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries information about a specified 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:GetBasicEndpoint

get

*BasicEndpoint

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can use the client to generate the token, but 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
EndpointId	string	Yes	The ID of the endpoint that you want to query.	ep-bp14sz7ftcwwjgrdm****

Response elements

Element	Type	Description	Example
	object	The response parameters.
AcceleratorId	string	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
EndpointGroupId	string	The ID of the endpoint group to which the endpoint belongs.	epg-bp1dmlohjjz4kqaun****
EndPointId	string	The ID of the endpoint associated with the basic GA instance.	ep-bp14sz7ftcwwjgrdm****
Name	string	The name of the endpoint.	ep01
EndpointType	string	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.	ENI
EndpointAddress	string	The address of the endpoint.	eni-bp1a05txelswuj8g****
EndpointSubAddress	string	The secondary address of the endpoint. Returned only 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
EndpointSubAddressType	string	The type of the secondary address of the endpoint. primary: a primary private IP address. secondary: a secondary private IP address. Returned only if the endpoint type is ECS, ENI, or NLB. If the endpoint type is NLB, only primary is returned.	primary
EndpointZoneId	string	The zone ID of the endpoint. Returned only if the endpoint type is NLB.	cn-hangzhou-g
State	string	The status of the endpoint. Valid values: init: The endpoint is being initialized. active: The endpoint is available. updating: The endpoint is being configured. binding: The endpoint is being associated. unbinding: The endpoint is being disassociated. deleting: The endpoint is being deleted. bound: The endpoint is associated.	active
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "AcceleratorId": "ga-bp17frjjh0udz4qz****",
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "EndPointId": "ep-bp14sz7ftcwwjgrdm****",
  "Name": "ep01",
  "EndpointType": "ENI",
  "EndpointAddress": "eni-bp1a05txelswuj8g****",
  "EndpointSubAddress": "172.16.XX.XX",
  "EndpointSubAddressType": "primary",
  "EndpointZoneId": "cn-hangzhou-g",
  "State": "active",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.