虚拟资源变更消息通知

openid

必选

请求头参数列表

String

会话标识，用于Open API的鉴权。

systemID

必选

请求实体参数列表

String

第三方系统标识。

openID

必选

请求实体参数列表

String

网管主动连接第三方系统的认证凭证，由第三方系统分配和利用此字符串认证。

url

必选

请求实体参数列表

String

网管以 POST 方式向该 URL发送通知消息。

dataType

可选

请求实体参数列表

String

通知报文的 data 字段类型。

desc

可选

请求实体参数列表

String

第三方系统描述。

code

int

操作返回码。可以是如下值之一：

• 0：成功
• 非0：失败。其中 1001 表示 license 无效；1002 表示 license 不具有调用 OpenAPI 的功能；1204 表示认证失败；1501 表示 systemID 未给出；1502表示 systemID 不合法；1503 表示第三方系统认证凭证 openID 未提供；1504 表示第三方系统认证凭证 openID 不合法；1505 表示 dataType 不支持；1506 表示第三方系统消息接收 URL 未提供；1507 表示第三方系统消息接收 URL 不合法；1508 表示第三方系统消息接收 URL 不在 OpenAPI 白名单中；1509 表示虽然提供了描述信息但不合法；1510 表示请求的 resourceURI 不存在（即整个请求地址对应资源不存在）；1511 表示请求地址无效而导致订阅无效。

data

String

此处为 null。

description

String

接口调用结果的描述信息。

请求 URL

PUT https://eSightIP: port/rest/openapi/notification/virtual/res/event HTTP/1.1

请求头

openid: 775c47f9-9a1b-43f9-a24b-2c3db1a55622;

请求实体

systemID=example%40system&openID=1b7a6992-5d5f-4091-a49f-ec2e09640a05&url=https%3A%2F%2FdemoIP%3AdemoPort%2Fnotification&dataType=JSON&desc=eSight+DesignIn+Demo

响应实体

{"code":0,"data":null,"description":"Operation success."}

openid

必选

消息头参数列表

String

会话标识，用于Open API的鉴权。

systemID

必选

URL 参数列表

String

第三方系统标识。

desc

可选

URL 参数列表

String

三方系统描述。

code

int

操作返回码。可以是如下值之一：

• 0：成功
• 非0：失败。其中 1001 表示 license 无效；1002 表示 license 不具有调用 OpenAPI 的功能；1204 表示认证失败；1501 表示 systemID 未给出；1502表示 systemID 不合法；1512 表示请求地址无效而导致退订无效。

data

String

此处为 null。

description

String

接口调用结果的描述信息。

请求 URL

DELETE https://eSightIP:port/rest/openapi/notification/virtual/res/event?systemID=example%40system&desc=eSight+DesignIn+Demo+Unsubscription. HTTP/1.1

请求头

openid: 775c47f9-9a1b-43f9-a24b-2c3db1a55622;

请求实体

N/A

响应实体

{"code":0,"data":null,"description":"Operation success."}

resourceURI

String

资源类型 URI，与订阅消息的URI定义一致，该变更通知固定为“/rest/openapi/notification/virtual/res/event”字符串。

msgType

int

消息类型。取值范围：

• 1：新增
• 2：删除
• 3：更新

data

list

以 JSON 数组形式描述的数据对象。告警相关数据的结构，参见下面定义

说明：

如果消息接收地址为 HTTP 协议，则 data 的值为加密字符串，需要第三方系统根据配置文件中的 KEY 和 IV 值解密，之后再解析数据对象。

extendedData

String

以字符串表示的 JSON 附加数据对象，此处为空对象 “{}”。

description

String

消息通知描述。

timestamp

String

消息发出的时间戳，eSight 服务器协调时间格式。

generatedTime

String

事件产生时间，“2017-06-26T15:45:07.501000”

resourceType

String

资源类型，支持类型：VM、HOST、PORT、VOLUME、HOSTNIC和BOND。

eventType

String

变更类型

消息类型：

• 1：新增
• 2：删除
• 3：更新

resourceDetail

Object

资源变更详细信息(不同资源类型的变更，内容不同)，以字符串表示的 JSON 附加数据对象，此处为空对象 “{}”。

vmId

String

虚拟机ID

systemDn

String

归属OpenStack实例DN

vmName

String

虚拟机名称

vmStatus

String

运行状态，虚拟机的原生状态

projectId

String

项目ID

domainId

String

域ID

projectName

String

项目名称

domainName

String

域名称

description

String

描述

vmUuid

String

虚拟UUID

ipAddrList

String

IP地址列表，以英文半角分号分隔的字符串

macList

String

MAC地址列表，以英文半角分号分隔的字符串

flavorInfo

String

虚拟机规格

flavorName

String

规格名称

imageId

String

镜像ID

imageName

String

镜像名称

securityGroupName

String

安全组名称

powerStatus

int

电源状态，取值范围：

