共通パラメーターを照会します。複数のクエリタイプがサポートされています。
操作説明
この操作を呼び出す前に、Key Management Service (KMS) のシークレットを管理する権限があることを確認してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
oos:ListSecretParameters |
list |
*SecretParameter
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-hangzhou |
| Name |
string |
任意 |
パラメーターの名前。 キーワードを入力して、あいまい一致モードでパラメーター名を照会できます。 |
MySecretParameter |
| MaxResults |
integer |
任意 |
1ページあたりのエントリ数。 有効値:10~100。 デフォルト値:50。 |
50 |
| NextToken |
string |
任意 |
次の結果ページを取得するために使用されるトークン。 |
sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA |
| SortField |
string |
任意 |
クエリ結果のソートに使用されるフィールド。 有効値:
|
Name |
| SortOrder |
string |
任意 |
エントリがソートされる順序。 有効値:
|
Descending |
| Path |
string |
任意 |
パラメーターのパス。 たとえば、パラメーターの名前が /path/path1/Myparameter の場合、パラメーターのパスは /path/path1/ です。 |
/path1/path2/ |
| Recursive |
boolean |
任意 |
指定されたパス内のすべてのレベルのディレクトリからパラメーターを照会するかどうかを指定します。 デフォルト値:false。 |
false |
| Tags |
object |
任意 |
パラメーターのタグ。 |
{"k1": "v1", "k2": "v2"} |
| ResourceGroupId |
string |
任意 |
リソースグループの ID。 |
rg-acfmxsn4m4****** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| NextToken |
string |
次の結果ページを取得するために使用されるトークン。 |
sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA |
| RequestId |
string |
リクエストの ID。 |
CA9C6248-AF2A-4AE9-A166-88FD901BBB90 |
| MaxResults |
integer |
1ページあたりに返されるエントリ数。 |
50 |
| Parameters |
array<object> |
パラメーターに関する情報。 |
|
|
array<object> |
|||
| Type |
string |
パラメーターのタイプ。 |
Secret |
| UpdatedDate |
string |
パラメーターが更新された時間。 |
2020-09-01T09:35:17Z |
| UpdatedBy |
string |
パラメーターを更新したユーザー。 |
root(130900000) |
| KeyId |
string |
暗号化に使用される KMS カスタマーマスターキー (CMK) の ID。 |
80e9409f-78fa-42ab-84bd-83f40c****** |
| Tags |
object |
パラメーターのタグ。 |
{"k1": "v1", "k2": "v2"} |
| Description |
string |
パラメーターの説明。 |
SecretParameter |
| ResourceGroupId |
string |
リソースグループの ID。 |
rg-acfmxsn4m4****** |
| CreatedBy |
string |
パラメーターを作成したユーザー。 |
root(130900000) |
| CreatedDate |
string |
パラメーターが作成された時間。 |
2020-09-01T09:28:47Z |
| ParameterVersion |
string |
パラメーターのバージョン番号。 |
1 |
| Name |
string |
パラメーターの名前。 |
MySecretParameter |
| Id |
string |
パラメーターの ID。 |
p-14ed150fdcd048xxxxxx |
| ShareType |
string |
パラメーターの共有タイプ。 |
Private |
例
成功レスポンス
JSONJSON
{
"NextToken": "sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA",
"RequestId": "CA9C6248-AF2A-4AE9-A166-88FD901BBB90",
"MaxResults": 50,
"Parameters": [
{
"Type": "Secret",
"UpdatedDate": "2020-09-01T09:35:17Z",
"UpdatedBy": "root(130900000)",
"KeyId": "80e9409f-78fa-42ab-84bd-83f40c******",
"Tags": {
"k1": "v1",
"k2": "v2"
},
"Description": "SecretParameter",
"ResourceGroupId": "rg-acfmxsn4m4******",
"CreatedBy": "root(130900000)",
"CreatedDate": "2020-09-01T09:28:47Z",
"ParameterVersion": "1",
"Name": "MySecretParameter",
"Id": "p-14ed150fdcd048xxxxxx",
"ShareType": "Private"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。