创建通用短信接收端

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

操作 ID

CreateSNSUniversalSmsEndpoint

起始版本

5.1.8

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

params
Object必填
请求体参数结构
- smsAccessKeyId
  String必填
  sms访问密钥ID。
- smsAccessKeySecret
  String必填
  sms访问密钥。
- supplier
  String必填
  暂无描述。
- additionParam
  Map
  可选。
- name
  String必填
  资源名称
- description
  String
  资源的详细描述
- platformUuid
  String
  可选。
- resourceUuid
  String
  资源UUID
- tagUuids
  List
  标签UUID列表
systemTags
List
系统标签
userTags
List
用户标签

响应状态

200 OK

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

success
boolean必填
操作是否成功。
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
SNSUniversalSmsEndpointInventory必填
详情参考inventory
- smsAccessKeyId
  String必填
  访问密钥ID
- smsAccessKeySecret
  String必填
  访问密钥密码
- supplier
  String必填
  短信提供商
- name
  String必填
  资源名称
- uuid
  String必填
  资源的UUID，唯一标示该资源
- description
  String必填
  资源的详细描述
- state
  String必填
  当前状态。
- platformUuid
  String必填
  平台UUID。
- createDate
  Timestamp必填
  创建时间
- lastOpDate
  Timestamp必填
  最后一次修改时间
- platform
  SNSApplicationPlatformInventory必填
  详情参考#platform
  uuid
  String必填
  资源的UUID，唯一标示该资源
  name
  String必填
  资源名称
  description
  String必填
  资源的详细描述
  type
  String必填
  类型
  createDate
  Timestamp必填
  创建时间
  lastOpDate
  Timestamp必填
  最后一次修改时间

请求示例

curl -X POST '{host}/zstack/v1/sns/application-endpoints/universal-sms' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "smsAccessKeyId": "{smsAccessKeyId}",
    "smsAccessKeySecret": "{smsAccessKeySecret}",
    "supplier": "{supplier}",
    "additionParam": {},
    "name": "{name}",
    "description": "{description}",
    "platformUuid": "{platformUuid}",
    "resourceUuid": "{resourceUuid}",
    "tagUuids": [
      "{tagUuids}"
    ]
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

响应示例

{
  "inventory": {
    "smsAccessKeyId": "smsAccessKeyId",
    "smsAccessKeySecret": "smsAccessKeySecret",
    "name": "example",
    "uuid": "917fe66f76b241f0843dfbd6be685fc1",
    "description": "description example",
    "type": "UniversalSms",
    "state": "Enabled",
    "platformUuid": "4eb0ceebf95b452585ebeacd647d9f35",
    "createDate": "Jun 13, 2024 5:28:34 PM",
    "lastOpDate": "Jun 13, 2024 5:28:34 PM",
    "connectionStatus": "UP"
  }
}

云主机相关接口

云盘相关接口

镜像相关接口

亲和组相关接口

云主机调度策略相关接口

计算规格相关接口

云盘规格相关接口

弹性伸缩组相关接口

快照组相关接口

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相关接口

定时运维相关接口

标签管理相关接口

迁移服务相关接口

组织架构相关接口

项目管理相关接口