調用ListSecrets接口查詢當前阿里云賬號在當前地域創建的所有憑據。
此接口返回憑據對象的元數據信息,不返回被加密存儲的憑據值。
本文將提供一個示例,返回當前用戶在當前地域創建的憑據,其中當前頁數PageNumber
設置為1
,每頁中返回的個數PageSize
設置為2
,共返回2個憑據信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | ListSecrets | 要執行的操作。取值:ListSecrets。 |
FetchTags | String | 否 | 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接口進行查詢。
Filters同一個Key中的多個Value之間的邏輯關系為OR。例如:輸入 |
返回數據
名稱 |
類型 |
示例值 |
描述 |
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 | 憑據類型。取值:
|
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. | 參數非法。 |
訪問錯誤中心查看更多錯誤碼。