文档首页/ 密码安全中心 DEW/ API参考（联盟区域）/ API说明/ 凭据管理服务/ 查询凭据实例
更新时间：2026-03-19 GMT+08:00
查看PDF
分享

查询凭据实例

功能介绍

查询凭据实例。通过标签过滤，筛选用户凭据,返回凭据列表。

URI

POST /v1/{project_id}/csms/{resource_instances}/action

表1 路径参数

参数

是否必选

参数类型

描述

resource_instances

是

String

定值为resource_instances。

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

limit

否

String

查询记录数（“action”为“count”时，无需设置此参数），如果“action”为“filter”，默认为“10”。 limit的取值范围为“1-1000”。

offset

否

String

查询第一页数据时，将查询前一页数据时响应体中的值带入此参数（“action”为“count”时，无需设置此参数）。

action

否

String

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

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

tags

否

Array of Tag objects

标签列表，key和value键值对的集合。

  • key：表示标签键，一个凭据下最多包含20个key，key不能为空，不能重复，同一个key中value不能重复。key最大长度为36个字符。key之间是“与”的关系
  • value：表示标签值。每个值最大长度43个字符，value之间为“或”的关系。

matches

否

Array of TagItem objects

搜索字段。

  • key为搜索的字段，目前仅支持搜索凭据名称，值为“resource_name”。
  • value为模糊匹配的值，最大长度为255个字符。为空返回空值。

sequence

否

String

请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff
表4 Tag

参数

是否必选

参数类型

描述

key

否

String

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

values

否

Array of strings

标签值集合
表5 TagItem

参数

是否必选

参数类型

描述

key

否

String

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

value

否

String

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

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

resources

Array of ActionResources objects

资源实例列表，详情请参见resource字段数据结构说明。

total_count

Integer

总记录数。
表7 ActionResources

参数

参数类型

描述

resource_id

String

资源ID。

resource_detail

Secret object

凭据对象。

resource_name

String

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

tags

Array of TagItem objects

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

sys_tags

Array of TagItem objects

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

参数

参数类型

描述

id

String

凭据的资源标识符。

name

String

凭据名称。

state

String

凭据状态，取值如下：

ENABLED：表示启用状态

DISABLED：表示禁用状态

PENDING_DELETE：表示待删除状态

FROZEN：表示冻结状态

kms_key_id

String

用于加密凭据值的KMS主密钥的ID值。

description

String

凭据的描述信息。

create_time

Long

凭据创建时间，时间戳，即从1970年1月1日至该时间的总秒数。

update_time

Long

凭据上次更新时间，时间戳，即从1970年1月1日至该时间的总秒数。

scheduled_delete_time

Long

凭据计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数。

凭据不在删除计划中时，本项值为null。
表9 TagItem

参数

参数类型

描述

key

String

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

value

String

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

状态码： 400

表10 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

-
表11 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 401

表12 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

-
表13 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 403

表14 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

-
表15 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 404

表16 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

-
表17 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 500

表18 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

-
表19 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 502

表20 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

-
表21 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 504

表22 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

-
表23 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

请求示例

通过标签键为key1,标签值为val1的标签进行过滤，筛选用户凭据，返回凭据列表。

{
  "action" : "filter",
  "tags" : [ {
    "key" : "key1",
    "values" : [ "val1" ]
  } ]
}

响应示例

状态码： 200

请求已成功

{
  "total_count" : 1,
  "resources" : [ {
    "resource_id" : "2d1152f2-290d-4756-a1d2-e12c14992416"
  }, {
    "resource_detail" : {
      "id" : "2d1152f2-290d-4756-a1d2-e12c14992416",
      "name" : "example_name",
      "state" : "ENABLED",
      "description" : "",
      "kms_key_id" : "1213d410-ass1-1254-1a2d-3cca2sa2w554",
      "create_time" : 1581507580000,
      "update_time" : 1581507580000,
      "scheduled_delete_time" : 1581507580000
    }
  }, {
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  }, {
    "sys_tags" : null
  }, {
    "resource_name" : "example_name"
  } ]
}

状态码

状态码

描述

200

请求已成功

400

请求参数有误

401

被请求的页面需要用户名和密码

403

认证失败

404

资源不存在，资源未找到

500

服务内部错误

502

请求未完成。服务器从上游服务器收到一个无效的响应

504

网关超时

错误码

请参见错误码。

父主题： 凭据管理服务