更新时间:2022-08-23 GMT+08:00

查询密钥标签

功能介绍

查询指定密钥的标签信息。

标签管理服务需要使用该接口查询指定密钥的全部标签数据。

URI

  • URI格式

    GET /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 响应参数

参数

是否必选

参数类型

描述

tags

Array of objects

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

existTagNum

Integer

密钥的标签个数。

示例

如下以查询密钥标签为例。

  • 请求样例

  • 响应样例
    {         "tags": [
               {
                "key": "key1",
                "value": "value1"
               },
               {
                "key": "key2",
                "value": "value3"
               }
               ],
               "existTagsNum":2 
    }
    {     
            "error": {        
                  "error_code": "KMS.XXXX",         
                  "error_msg": "XXX"    
              } 
     }

状态码

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

状态码

编码

状态说明

200

OK

请求已成功。

异常状态码,请参见状态码