AI 助理
备案控制台
文档
输入文档关键字查找
首页 全球加速 开发参考 API参考 API目录 终端节点（自定义路由类型监听） ListCustomRoutingEndpoints - 查询自定义终端节点列表

ListCustomRoutingEndpoints - 查询自定义终端节点列表

更新时间：
产品详情
我的收藏

查询终端节点配置。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
PageNumberinteger否

列表的页码。默认值：1。

1
PageSizeinteger否

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

10
AcceleratorIdstring是

待查询终端节点列表的全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
ListenerIdstring否

待查询终端节点列表的监听 ID。

lsr-bp1bpn0kn908w4nbw****
EndpointGroupIdstring否

待查询终端节点列表的终端节点组 ID。

epg-bp16jdc00bhe97sr5****

返回参数

名称类型描述示例值
object

返回参数列表。

RequestIdstring

请求 ID。

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

列表条目数。

10
PageSizeinteger

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

10
PageNumberinteger

列表的页码。

1
Endpointsarray<object>

终端节点信息。

object

终端节点信息。

AcceleratorIdstring

终端节点所属全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
ListenerIdstring

终端节点所属监听 ID。

lsr-bp1bpn0kn908w4nbw****
EndpointGroupIdstring

终端节点所属终端节点组 ID。

epg-bp16jdc00bhe97sr5****
EndpointIdstring

终端节点 ID。

ep-bp14sz7ftcwwjgrdm****
Typestring

终端节点后端服务类型。

PrivateSubNet：私网 CIDR。

PrivateSubNet
Endpointstring

终端节点交换机（vSwitch）实例名称。

vsw-test01
TrafficToEndpointPolicystring

后端服务流量通行策略。

  • AllowAll：允许所有访问流量访问指定后端服务。

  • DenyAll：拒绝所有访问流量访问指定后端服务。

  • AllowCustom：指定可以接收访问流量的通行目标。

DenyAll
ServiceIdstring

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

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

是否为托管实例。取值：

  • true：是托管实例。

  • false：不是托管实例。

true
ServiceManagedInfosarray<object>

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

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

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

    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",
  "TotalCount": 10,
  "PageSize": 10,
  "PageNumber": 1,
  "Endpoints": [
    {
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "EndpointGroupId": "epg-bp16jdc00bhe97sr5****",
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "Type": "PrivateSubNet",
      "Endpoint": "vsw-test01",
      "TrafficToEndpointPolicy": "DenyAll",
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ]
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    400NoPermissionNo permissions.无权限

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

    变更历史

    变更时间变更内容概要操作
    2024-07-11OpenAPI 错误码发生变更查看变更详情
    2023-07-20API 内部配置变更，不影响调用查看变更详情
    上一篇：DescribeCustomRoutingEndpoint - 查询自定义终端节点下一篇：DeleteCustomRoutingEndpoints - 删除自定义路由类型监听的终端节点
    文档推荐