更新时间:2026-10-22 GMT+08:00
分享

查询资源池网络拓扑 - ShowPoolNetworkTopology

功能介绍

查询指定资源池的网络拓扑信息,展示资源池内节点的网络拓扑层级关系。超平面网络互通场景下,按资源规格分组,按网络标签层级聚合展示节点拓扑树。

调试

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

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/pools/{pool_name}/networktopology

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

pool_name

是

String

参数解释:池名称。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

[数组元素]

Array of NetworkTopologyNode objects

资源池网络拓扑节点信息。

表3 NetworkTopologyNode

参数

参数类型

描述

type

String

拓扑层级类型,可扩展。当前取值如下:

  • roce:参数面网络

  • superpod:超平面网络

  • rack:机柜(仅A5机型存在)

count

Integer

该层级下所有节点总数。

availableCount

Integer

该层级下可用节点数(状态为Available且非HA冗余的节点)。

resourceflavor

String

资源规格名称。

labelkey

String

对应的节点标签键。

labelvalue

String

对应的节点标签值。

subs

Array of NetworkTopologyNode objects

子拓扑节点列表。

状态码:404

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:ModelArts错误码。

取值范围:不涉及。

error_msg

String

参数解释:具体错误信息。

取值范围:不涉及。

请求示例

查询资源池网络拓扑。

GET https://{endpoint}/v2/{project_id}/pools/{pool_name}/networktopology

{ }

响应示例

状态码:200

[ {
  "type" : "roce",
  "count" : 6,
  "availableCount" : 4,
  "resourceflavor" : "modelarts.pool.ai1.a5",
  "labelkey" : "os.modelarts.node/roce.network",
  "labelvalue" : "roce-001",
  "subs" : [ {
    "type" : "superpod",
    "count" : 4,
    "availableCount" : 3,
    "resourceflavor" : "modelarts.pool.ai1.a5",
    "labelkey" : "os.modelarts.node/hyperinstance.group.id",
    "labelvalue" : "hg-001",
    "subs" : [ {
      "type" : "rack",
      "count" : 2,
      "availableCount" : 2,
      "resourceflavor" : "modelarts.pool.ai1.a5",
      "labelkey" : "os.modelarts.node/spod.id",
      "labelvalue" : "rack-001"
    }, {
      "type" : "rack",
      "count" : 2,
      "availableCount" : 1,
      "resourceflavor" : "modelarts.pool.ai1.a5",
      "labelkey" : "os.modelarts.node/spod.id",
      "labelvalue" : "rack-002"
    } ]
  }, {
    "type" : "superpod",
    "count" : 2,
    "availableCount" : 1,
    "resourceflavor" : "modelarts.pool.ai1.a5",
    "labelkey" : "os.modelarts.node/hyperinstance.group.id",
    "labelvalue" : "hg-002",
    "subs" : [ {
      "type" : "rack",
      "count" : 2,
      "availableCount" : 1,
      "resourceflavor" : "modelarts.pool.ai1.a5",
      "labelkey" : "os.modelarts.node/spod.id",
      "labelvalue" : "rack-003"
    } ]
  } ]
}, {
  "type" : "roce",
  "count" : 2,
  "availableCount" : 2,
  "resourceflavor" : "modelarts.pool.ai1.a3",
  "labelkey" : "os.modelarts.node/roce.network",
  "labelvalue" : "roce-a3-001",
  "subs" : [ {
    "type" : "superpod",
    "count" : 2,
    "availableCount" : 2,
    "resourceflavor" : "modelarts.pool.ai1.a3",
    "labelkey" : "os.modelarts.node/spod.id",
    "labelvalue" : "spod-001"
  } ]
} ]

状态码:404

{
  "error_code" : "ModelArts.50015001",
  "error_msg" : "pool not found"
}

状态码

状态码

描述

200

OK。

404

Not Found。

错误码

请参见错误码。

相关文档