查询凭据列表
功能介绍
查询当前用户在本项目下创建的所有凭据。
接口约束
此接口返回的信息为凭据的元数据信息，不包含凭据值。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/secrets
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
String |
每页返回的个数。 默认值：50。 |
|
marker |
否 |
String |
分页查询起始的凭据名称，为空时为查询第一页 |
|
event_name |
否 |
String |
指定事件名称时，仅返回关联该事件的凭据 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
凭据类型
|
|
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。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
next_marker |
String |
下一页查询地址（本页的末尾凭据名称，下一页起始凭据名称）。 |
|
previous_marker |
String |
本页的起始凭据名称，上一页末尾凭据名称。 |
|
current_count |
Integer |
本页返回条目数量。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：502
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：504
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码：200
请求已成功
{
"secrets" : [ {
"id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"name" : "secret-name-test",
"state" : "ENABLED",
"kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
"description" : "description",
"create_time" : 1581507580000,
"update_time" : 1581507580000,
"scheduled_delete_time" : 1581507580000,
"secret_type" : "RDS-FG",
"auto_rotation" : true,
"rotation_config" : "{'InstanceId':'indstance id','SecretSubType':'MultiUser'}",
"rotation_period" : "1d",
"rotation_time" : 1668567940000,
"next_rotation_time" : 1668629140000,
"event_subscriptions" : [ "pocEvent" ]
} ],
"page_info" : {
"next_marker" : "secret-name-test",
"previous_marker" : "secret-name-test",
"current_count" : 1
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
|
400 |
请求参数有误 |
|
401 |
被请求的页面需要用户名和密码 |
|
403 |
认证失败 |
|
404 |
资源不存在，资源未找到 |
|
500 |
服务内部错误 |
|
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
|
504 |
网关超时 |
错误码
请参见错误码。
