Queries detailed information about a specified endpoint group 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetBasicEndpointGroup

The operation that you want to perform. Set the value to GetBasicEndpointGroup.

RegionId String Yes cn-hangzhou

The ID of the region where the basic GA instance is deployed. Set the value to cn-hangzhou.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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

You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
EndpointGroupId String Yes epg-bp1dmlohjjz4kqaun****

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

Response parameters

Parameter Type Example Description
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

AcceleratorId String ga-bp17frjjh0udz4qz****

The ID of the basic GA instance.

EndpointGroupId String epg-bp1dmlohjjz4kqaun****

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

Name String group1

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

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

Description String BasicEndpointGroup

Detailed information about the endpoint group that is associated with the basic GA instance.

EndpointGroupRegion String cn-shanghai

The ID of the region to which the endpoint group of the basic GA instance belongs.

EndpointType String ENI

The type of the endpoint. Valid values:

  • ENI: an elastic network interface (ENI)
  • SLB: a Server Load Balancer (SLB) instance
EndpointAddress String eni-bp1a05txelswuj8g****

The address of the endpoint.

State String active

The status of the endpoint group that is associated with the basic GA instance. Valid values:

  • init: The endpoint group is being initialized.
  • active: The endpoint group is running as expected.
  • creating: The endpoint group is being created.
  • configuring: The endpoint group is being configured.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetBasicEndpointGroup
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&EndpointGroupId=epg-bp1dmlohjjz4kqaun****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetBasicEndpointGroupResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>
    <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>
    <Name>group1</Name>
    <Description>BasicEndpointGroup</Description>
    <EndpointGroupRegion>cn-shanghai</EndpointGroupRegion>
    <EndpointType>ENI</EndpointType>
    <EndpointAddress>eni-bp1a05txelswuj8g****</EndpointAddress>
    <State>active</State>
</GetBasicEndpointGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId" : "ga-bp17frjjh0udz4qz****",
  "EndpointGroupId" : "epg-bp1dmlohjjz4kqaun****",
  "Name" : "group1",
  "Description" : "BasicEndpointGroup",
  "EndpointGroupRegion" : "cn-shanghai",
  "EndpointType" : "ENI",
  "EndpointAddress" : "eni-bp1a05txelswuj8g****",
  "State" : "active"
}

Error codes

For a list of error codes, visit the API Error Center.