全部產品
Search
文件中心

:ListSecrets - 查詢目前使用者在當前地區建立的所有憑據

更新時間:Apr 10, 2026

查詢目前使用者在當前地區建立的所有憑據。

介面說明

  • 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

歸屬的雲產品

alb

樣本

正常返回樣本

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": "alb"
      }
    ]
  }
}

錯誤碼

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.

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

變更歷史

更多資訊,參考變更詳情