全部产品
Search
文档中心

全球加速:ListCustomRoutingPortMappings - 查询生成的端口映射表

更新时间:Jul 31, 2024

调用ListCustomRoutingPortMappings接口查询生成的端口映射表(自定义路由类型监听)。

接口说明

配置自定义路由类型监听及终端节点组后,全球加速实例能够根据配置的监听端口范围、目标终端节点组协议和端口范围,以及终端节点(交换机 vSwitch)的 IP 地址信息,生成端口映射表。自定义路由类型监听可根据该端口映射表确定性地将流量路由到交换机中特定 IP 地址和端口。本接口用于查询生成的端口映射表。

调试

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

授权信息

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

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

列表条目数。

1
PageSizeinteger

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

10
PageNumberinteger

列表的页码。

1
PortMappingsarray<object>

端口映射表信息。

object

端口映射表信息。

AcceleratorIdstring

端口映射表所属全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
ListenerIdstring

端口映射表所属自定义路由类型监听 ID。

lsr-bp1bpn0kn908w4nbw****
EndpointGroupIdstring

终端节点组 ID。

epg-bp14sz7ftcwwjgrdm****
EndpointIdstring

终端节点 ID。

ep-bp14sz7ftcwwjgrdm****
EndpointGroupRegionstring

终端节点组所属地域 ID。

us-west-1
Vswitchstring

终端节点交换机(vSwitch)实例名称。

vsw-test01
AcceleratorPortinteger

加速端口。

3000
Protocolsarray

后端服务协议类型。

  • TCP:TCP 协议。

  • UDP:UDP 协议。

string

后端服务协议类型。

  • TCP:TCP 协议。

  • UDP:UDP 协议。

TCP
DestinationTrafficStatestring

后端实例流量通行策略。

  • allow:允许后端实例接收流量。

  • deny:不允许后端实例接收流量。

allow
DestinationSocketAddressobject

后端实例服务 IP 地址与端口信息。

IpAddressstring

后端实例服务 IP 地址。

10.0.XX.XX
Portinteger

后端实例服务端口。

443

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "PortMappings": [
    {
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "EndpointGroupRegion": "us-west-1",
      "Vswitch": "vsw-test01",
      "AcceleratorPort": 3000,
      "Protocols": [
        "TCP"
      ],
      "DestinationTrafficState": "allow",
      "DestinationSocketAddress": {
        "IpAddress": "10.0.XX.XX",
        "Port": 443
      }
    }
  ]
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-07-11OpenAPI 错误码发生变更查看变更详情
2023-07-20API 内部配置变更,不影响调用查看变更详情