アカウント配下のすべてのカスタムリストとその詳細を一覧表示します。クエリパラメーターを使用して結果をフィルターし、ページングして特定のリストセットを取得できます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
esa:ListLists |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| QueryArgs |
object |
任意 |
JSON フォーマットで渡されるクエリパラメーター。さまざまなフィルター条件が含まれます。 |
ListLists |
| IdLike |
string |
任意 |
リスト ID のあいまい一致に使用される値。 |
40000001 |
| NameLike |
string |
任意 |
リスト名のあいまい一致に使用される値。 |
example |
| DescriptionLike |
string |
任意 |
リストの説明のあいまい一致に使用される値。 |
a custom list |
| ItemLike |
string |
任意 |
リスト内容のあいまい一致に使用される値。 |
10.1.1.1 |
| NameItemLike |
string |
任意 |
リスト内容とリスト名の両方を同時にあいまい一致させるために使用される値。 |
10.1.1.1 |
| Kind |
string |
任意 |
カスタムリストの種類。 |
ip |
| OrderBy |
string |
任意 |
結果のソートに使用する列。 |
id |
| Desc |
boolean |
任意 |
結果を降順でソートするかどうかを指定します。 |
true |
| PageNumber |
integer |
任意 |
ページング用のページ番号。 |
1 |
| PageSize |
integer |
任意 |
ページング用の 1 ページあたりのエントリ数。 |
20 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| RequestId |
string |
リクエストの ID。 |
36af3fcc-43d0-441c-86b1-428951dc8225 |
| TotalCount |
integer |
フィルター適用後のレコードの総数。 |
5 |
| Usage |
integer |
ユーザーによって消費された使用量。 |
10 |
| Lists |
array<object> |
リスト情報の配列。ページングされたリストデータがフォーマットに含まれます。 |
|
|
object |
リスト情報のフォーマット。 |
||
| UpdateTime |
string |
リストが最後に変更済みの時間。 フォーマット: RFC 3339 / ISO 8601、協定世界時 (UTC) タイムゾーン (末尾は Z)。 例: 2026-06-10T14:23:45Z |
2024-01-01T00:00:00Z |
| Id |
integer |
カスタムリストの ID。 ListLists 操作を呼び出すことで ID を取得できます。 |
40000001 |
| Name |
string |
リストの名前。 |
example |
| Kind |
string |
リストの種類。 |
ip |
| Description |
string |
リストの説明。 |
a custom list |
| Length |
integer |
リスト内容配列の長さ。リスト内の項目数を示します。 |
100 |
| PageNumber |
integer |
現在のページ番号。 |
1 |
| PageSize |
integer |
1 ページあたりのエントリ数。 |
20 |
| ItemsUsage |
integer |
項目の使用量の合計。 |
5000 |
例
成功レスポンス
JSONJSON
{
"RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
"TotalCount": 5,
"Usage": 10,
"Lists": [
{
"UpdateTime": "2024-01-01T00:00:00Z",
"Id": 40000001,
"Name": "example",
"Kind": "ip",
"Description": "a custom list",
"Length": 100
}
],
"PageNumber": 1,
"PageSize": 20,
"ItemsUsage": 5000
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | 入力パラメーターのフォーマット検証が失敗しました。有効な値を指定してください。 |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | サービスの呼び出しに失敗しました。後でもう一度お試しいただくか、詳細についてはカスタマーサポートにお問い合わせください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。