• 0 ：未知
• 1 ：运行中
• 3 ：停止
• 4 ：关机
• 6 ：崩溃
• 7 ：挂起
• 9 ：创建中

virtualType

String

虚拟化平台类型

createTime

long

创建时间

azId

String

归属AZID

hostId

String

归属OpenStack主机ID

vmGroupId

String

归属虚拟机组ID

vmIdOnvEnv

String

归属的FC或者vCenter 虚拟机标识

mergeStatus

String

归并后虚拟机状态，取值范围：

• normal：正常
• poweroff：下电
• fault：故障
• other：其他

volumeIdList

String

绑定的卷ID列表

capacityData

CapacityData

虚拟机的容量信息

cpuCores

int

CPU核数

cpuFreqsGhz

int

CPU频率（GHz）

memSize

int

内存（MB）

diskSize

int

磁盘容量（GB）

rootSize

int

根磁盘（GB）

swapSize

int

交换磁盘（GB）

ephemeralSize

int

临时磁盘（GB）

hostId

String

主机标识

systemDn

String

云平台的网元DN

physicalServerDn

String

物理服务器DN

hostName

String

主机名称

hostDesc

String

描述

ipAddr

String

主机ip

bmcIp

String

bmc的IP地址

mgrIpAddr

String

管理ip地址

status

String

原始状态

physicalCpu

int

物理CPU个数

mergeStatus

String

运行状态

如果请求参数：系统类型为FusionSphere，则该值取值范围：

• normal:正常
• offline:离线

如果请求参数：系统类型为FusionCompute或者vCenter Server，则取值范围：

• normal:正常
• fault:故障
• poweroff:下电
• other:其他

isolationStatus

String

隔离状态

如果请求参数：系统类型为FusionSphere，则该值取值范围：

• isolated:隔离
• nonisolated:未隔离

如果请求参数：系统类型为非FusionSphere，则该值固定为空

vendor

String

服务器厂商

model

String

服务器型号

ntpIp1

String

NTP服务器ip地址或域名1

ntpIp2

String

NTP服务器ip地址或域名2

ntpIp3

String

NTP服务器ip地址或域名3

primaryDnsIp

String

主DNS IP地址

secondaryDnsIps

String

备用DNS IP地址

domainName

String

域名

nicQuantity

int

网卡总数

platformType

String

如果请求参数：系统类型为FusionSphere，则该值取值范围：

• 1：FusionCompute
• 2：KVM
• 3：Ironic
• 4：vCenter

如果请求参数：系统类型为FusionCompute，则该值固定为FusionCompute；如果请求参数：系统类型为vCenter Server，则该值固定是vCenter Server

fcHostExtData

FcHostExtData

FC类型的主机扩展属性

vcenterHostExtData

VcenterHostExtData

vCenter类型的主机扩展属性

fsHostExtData

FsHostExtData

FS类型的主机扩展属性

capacityData

CapacityData

容量数据结构定义

multiPathMode

String

用户设置的多路径类型

hostMultiPathMode

String

主机实际生效的多路径类型

ntpCycle

int

ntp同步周期，秒

imcSetting

String

当前IMC设置

maxImcSetting

String

主机CPU最大能够支持的IMC模式

haState

String

HA状态

haRole

String

HA角色

isFailOverHost

int

被指定为故障切换主机

uuid

String

硬件UUID

overallStatus

String

健康状态，取值范围：

• green：正常
• red：警示
• gray：未知
• yellow：警告

powerState

int

电源状态

bmcMacAddress

String

BMC MAC地址

isDhcp

int

主机启动DHCP

osType

String

主机操作系统类型

version

String

主机版本号

autoStartEnabled

int

使能自动启动

autoStartstartDelay

int

自动启动延时

autoStartstopAction

String

停止动作

autoStartstopDelay

int

停止延时

autoStartwaitForHeartbeat

int

心跳检测

zoneName

String

时区名称

zonekey

String

时区属性

zonegmtOffset

int

时区偏移量

zonedescription

String

时区描述

biosVersion

String

BIOS版本号

biosReleaseDate

String

BIOS发布日期

cpuModel

String

CPU型号

numHBAs

int

HBA总数

powerCurrentPolicy

String

当前电源策略

powerHardwareSupport

String

电源可支持策略(电源管理技术)

powerSystemInfo

String

电源系统信息

maxRunningVMs

int

最大可运行VM总数

maxSupportedVMs

int

最大支持VM总数

maxRegisteredVMs

int

最大注册VM总数

maxVcpusPerFtVm

int

每VM最大CPU数

vmotionSupported

int

支持VM迁移

EvcSupported

int

支持EVC模式

hypervisorID

List

Hypervisor标识列表，list成员类型是String

azId

String

归属AZID

hostGroupName

String

归属主机组名称

clusterID

List

云平台集群ID列表，list成员类型是String

serviceStatus

String

服务状态，取值范围：

• 正常/up
• 故障/down

totalCapacity

Capacity

主机内总容量

freeCapacity

Capacity

