文档首页> 数据加密服务 DEW> API参考（阿布扎比区域）> API说明> 管理密钥> 添加密钥标签
更新时间：2022-12-06 GMT+08:00
查看PDF

添加密钥标签

功能介绍

添加密钥标签。

URI

  • URI格式

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

  • 参数说明
    表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 请求参数

参数

是否必选

参数类型

描述

tag

是

Array of object

包含标签，详情请参见表3。

sequence

否

String

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

例如：919c82d4-8046-4722-9094-35c3c6524cff
表3 tag字段数据结构说明

参数

是否必选

参数类型

描述

key

是

String

键。

最大长度36个unicode字符。 key不能为空。不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。

value

是

String

值。

每个值最大长度43个unicode字符，可以为空字符串。 不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。

响应消息

无

示例

如下以添加标签键为“DEV”，标签值为“DEV1”为例。

  • 请求样例
    {   
  "tag":
     {  
        "key":"DEV",
        "value":"DEV1"
     }
}
  • 响应样例
    { 
}
    或 
    {    
       "error": {        
              "error_code": "KMS.XXXX",        
              "error_msg": "XXX"     
     } 
}

状态码

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

状态码

编码

状态说明

204

No Content

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

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

父主题： 管理密钥