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

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

操作説明

この操作を呼び出すには、Resource Access Management (RAM) ユーザーまたは RAM ロールに必要なポリシーが付与されている必要があります。詳細については、「Resource Access Management」をご参照ください。
この操作はシークレットのメタデータのみを返し、シークレット値は返しません。

この例では、現在のユーザーが現在のリージョンで作成したシークレットをクエリする方法を示します。 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	任意	指定された条件に基づいてシークレットをフィルターします。値は、最大 10 個のキーと値のペアのリストです。タグでフィルターする場合、クエリは最大 4,000 個のリソースを返します。 4,000 個を超えるリソースがフィルターに一致する場合は、ListResourceTags 操作を呼び出してください。 Key 説明：フィルタープロパティ。タイプ：文字列。 Values 説明：フィルター値。タイプ：文字列。最大 10 個の項目を指定できます。 Key の有効な値： `Key` を SecretName に設定して、シークレット名でフィルターします。 `Key` を Description に設定して、シークレットの説明でフィルターします。 `Key` を TagKey に設定して、タグキーでフィルターします。 `Key` を TagValue に設定して、タグ値でフィルターします。 `Key` を DKMSInstanceId に設定して、KMS インスタンス ID でフィルターします。 Key を SecretType に設定して、シークレットタイプでフィルターします。 `Values` には、`Generic`、`RDS`、`Redis`、`RAMCredentials`、`ECS`、または `PolarDB` を指定できます。 `Key` を Creator に設定して、シークレットの作成者でフィルターします。キーに複数の値を指定した場合、フィルターは論理和 (OR) を適用します。たとえば、`[ {"Key":"SecretName", "Values":["sec1","sec2"]} ]` と入力すると、`(SecretName=sec1 OR SecretName=sec2)` を意味します。	[{"Key":"SecretName", "Values":["Val1","Val2"]}]

レスポンスフィールド

フィールド	型	説明	例
	object
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	2
RequestId	string	Alibaba Cloud がリクエストのために生成した一意の識別子。問題の特定やトラブルシューティングに使用します。	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	リソースタグ。
TagValue	string	タグ値。	val1
TagKey	string	タグキー。	key1
OwingService	string	所有者サービス。	alb

例

成功レスポンス

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

エラーコード

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.

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

変更履歴

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