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

查询密钥实例

功能介绍

查询密钥实例。

通过标签过滤，查询指定用户主密钥的详细信息。

URI

  • URI格式

    POST /v1.0/{project_id}/kms/resource_instances/action

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    项目ID。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

tags

否

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

limit

否

String

查询记录数（“action”为“count”时，无需设置此参数），如果“action”为“filter”，默认为“10”。

limit的取值范围为“1-1000”。

offset

否

String

索引位置。从offset指定的下一条数据开始查询。查询第一页数据时，将查询前一页数据时响应体中的值带入此参数（“action”为“count”时，无需设置此参数）。如果“action”为“filter”，offset默认为“0”。

offset必须为数字，不能为负数。

action

是

String

操作标识（可设置为“filter”或者“count”）。

  • filter：表示过滤。
  • count：表示查询总条数。

matches

否

Array of objects

搜索字段。

  • key为要匹配的字段，例如：resource_name等。
  • value为匹配的值，最大长度为255个字符，不能为空。

sequence

否

String

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

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

响应消息

表3 响应参数

参数

是否必选

参数类型

描述

resources

是

Array of objects

资源实例列表，详情请参见表4。

total_count

是

Integer

总记录数。
表4 resource字段数据结构说明

参数

是否必选

参数类型

描述

resource_id

是

String

资源ID。

resource_detail

是

Object

资源详情，详情请参见表4。

tags

是

Array of objects

标签列表，没有标签，数组默认为空。

resource_name

是

String

资源名称，默认为空字符串。

示例

以下以查询密钥实例为例。

  • 请求样例 
       {
          "offset": "100", 
          "limit": "100", 
          "action": "filter", 
          "matches":[
          {
                   "key": "resource_name", 
                   "value": "resource1"
                }
           ], 
          "tags": [
               {
                   "key": "key1", 
                   "values": [
                            "value1", 
                            "value2"
                   ]
               }
          ]
     }
  • 响应样例 
    { 
 "resources": [{
       "resource_id": "90c03e67-5534-4ed0-acfa-89780e47a535",
       "resource_detail": {
              "key_id": "90c03e67-5534-4ed0-acfa-89780e47a535",
              "domain_id": "4B688Fb77412Aee5570E7ecdbeB5afdc",
              "key_alias": "tagTest_xmdmi",
              "key_description": "123",
              "creation_date": 1521449277000,
              "scheduled_deletion_date": "",
              "key_state": 2,
              "default_key_flag": 0,
              "key_type": 1
       },
       "resource_name": "tagTest_xmdmi",
       "tags": [{
              "key": "$",
              "value": "testValue!"
       }, {
              "key": "1",
              "value": "ccwZ"
       }, {
              "key": "1&",
              "value": "testValue!"
       }, {
              "key": "abcd",
              "value": "1&"
       }, {
              "key": "efg",
              "value": "1&"
       }, {
              "key": "faregbqer",
              "value": "AAaa00-99"
       }, {
              "key": "fcwefwq",
              "value": "$"
       }, {
              "key": "fwqegqwrg",
              "value": "1&"
       }, {
              "key": "haha",
              "value": "qzzahnzgoqbkabppdehnbrrgbrkvlxkkfoosqyhdylq"
       }, {
              "key": "quapxpysduboguiluwargcgmvcgxinianbhl",
              "value": "testValue!"
       }]
 }]
 "total_count": "1"}

    或

    {     
       "error": {        
       "error_code": "KMS.XXXX",         
       "error_msg": "XXX"     
        }
 }

状态码

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

状态码

编码

状态说明

200

OK

请求已成功。

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

父主题： API说明