跳转到主要内容
API Explorer|API Explorer
运维管理/监控相关接口/通知服务相关接口
POSTNotification Service APIs起始版本 3.7.0同步需要认证

创建阿里云短信接收端

创建阿里云短信接收端

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • accessKeyUuidString必填

      阿里云AccessKey信息Uuid

    • receiversList

      短信接收者

    • nameString必填

      接收端名称

    • descriptionString

      接收端的详细描述

    • platformUuidString

      平台UUID。

    • resourceUuidString

      资源UUID。若指定，资源会使用该字段值作为UUID。

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventorySNSSmsEndpointInventory必填

    详情参考inventory

    • receiversList必填

      短信接收者

    • nameString必填

      短信接收端名称

    • uuidString必填

      短信接收端的UUID，唯一标示该资源

    • descriptionString必填

      短信接收端的详细描述

    • typeString必填

      短信接收端类型

    • stateString必填

      短信接收端状态

    • platformUuidString必填

      平台UUID。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

POST/zstack/v1/sns/sms-endpoints/aliyunsms

/zstack/v1/sns/sms-endpoints/aliyunsms

操作 ID

CreateSNSAliyunSmsEndpoint

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/sns/sms-endpoints/aliyunsms' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"accessKeyUuid":"<accessKeyUuid>","receivers":["<receivers>"],"name":"<name>","description":"<description>","platformUuid":"<platformUuid>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "name": "example", "uuid": "041723a4d9d14e8686dbec7d1369c05e", "description": "example SNSSmsEndpoint Description", "type": "AliyunSms", "state": "Enabled", "platformUuid": "4eb0ceebf95b452585ebeacd647d9f35", "createDate": "Mar 26, 2024 2:43:19 AM", "lastOpDate": "Mar 26, 2024 2:43:19 AM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史