# 查询网络资源列表 - ListNetworks #### 功能介绍 查询网络资源列表接口用于获取系统中已创建的网络资源信息。该接口适用于以下场景：当用户需要监控网络状态、进行资源规划、排查网络问题或进行审计时，可通过此接口查询系统中现有的网络资源列表。使用该接口的前提条件是用户具有相应的权限，并且系统中已存在网络资源。查询操作完成后，接口将返回网络资源列表，包含资源ID、类型、状态、创建时间等详细信息。若用户无权限、系统中无网络资源或查询参数有误，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListNetworks)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:network:list | List | network \* | - | - | - | | modelarts:network:list | List | - | - g:EnterpriseProjectId - g:TagKeys - g:RequestTag/\ | - | - | #### URI GET /v1/{project_id}/networks 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID，获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | labelSelector | 否 | String | **参数解释**：标签筛选。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | limit | 否 | Integer | **参数解释**：分页单次查询返回的资源数量。 **约束限制**：不涉及。 **取值范围**：0 - 500。 **默认取值**：500。 | | continue | 否 | String | **参数解释**：分页查询的偏移标志。取值来自用户上一次分页查询响应结果中metadata.continue中的值，值为空默认无偏移。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | apiVersion | String | **参数解释**：资源的API版本。 **取值范围**：可选值如下： - v1：当前资源版本为v1。 | | kind | String | **参数解释**：资源的类型。 **取值范围**：可选值如下： - NetworkList：网络列表。 | | metadata | [NetworkListMetadata] object | **参数解释**：网络资源列表的元信息。 | | items | Array of [Network] objects | **参数解释**：网络资源列表。 | 表4NetworkListMetadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | continue | String | **参数解释**：分页查询时，下一次查询位置。 **取值范围**：不涉及。 | | remainingItemCount | Integer | **参数解释**：剩余资源个数。 **取值范围**：不涉及。 | 表5Network | 参数 | 参数类型 | 描述 | |:---|:---|:---| | apiVersion | String | **参数解释**：资源的API版本。 **取值范围**：可选值如下： - v1：当前资源版本为v1。 | | kind | String | **参数解释**：资源的类型。 **取值范围**：可选值如下： - Network：网络。 | | metadata | [NetworkMetadata] object | **参数解释**：网络资源的元信息。 | | spec | [NetworkSpec] object | **参数解释**：网络资源的规格信息。 | | status | [NetworkStatus] object | **参数解释**：网络资源的状态信息。 | 表6NetworkMetadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：网络资源的ID。 **取值范围**：不涉及。 | | creationTimestamp | String | **参数解释**：网络的创建时间。例如"2025-11-01T03:49:41Z"。 **取值范围**：不涉及。 | | labels | [NetworkMetadataLabels] object | **参数解释**：网络的标签信息。 | | annotations | [NetworkMetadataAnnotations] object | **参数解释**：网络的注释信息。 | 表7NetworkMetadataLabels | 参数 | 参数类型 | 描述 | |:---|:---|:---| | os.modelarts/name | String | **参数解释**：资源池的显示名称。 **取值范围**：只能以小写字母开头，数字、中划线组成，不能以中划线结尾，且长度为4-32。 | | os.modelarts/workspace.id | String | **参数解释** ：工作空间ID。获取方法请参见[查询工作空间列表](https://support.huaweicloud.com/api-modelarts/ListWorkspace.html#ZH-CN_TOPIC_0000002723741766)。 **取值范围**：不涉及。 | 表8NetworkMetadataAnnotations | 参数 | 参数类型 | 描述 | |:---|:---|:---| | os.modelarts/description | String | **参数解释**：网络的描述信息。 **取值范围**：不能包含字符!\<\>=\&"'。 | 表9NetworkSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cidr | String | **参数解释**：网络的cidr值。 **取值范围**： - 172.16.0.0/12\~24 - 192.168.0.0/16\~24 | | connection | [NetworkConnection] object | **参数解释**：当前网络与其他资源的连通信息。 | 表10NetworkConnection | 参数 | 参数类型 | 描述 | |:---|:---|:---| | peerConnectionList | Array of [PeerConnectionItem] objects | **参数解释**：Peer方式打通网络列表。 | 表11PeerConnectionItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | peerVpcId | String | **参数解释**：对端的VPC ID。 **取值范围**：不涉及。 | | peerSubnetId | String | **参数解释**：对端的子网ID。 **取值范围**：不涉及。 | | defaultGateWay | Boolean | **参数解释**：创建默认路由的开关，默认为false不创建。 **取值范围**：不涉及。 | 表12NetworkStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | phase | String | **参数解释**：网络资源的当前状态。 **取值范围**：可选值如下： - Creating：网络创建中。 - Active：网络正常。 - Abnormal：网络异常。 | | connectionStatus | [NetworkConnectionStatus] object | **参数解释**：网络与其他云服务联通状态。 | 表13NetworkConnectionStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | peerConnectionStatus | Array of [PeerConnectionStatus] objects | **参数解释**：Peer方式打通网络的状态信息列表。 | | sfsTurboStatus | Array of [SfsTurboConnectionStatus] objects | **参数解释**：网络可连通的SFS Turbo信息列表。 | 表14PeerConnectionStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | peerVpcId | String | **参数解释**：对端的VPC ID。 **取值范围**：不涉及。 | | peerSubnetId | String | **参数解释**：对端的子网ID。 **取值范围**：不涉及。 | | defaultGateWay | Boolean | **参数解释**：创建默认路由的开关。 **取值范围**：默认为false不创建。 | | phase | String | **参数解释**：网络的连接状态。 **取值范围**：可选值如下： - Connecting：网络连接中 - Active：网络连接正常 - Abnormal：网络连接不正常 | 表15SfsTurboConnectionStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sfsId | String | **参数解释**：sfsTurbo实例的ID。 **取值范围**：不涉及。 | | connectionType | String | **参数解释**：关联方式。 **取值范围**：可选值如下： - VpcPort：通过挂载网卡直通 - Peering：通过对等连接打通 | | ipAddr | String | **参数解释**：SFS Turbo的访问地址。 **取值范围**：不涉及。 | | status | String | **参数解释**：与SFS Turbo的连接状态信息。 **取值范围**：可选值如下： - Active：SFS连通状态正常 - Abnormal：SFS连通状态异常 - Creating：SFS连通状态创建关联中 - Deleting：SFS连通状态解除关联中 | #### 请求示例 查询资源池列表。 ``` GET https://{endpoint}/v1/{project_id}/networks { } ``` #### 响应示例 **状态码：200** ``` { "kind" : "NetworkList", "apiVersion" : "v1", "metadata" : { }, "items" : [ { "kind" : "Network", "apiVersion" : "v1", "metadata" : { "name" : "network-7a03-86c13962597848eeb29c5861153a391f", "creationTimestamp" : "2022-09-16T09:44:59Z", "labels" : { "os.modelarts/name" : "network-7a03", "os.modelarts/workspace.id" : "0" }, "annotations" : { } }, "spec" : { "cidr" : "192.168.128.0/17", "connection" : { } }, "status" : { "phase" : "Active", "connectionStatus" : { } } } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。