DescribePrefixLists - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

プレフィックスリストの情報を照会します。

操作説明

リクエストでは、AddressFamily、PrefixListId.N、PrefixListName などのリクエストパラメーターを指定できます。指定されたパラメーター間は論理 AND 関係です。設定したパラメーターのみがフィルター条件に含まれます。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribePrefixLists

get

*PrefixList

acs:ecs:{#regionId}:{#accountId}:prefixlist/{#PrefixListId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions 操作を呼び出すと、最新のリージョンリストを照会できます。	cn-chengdu
RegionId	string	必須	リージョン ID。 DescribeRegions 操作を呼び出すと、最新のリージョンリストを照会できます。	cn-chengdu
PrefixListName	string	任意	プレフィックスリストの名前。	PrefixListNameSample
NextToken	string	任意	結果の新しいページを取得するためにリクエストで使用されるページネーショントークン。この操作を前回呼び出した際に返された `NextToken` の値を設定します。この操作を初めて呼び出す場合は、このパラメーターを空のままにしてください。	AAAAAdDWBF2****
MaxResults	integer	任意	1 ページあたりのエントリ数。有効値：1～100。デフォルト値：10。	10
AddressFamily	string	任意	IP アドレスファミリー。有効値： IPv4 IPv6 デフォルトでは、このパラメーターは空です。これは、すべてのプレフィックスリストが照会されることを意味します。	IPv4
PrefixListId	array	任意	プレフィックスリストの ID。 N の有効値：0～100。	pl-x1j1k5ykzqlixdcy****
	string	任意	プレフィックスリスト N の ID。 N の有効値：0～100。	pl-x1j1k5ykzqlixdcy****
ResourceGroupId	string	任意	プレフィックスリストが属するリソースグループの ID。	rg-bp67acfmxazb4p****
Tag	array<object>	任意	プレフィックスリストのタグ。
	object	任意	プレフィックスリストのタグ N。
Key	string	任意	プレフィックスリストのタグ N のキー。 N の有効値：1～20。タグキーは空の文字列にできません。タグキーの長さは最大 128 文字です。 aliyun または acs: で始めることはできず、http:// または `https://` を含めることはできません。	TestKey
Value	string	任意	プレフィックスリストのタグ N の値。 N の有効値：1～20。タグ値は空の文字列にできます。タグ値の長さは最大 128 文字で、http:// または `https://` を含めることはできません。	TestValue

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	今回の呼び出しで返されるクエリートークン。戻り値が空の場合、それ以上データは返されません。	AAAAAdDWBF2****
RequestId	string	リクエスト ID。	38793DB8-A4B2-4AEC-BFD3-111234E9188D
PrefixLists	object
PrefixList	array<object>	プレフィックスリストの詳細。
	array<object>
CreationTime	string	プレフィックスリストが作成された時間。	2021-02-20T07:11Z
AssociationCount	integer	関連付けられたリソースの数。	1
MaxEntries	integer	プレフィックスリストに含めることができるエントリの最大数。	20
Description	string	プレフィックスリストの説明。	This is description.
AddressFamily	string	プレフィックスリストの IP アドレスファミリー。有効値： IPv4 IPv6	IPv4
PrefixListName	string	プレフィックスリストの名前。	PrefixListNameSample
PrefixListId	string	プレフィックスリストの ID。	pl-x1j1k5ykzqlixdcy****
Tags	object
Tag	array<object>	プレフィックスリストのタグ。
	object	プレフィックスリストのタグ。
TagValue	string	タグキー。プレフィックスリストには 1～20 個のタグを付与できます。タグキーは空の文字列にできません。タグキーの長さは最大 128 文字で、`acs:` または `aliyun` で始めることはできません。 `http://` または `https://` を含めることはできません。	TestKey
TagKey	string	タグ値。プレフィックスリストには 1～20 個のタグを付与できます。タグ値は空の文字列にできます。タグ値の長さは最大 128 文字で、http:// または `https://` を含めることはできません。	TestValue
ResourceGroupId	string	プレフィックスリストが属するリソースグループの ID。	rg-bp67acfmxazb4p****

例

成功レスポンス

JSONJSON

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D",
  "PrefixLists": {
    "PrefixList": [
      {
        "CreationTime": "2021-02-20T07:11Z",
        "AssociationCount": 1,
        "MaxEntries": 20,
        "Description": "This is description.",
        "AddressFamily": "IPv4",
        "PrefixListName": "PrefixListNameSample",
        "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestKey",
              "TagKey": "TestValue\n"
            }
          ]
        },
        "ResourceGroupId": "rg-bp67acfmxazb4p****\n"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter	%s
400	LimitExceed.PrefixListId	The specified number of PrefixListId exceeds the limit.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.

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

変更履歴

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