跳转到主要内容
ZStack
平台运维/云平台监控相关接口/监控报警/通知服务/通知服务相关接口

创建插件通知平台

创建插件通知平台

POST/zstack/v1/sns/application-platforms/plugin

操作 ID

CreateSNSPluginPlatform

起始版本

5.5.38

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • name
      String必填

      平台名称

    • description
      String

      平台描述

    • pluginDriverUuid
      String必填

      已加载的SNS EndpointDriver UUID，须支持SEND_SNS_MESSAGE

    • properties
      Map

      按Driver的optionTypes声明填写；若Driver声明必填项则必须提供

    • resourceUuid
      String

      资源UUID

    • tagUuids
      List

      标签UUID列表

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventory
    SNSPluginPlatformInventory必填

    详情参考inventory

    • pluginDriverUuid
      String必填

      关联的插件Driver UUID

    • properties
      Map必填

      插件声明的平台配置；敏感字段仅返回是否已配置

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • state
      String必填

      平台状态

    • type
      String必填

      平台类型，插件通知平台固定为Plugin

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • driver
      PluginDriverInventory必填

      详情参考driver

      • uuid
        String必填

        插件Driver UUID

      • name
        String必填

        资源名称

      • type
        String必填

        资源类型

      • vendor
        String必填

        插件供应商

      • features
        String必填

        插件特性

      • deleted
        boolean必填

        插件是否已被软删除

      • license
        String必填

        插件许可证

      • version
        String必填

        插件版本

      • description
        String必填

        资源的详细描述

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

      • optionTypes
        Collection必填

        详情参考optionTypes

        • uuid
          String必填

          配置字段UUID

        • name
          String必填

          配置字段名称

        • code
          String必填

          配置字段唯一编码

        • category
          String必填

          配置字段分类

        • required
          Boolean必填

          是否必填

        • editable
          Boolean必填

          是否允许编辑

        • enabled
          Boolean必填

          是否启用

        • displayOrder
          Integer必填

          字段显示顺序

        • placeHolderText
          String必填

          输入框占位提示

        • defaultValue
          String必填

          字段默认值

        • noSelection
          String必填

          未选择选项时使用的值

        • noBlank
          Boolean必填

          是否禁止空白值

        • secretField
          Boolean必填

          是否为敏感字段

        • minVal
          Long必填

          允许的最小数值

        • maxVal
          Long必填

          允许的最大数值

        • minLength
          Long必填

          允许的最小输入长度

        • maxLength
          Long必填

          允许的最大输入长度

        • fieldContext
          String必填

          字段所属配置上下文

        • fieldClass
          String必填

          字段展示样式类

        • fieldLabel
          String必填

          字段展示名称

        • fieldCode
          String必填

          字段国际化编码

        • fieldName
          String必填

          字段保存键名

        • fieldGetName
          String必填

          读取字段值时使用的键名

        • fieldSetName
          String必填

          保存字段值时使用的键名

        • fieldGetContext
          String必填

          读取字段值时使用的配置上下文

        • fieldSetContext
          String必填

          保存字段值时使用的配置上下文

        • fieldGroup
          String必填

          字段所属展示分组

        • fieldGroupI18nCode
          String必填

          字段分组国际化编码

        • helpText
          String必填

          字段帮助信息

        • helpTextI18nCode
          String必填

          字段帮助信息国际化编码

        • optionSourceType
          String必填

          动态选项的数据源类型

        • optionSource
          String必填

          动态选项的数据源

        • dependsOn
          String必填

          当前字段依赖的其他字段

        • showOnEdit
          Boolean必填

          编辑时是否显示

        • displayValueOnDetails
          Boolean必填

          详情页是否显示字段值

        • showOnCreate
          Boolean必填

          创建时是否显示

        • verifyPattern
          String必填

          字段值校验正则表达式

        • inputType
          InputType必填

          详情参考inputType

          • text
            InputType必填

            单行文本输入框

          • password
            InputType必填

            密码输入框

          • number
            InputType必填

            数字输入框

          • textarea
            InputType必填

            多行文本输入框

          • select
            InputType必填

            单选下拉框

          • multiSelect
            InputType必填

            多选下拉框

          • checkbox
            InputType必填

            复选框

          • radio
            InputType必填

            单选按钮

          • credential
            InputType必填

            凭证选择器

          • typeahead
            InputType必填

            支持搜索的单选输入框

          • multiTypeahead
            InputType必填

            支持搜索的多选输入框

          • code-editor
            InputType必填

            代码编辑器

          • hidden
            InputType必填

            隐藏字段