查询凭据的版本列表
功能介绍
查询指定凭据下的版本列表信息。
接口约束
此接口返回的信息为凭据版本的元数据信息,不包含凭据值。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/secrets/{secret_name}/versions
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
secret_name |
是 |
String |
凭据名称。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
分页参数,取值为上一页数据的最后一条记录的版本号。 |
limit |
否 |
Integer |
每页显示的条目数量。默认值50。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
version_metadatas |
Array of VersionMetadata objects |
version_metadata对象。 |
page_info |
PageInfo object |
分页信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
凭据的版本号标识符,凭据对象下唯一。 |
create_time |
Long |
凭据版本创建时间,时间戳,即从1970年1月1日至该时间的总秒数。 |
kms_key_id |
String |
加密版本凭据值的KMS主密钥ID。 |
secret_name |
String |
凭据名称。 |
version_stages |
Array of strings |
凭据版本被标记的状态列表。每个版本标签对于凭据对象下版本是唯一存在的,如果你创建版本时,指定的是同一凭据对象下的一个已经标记在其他版本上的状态,该标签将自动从其他版本上删除,并附加到此版本上。 如果未指定version_stage的值,则凭据管理服务会自动移动临时标签SYSCURRENT到此新版本。 |
参数 |
参数类型 |
描述 |
---|---|---|
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
请求已成功
{ "version_metadatas" : [ { "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "create_time" : 1581507580000, "secret_name" : "secret-name-demo", "version_stages" : [ "pending", "used" ] } ], "page_info" : { "next_marker" : "v10", "previous_marker" : "v1", "current_count" : 10 } }
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
400 |
请求参数有误 |
401 |
被请求的页面需要用户名和密码 |
403 |
认证失败 |
404 |
资源不存在,资源未找到 |
500 |
服务内部错误 |
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
504 |
网关超时 |
错误码
请参见错误码。