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

创建阿里云短信接收端

创建阿里云短信接收端

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

操作 ID

CreateSNSAliyunSmsEndpoint

起始版本

3.7.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • accessKeyUuid
      String必填

      阿里云AccessKey信息Uuid

    • receivers
      List

      短信接收者

    • name
      String必填

      接收端名称

    • description
      String

      接收端的详细描述

    • platformUuid
      String

      可选。

    • resourceUuid
      String

      可选。

    • tagUuids
      List

      标签UUID列表

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
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
    SNSSmsEndpointInventory必填

    详情参考inventory

    • receivers
      List必填

      短信接收者

    • name
      String必填

      短信接收端名称

    • uuid
      String必填

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

    • description
      String必填

      短信接收端的详细描述

    • type
      String必填

      短信接收端类型

    • state
      String必填

      短信接收端状态

    • platformUuid
      String必填

      平台UUID。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间