创建阿里云短信接收端

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

Request

cURL

curl --request POST \
  --url '/v1/sns/sms-endpoints/aliyunsms' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/sns/sms-endpoints/aliyunsms"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "accessKeyUuid": "4eb00e2bf95bp5s505e6eccd647d9k35",
    "receivers": [
      "13555555555",
      "18666666666"
    ],
    "name": "AliyunSms",
    "description": "This is an Aliyun SMS Endpoint"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"accessKeyUuid":"4eb00e2bf95bp5s505e6eccd647d9k35","receivers":["13555555555","18666666666"],"name":"AliyunSms","description":"This is an Aliyun SMS Endpoint"}}' http://localhost:8080/zstack/v1/sns/sms-endpoints/aliyunsms

参数列表

名字	类型	位置	描述	起始版本
accessKeyUuid	String	body(包含在params结构中)	阿里云AccessKey信息Uuid	3.7.0
receivers (可选)	List	body(包含在params结构中)	短信接收者	3.7.0
name	String	body(包含在params结构中)	接收端名称	3.7.0
description (可选)	String	body(包含在params结构中)	接收端的详细描述	3.7.0
platformUuid (可选)	String	body(包含在params结构中)		3.7.0
resourceUuid (可选)	String	body(包含在params结构中)		3.7.0
tagUuids (可选)	List	body(包含在params结构中)	标签UUID列表	3.7.0
systemTags (可选)	List	body	系统标签	3.7.0
userTags (可选)	List	body	用户标签	3.7.0

API返回

返回示例

{
  "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"
  }
}

名字	类型	描述	起始版本
success	boolean		5.0.0
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	3.7.0
inventory	SNSSmsEndpointInventory	详情参考inventory	3.7.0

error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

inventory

名字	类型	描述	起始版本
receivers	List	短信接收者	3.7.0
name	String	短信接收端名称	3.7.0
uuid	String	短信接收端的UUID，唯一标示该资源	3.7.0
description	String	短信接收端的详细描述	3.7.0
type	String	短信接收端类型	3.7.0
state	String	短信接收端状态	3.7.0
platformUuid	String		3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0

SDK示例

Java SDK

CreateSNSAliyunSmsEndpointAction action = new CreateSNSAliyunSmsEndpointAction();
action.accessKeyUuid = "4eb00e2bf95bp5s505e6eccd647d9k35";
action.receivers = asList("13555555555","18666666666");
action.name = "AliyunSms";
action.description = "This is an Aliyun SMS Endpoint";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateSNSAliyunSmsEndpointAction.Result res = action.call();

Python SDK

CreateSNSAliyunSmsEndpointAction action = CreateSNSAliyunSmsEndpointAction()
action.accessKeyUuid = "4eb00e2bf95bp5s505e6eccd647d9k35"
action.receivers = [13555555555, 18666666666]
action.name = "AliyunSms"
action.description = "This is an Aliyun SMS Endpoint"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateSNSAliyunSmsEndpointAction.Result res = action.call()