ListNetworks - 获取资源组网络资源列表

更新时间:
复制 MD 格式

获取资源组网络资源列表。

接口说明

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

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListNetworks

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ResourceGroupId

string

是

通用资源组唯一标识

Serverless_res_group_524257424564736_6831777003****

PageSize

integer

否

分页大小

10

PageNumber

integer

否

分页页码

1

SortBy

string

否

排序字段列表,支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"(Asc 可以缺省)。排序字段的枚举值如下:

  • Id (Desc/Asc):网络 ID

  • Status (Desc/Asc):网络状态

  • CreateUser (Desc/Asc):创建用户

  • CreateTime (Desc/Asc):创建时间

默认值为 CreateTime Asc

CreateTime Asc

返回参数

名称

类型

描述

示例值

object

Schema of Response

Success

boolean

是否请求成功

true

PagingInfo

object

分页列表

NetworkList

array<object>

获取到的通用资源组网络资源详细信息列表

object

网络资源详细信息

Id

integer

网络资源 ID

1000

ResourceGroupId

string

所属通用资源组的唯一标识

Serverless_res_group_524257424564736_6831777003XXXXX

VpcId

string

网络资源的 VPC ID

vpc-m2et4f3oc8msfbccXXXXX

VswitchId

string

网络资源的交换机 ID

vsw-uf8usrhs7hjd9amsXXXXX

SecurityGroupId

string

网络资源组的安全组 ID

sg-2ze13vamugr7jenXXXXX

Status

string

当前网络资源状态,Pending 代表等待,Creating 代表创建中,Running 代表正常运行中,Deleting 代表删除中,Deleted 代表已删除

枚举值:

  • Creating :

    创建中

  • Running :

    运行中

  • Deleted :

    已删除

  • Deleting :

    删除中

  • Pending :

    等待中

Running

CreateUser

string

创建该网络资源的用户 ID

11075500042XXXXX

CreateTime

integer

创建时间,为 64 位时间戳

1727055811000

PageNumber

integer

分页页码

1

PageSize

integer

分页大小

100

TotalCount

integer

全部数据条目

100

RequestId

string

请求的 ID,用于定位日志,排查问题

6A6CBE87-9F91-1323-B680-E7A7065XXXXX

示例

正常返回示例

JSON格式

{
  "Success": true,
  "PagingInfo": {
    "NetworkList": [
      {
        "Id": 1000,
        "ResourceGroupId": "Serverless_res_group_524257424564736_6831777003XXXXX",
        "VpcId": "vpc-m2et4f3oc8msfbccXXXXX",
        "VswitchId": "vsw-uf8usrhs7hjd9amsXXXXX",
        "SecurityGroupId": "sg-2ze13vamugr7jenXXXXX",
        "Status": "Running",
        "CreateUser": "11075500042XXXXX",
        "CreateTime": 1727055811000
      }
    ],
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 100
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

错误码

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

变更历史

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