All Products
Search
Document Center

Global Accelerator:DescribeEndpointGroup

更新時間:Jul 31, 2024

Queries information about an endpoint group.

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:DescribeEndpointGroupget
  • EndpointGroup
    acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointGroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where your Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
EndpointGroupIdstringYes

The ID of the endpoint group that you want to query.

epg-bp14sz7ftcwwjgrdm****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HealthCheckIntervalSecondsinteger

The interval between two consecutive health checks. Unit: seconds.

3
TrafficPercentageinteger

The traffic ratio of the endpoint group when the specified listener is associated with multiple endpoint groups.

20
EndpointGroupIdstring

The ID of the endpoint group.

epg-bp14sz7ftcwwjgrdm****
Descriptionstring

The description of the endpoint group.

group1
EndpointGroupIpListarray

The active endpoint IP addresses of the endpoint group.

string

The active endpoint IP addresses of the endpoint group.

101.XX.XX.22
EndpointGroupUnconfirmedIpListarray

The endpoint group IP addresses to be confirmed. After the GA instance is upgraded, the IP addresses that are added to the endpoint group need to be confirmed.

string

The endpoint group IP addresses to be confirmed after the GA instance is upgraded.

101.XX.XX.22
RequestIdstring

The ID of the request.

6FEA0CF3-D3B9-43E5-A304-D217037876A8
HealthCheckPathstring

The path to which health check probes are sent.

/healthcheck
ThresholdCountinteger

The number of consecutive failed health checks that must occur before an endpoint is considered unhealthy.

3
Namestring

The name of the endpoint group.

group1
EndpointGroupRegionstring

The ID of the region where the endpoint group is deployed.

cn-hangzhou
Statestring

The status of the endpoint group. Valid values:

  • init: The endpoint group is being initialized.
  • active: The endpoint group is running as expected.
  • updating: The endpoint group is being updated.
  • deleting: The endpoint group is being deleted.
active
HealthCheckProtocolstring

The protocol over which health check requests are sent. Valid values:

  • tcp or TCP
  • http or HTTP
  • https or HTTPS
tcp
HealthCheckPortinteger

The port that is used for health checks.

20
EndpointConfigurationsarray<object>

The configurations of endpoints in the endpoint group.

object

The configurations of the endpoint.

Typestring

The type of the endpoint. Valid values:

  • Domain: a custom domain name.
  • Ip: a custom IP address.
  • PublicIp: a public IP address provided by Alibaba Cloud.
  • ECS: an Elastic Compute Service (ECS) instance.
  • SLB:: a Server Load Balancer (SLB) instance.
  • ALB: an Application Load Balancer (ALB) instance.
  • OSS: an Object Storage Service (OSS) bucket.
  • ENI: an elastic network interface (ENI).
  • NLB: a Network Load Balancer (NLB) instance.
Ip
EnableClientIPPreservationboolean

Indicates whether the client IP address preservation feature is enabled. Valid values:

  • true
  • false
false
Weightinteger

The weight of the endpoint.

20
ProbeProtocolstring

The protocol that is used to monitor latency. Valid values:

  • tcp
  • icmp
tcp
Endpointstring

The IP address, domain name, or ID of the endpoint.

120.XX.XX.21
EnableProxyProtocolboolean

Indicates whether the proxy protocol is used to preserve client IP addresses.

false
ProbePortinteger

The port that is used to monitor latency.

80
SubAddressstring

The private IP address of the ENI.

172.168.XX.XX
PortOverridesarray<object>

The mappings between ports.

object

The mappings between ports.

ListenerPortinteger

The listener port.

443
EndpointPortinteger

The endpoint port.

80
EndpointRequestProtocolstring

The protocol that is used by the backend service.

  • HTTP
  • HTTPS
HTTP
EndpointProtocolVersionstring

The version of the protocol that is used by the backend service.

  • HTTP1.1
  • HTTP2
EndpointGroupTypestring

The type of endpoint group. Valid values:

  • default: a default endpoint group
  • virtual: a virtual endpoint group
default
ForwardingRuleIdsarray

The ID of the forwarding rule that is associated with the endpoint group.

string

The ID of the forwarding rule that is associated with the endpoint group.

frule-bp19a3t3yzr21q3****
AcceleratorIdstring

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
ListenerIdstring

The ID of the listener.

lsr-bp1bpn0kn908w4nbw****
SlsRegionstring

The region of the Log Service project.

cn-hangzhou
SlsProjectNamestring

The name of the Log Service project.

