查询凭据列表 - ListSecrets

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32

默认取值：

不涉及

limit

否

String

参数解释：

查询返回凭据列表当前页面的数量

约束限制：

每页默认返回50，最多返回1000条凭据

取值范围：

不涉及

默认取值：

不涉及

marker

否

String

参数解释：

以单页最后一条凭据名称作为分页标记。为空时为查询第一页

约束限制：

marker需要和limit配合使用，不能独立使用。当最后一页返回数量小于limit时，表示查询结束

取值范围：

不涉及

默认取值：

不涉及

event_name

否

String

参数解释：

事件通知的名称，查询返回所有绑定该事件的凭据

约束限制：

不涉及

取值范围：

满足正则要求：^[a-zA-Z0-9_-]{1,64}$

默认取值：

不涉及

with_shared

否

Boolean

参数解释：

查询凭据列表时，是否查询其他账号通过RAM共享的凭据

• 用户调用本接口时无需关注该参数，使用默认值

• RAM中查询可共享的凭据时，需要传false，避免查询到其他账号共享给当前账号的凭据

约束限制：

不涉及

取值范围：

true或者false

默认取值：

true

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。使用AK、SK等认证方式，此处非必选

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

secrets

Array of Secret objects

参数解释：

凭据详情列表

取值范围：

不涉及

page_info

PageInfo object

参数解释：

列表分页信息

取值范围：

不涉及

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

参数解释：

轮转周期

取值范围：

4小时-8，760小时 （365天）

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

参数解释：

下一次轮转时间戳

取值范围：

不涉及

last_used_time

Long

参数解释：

最近一次获取凭据值的时间

取值范围：

不涉及

event_subscriptions

Array of strings

参数解释：

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

取值范围：

不涉及

enterprise_project_id

String

参数解释：

企业项目ID

取值范围：

不涉及

rotation_func_urn

String

参数解释：

FunctionGraph函数的urn

取值范围：

不涉及

domain_id

String

参数解释：

凭据所属的租户的id

取值范围：

不涉及

replica_type

String

参数解释：

多 Region 凭据类型

取值范围：

• STANDALONE：表示当前凭据没有 多Region 副本

• PRIMARY：表示当前凭据有多 Region 副本，当前凭据为主凭据

• REPLICA：表示当前凭据有多 Region 副本，当前凭据为副本凭据

replicas

Array of Replica objects

参数解释：

副本凭据信息

取值范围：

不涉及

id

String

参数解释：

凭据资源标识符

取值范围：

不涉及

kms_key_id

String

参数解释：

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

取值范围：

不涉及

project_id

String

参数解释：

凭据所属的 project_id

取值范围：

不涉及

region

String

参数解释：

凭据所属的 region 名称

取值范围：

不涉及

replica_type

String

参数解释：

多 Region 凭据类型

取值范围：

• PRIMARY：当前凭据为主凭据

• REPLICA：当前凭据为副本凭据

status

String

参数解释：

副本凭据同步状态

取值范围：

• IN_PROGRESS：副本凭据待同步

• IN_SYNC：副本与主凭据同步

• FAILED：副本凭据与主凭据同步失败

created_at

Long

参数解释：

创建时间戳

取值范围：

不涉及

updated_at

Long

参数解释：

更新时间戳

取值范围：

不涉及

next_marker

String

参数解释：

下一页查询地址（本页的末尾凭据名称，下一页起始凭据名称）

取值范围：

不涉及

previous_marker

String

参数解释：

本页的起始凭据名称，上一页末尾凭据名称

取值范围：

不涉及

current_count

Integer

参数解释：

本页返回条目数量

取值范围：

不涉及

200

请求已成功