查询网络配置列表 - ListV2Networks
功能介绍
查询工作空间下的网络配置列表。接口支持分页查询。此接口为同步接口。
调用方法
请参见如何调用API。
URI
GET /v2/workspaces/{workspace_id}/networks
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 是 | String | 参数解释:工作空间ID,可通过查询工作空间列表获取工作空间ID。 约束限制:不涉及。 取值范围:长度为32~36的英文字符、数字和中划线的组合。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释:分页偏移量。 约束限制:不涉及。 取值范围:0~10000。 默认取值:0。 |
| limit | 否 | Integer | 参数解释:分页大小。 约束限制:不涉及。 取值范围:1~1000。 默认取值:100。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:用户Token,通过调用获取IAM用户Token接口获取。 约束限制:不涉及。 取值范围:只能由英文字母、数字及特殊字符组成,长度不超过65534个字符。Token格式由IAM服务定义,具体字符集参见IAM服务相关文档。 默认取值:不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释:总记录数。 取值范围:不涉及。 |
| networks | Array of V2NetworkBriefInfo objects | 参数解释:网络配置列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释:网络连接的ID。 取值范围:长度为1~64的英文、数字、中划线组合。 |
| vpc_cidr | String | 参数解释:路由网段范围,标准的IPv4格式。 取值范围:允许网段为10.0.0.0~10.255.0.0/8~22,172.16.0.0~172.31.0.0/12~22,192.168.0.0~192.168.0.0/16~22。 |
| create_time | String | 参数解释:资源创建时间,使用UTC时间,ISO 8601格式,yyyy-MM-dd'T'HH:mm:ss.SSSXXX,例如:2025-01-10T03:37:12.000+00:00。 取值范围:不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
请求示例
GET /v2/workspaces/{workspace_id}/networks 响应示例
状态码:200
{
"total" : 1,
"networks" : [ {
"id" : "b935d0ef-f4eb-4b95-aff1-9d33ae9f57b6",
"create_time" : "2026-03-16T12:24:30.401+00:00",
"vpc_cidr" : "10.0.0.0/8"
} ]
} 状态码:400
{
"error_code" : "AIDataLake.00010151",
"error_msg" : "Parameter value is invalid.",
"solution_msg" : "Please input valid parameter value."
} 状态码:401
{
"error_code" : "APIGW.0301",
"error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
"solution_msg" : "Check whether the IAM authentication information is correct."
} 状态码:403
{
"error_code" : "AIDataLake.00010150",
"error_msg" : "The operation is not allowed.",
"solution_msg" : "Check whether the operation is allowed in the current status."
} 状态码:500
{
"error_code" : "AIDataLake.00011001",
"error_msg" : "Internal error.",
"solution_msg" : "Contact technical support or try again later."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 请求参数错误。 |
| 401 | 未授权。 |
| 403 | 禁止访问。 |
| 500 | 内部服务器错误。 |