ListRoutes - 获取网络资源的路由列表 - 大数据开发治理平台 DataWorks

获取网络资源的路由列表。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListRoutes

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ResourceGroupId	string	是	通用资源组唯一标识	Serverless_res_group_524257424564736_6831777003XXXXX
NetworkId	integer	否	网络资源 ID	1000
PageSize	integer	否	分页大小	100
PageNumber	integer	否	分页页码	1
SortBy	string	否	排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc 可以缺省）。排序字段的枚举值如下： Id (Desc/Asc)：路由 ID DestinationCidr (Desc/Asc)：目的 CIDR CreateTime (Desc/Asc)：创建时间默认为 CreateTime Asc	CreateTime Asc

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Success	boolean	是否请求成功	true
PagingInfo	object	分页列表
RouteList	array<object>	获取到的网络资源路由信息列表
	object	路由详细信息
Id	integer	路由 ID	1000
ResourceGroupId	string	所属资源组唯一标识符	Serverless_res_group_524257424564736_6831777003****
ResourceId	string	网络资源唯一标识符	ns-679XXXXXX
DestinationCidr	string	路由目的 CIDR	192.168.0.0/16
CreateTime	integer	创建时间，为 64 位时间戳	1727055811000
NetworkId	integer	所属网络资源 ID	1000
PageNumber	integer	分页页码	1
PageSize	integer	分页大小	100
TotalCount	integer	全部数据条目	100
RequestId	string	请求的 ID，用于定位日志，排查问题	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

示例

正常返回示例

JSON格式

{
  "Success": true,
  "PagingInfo": {
    "RouteList": [
      {
        "Id": 1000,
        "ResourceGroupId": "Serverless_res_group_524257424564736_6831777003****",
        "ResourceId": "ns-679XXXXXX",
        "DestinationCidr": "192.168.0.0/16",
        "CreateTime": 1727055811000,
        "NetworkId": 1000
      }
    ],
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 100
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

错误码

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

变更历史

更多信息，参考变更详情。