首页 云网管 开发参考 API参考 API目录 资源管理相关 GetPhysicalSpaceTopo - GetPhysicalSpaceTopo

GetPhysicalSpaceTopo - GetPhysicalSpaceTopo

更新时间: 2024-03-01 18:18:36

查询物理空间拓扑结构。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cmn:GetPhysicalSpaceTopo
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PhysicalSpaceIdstring

物理空间 ID。

space-ez6zd3w68ma4fsd4
TopoTypestring

拓扑类型。

  • lldp:lldp 采集。
  • mac:mac 采集。
lldp
InstanceIdstring

实例 ID。

cmn-cn-xxxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

F6EC6EAF-8C8F-5D72-BE74-FD03A1123450
TopoDataobject

拓扑数据。

UpdateTimestring

更新时间。

2023-02-01 22:24:16
SourceDeviceIdstring

源设备 ID。

device-gbutctzxtuu7t122
SourcePortstring

源设备端口。

GE2/3/0/1
TargetDeviceIdstring

目标设备 ID。

device-i2g2iaiao5ja12345
TargetPortstring

目标设备端口。

TE1/0/28
SourceDeviceNamestring

源设备名。

TEST-xxxx1
TargetDeviceNamestring

目标设备名。

TEST-xxxx2
Devicesobject []

设备信息。

DeviceIdstring

设备 ID。

device-9i8867jzljw12345
DeviceRolestring

设备角色。

ASW
HostNamestring

设备主机名。

TEST-xxxx3
Ipstring

设备 IP。

127.0.xxx.xxx

示例

正常返回示例

JSON格式

{
  "RequestId": "F6EC6EAF-8C8F-5D72-BE74-FD03A1123450",
  "TopoData": {
    "UpdateTime": "2023-02-01 22:24:16",
    "Links": [
      {
        "SourceDeviceId": "device-gbutctzxtuu7t122",
        "SourcePort": "GE2/3/0/1",
        "TargetDeviceId": "device-i2g2iaiao5ja12345",
        "TargetPort": "TE1/0/28",
        "SourceDeviceName": "TEST-xxxx1",
        "TargetDeviceName": "TEST-xxxx2"
      }
    ],
    "Devices": [
      {
        "DeviceId": "device-9i8867jzljw12345",
        "DeviceRole": "ASW",
        "HostName": "TEST-xxxx3",
        "Ip": "127.0.xxx.xxx"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400SignatureDoesNotMatch签名不通过-
403NoPermission没有权限-
404Invalid%s.NotFoundThe specified resource %s does not exist.找不到对应资源
404ServiceNotFound后端服务未找到-
500InternalError服务器内部错误-
503ServiceUnavailable服务不可用-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
上一篇: GetPhysicalSpace - 根据ID查询物理空间详情 下一篇: UpdatePhysicalSpace - 根据ID编辑物理空间