文档首页/ 密码安全中心 DEW/ API参考/ API/ 凭据管理服务/ 凭据版本管理/ 批量查询明文凭据值 - BatchShowSecretVersion
更新时间：2026-08-27 GMT+08:00
查看PDF
分享

批量查询明文凭据值 - BatchShowSecretVersion

功能介绍

批量查询明文凭据值，仅获取latest凭据值，即仅获取凭据版本状态为"SYSCURRENT"的凭据版本值。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    csms:secret:batchGetSecretValue

    Read

    -

    -

    csms:secretVersion:batchGetSecretValue

    kms:cmk:decryptDataKey

URI

POST /v1/{project_id}/secrets/batch-get-secret-value

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

secret_name_list

否

Array of strings

参数解释：

待获取凭据值的凭据名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：

返回的凭据版本总数

取值范围：

不涉及

versions

Array of Version objects

参数解释：

凭据版本值

取值范围：

不涉及
表5 Version

参数

参数类型

描述

version_metadata

VersionMetadata object

参数解释：

凭据版本元数据信息

取值范围：

不涉及

secret_binary

String

参数解释：

二进制类型凭据在base64编码后的明文，凭据管理服务将其加密后，存入凭据的初始版本中

类型：base64编码的二进制数据对象

取值范围：

不涉及

secret_string

String

参数解释：

文本类型凭据的明文，凭据管理服务将其加密后，存入凭据的初始版本中

取值范围：

不涉及
表6 VersionMetadata

参数

参数类型

描述

id

String

参数解释：

凭据的版本号标识符，凭据对象下唯一

取值范围：

不涉及

create_time

Long

参数解释：

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

取值范围：

不涉及

expire_time

Long

参数解释：

凭据版本过期时间，时间戳，即从1970年1月1日至该时间的总毫秒数。默认为空，凭据订阅“版本过期”事件类型时，有效期判断所依据的值

取值范围：

不涉及

kms_key_id

String

参数解释：

加密版本凭据值的KMS主密钥ID

取值范围：

不涉及

secret_name

String

参数解释：

凭据名称

取值范围：

不涉及

version_stages

Array of strings

参数解释：

凭据版本被标记的状态列表。每个版本标签对于凭据对象下版本是唯一存在的，如果创建版本时，指定的是同一凭据对象下的一个已经标记在其他版本上的状态，该标签将自动从其他版本上删除，并附加到此版本上

如果未指定version_stage的值，则凭据管理服务会自动移动临时标签SYSCURRENT到此新版本

取值范围：

不涉及

请求示例

获取凭据名称为secretname1和secretname2的凭据值。

/v1/7fb65ef26f174116bd303ae2bab367a7/secrets/batch-get-secret-value

{
  "secret_name_list" : [ "secretname1", "secretname2" ]
}

响应示例

状态码：200

{
  "versions" : [ {
    "version_metadata" : {
      "id" : "v5",
      "create_time" : 1786671025000,
      "expire_time" : null,
      "secret_name" : "001123",
      "kms_key_id" : "6452d410-dbb7-4700-9c10-9ff1d470e132",
      "version_stages" : [ "SYSCURRENT" ]
    },
    "secret_string" : "{\"AA\":\"AA\"}"
  }, {
    "version_metadata" : {
      "id" : "v2",
      "create_time" : 1786671025000,
      "expire_time" : null,
      "secret_name" : "001123",
      "kms_key_id" : "6452d410-dbb7-4700-9c10-9ff1d470e132",
      "version_stages" : [ "SYSCURRENT" ]
    },
    "secret_string" : "{\"AA2\":\"AA\"}"
  } ],
  "total_count" : 2
}

状态码

状态码

描述

200

错误码

请参见错误码。

父主题： 凭据版本管理

相关文档