ListSecrets - - Alibaba Cloud ドキュメントセンター

現在のリージョン内のすべてのシークレットをクエリします。

操作説明

Resource Access Management (RAM) ユーザーまたは RAM ロールには、この操作を呼び出すために必要な権限が必要です。詳細については、「リソースアクセスマネジメント」をご参照ください。
この操作は、シークレットのメタデータを返しますが、暗号化された値は返しません。

このトピックでは、シークレットをクエリする方法の例を示します。この例では、PageNumber を 1 に、PageSize を 2 に設定して、2 つのシークレットを返します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FetchTags	string	任意	応答にシークレットのリソースタグを含めるかどうかを指定します。有効な値: true: タグが含まれます。 false (デフォルト): タグは含まれません。	false
PageNumber	integer	任意	ページ番号。有効な値: 0 より大きい値。デフォルト値: 1。	1
PageSize	integer	任意	ページあたりのエントリ数。有効な値: 1～100。デフォルト値: 10。	2
Filters	string	任意	クエリするシークレットのフィルター条件。値はキーと値のペアで構成され、0～10 個のペアを含めることができます。タグでリソースをフィルター処理する場合、最大 4,000 個のリソースを返すことができます。リソースの数が 4,000 を超える場合は、ListResourceTags 操作を呼び出してクエリを実行します。 Key 説明: クエリするプロパティ。タイプ: String。 Values 説明: プロパティの値。タイプ: String。値には 0～10 個のアイテムを含めることができます。 Key の有効な値: Key を SecretName に設定した場合、シークレット名を示します。Value を実際のシークレット名に設定します。 Key を Description に設定した場合、シークレットの説明を示します。Value を実際の説明に設定します。 Key を TagKey に設定した場合、タグキーを示します。Value を実際のタグキーに設定します。 Key を TagValue に設定した場合、タグの値を示します。Value を実際のタグの値に設定します。 Key を DKMSInstanceId に設定した場合、KMS インスタンスの ID を示します。Value を実際のインスタンス ID に設定します。 Key を SecretType に設定した場合、シークレットのタイプを示します。Value を Generic、Rds、Redis、RAMCredentials、ECS、または PolarDB に設定します。 Key を Creator に設定した場合、シークレットの作成者を示します。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。Alibaba Cloud は、リクエストごとに一意の ID を生成します。この 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

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。