ListDynamicRoutes - 批量查询动态路由

获取当前阿里云账号下所有动态路由的信息。

调试

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

授权信息

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

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

请求参数

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

分页查询时显示的当前页的页码。取值:1~10000。

1
PageSizeinteger

分页查询时设置的每页数量。取值:1~1000。

10
Namestring

动态路由名称。长度为 1~128 个字符,支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

dynamic_route_name
Statusstring

动态路由状态。取值:

  • Enabled:开启。
  • Disabled:关闭。
Enabled
DynamicRouteIdsarray

动态路由 ID 集合。最多可输入 100 个动态路由 ID。

string

动态路由 ID。取值来源:

dr-30108b6c9d31****
RegionIdsarray

SASE 的 POP 集群接入点支持的地域列表。

string

SASE 的 POP 集群接入点支持的地域。取值来源:

枚举值:
  • cn-shenzhen深圳
  • cn-beijing北京
  • cn-shanghai上海
  • ap-southeast-1新加坡
  • us-east-1弗吉尼亚
  • us-west-1硅谷
  • cn-hangzhou杭州
  • cn-chengdu成都
ap-southeast-1
ApplicationIdstring

动态路由的内网访问应用 ID。无法和内网访问标签 ID 同时过滤。取值来源:

pa-application-e12860ef6c48****
TagIdstring

动态路由的内网访问标签 ID。无法和内网访问应用 ID 同时过滤。取值来源:

tag-d3f64e8bdd4a****
NextHopstring

动态路由下一跳实例 ID。取值来源:

connector-8ccb13b6f52c****

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

58D6B23E-E5DA-5418-8F61-51A3B5A30049
TotalNuminteger

动态路由的总数。

1
DynamicRoutesarray<object>

动态路由列表。

dynamicRouteobject

动态路由。

DynamicRouteIdstring

动态路由 ID。

dr-a0ca843f53cf****
Namestring

动态路由的名称。

dynamic_route_name
Descriptionstring

动态路由的描述。

这是一条动态路由
Statusstring

动态路由状态。取值:

  • Enabled:开启。
  • Disabled:关闭。
Enabled
Priorityinteger

动态路由优先级。数字 1 表示优先级最高。优先级排序和列表查询从上到下保持一致。

1
RegionIdsarray

SASE 的 POP 集群接入点支持的地域列表。

regionIdstring

SASE 的 POP 集群接入点支持的地域。

枚举值:
  • cn-shenzhen深圳
  • cn-beijing北京
  • cn-shanghai上海
  • ap-southeast-1新加坡
  • us-east-1弗吉尼亚
  • us-west-1硅谷
  • cn-hangzhou杭州
  • cn-chengdu成都
ap-southeast-1
ApplicationTypestring

动态路由的应用类型。取值:

  • All:全部应用。
  • Application:应用。
  • Tag:标签。
Application
ApplicationIdsarray

动态路由的内网访问应用 ID 集合。当应用类型为 Application 时,该字段有值。

applicationIdstring

动态路由的内网访问应用 ID。

pa-application-e12860ef6c48****
TagIdsarray

动态路由的内网访问标签 ID 集合。当应用类型为 Tag 时,该字段有值。

tagIdstring

动态路由的内网访问标签 ID。

tag-d3f64e8bdd4a****
DynamicRouteTypestring

动态路由类型。取值:connector:自有专线。

connector
NextHopstring

动态路由下一跳示例 ID。

connector-8ccb13b6f52c****
CreateTimestring

动态路由创建时间。

2023-03-21 11:50:03

示例

正常返回示例

JSON格式

{
  "RequestId": "58D6B23E-E5DA-5418-8F61-51A3B5A30049",
  "TotalNum": 1,
  "DynamicRoutes": [
    {
      "DynamicRouteId": "dr-a0ca843f53cf****",
      "Name": "dynamic_route_name",
      "Description": "这是一条动态路由",
      "Status": "Enabled",
      "Priority": 1,
      "RegionIds": [
        "ap-southeast-1"
      ],
      "ApplicationType": "Application",
      "ApplicationIds": [
        "pa-application-e12860ef6c48****"
      ],
      "TagIds": [
        "tag-d3f64e8bdd4a****"
      ],
      "DynamicRouteType": "connector",
      "NextHop": "connector-8ccb13b6f52c****",
      "CreateTime": "2023-03-21 11:50:03"
    }
  ]
}

错误码

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