查询文本模板支持的参数

GET/zstack/v1/zwatch/textTemplateArg

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/zwatch/textTemplateArg

参数列表

名字类型位置描述可选值起始版本
systemTags (可选)Listquery系统标签 4.2.0
userTags (可选)Listquery用户标签 4.2.0

API返回

返回示例

{
  "defaultSupportedParams": {
    "alarm": [
      "ALARM_NAME",
      "ALARM_UUID",
      "ALARM_COMPARISON_OPERATOR",
      "ALARM_COMPARISON_OPERATOR_REVERSE",
      "ALARM_METRIC",
      "ALARM_NAMESPACE",
      "ALARM_THRESHOLD",
      "ALARM_LABELS",
      "ALARM_DURATION",
      "ALARM_PREVIOUS_STATUS",
      "ALARM_CURRENT_STATUS",
      "ALARM_CURRENT_VALUE",
      "ALARM_TIME",
      "ALARM_RESOURCE_TYPE",
      "ALARM_RESOURCE_ID",
      "ALARM_RESOURCE_NAME",
      "TITLE_ALARM_RESOURCE_NAME",
      "ALARM_ACCOUNT_UUID",
      "ALARM_DATA_UUID",
      "ALARM_EMERGENCY_LEVEL",
      "ALARM_RESOURCE_IP",
      "ALARM_RESOURCE_CLUSTER_UUID",
      "ALARM_RESOURCE_CLUSTER_NAME"
    ],
    "event": [
      "EVENT_NAMESPACE",
      "EVENT_NAME",
      "EVENT_LABELS",
      "EVENT_EMERGENCY_LEVEL",
      "EVENT_RESOURCE_ID",
      "EVENT_RESOURCE_NAME",
      "EVENT_ERROR",
      "EVENT_TIME",
      "EVENT_SUBSCRIPTION_UUID",
      "EVENT_ACCOUNT_UUID",
      "EVENT_DATA_UUID",
      "EVENT_RESOURCE_IP",
      "EVENT_RESOURCE_CLUSTER_UUID",
      "EVENT_RESOURCE_CLUSTER_NAME"
    ]
  }
}
名字类型描述起始版本
defaultSupportedParamsMap默认支持参数列表4.2.0
successboolean 4.2.0
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error4.2.0

error

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

SDK示例

Java SDK

GetTextTemplateArgAction action = new GetTextTemplateArgAction();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetTextTemplateArgAction.Result res = action.call();

Python SDK

GetTextTemplateArgAction action = GetTextTemplateArgAction()
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetTextTemplateArgAction.Result res = action.call()