文档首页 > > API参考> API> 使用标签管理服务> 批量添加删除资源标签

批量添加删除资源标签

分享
更新时间: 2019/11/19 GMT+08:00

功能介绍

  • 接口名称

    BatchCreateOrDeleteResourceTags

  • 接口描述

    为指定实例批量添加或删除标签。

    一个资源上最多有10个标签。

    此接口为幂等接口:创建时如果请求体中存在重复key则报错。

    创建时,不允许重复key,如果数据库存在就覆盖。

    删除时,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验。

URI

  • URI格式

    POST /v2/{project_id}/{resource_type}/{resource_id}/tags/action

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

    获取项目ID请参考获取项目ID

    resource_type

    String

    资源类型

    目前有:

    smn_topic,主题

    smn_sms,短信

    smn_application,移动推送

    resource_id

    String

    资源ID

    获取resource_id的方法:

    • 当resource_type为“smn_topic”时,
      • 手动添加请求消息头“X-SMN-RESOURCEID-TYPE=name”,资源ID即为topic名称。
      • 不添加请求消息头,通过“查询资源实例”,获取资源ID。
    • 当resource_type为“smn_application”时,resource_id即为application_id。
    • 当resource_type为“smn_sms”时,resource_id为签名ID。您可在控制台获取。

请求消息

  • 要素说明

    名称

    是否必选

    参数类型

    说明

    tags

    Resource_tag结构体数组

    标签列表,结构体说明请参见表1

    删除时tags结构体不能缺失,key不能为空或空字符串,且不针对字符集范围进行校验。

    action

    String

    操作标识:仅限于create(创建)、delete(删除)。

    表1 Resource_tag结构体

    名称

    是否必选

    参数类型

    说明

    约束

    key

    String

    最大长度36个unicode字符, 不能为空或空字符串。只能包含大写字母、小写字母、数字和特殊字符(-_),且首尾不能为空格。

    value

    String

    每个值最大长度43个unicode字符,可以为空字符串。 只能包含大写字母、小写字母、数字和特殊字符(-_),且首尾不能为空格。

  • 请求样例
    POST https://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tags/action
  • 请求体
    action为“create”时请求体
    {
        "action": "create",
        "tags": [
            {
                "key": "key1",
                "value": "value1"
            },
            {
                "key": "key",
                "value": "value3"
            }
        ]
    }

    action为“delete”时请求体

    {
        "action": "delete",
        "tags": [
            {
                 "key": "key1"
             },
            {
                "key": "key2",
                "value": "value3"
            }
        ]
    }

响应消息

返回值

请参考返回值

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区