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、Redis、RAMCredentials、ECS、PolarDB。 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憑據。 Redis：Redis/Tair憑據。 RAMCredentials：RAM憑據。 ECS：ECS憑據。 PolarDB：PolarDB憑據。
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.	參數非法。

訪問錯誤中心查看更多錯誤碼。