创建短信插件通知对象

POST/zstack/v1/sns/application-endpoints/plugin/sms

操作 ID

CreateSNSSmsPluginEndpoint

起始版本

5.5.38

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

params
Object必填
请求体参数结构
- name
  String必填
  通知对象名称
- description
  String
  通知对象描述
- platformUuid
  String必填
  必填；平台须存在、已启用且当前账户拥有或获共享，关联Driver须为SMS类型并支持SEND_SNS_MESSAGE
- timeoutInSeconds
  long必填
  发送超时时间
- properties
  Map
  通知对象配置
- receivers
  List必填
  1至200个互不重复的短信接收号码
- type
  String
  可省略；短信Driver由platformUuid关联的平台确定
- resourceUuid
  String
  资源UUID
- tagUuids
  List
  标签UUID列表
systemTags
List
系统标签
userTags
List
用户标签

响应状态

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
SNSPluginEndpointInventory必填
详情参考inventory
- pluginDriverUuid
  String必填
  关联的插件Driver UUID
- timeoutInSeconds
  long必填
  发送超时时间，单位为秒
- properties
  Map必填
  插件通知对象配置
- name
  String必填
  资源名称
- uuid
  String必填
  资源的UUID，唯一标示该资源
- description
  String必填
  资源的详细描述
- type
  String必填
  类型
- state
  String必填
  资源的状态
- platformUuid
  String必填
  应用平台UUID
- createDate
  Timestamp必填
  创建时间
- lastOpDate
  Timestamp必填
  最后一次修改时间
- connectionStatus
  String必填
  联通状态(UP,DOWN)
- 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必填
  隐藏字段
- platform
  SNSApplicationPlatformInventory必填
  详情参考platform
  uuid
  String必填
  资源的UUID，唯一标示该资源
  name
  String必填
  资源名称
  description
  String必填
  资源的详细描述
  state
  String必填
  资源的状态
  type
  String必填
  类型
  createDate
  Timestamp必填
  创建时间
  lastOpDate
  Timestamp必填
  最后一次修改时间

请求示例

curl -X POST '{host}/zstack/v1/sns/application-endpoints/plugin/sms' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "name": "{name}",
    "description": "{description}",
    "platformUuid": "{platformUuid}",
    "timeoutInSeconds": "{timeoutInSeconds}",
    "properties": {},
    "receivers": [
      "{receivers}"
    ],
    "type": "{type}",
    "resourceUuid": "{resourceUuid}",
    "tagUuids": [
      "{tagUuids}"
    ]
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

响应示例

{
  "inventory": {
    "uuid": "9ba1ed979c7c4774b30292bc683141b6",
    "name": "SMS plugin endpoint",
    "type": "Plugin",
    "state": "Enabled",
    "pluginDriverUuid": "b8fbed0254193eae88617f83930e0ca8",
    "properties": {},
    "platformUuid": "8d7ef42fe7873d88a59c383b16c96bc3",
    "timeoutInSeconds": 30
  }
}

云主机相关接口

云盘相关接口

镜像相关接口

亲和组相关接口

云主机调度策略相关接口

计算规格相关接口

云盘规格相关接口

弹性伸缩组相关接口

快照组相关接口

SSH密钥相关接口

区域相关接口

集群相关接口

物理机相关接口

GPU设备相关接口

主存储相关接口

镜像服务器相关接口

SAN存储相关接口

物理网络相关接口

PCI设备相关接口

USB重定向相关接口

USB透传相关接口

SR-IOV相关接口

龙芯SE模块相关接口

海光SE模块相关接口

本地存储相关接口

NFS主存储相关接口

Shared Mount Point主存储相关接口

Ceph主存储相关接口

Shared Block主存储相关接口

XStor Block主存储相关接口

镜像仓库服务器相关接口

Ceph镜像服务器相关接口

iSCSI服务器相关接口

FC存储相关接口

NVMe存储相关接口

SDN设备相关接口

二层网络资源相关接口

三层网络相关接口

路由资源相关接口

VPC相关接口

OSPF相关接口

组播路由相关接口

策略路由相关接口

路由器路由表相关接口

网络服务相关接口

防火墙相关接口

安全组相关接口

虚拟IP相关接口

弹性IP相关接口

端口转发相关接口

负载均衡相关接口

IPsec相关接口

Netflow相关接口

端口镜像相关接口

共享带宽相关接口

安全策略定时计划相关接口

资源编排相关接口

裸金属管理相关接口

安装服务相关接口

弹性裸金属管理(Plus)

vCenter相关接口

容量管理相关接口

管理节点相关接口

通知服务相关接口

时序数据（Metric）

事件（Event）

报警器（Alarm）

事件订阅（Event Subscription）

报警文本模板（Text Template）

审计

CBT相关接口

灾备服务相关接口

持续数据保护(CDP)相关接口

脚本库相关接口

XML Hook相关接口

定时运维相关接口

标签管理相关接口

迁移服务相关接口

组织架构相关接口

项目管理相关接口