存储服务

创建 ZCE-X 报警平台

POST/zstack/v1/zce-x-plugin/{uuid}/alert-platform

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {},
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{}}' \
http://localhost:8080/zstack/v1/zce-x-plugin/77e1393bf5aa4536a018b4c0c4e29c72/alert-platform

参数列表

名字类型位置描述可选值起始版本
uuidStringurlZCE-X 信息的 UUID，唯一标示该资源 4.10.6
resourceUuid (可选)Stringbody(包含在params结构中)资源 UUID 4.10.6
tagUuids (可选)Listbody(包含在params结构中)标签 UUID 列表 4.10.6
systemTags (可选)Listbody系统标签 4.10.6
userTags (可选)Listbody用户标签 4.10.6

API返回

返回示例

{
  "thirdPartyPlatform": {
    "uuid": "eec32b6fe11a464790641439f1d7c754",
    "name": "xsky-172.20.11.24",
    "type": "XSKY",
    "url": "http://172.20.11.24:8086/alerts/?token=001adb2ef25e41b7bd01b28651fcfa6a",
    "template": "{\n    \"product\":\"XSKY\",\n    \"service\":\"XSKY\",\n    \"message\":\"${resource_type + '[' + resource_name+'] ' + group + ' ' + alert_value}\",\n    \"metric\":\"${resource_type + '::' + group}\",\n    \"alertLevel\":\"${level == 'info' ? 'Normal' : level == 'warning' ? 'Important' : 'Emergent'}\",\n    \"alertTime\":\"${create}\",\n    \"dimensions\":\"{'resource_name':'${resource_name}'}\",\n    \"dataSource\":\"xsky-172.20.196.185\"\n}",
    "description": "desc",
    "lastSyncDate": "Feb 18, 2025 7:52:39 AM",
    "lastOpDate": "Feb 18, 2025 7:52:39 AM",
    "createDate": "Feb 18, 2025 7:52:39 AM"
  },
  "inventory": {
    "zceXUuid": "77e1393bf5aa4536a018b4c0c4e29c72",
    "thirdPartyPlatformUuid": "eec32b6fe11a464790641439f1d7c754",
    "createDate": "Nov 14, 2017 2:20:57 PM"
  }
}
名字类型描述起始版本
successboolean添加是否成功4.10.6
thirdPartyPlatformThirdpartyPlatformInventory详情参考thirdPartyPlatform4.10.6
inventoryZceXThirdPartyPlatformAlertRefInventory详情参考inventory4.10.6
errorErrorCode错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error4.10.6

thirdPartyPlatform

名字类型描述起始版本
uuidString平台UUID3.10
nameString平台名称3.10
typeString平台类型3.10
urlString平台地址3.10
templateString消息转换模板3.10
stateString平台状态3.10
descriptionString平台详细描述3.10
lastSyncDateTimestamp上一次同步消息时间3.10
lastOpDateTimestamp最后一次修改时间3.10
createDateTimestamp创建时间3.10

inventory

名字类型描述起始版本
zceXUuidStringZCE-X 资源 UUID4.10.6
thirdPartyPlatformUuidString关联的第三方报警平台 UUID4.10.6
createDateTimestamp创建时间4.10.6

error

名字类型描述起始版本
codeString错误码号，错误的全局唯一标识，例如SYS.1000, HOST.10014.10.0
descriptionString错误的概要描述4.10.0
detailsString错误的详细信息4.10.0
elaborationString保留字段，默认为null4.10.0
opaqueLinkedHashMap保留字段，默认为null4.10.0
causeErrorCode根错误，引发当前错误的源错误，若无原错误，该字段为null4.10.0

SDK示例

Java SDK

CreateZceXAlertPlatformAction action = new CreateZceXAlertPlatformAction();
action.uuid = "77e1393bf5aa4536a018b4c0c4e29c72";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateZceXAlertPlatformAction.Result res = action.call();

Python SDK

CreateZceXAlertPlatformAction action = CreateZceXAlertPlatformAction()
action.uuid = "77e1393bf5aa4536a018b4c0c4e29c72"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateZceXAlertPlatformAction.Result res = action.call()

POST添加 ZCE-X

上一页

DELETE删除 ZCE-X 报警平台

下一页