文档首页/ 数据加密服务 DEW/ API参考/ API说明/ 凭据管理服务/ 凭据标签管理/ 查询凭据实例
更新时间：2025-09-18 GMT+08:00
查看PDF
分享

查询凭据实例

功能介绍

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

调用方法

请参见如何调用API。

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

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

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

action

是

String

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

  • filter：表示过滤。

  • count：表示查询总条数。

tags

否

Array of Tag objects

标签列表，key和value键值对的集合。最多不超过10个。

matches

否

Array of TagMatches objects

搜索字段。

  • key为搜索的字段，目前仅支持搜索凭据名称，值为“resource_name”。

  • value为模糊匹配的值，最大长度为255个字符。为空返回空值。

sequence

否

String

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

例如：919c82d4-8046-4722-9094-35c3c6524cff
表4 Tag

参数

是否必选

参数类型

描述

key

否

String

标签键。

values

否

Array of strings

标签值集合。

约束：最多包含10个value。标签列表中的标签value值不允许重复。标签列表如果为空列表，表示匹配任意值。标签列表中多个value之间是“或”的关系，在key已经满足要求的前提下，满足请求中的某个value就会匹配出来。
表5 TagMatches

参数

是否必选

参数类型

描述

key

否

String

为要匹配的字段。

约束：值只能为resource_name。

value

否

String

模糊匹配的值。

约束：最大长度为255个字符，为空返回空值。

响应参数

状态码：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 SysTag 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。

secret_type

String

凭据类型

  • COMMON：通用凭据(默认)。用于应用系统中的各种敏感信息储存。

  • RDS：RDS凭据 。专门针对RDS的凭据，用于存储RDS的账号信息。（已不支持，使用RDS-FG替代）

  • RDS-FG：RDS凭据 。专门针对RDS的凭据，用于存储RDS的账号信息。

  • GaussDB-FG：TaurusDB凭据。专门针对TaurusDB的凭据，用于存储TaurusDB的账号信息。

auto_rotation

Boolean

自动轮转

取值：true 开启, false 关闭(默认)

rotation_period

String

轮转周期

约束：6小时-8,760小时 （365天）

类型：Integer[unit] ，Integer表示时间长度 。unit表示时间单位，d（天）、h（小时）、m（分钟）、s（秒）。例如 1d 表示一天，24h也表示一天

说明：当开启自动轮转时，必须填写该值

rotation_config

String

轮转配置

约束：范围不超过1024个字符。

当secret_type为RDS-FG、GaussDB-FG时，配置为{"InstanceId":"","SecretSubType":""}

说明：当secret_type为RDS-FG、GaussDB-FG时，必须填写该值

InstanceId为实例ID,SecretSubType为轮转子类型，取值为：SingleUser，MultiUser。

SingleUser：指定轮转类型为单用户模式轮转，每次轮转将指定账号重置为新的口令。

MultiUser：指定轮转类型为双用户模式轮转，SYSCURRENT和SYSPREVIOUS分别引用其中一个账号。凭据轮转时，SYSPREVIOUS引用的账号口令会被重置为新的随机口令，随后凭据交换SYSCURRENT和SYSPREVIOUS对账号的引用。

rotation_time

Long

轮转时间戳

next_rotation_time

Long

下一次轮转时间戳

event_subscriptions

Array of strings

凭据订阅的事件列表，当前最大可订阅一个事件。当事件包含的基础事件触发时，通知消息将发送到事件对应的通知主题。

enterprise_project_id

String

企业项目ID

rotation_func_urn

String

FunctionGraph函数的urn。
表9 TagItem

参数

参数类型

描述

key

String

标签的名称。

同一个凭据，一个标签键只能对应一个标签值；不同的凭据可以使用相同的标签键。

用户最多可以给单个凭据添加20个标签。

约束：取值范围为1到128个字符，满足正则匹配"^((?!\s)(?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)(?<!\s)$"

value

String

标签的值。

约束：取值范围不超过255个字符，满足正则匹配"^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$"
表10 SysTag

参数

参数类型

描述

key

String

标签键。

value

String

标签值。

状态码：400

表11 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。
表12 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码：401

表13 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。
表14 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码：403

表15 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。
表16 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码：404

表17 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。
表18 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码：500

表19 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。
表20 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码：502

表21 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。
表22 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码：504

表23 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。
表24 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

请求示例

通过标签过滤，筛选用户凭据，返回凭据列表。

{
  "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

网关超时

错误码

请参见错误码。

父主题： 凭据标签管理

相关文档