更新主题(UpdateSNSTopic)

API请求

URLs

PUT zstack/v1/sns/topics/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateSNSTopic": {
    "name": "new name",
    "locale": "zh_CN"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateSNSTopic":{"name":"new name","locale":"zh_CN"}}' \
http://localhost:8080/zstack/v1/sns/topics/3e7550bf8ead3f02b366df6e499dc285/actions

参数列表

名字	类型	位置	描述	可选值	起始版本
uuid	String	url	资源的UUID，唯一标示该资源		2.3
name (可选)	String	body(包含在updateSNSTopic结构中)	资源名称		2.3
description (可选)	String	body(包含在updateSNSTopic结构中)	资源的详细描述		2.3
systemTags (可选)	List	body	系统标签		2.3
userTags (可选)	List	body	应用标签		2.3
locale (可选)	String	body(包含在updateSNSTopic结构中)	国际化语言	zh_CN en_US	5.0.0

API返回

返回示例

{
  "inventory": {
    "uuid": "1a688d109d5e4f1b90a2b1b6b7d90c07",
    "name": "new name",
    "state": "Enabled",
    "locale": "zh_CN",
    "createDate": "Dec 25, 2023 2:06:14 PM",
    "lastOpDate": "Dec 25, 2023 2:06:14 PM"
  }
}

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

#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

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	2.3
name	String	资源名称	2.3
description	String	资源的详细描述	2.3
state	String	状态	2.3
createDate	Timestamp	创建时间	2.3
lastOpDate	Timestamp	最后一次修改时间	2.3

SDK示例

Java SDK

UpdateSNSTopicAction action = new UpdateSNSTopicAction();
action.uuid = "3e7550bf8ead3f02b366df6e499dc285";
action.name = "new name";
action.locale = "zh_CN";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateSNSTopicAction.Result res = action.call();

Python SDK

UpdateSNSTopicAction action = UpdateSNSTopicAction()
action.uuid = "3e7550bf8ead3f02b366df6e499dc285"
action.name = "new name"
action.locale = "zh_CN"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateSNSTopicAction.Result res = action.call()

上一篇更改主题状态(ChangeSNSTopicState)下一篇查询主题(QuerySNSTopic)