ListSecrets - 密钥管理服务

此接口返回凭据对象的元数据信息，不返回被加密存储的凭据值。

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListSecrets	要执行的操作。取值：ListSecrets。
FetchTags	String	否	false	返回值中是否包含凭据的资源标签。取值： true：包含。 false（默认值）：不包含。
PageNumber	Integer	否	1	当前页数。取值范围：大于0。默认值：1。
PageSize	Integer	否	2	每页返回值的个数。取值范围：1~100。默认值：10。
Filters	String	否	[{"Key":"SecretName", "Values":["Val1","Val2"]}]	查询符合指定条件的凭据。由Key-Values键值对组成，长度为0~10。使用一个标签键值过滤资源时，查询到的资源数量不能超过4000个。如果资源数量超过4000个，请使用ListResourceTags接口进行查询。 Key 描述：需要查询的属性。类型：String。取值： SecretName：凭据名称。 Description：凭据描述。 TagKey：标签键。 TagValue：标签值。 DKMSInstanceId：KMS实例的实例ID。 SecretType：凭据类型。 Values 描述：属性的具体取值。类型：String。长度：0~10。取值说明： Key取值为SecretName时：长度为1~192个字符，可包含英文字母、数字和特殊字符 `_/+=.@-`。 Key取值为Description时：长度为1~256个字符。 Key取值为TagKey时：长度为1~256个字符，可包含英文字母、数字和特殊字符`/_-.+=@:`。 Key取值为TagValue时：长度为1~256个字符，可包含英文字母、数字和特殊字符 `/_-.+=@:`。 Key取值为DKMSInstanceId时：KMS实例的实例ID，例如kst-xxx。 Key取值为SecretType时：凭据类型，取值为Generic、Rds、RAMCredentials、ECS。 Filters同一个Key中的多个Value之间的逻辑关系为OR。例如：输入`[ {"Key":"SecretName", "Values":["sec1","sec2"]} ]`时，语义为： `(SecretName=sec1 OR SecretName=sec2)` 。

返回数据

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListSecrets
&FetchTags=false
&PageNumber=1
&PageSize=2
&Filters=[{"Key":"SecretName", "Values":["Val1","Val2"]}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListSecretsResponse>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <RequestId>6a6287a0-ff34-4780-a790-fdfca900557f</RequestId>
    <TotalCount>55</TotalCount>
    <SecretList>
        <SecretName>secret001</SecretName>
        <UpdateTime>2023-07-17T07:59:05Z</UpdateTime>
        <SecretType>Generic</SecretType>
        <PlannedDeleteTime>2023-08-17T07:59:05Z</PlannedDeleteTime>
        <CreateTime>2023-07-17T07:59:05Z</CreateTime>
        <Tags>
            <TagValue>val1</TagValue>
            <TagKey>key1</TagKey>
        </Tags>
    </SecretList>
</ListSecretsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is not valid.	参数非法。
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.	提供的 Access Key ID不存在

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