現在のリージョンでAlibaba Cloudアカウントによって作成されたすべてのシークレットを照会します。

この操作は、シークレットオブジェクトに格納されたメタデータ情報を返しますが、暗号化されたシークレット値は返しません。

この例では、現在のリージョンの現在のアカウントによって作成されたシークレットが返されます。 PageNumberパラメーターは1に設定され、PageSizeパラメーターは2に設定され、2つのシークレットが返されることを示します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 ListSecrets

実行する操作です。 値をListSecretsに設定します。

FetchTags String 任意 false

シークレットのリソースタグを返すかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: リソースタグが返されます。
  • false: リソースタグは返されません。 デフォルト値です。
PageNumber Integer 任意 1

返されるページ数。

ページ番号は 1 から始まります。

デフォルト値:1。

PageSize Integer 任意 2

各ページで返されるエントリ数。

有効値:1~100 。

Default value: 10.

フィルター String 任意 [{"Key":"SecretName", "Values":["$Val1", "$Val2"]}]

秘密のフィルター。 フィルターはキーと値のペアです。 1つのキーと値のペアを指定するか、このパラメーターを空のままにします。 タグキーまたは値に基づいてリソースをフィルタリングすると、最大4,000個のリソースを応答で返すことができます。 4,000を超えるリソースをクエリするには、ListTagResources操作を呼び出します。

  • Key
    • 説明: フィルタリングするプロパティ。
    • タイプ: string。
    • 設定可能な値は以下のとおりです。
      • SecretName: シークレット名。
      • 説明: シークレットの説明。
      • TagKey: タグキー。
      • TagValue: タグ値。
    • 説明: フィルタリング後に含まれる値。
    • タイプ: string。
    • 長さ: 0〜10。
    • 設定可能な値は以下のとおりです。
      • キーフィールドがSecretNameに設定されている場合、値は1 ~ 192文字である必要があり、英数字、および特殊文字を使用できます。 特殊文字には、アンダースコア (_) 、スラッシュ (/) 、プラス記号 (+) 、等号 (=) 、ピリオド (.) 、アット記号 (@) 、ハイフン (-) が含まれます。
      • [キー] フィールドが [説明] に設定されている場合、値は1 ~ 256文字である必要があります。
      • キーフィールドがTagKeyに設定されている場合、値は1 ~ 256文字である必要があり、英数字、および特殊文字を使用できます。 特殊文字には、スラッシュ (/) 、アンダースコア (_) 、ハイフン (-) 、ピリオド (.) 、プラス記号 (+) 、等号 (=) 、アット記号 (@) 、およびコロン (:) が含まれます。
      • キーフィールドがTagValueに設定されている場合、値の長さは1 ~ 256文字である必要があり、英数字、および特殊文字を使用できます。 特殊文字には、スラッシュ (/) 、アンダースコア (_) 、ハイフン (-) 、ピリオド (.) 、プラス記号 (+) 、等号 (=) 、アット記号 (@) 、およびコロン (:) が含まれます。

フィルターパラメーターのキーの値間の論理関係はORです。 例: [ {"Key":"SecretName", "Values":["sec1", "sec2"]} ] 。 この例では、セマンティクスは、SecretName=sec 1またはSecretName=sec 2

レスポンスパラメーター

パラメーター データ型 説明
PageNumber Integer 1

返されたページの数です。

PageSize Integer 2

1 ページあたりで返されるエントリ数。

RequestId String 6a6287a0-ff34-4780-a790-fdfca900557f

リクエストの ID です。

SecretList シークレットの配列

秘密のリスト。

シークレット
CreateTime String 2020-07-17T07:59:05Z

シークレットが作成された時刻。

PlannedDeleteTime String 202008-17T07: 59:05Z

シークレットが削除される予定の時刻。

SecretName String secret001

秘密の名前。The name of the secret.

SecretType String ジェネリック

シークレットのタイプ。 設定可能な値は以下のとおりです。

  • Generic: 標準シークレットを示します。
  • Rds: 管理対象のApsaraDB RDSシークレットを示します。
タグ タグの配列

シークレットのリソースタグ。

FetchTagsパラメーターがfalseに設定されているか指定されていない場合、このパラメーターは返されません。

タグ
TagKey String key1

タグキー。

TagValue String val1

タグの値。

UpdateTime String 2020-07-17T07:59:05Z

シークレットが更新された時刻。

TotalCount Integer 55

返されたシークレットの数。

リクエストの例

4http(s)://[Endpoint]/? Action=ListSecrets
&PageNumber=1
&PageSize=2
&<Common request parameters>

正常に処理された場合のレスポンス例

XML 形式

<KMS>
<SecretList>
<シークレット>
<SecretName>secret001</SecretName>
<SecretType> ジェネリック </SecretType>
<CreateTime>2020-07-17T07:59:05Z</CreateTime>
<UpdateTime>2020-07-17T07:59:05Z</UpdateTime>
</Secret>
<シークレット>
<SecretName>cache_client</SecretName>
<SecretType> ジェネリック </SecretType>
<CreateTime>2020-07-23T11:56:29Z</CreateTime>
<UpdateTime>2021-01-12T02:15:42Z</UpdateTime>
</Secret>
</SecretList>
<RequestId>6a6287a0-ff34-4780-a790-fdfca900557f</RequestId>
<PageNumber>1</PageNumber>
<PageSize>2</PageSize>
<TotalCount>55</TotalCount>
</KMS>

JSON 形式

{
"SecretList": {
"秘密": [
{
"SecretName": "secret001" 、"SecretType": "Generic" 、"CreateTime": "2020-07-17T07:59:05Z" 、"UpdateTime": "2020-07-17T07:59:05Z"
},
{
"SecretName": "cache_client" 、"SecretType": "Generic" 、"CreateTime": "2020-07-23T11:56:29Z" 、"UpdateTime": "2021-01-12T02:15:42Z"
}
]
},
"RequestId": "6a6287a0-ff34-4780-a790-fdfca900557f" 、"PageNumber": 1、"PageSize": 2、"TotalCount": 55
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。