主机内剩余容量

vmStatistics

Statistics

主机内虚拟机统计

cpuCore

int

CPU总核数；如果返回值为-1表示不支持查询

cpuHz

int

CPU主频(MHz)；仅适用FusionCompute和vCenter Server类型；如果返回值为-1表示不支持查询

memSize

long

内存总数(MB)；如果返回值为-1表示不支持查询

diskSize

long

磁盘总数(GB)；仅适用FusionSphere类型；如果返回值为-1表示不支持查询

total

int

总数

running

int

运行状态总数

fault

int

故障状态总数

poweroff

int

关机状态总数

other

int

其他状态总数

vDiskId

string

磁盘卷ID

systemDn

string

平台标识

name

String

卷名称

status

String

原始卷状态

quantitySize

int

卷的最大容量（GB）

isBindtoVm

int

卷的绑定状态，取值范围：

• 0：未绑定
• 1：已绑定

bindToVmIdList

String

绑定虚拟机Id列表。以英文半角分号;分隔的字符串

srcVolumeUrn

String

原卷ID

description

String

卷描述信息

shareType

String

卷共享类型

uuid

String

卷uuid

mergeStatus

String

归并后状态，取值范围：

• available：可用
• used：已用
• fault：故障
• changing：执行中
• removed：已删除

projectId

String

项目

domainId

String

域

projectName

String

项目名称

domainName

String

域名称

azName

String

可用分区

snapshotId

String

卷源自快照ID

createdAt

long

创建时间（毫秒），UTC时间

updatedAt

long

更新时间（毫秒），UTC时间

hostId

String

卷所在主机ID

vDiskTypeId

String

卷归属的磁盘类型ID

lunId

String

对应的存储设备LUNId

vNicId

String

虚拟端口ID

systemDn

String

云平台的网元DN

name

String

端口名称

status

String

状态，取值范围：

• ACTIVE：运行中
• BUILD：创建中
• DOWN：已停止
• ERROR：错误
• REBUILD：重建中
• N/A：未知

adminStateUp

String

管理状态，取值范围：

• true
• false

vifType

String

vif类型

macAddress

String

mac地址列表，以英文半角分号分隔的字符串

description

String

描述信息

networkId

String

虚拟网络ID

hostId

String

主机ID

deviceId

String

挂载设备ID，若关联虚拟机，则为虚拟机uuid

deviceOwner

String

归属设备owner

ipAddress

String

ip地址列表，以英文半角分号分隔的字符串

projectId

String

所属租户ID

pNicId

String

如果主机端口类型为pNic，则为主机端口ID；

如果主机端口类型为bond，则为bond名称。

pNicType

String

主机端口类型，取值范围：

• pNic：物理网口
• bond：bond

overlayType

String

是否是混合overlay场景，若是则vSwitch类型为CE1800V，取值范围

• Hybrid：混合overlay场景
• 其他：非混合overlay场景

createTime

long

创建时间（毫秒），UTC时间

updateTime

long

更新时间（毫秒），UTC时间

pNicId

String

主机物理端口ID

systemDn

String

云平台的网元DN

name

String

端口名称

hostId

String

主机ID

devName

String

设备名称

permanentMac

String

mac地址

description

String

描述信息

bondName

String

bond名称

mappingType

String

映射类型，取值范围：

• sr-iov：硬直通
• kernel-ovs：内核态OVS软交换
• user-evs：用户态EVS软交换
• user-ovs：用户态OVS软交换
• linux : Linux网桥
• hw-ovs：硬件加速用户态OVS软交换
• hw-evs：硬件加速用户态EVS软交换

physicalNetworkName

String

物理网络名称

status

String

端口状态，取值范围：

• UP
• DOWN

speed

String

速率

systemDn

String

云平台的网元DN

name

String

bond名称

hostId

String

主机id

mode

String

工作模式，取值范围：

• nobond：主备模式。
• active-standby：主备模式，同nobond。
• lacp：负载均衡模式。l2_smac：基于源mac负载均衡模式。该选项只支持ovs模式。

pNicName

String

主物理端口名称

如果工作模式为主备模式，则该值取值为主端口名称

如果工作模式为lacp，则该值固定为空

macAddress

String

mac地址

status

String

状态，取值范围：

• UP
• DOWN

mappingType

String

映射类型，取值范围：

• sr-iov：硬直通
• kernel-ovs：内核态OVS软交换
• user-evs：用户态EVS软交换
• user-ovs：用户态OVS软交换
• linux : linux网桥
• hw-ovs：硬件加速用户态OVS软交换
• hw-evs：硬件加速用户态EVS软交换

physicalNetworkName

String

物理网络名称

request.getParameter("resourceURI")

"/rest/openapi/notification/virtual/res/event"

request.getParameter("msgType")

1

request.getParameter("data")

"[{}]"

request.getParameter("description")

""

request.getParameter("timestamp")

"2016-11-26 17:44:20"

request.getParameter("extendedData")

"{}"