文档

DescribeCustomRoutingEndpointGroup - 查询自定义路由类型监听关联的指定终端节点组配置信息

更新时间:

查询自定义路由类型监听关联的指定终端节点组配置信息。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
EndpointGroupIdstring

待查询的终端节点组 ID。

epg-bp1dmlohjjz4kqaua****

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

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

全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
ListenerIdstring

自定义路由类型监听 ID。

lsr-bp1bpn0kn908w4nbw****
EndpointGroupIdstring

终端节点组 ID。

epg-bp1dmlohjjz4kqaua****
Namestring

终端节点组名称。

group1
Descriptionstring

终端节点组的描述信息。

EndpointGroup
EndpointGroupIpListarray

终端节点组出公网 IP 列表。

string

终端节点组出公网 IP 列表。

203.0.XX.XX
EndpointGroupUnconfirmedIpListarray

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

string

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

203.0.XX.XX
EndpointGroupRegionstring

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

cn-hangzhou
Statestring

终端节点组的状态。

  • init:初始化。
  • active:正常。
  • updating:更新中。
  • deleting:删除中。
active
SlsRegionstring

在日志服务中创建的日志信息所属地域。

cn-hangzhou
SlsProjectNamestring

日志项目(Project)名称。

pn-01
SlsLogStoreNamestring

日志库(Logstore)名称。

lsn-01
AccessLogSwitchstring

日志绑定状态。

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

是否开启了访问日志。

  • 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

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "EndpointGroupId": "epg-bp1dmlohjjz4kqaua****",
      "Name": "group1",
      "Description": "EndpointGroup",
      "EndpointGroupIpList": [
        "203.0.XX.XX"
      ],
      "EndpointGroupUnconfirmedIpList": [
        "203.0.XX.XX"
      ],
      "EndpointGroupRegion": "cn-hangzhou",
      "State": "active",
      "SlsRegion": "cn-hangzhou",
      "SlsProjectName": "pn-01",
      "SlsLogStoreName": "lsn-01",
      "AccessLogSwitch": "on",
      "EnableAccessLog": true,
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ]
    }

    错误码

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

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

    变更历史

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