邮件推送 >
API 参考 >
新增API >
Tag操作

Tag操作

更新时间：2019-09-29 14:37

创建Tag

描述

CreateTag 创建标签

请求参数

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：CreateTag
TagName	String	是	标签名称

其他请求参数，请参见公共请求参数。

返回参数

名称	类型	描述
tagId	Integer	标签ID

公共返回参数，请参见公共返回参数。

错误码

错误代码	描述	Http状态码	语义
InvalidTagNumber.Malformed			标签的数量超过了限额
InvalidTagName.Duplicate			指定的标记名称已经存在
InvalidTagName.Malformed			标签非法
InternalError			未知错误

删除Tag

描述

DeleteTag 删除标签

请求参数

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：DeleteTag
TagId	String	是	标签ID

其他请求参数，请参见公共请求参数。

返回参数

公共返回参数，请参见公共返回参数。

错误码

错误代码	描述	Http状态码	语义
InvalidTagId.Malformed			指定的标签ID不存在

获取Tag

描述

QueryTagByParam 获取标签

请求参数

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：QueryTagByParam
KeyWord	String	否	标签名称，长度1-50，默认为所有标签，例如：1aTag

其他请求参数，请参见公共请求参数。

返回参数

名称	类型	描述
pageNumber	Int
pageSize	Int
totalCount	Int
data	Array	数据记录

data

名称	类型	描述
tagId	Integer	标签ID
tagName	String	标签名称

公共返回参数，请参见公共返回参数。

错误码

错误代码	描述	Http状态码	语义
InvalidKeyword.Malformed			指定的关键字格式错误

修改Tag

描述

ModifyTag 修改标签

请求参数

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：ModifyTag
TagId	Integer	是	标签ID
TagName	String	是	标签名称

其他请求参数，请参见公共请求参数。

返回参数

公共返回参数，请参见公共返回参数。

错误码

错误代码	描述	Http状态码	语义
InvalidTag.NotFound			未找到指定的标签
InvalidTagId.Malformed			指定的标签ID不存在
InvalidTagNumber.Malformed			标签的数量超过了限额
InvalidTagName.Duplicate			指定的标记名称已经存在
InvalidTagName.Malformed			标签非法
InternalError			未知错误

文档反馈