文档首页/ AI开发平台ModelArts/ API参考/ 资源管理/ 查询网络资源
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

查询网络资源

功能介绍

查询指定网络资源的详情信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/networks/{network_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID。获取方法请参见获取项目ID和名称。

network_name

是

String

系统自动生成的网络名称。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

apiVersion

String

API版本。可选值如下：

  • v1

kind

String

资源类型。可选值如下：

  • Network：网络

metadata

NeworkMetadata object

网络资源的metadata信息。

spec

NetworkSpec object

网络资源的描述信息。

status

NetworkStatus object

网络资源的状态信息。
表3 NeworkMetadata

参数

参数类型

描述

name

String

系统自动生成的network名称，相当于networkId。networkId指的是ModelArts基于用户输入的网络名称生成的唯一ID值。

creationTimestamp

String

时间戳，例如"2021-11-01T03:49:41Z"。

labels

NetworkMetadataLabels object

网络资源的标签信息。

annotations

NetworkMetadataAnnotations object

网络资源的注释信息。
表4 NetworkMetadataLabels

参数

参数类型

描述

os.modelarts/name

String

用户指定的network名称。

os.modelarts/workspace.id

String

工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。
表5 NetworkMetadataAnnotations

参数

参数类型

描述

os.modelarts/description

String

网络资源描述，用于说明用于某种场景。不能包含字符!<>=&"'。
表6 NetworkSpec

参数

参数类型

描述

cidr

String

网络的cidr。取值范围：

  • 172.16.0.0/12~24

  • 192.168.0.0/16~24。

connection

NetworkConnection object

当前网络与其他云服务的连通信息。
表7 NetworkConnection

参数

参数类型

描述

peerConnectionList

Array of peerConnectionList objects

Peer方式打通网络列表。
表8 peerConnectionList

参数

参数类型

描述

peerVpcId

String

对端的VPC ID。

peerSubnetId

String

对端的子网ID。

defaultGateWay

Boolean

默认路由开关。
表9 NetworkStatus

参数

参数类型

描述

phase

String

网络的当前状态。可选值如下：

  • Creating：网络创建中

  • Active：网络正常

  • Abnormal：网络不正常

connectionStatus

NetworkConnectionStatus object

网络与其他云服务连通状态信息。
表10 NetworkConnectionStatus

参数

参数类型

描述

peerConnectionStatus

Array of peerConnectionStatus objects

Peer方式打通网络的状态信息列表。

sfsTurboStatus

Array of sfsTurboStatus objects

网络可连通的SFS Turbo信息列表。
表11 peerConnectionStatus

参数

参数类型

描述

peerVpcId

String

对端的VPC ID。

peerSubnetId

String

对端的子网ID。

defaultGateWay

Boolean

默认路由开关。

phase

String

网络的连接状态。可选值如下：

  • Connecting：网络连接中

  • Active：网络连接正常

  • Abnormal：网络连接不正常
表12 sfsTurboStatus

参数

参数类型

描述

sfsId

String

SFS Turbo的ID。

name

String

SFS Turbo的名称。

status

String

与SFS Turbo的连接状态信息。可选值如下：

  • Active：SFS连通状态正常

  • Abnormal：SFS连通状态异常

ipAddr

String

SFS Turbo的访问地址。

状态码： 404

表13 响应Body参数

参数

参数类型

描述

error_code

String

ModelArts错误码。

error_msg

String

具体错误信息。

请求示例

查询网络详情。

GET https://{endpoint}/v1/{project_id}/networks/{network_name}

{ }

响应示例

状态码： 200

OK。

{
  "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" : { }
  }
}

状态码： 404

Not Found。

{
  "error_code" : "ModelArts.50025001",
  "error_msg" : "Network not exist."
}

状态码

状态码

描述

200

OK。

404

Not Found。

错误码

请参见错误码。

父主题： 资源管理

相关文档