调用DescribeEndpointGroup查询指定终端节点组。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeEndpointGroup

系统规定参数。取值:DescribeEndpointGroup

EndpointGroupId String epg-bp1dmlohjjz4kqaun****

要查询的终端节点组的ID。

RegionId String cn-hangzhou

全球加速实例所在的地域,仅取值cn-hangzhou

返回数据

名称 类型 示例值 描述
Description String group1

终端节点组的描述信息。

EndpointConfigurations Array

终端节点配置信息。

EnableClientIPPreservation Boolean false

是否开启了保持客户端源IP功能。

  • true:开启了保持客户端源IP功能。
  • false:未开启保持客户端源IP功能。
Endpoint String 120.xx.xx.21

终端节点的IP或域名。

ProbePort Integer 80

延时监控的探测端口。

ProbeProtocol String tcp

延时监控的探测协议。

  • icmp:icms协议。
  • tcp:tcp协议。
Type String Ip

终端节点类型。

  • Domain:自定义域名。
  • Ip:自定义IP。
  • PublicIp:阿里云公网IP。
  • ECS:阿里云ECS实例。
  • SLB:阿里云SLB实例。
Weight Integer 20

终端节点的权重。

EndpointGroupId String epg-bp1dmlohjjz4kqaun****

终端节点组ID。

EndpointGroupRegion String cn-hangzhou

终端节点组所属的地域。

HealthCheckIntervalSeconds Integer 3

健康检查的时间间隔,单位为秒。

HealthCheckPath String /healthcheck

健康检查路径。

HealthCheckPort Integer 20

健康检查的端口。

HealthCheckProtocol String tcp

健康检查的协议。

  • tcp:TCP协议。
  • http:HTTP协议。
  • https:HTTPS协议。
ListenerId String lsr-bp1bpn0kn908w4nbw****

监听实例ID。

Name String group1

终端节点组的名称。

RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

请求ID。

State String active

终端节点组的状态。

  • init:初始化。
  • active:正常。
  • creating:创建中。
  • configuring:配置中。
ThresholdCount Integer 3

健康检查判定终端节点为不健康的次数。

TotalCount Integer 10

列表条目数。

TrafficPercentage Integer 20

监听有多个终端节点组时的权重。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeEndpointGroup
&EndpointGroupId=epg-bp1dmlohjjz4kqaun****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<DescribeEndpointGroupResponse>
      <EndpointGroupId>epg-bp1ple63864a5hyj5****</EndpointGroupId>
      <EndpointGroupRegion>cn-qingdao</EndpointGroupRegion>
      <EndpointConfigurations>
            <Weight>100</Weight>
            <Type>Ip</Type>
            <Endpoint>47.xx.xx.221</Endpoint>
      </EndpointConfigurations>
      <ThresholdCount>3</ThresholdCount>
      <Name>dede</Name>
      <State>init</State>
      <RequestId>A3E6CB31-DA8A-4437-8B0B-E36546AE9E79</RequestId>
      <ListenerId>lsr-bp12tl35dpsilnsb1****</ListenerId>
</DescribeEndpointGroupResponse>

JSON 格式

{
  "EndpointGroupId": "epg-bp1ple63864a5hyj5****",
  "EndpointGroupRegion": "cn-qingdao",
  "EndpointConfigurations": [
    {
      "Weight": 100,
      "Type": "Ip",
      "Endpoint": "47.xx.xx.221"
    }
  ],
  "ThresholdCount": 3,
  "Name": "dede",
  "State": "init",
  "RequestId": "A3E6CB31-DA8A-4437-8B0B-E36546AE9E79",
  "ListenerId": "lsr-bp12tl35dpsilnsb1****"
}

错误码

访问错误中心查看更多错误码。