ListSecrets - 查询当前用户在当前地域创建的所有凭据_密钥管理服务(KMS)-阿里云帮助中心

查询当前用户在当前地域创建的所有凭据。

接口说明

RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。
此接口返回凭据对象的元数据信息，不返回被加密存储的凭据值。

本文将提供一个示例，返回当前用户在当前地域创建的凭据，其中当前页数PageNumber设置为1，每页中返回的个数PageSize设置为2，共返回 2 个凭据信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
FetchTags	string	否	返回值中是否包含凭据的资源标签。取值： true：包含。 false（默认值）：不包含。	false
PageNumber	integer	否	当前页数。取值范围：大于 0。默认值：1。	1
PageSize	integer	否	每页返回值的个数。取值范围：1~100。默认值：10。	2
Filters	string	否	查询符合指定条件的凭据。由 Key-Values 键值对组成，长度为 0~10。使用一个标签键值过滤资源时，查询到的资源数量不能超过 4000 个。如果资源数量超过 4000 个，请使用 ListResourceTags 接口进行查询。 Key 描述：需要查询的属性。类型：String。 Values 描述：属性的具体取值。类型：String。长度：0~10。取值： Key 取值为 SecretName 时表示凭据名称。Vaule 请按照实际填写。 Key 取值为 Description 时表示凭据描述。Vaule 请按照实际填写。 Key 取值为 TagKey 时表示标签键。Vaule 请按照实际填写。 Key 取值为 TagValue 时表示标签值。Vaule 请按照实际填写。 Key 取值为 DKMSInstanceId 时表示 KMS 实例的实例 ID。Vaule 请按照实际填写。 Key 取值为 SecretType 时表示凭据类型。Vaule 取值为 Generic、Rds、Redis、RAMCredentials、ECS、PolarDB。 Key 取值为 Creator 时表示凭据创建者。Vaule 请按照实际填写。 Filters 同一个 Key 中的多个 Value 之间的逻辑关系为 OR。例如：输入`[ {"Key":"SecretName", "Values":["sec1","sec2"]} ]`时，语义为： `(SecretName=sec1 OR SecretName=sec2)` 。	[{"Key":"SecretName", "Values":["Val1","Val2"]}]

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	当前页数。	1
PageSize	integer	每页返回值的个数。	2
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	6a6287a0-ff34-4780-a790-fdfca900557f
TotalCount	integer	凭据列表中的凭据个数。	55
SecretList	object
Secret	array<object>	凭据列表。
	array<object>
SecretName	string	凭据名称。	secret001
UpdateTime	string	更新时间。	2024-07-17T07:59:05Z
SecretType	string	凭据类型。取值： Generic：通用凭据。 Rds：RDS 凭据。 Redis：Redis/Tair 凭据。 RAMCredentials：RAM 凭据。 ECS：ECS 凭据。 PolarDB：PolarDB 凭据。	Generic
PlannedDeleteTime	string	计划删除时间。	2024-08-17T07:59:05Z
CreateTime	string	创建时间。	2024-07-17T07:59:05Z
Tags	object
Tag	array<object>	凭据的资源标签。如果 FetchTags 取值为 false 或者未指定，则不返回该参数。
	object	凭据的资源标签。如果 FetchTags 取值为 false 或者未指定，则不返回该参数。
TagValue	string	标签值。	val1
TagKey	string	标签键。	key1
OwingService	string

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "PageSize": 2,
  "RequestId": "6a6287a0-ff34-4780-a790-fdfca900557f",
  "TotalCount": 55,
  "SecretList": {
    "Secret": [
      {
        "SecretName": "secret001",
        "UpdateTime": "2024-07-17T07:59:05Z",
        "SecretType": "Generic",
        "PlannedDeleteTime": "2024-08-17T07:59:05Z",
        "CreateTime": "2024-07-17T07:59:05Z",
        "Tags": {
          "Tag": [
            {
              "TagValue": "val1",
              "TagKey": "key1"
            }
          ]
        },
        "OwingService": ""
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
400	InvalidParameter	some of the specified parameters "\" is not valid
500	InternalFailure	Internal Failure
403	Forbidden.NoPermission	This operation is forbidden by permission system
404	Forbidden.ResourceNotFound	Resource not found
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。