查询网络资源列表
功能介绍
查询网络资源列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/networks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:用户项目ID,获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
参数解释:分页单次查询返回的资源数量。 约束限制:不涉及。 取值范围:0 - 500。 默认取值:500。 |
continue |
否 |
String |
参数解释:分页查询的偏移标志。取值来自用户上一次分页查询响应结果中metadata.continue中的值,值为空默认无偏移。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
labelSelector |
否 |
String |
参数解释:标签筛选查询。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
参数解释:资源的API版本。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
kind |
String |
参数解释:资源的类型。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
metadata |
metadata object |
参数解释:网络资源列表的元信息。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
items |
Array of Network objects |
参数解释:网络资源列表。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
continue |
String |
参数解释:分页查询的偏移标志。 约束限制:可选。 取值范围:取值来自用户上一次分页查询响应结果中metadata.continue中的值,值为空默认无偏移。 默认取值:不涉及。 |
remainingItemCount |
Integer |
参数解释:分页查询中剩余资源的数量。 默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
参数解释:资源的API版本。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
kind |
String |
参数解释:资源的类型。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
metadata |
NeworkMetadata object |
参数解释:网络资源的元信息。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
spec |
NetworkSpec object |
参数解释:网络资源的规格信息。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
status |
NetworkStatus object |
参数解释:网络资源的状态信息。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释:网络资源的ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
creationTimestamp |
String |
参数解释:网络的创建时间。例如"2025-11-01T03:49:41Z"。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
labels |
NetworkMetadataLabels object |
参数解释:网络的标签信息。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
annotations |
NetworkMetadataAnnotations object |
参数解释:网络的注释信息。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
os.modelarts/name |
String |
参数解释:资源池的显示名称。 约束限制:不涉及。 取值范围:只能以小写字母开头,数字、中划线组成,不能以中划线结尾,且长度为4-32。 默认取值:不涉及。 |
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 |
参数解释:Peer方式打通对端网络ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
peerSubnetId |
String |
参数解释:Peer方式打通对端子网ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
defaultGateWay |
Boolean |
参数解释:创建默认路由的开关。 约束限制:不涉及。 取值范围:取值范围:
默认取值:false。 |
参数 |
参数类型 |
描述 |
---|---|---|
phase |
String |
参数解释:网络资源的当前状态。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
connectionStatus |
NetworkConnectionStatus object |
参数解释:网络与其他云服务联通状态。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
peerConnectionStatus |
Array of peerConnectionStatus objects |
参数解释:网络对端连接的状态列表。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
sfsTurboStatus |
Array of sfsTurboStatus objects |
参数解释:网络连接SFS Turbo的状态列表。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
peerVpcId |
String |
参数解释:对端方式打通对端网络ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
peerSubnetId |
String |
参数解释:对端方式打通对端子网ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
defaultGateWay |
Boolean |
参数解释:创建默认路由的开关。 约束限制:不涉及。 取值范围:取值范围:
默认取值:false。 |
phase |
String |
参数解释:对端连接状态。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
sfsId |
String |
参数解释:连接的SFS Turbo实例ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
name |
String |
参数解释:连接的SFS Turbo实例名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
status |
String |
参数解释:SFS Turbo的连接状态。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
ipAddr |
String |
参数解释:连接的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。 |
错误码
请参见错误码。