ListCustomRoutingEndpointGroupDestinations - 查询终端节点组的映射信息配置列表

更新时间:
复制 MD 格式

调用ListCustomRoutingEndpointGroupDestinations接口查询终端节点组的映射信息配置列表(自定义路由类型监听)。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ga:ListCustomRoutingEndpointGroupDestinations

list

*CustomRoutingEndpointGroupDestination

acs:ga:{#regionId}:{#accountId}:ga/{#gaId}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

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

cn-hangzhou

PageNumber

integer

列表的页码。默认值:1

1

PageSize

integer

分页查询时每页的条目数。最大值:50。默认值:10

10

AcceleratorId

string

待查询终端节点组映射信息配置的全球加速实例 ID。

ga-bp1odcab8tmno0hdq****

ListenerId

string

待查询终端节点组映射信息配置的监听 ID。

lsr-bp1bpn0kn908w4nbw****

EndpointGroupId

string

待查询映射信息配置的终端节点组 ID。

epg-bp16jdc00bhe97sr5****

Protocols

array

终端节点组后端服务的协议类型。取值:

  • TCP:TCP 协议。

  • UDP:UDP 协议。

  • TCP,UDP:TCP 和 UDP 协议。

为空时查询所有协议类型。

您最多可输入 10 个协议信息。

string

终端节点组后端服务的协议类型。取值:

  • TCP:TCP 协议。

  • UDP:UDP 协议。

  • TCP,UDP:TCP 和 UDP 协议。

输入为空时,查询所有协议类型。

您最多可输入 10 个协议信息。

TCP

FromPort

integer

终端节点组后端服务起始端口。

取值范围:1~65499,且需满足 FromPortToPort,即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。

80

ToPort

integer

终端节点组后端服务结束端口。

取值范围:1~65499,且需满足 FromPortToPort,即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。

80

返回参数

名称

类型

描述

示例值

object

返回信息列表。

RequestId

string

请求 ID。

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

TotalCount

integer

列表条目数。

1

PageSize

integer

分页查询时每页的条目数。

10

PageNumber

integer

列表的页码。

1

Destinations

array<object>

终端节点组的映射信息。

array<object>

终端节点组的映射信息。

AcceleratorId

string

终端节点组映射信息配置所属的全球加速实例 ID。

ga-bp1odcab8tmno0hdq****

ListenerId

string

终端节点组映射信息配置所属的监听 ID。

lsr-bp1bpn0kn908w4nbw****

EndpointGroupId

string

映射信息配置所属的终端节点组 ID。

epg-bp14sz7ftcwwjgrdm****

DestinationId

string

终端关节点组映射信息配置 ID。

dst-123abc****

Protocols

array

终端节点组后端服务协议类型。

  • TCP:TCP 协议。

  • UDP:UDP 协议。

  • TCP,UDP:TCP 和 UDP 协议。

string

终端节点组后端服务协议类型。

  • TCP:TCP 协议。

  • UDP:UDP 协议。

  • TCP,UDP:TCP 和 UDP 协议。

TCP

FromPort

integer

终端节点组后端服务起始端口。

80

ToPort

integer

终端节点组后端服务结束端口。

80

ServiceId

string

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

说明

仅在 ServiceManaged 参数为 True 时有效。

ALB

ServiceManaged

boolean

是否为托管实例。取值:

  • true:是托管实例。

  • false:不是托管实例。

true

ServiceManagedInfos

array<object>

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

说明

仅在 ServiceManaged 参数为 True 时有效。

  • 当实例处于托管状态时,用户对实例的操作会受到限制,某些操作行为会被禁止。

object

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

Action

string

托管策略动作名称,取值:

  • Create:创建实例。

  • Update:更新当前实例。

  • Delete:删除当前实例。

  • Associate:引用/被引用当前实例。

  • UserUnmanaged:用户解托管实例。

  • CreateChild:在当前实例下创建子资源。

Create

ChildType

string

子资源类型,取值:

  • Listener:监听资源。

  • IpSet:加速地域资源。

  • EndpointGroup:终端节点组资源。

  • ForwardingRule:转发策略资源。

  • Endpoint:终端节点资源。

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

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

说明

仅在 Action 参数为 CreateChild 时有效

Listener

IsManaged

boolean

托管策略动作是否被托管,取值:

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

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

false

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "Destinations": [
    {
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
      "DestinationId": "dst-123abc****",
      "Protocols": [
        "TCP"
      ],
      "FromPort": 80,
      "ToPort": 80,
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Create",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ]
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 NoPermission No permissions. 无权限

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

变更历史

更多信息,参考变更详情