pn-01
SlsLogStoreNamestring

The name of the Logstore.

lsn-01
AccessLogSwitchstring

Indicates the binding status between the Simple Log Service project and the endpoint group. Valid values:

  • on: The endpoint group is bound to the Simple Log Service project.
  • off: The endpoint group is not bound to the Simple Log Service project.
  • binding: The endpoint group is being bound to the Simple Log Service project.
  • unbinding: The endpoint group is being unbound from the Simple Log Service project.
on
EnableAccessLogboolean

Indicates whether the access log feature is enabled. Valid values:

  • true
  • false
true
HealthCheckEnabledboolean

Indicates whether the health check feature is enabled. Valid values:

  • true: enabled
  • false: disabled
true
ServiceIdstring

The ID of the service that manages the GA instance.

Note This parameter takes effect only if ServiceManaged is set to True.
ALB
ServiceManagedboolean

Indicates whether the instance is managed.

  • true
  • false
true
ServiceManagedInfosarray<object>

The actions that users can perform on the managed instance.

Note
  • This parameter takes effect only if the value of ServiceManaged is true.
  • Users can perform only specific actions on a managed instance.
  • object
    Actionstring

    The name of the action on the managed instance.

    • Create
    • Update
    • Delete
    • Associate
    • UserUnmanaged
    • CreateChild
    Update
    ChildTypestring

    The type of the child resource.

    • Listener: listener.
    • IpSet: acceleration region.
    • EndpointGroup: endpoint group.
    • ForwardingRule: forwarding rule.
    • Endpoint: endpoint.
    • EndpointGroupDestination: protocol mapping of an endpoint group associated with a custom routing listener.
    • EndpointPolicy: traffic policy of an endpoint associated with a custom routing listener.
    Note This parameter takes effect only if the value of Action is CreateChild.
    Listener
    IsManagedboolean

    Indicates whether the specified actions are managed.

    • true: The specified actions are managed. Users cannot perform the specified actions on the managed instance.****
    • false: The specified actions are not managed. Users can perform the specified actions on the managed instance.
    false
    Tagsarray<object>

    The tag of the endpoint group.

    object

    Tag objects.

    Keystring

    The tag key of the endpoint group.

    test-key
    Valuestring

    The tag value of the endpoint group.

    test-value

    Examples

    Sample success responses

    JSONformat

    {
      "HealthCheckIntervalSeconds": 3,
      "TrafficPercentage": 20,
      "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
      "Description": "group1",
      "EndpointGroupIpList": [
        "101.XX.XX.22"
      ],
      "EndpointGroupUnconfirmedIpList": [
        "101.XX.XX.22"
      ],
      "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
      "HealthCheckPath": "/healthcheck",
      "ThresholdCount": 3,
      "Name": "group1",
      "EndpointGroupRegion": "cn-hangzhou",
      "State": "active",
      "HealthCheckProtocol": "tcp",
      "HealthCheckPort": 20,
      "EndpointConfigurations": [
        {
          "Type": "Ip",
          "EnableClientIPPreservation": false,
          "Weight": 20,
          "ProbeProtocol": "tcp",
          "Endpoint": "120.XX.XX.21",
          "EnableProxyProtocol": false,
          "ProbePort": 80,
          "SubAddress": "172.168.XX.XX"
        }
      ],
      "PortOverrides": [
        {
          "ListenerPort": 443,
          "EndpointPort": 80
        }
      ],
      "EndpointRequestProtocol": "HTTP",
      "EndpointProtocolVersion": "",
      "EndpointGroupType": "default",
      "ForwardingRuleIds": [
        "frule-bp19a3t3yzr21q3****"
      ],
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "SlsRegion": "cn-hangzhou",
      "SlsProjectName": "pn-01",
      "SlsLogStoreName": "lsn-01",
      "AccessLogSwitch": "on",
      "EnableAccessLog": true,
      "HealthCheckEnabled": true,
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ],
      "Tags": [
        {
          "Key": "test-key",
          "Value": "test-value"
        }
      ]
    }

    Error codes

    HTTP status codeError codeError messageDescription
    500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.An error occurred while the request was being processed. Try again later.

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

    Change history

    Change timeSummary of changesOperation
    2024-07-20The Error code has changed. The response structure of the API has changedView Change Details
    2023-09-14The Error code has changed. The response structure of the API has changedView Change Details
    2023-08-15The Error code has changed. The response structure of the API has changedView Change Details
    2021-04-27The Error code has changed. The response structure of the API has changedView Change Details