All Products
Search

This Product

    Global Accelerator:GetBasicEndpoint

    Document Center

    Global Accelerator:GetBasicEndpoint

    Last Updated:Apr 28, 2024

    Queries detailed information about an endpoint that is associated with a basic Global Accelerator (GA) instance.

    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:GetBasicEndpointRead
    • BasicEndpoint
      acs:ga:{#regionId}:{#accountId}:basicendpoint/{#EndPointId}
      none
    		none

    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
    EndpointIdstringYes

    The ID of the endpoint that you want to query.

    		ep-bp14sz7ftcwwjgrdm****

    Response parameters

    ParameterTypeDescriptionExample
    object

    A list of response parameters.

    AcceleratorIdstring

    The ID of the basic GA instance.

    		ga-bp17frjjh0udz4qz****
    EndpointGroupIdstring

    The ID of the endpoint group to which the endpoint belongs.

    		epg-bp1dmlohjjz4kqaun****
    EndPointIdstring

    The ID of the endpoint that is associated with the basic GA instance.

    		ep-bp14sz7ftcwwjgrdm****
    Namestring

    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.
    		ENI
    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 type of the endpoint is set to 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 deployed.

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

    		cn-hangzhou-g
    Statestring

    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
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

    {
  "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

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

    Change history

    Change timeSummary of changesOperation
    2023-04-20The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.