文档

DescribeEndpointGroup - 查询指定终端节点组信息

更新时间:

调用DescribeEndpointGroup接口查询指定终端节点组信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ga:DescribeEndpointGroupRead
  • EndpointGroup
    acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointGroupId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
EndpointGroupIdstring

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

epg-bp14sz7ftcwwjgrdm****

返回参数

名称类型描述示例值
object

返回信息列表。

HealthCheckIntervalSecondsinteger

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

3
TrafficPercentageinteger

监听实例有多个终端节点组时,配置到不同终端节点组的流量比例。

100
EndpointGroupIdstring

终端节点组 ID。

epg-bp14sz7ftcwwjgrdm****
Descriptionstring

终端节点组的描述信息。

group1
EndpointGroupIpListarray

终端节点组活跃的终端节点 IP 列表。

string

终端节点组活跃的终端节点 IP 列表。

101.XX.XX.22
EndpointGroupUnconfirmedIpListarray

全球加速实例升级后新增待确认的终端节点组 IP 列表。

string

全球加速实例升级后新增待确认的终端节点组 IP 列表。

101.XX.XX.22
RequestIdstring

请求 ID。

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

健康检查路径。

/healthcheck
ThresholdCountinteger

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

3
Namestring

终端节点组的名称。

group1
EndpointGroupRegionstring

终端节点组所属的地域 ID。

cn-hangzhou
Statestring

终端节点组的状态。

  • init:初始化。

  • active:正常。

  • updating:更新中。

  • deleting:删除中。

active
HealthCheckProtocolstring

健康检查的协议。

  • tcpTCP:TCP 协议。

  • httpHTTP:HTTP 协议。

  • httpsHTTPS:HTTPS 协议。

tcp
HealthCheckPortinteger

健康检查的端口。

20
EndpointConfigurationsobject []

终端节点配置信息。

Typestring

终端节点类型。

  • Domain:自定义域名。
  • Ip:自定义 IP。
  • PublicIp:阿里云公网 IP。
  • ECS:阿里云 ECS 实例。
  • SLB:阿里云 SLB 实例。
  • ALB:阿里云 ALB 实例。
  • OSS:阿里云 OSS 实例。
  • ENI:阿里云弹性网卡。
  • NLB:阿里云 NLB 实例。
Ip
EnableClientIPPreservationboolean

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

  • true:开启了保持客户端源 IP 功能。

  • false:未开启保持客户端源 IP 功能。

false
Weightinteger

终端节点的权重。

255
ProbeProtocolstring

时延探测协议。

  • tcp:TCP 协议。
  • icmp:ICMP 协议。
tcp
Endpointstring

终端节点的 IP、域名或实例 ID。

120.XX.XX.21
EnableProxyProtocolboolean

是否使用 ProxyProtocol 方式保留客户端源 IP。

false
ProbePortinteger

延时监控的探测端口。

80
SubAddressstring

弹性网卡的私网 IP 地址。

172.168.XX.XX
PortOverridesobject []

端口映射关系。

ListenerPortinteger

监听端口。

443
EndpointPortinteger

终端节点端口。

80
EndpointRequestProtocolstring

后端服务协议。

  • HTTP
  • HTTPS
HTTP
EndpointGroupTypestring

终端节点组类型。

  • default:默认终端节点组。
  • virtual:虚拟终端节点组。
default
ForwardingRuleIdsarray

终端节点组关联的转发策略 ID。

string

终端节点组关联的转发策略 ID。

frule-bp19a3t3yzr21q3****
AcceleratorIdstring

全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
ListenerIdstring

监听实例 ID。

lsr-bp1bpn0kn908w4nbw****
SlsRegionstring

SLS 地域。

cn-hangzhou
SlsProjectNamestring

SLS 项目名称。

pn-01
SlsLogStoreNamestring

SLS 日志库名称。

lsn-01
AccessLogSwitchstring

日志绑定状态。

  • on:已绑定。
  • off:未绑定。
  • binding:绑定中。
  • unbinding:解绑中。
on
EnableAccessLogboolean

是否开启了访问日志。

  • true:开启访问日志。
  • false:关闭访问日志。
true
HealthCheckEnabledboolean

是否开启了健康检查。

  • true:开启健康检查。
  • false:关闭健康检查。
true
ServiceIdstring

托管实例所属的服务方 ID。

说明 仅在 ServiceManaged 参数为 True 时有效。
ALB
ServiceManagedboolean

是否为托管实例。

  • true:是托管实例。

  • false:不是托管实例。

true
ServiceManagedInfosobject []

用户在此托管实例下可执行的动作策略列表。

说明
  • 仅在 ServiceManaged 参数为 True 时有效。
  • 当实例处于托管状态时,用户对实例的操作会受到限制,某些操作行为会被禁止。
  • Actionstring

    托管策略动作名称。

    • Create:创建实例。
    • Update:更新当前实例。
    • Delete:删除当前实例。
    • Associate:引用/被引用当前实例。
    • UserUnmanaged:用户解托管实例。
    • CreateChild:在当前实例下创建子资源。
    Update
    ChildTypestring

    子资源类型。

    • Listener:监听资源。

    • IpSet:加速地域资源。

    • EndpointGroup:终端节点组资源。

    • ForwardingRule:转发策略资源。

    • Endpoint:终端节点资源。

    • EndpointGroupDestination:自定义路由监听下的终端节点组协议映射资源。

    • EndpointPolicy:自定义路由监听下的终端节点通行策略资源。

    说明 仅在 Action 参数为 CreateChild 时有效。
    Listener
    IsManagedboolean

    托管策略动作是否被托管。

    • true:托管策略动作被托管,用户无权在托管实例下执行 Action 指定的操作。
    • false:托管策略动作未被托管,用户可在托管实例下执行 Action 指定的操作。
    false
    Tagsobject []

    终端节点组的标签。

    Keystring

    终端节点组的标签键。

    test-key
    Valuestring

    终端节点组的标签值。

    test-value

    示例

    正常返回示例

    JSON格式

    {
      "HealthCheckIntervalSeconds": 3,
      "TrafficPercentage": 100,
      "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": 255,
          "ProbeProtocol": "tcp",
          "Endpoint": "120.XX.XX.21",
          "EnableProxyProtocol": false,
          "ProbePort": 80,
          "SubAddress": "172.168.XX.XX"
        }
      ],
      "PortOverrides": [
        {
          "ListenerPort": 443,
          "EndpointPort": 80
        }
      ],
      "EndpointRequestProtocol": "HTTP",
      "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"
        }
      ]
    }

    错误码

    HTTP status code错误码错误信息描述
    500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.处理请求时出现错误,请稍后重试。

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

    变更历史

    变更时间变更内容概要操作
    2023-09-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
    出参OpenAPI 返回结构发生变更
    2023-08-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
    出参OpenAPI 返回结构发生变更
    2021-04-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
    出参OpenAPI 返回结构发生变更
    • 本页导读 (1)
    文档反馈