查询网络资源列表
功能介绍
查询网络资源列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/networks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
用户项目ID。获取方法请参见获取项目ID和名称。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
labelSelector |
否 |
String |
标签筛选。 |
limit |
否 |
Integer |
分页单次查询返回数。 |
continue |
否 |
String |
分页查询时上一页位置。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
API版本。可选值如下:
|
kind |
String |
资源类型。可选值如下:
|
metadata |
metadata object |
网络资源列表的metadata信息。 |
items |
Array of Network objects |
网络资源列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
API版本。可选值如下:
|
kind |
String |
资源类型。可选值如下:
|
metadata |
NeworkMetadata object |
网络资源的metadata信息。 |
spec |
NetworkSpec object |
网络资源的描述信息。 |
status |
NetworkStatus object |
网络资源的状态信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
系统自动生成的network名称,相当于networkId。networkId指的是ModelArts基于用户输入的网络名称生成的唯一ID值。 |
creationTimestamp |
String |
时间戳,例如"2021-11-01T03:49:41Z"。 |
labels |
NetworkMetadataLabels object |
网络资源的标签信息。 |
annotations |
NetworkMetadataAnnotations object |
网络资源的注释信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
os.modelarts/name |
String |
用户指定的network名称。 |
os.modelarts/workspace.id |
String |
工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。 |
参数 |
参数类型 |
描述 |
---|---|---|
os.modelarts/description |
String |
网络资源描述,用于说明用于某种场景。不能包含字符!<>=&"'。 |
参数 |
参数类型 |
描述 |
---|---|---|
cidr |
String |
网络的cidr。取值范围:
|
connection |
NetworkConnection object |
当前网络与其他云服务的连通信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
peerConnectionList |
Array of peerConnectionList objects |
Peer方式打通网络列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
peerVpcId |
String |
对端的VPC ID。 |
peerSubnetId |
String |
对端的子网ID。 |
defaultGateWay |
Boolean |
默认路由开关。 |
参数 |
参数类型 |
描述 |
---|---|---|
phase |
String |
网络的当前状态。可选值如下:
|
connectionStatus |
NetworkConnectionStatus object |
网络与其他云服务连通状态信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
peerConnectionStatus |
Array of peerConnectionStatus objects |
Peer方式打通网络的状态信息列表。 |
sfsTurboStatus |
Array of sfsTurboStatus objects |
网络可连通的SFS Turbo信息列表。 |
请求示例
查询资源池列表。
GET https://{endpoint}/v2/{project_id}/pools { }
响应示例
状态码: 200
OK。
{ "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。 |
错误码
请参见错误码。