文档首页/ 数据加密服务 DEW/ API参考（吉隆坡区域）/ API说明/ 批量添加删除密钥标签
更新时间：2022-08-23 GMT+08:00
查看PDF

批量添加删除密钥标签

功能介绍

批量添加删除密钥标签。

URI

  • URI格式

    POST /v1.0/{project_id}/kms/{key_id}/tags/action

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    项目ID。

    key_id

    是

    String

    密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。

    例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

tags

是

Array of objects
标签列表，key和value键值对的集合。
  • key：表示标签键，一个密钥下最多包含10个key，key不能为空，不能重复，同一个key中value不能重复。key最大长度为36个字符。
  • value：表示标签值。每个值最大长度43个字符，value之间为“与”的关系。

action

是

String

操作标识：

仅限于“create”和“delete”。

sequence

否

String

请求消息序列号，36字节序列号。

例如：919c82d4-8046-4722-9094-35c3c6524cff

响应消息

无

示例

如下以添加标签键为“key1”和“key”，标签值为“value1”和“value3”为例。

  • 请求样例 
    { 
    "action": "create",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key",
            "value": "value3"
        }
    ]
}
    或 
    {
    "action": "delete",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value3"
        }
    ]
}
  • 响应样例 
    { 
}
    或 
    {    
       "error": {        
              "error_code": "KMS.XXXX",        
              "error_msg": "XXX"     
     } 
}

状态码

表3描述的是API返回的正常状态码。
表3 状态码

状态码

编码

状态说明

204

No Content

请求已成功，无内容返回。

异常状态码，请参见状态码。

父主题： API说明