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

プレフィックスリストの名前、アドレスファミリ、最大エントリ数、エントリの詳細など、プレフィックスリストの詳細を照会します。

今すぐお試しください

この 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:DescribePrefixListAttributes

get

*PrefixList

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-chengdu
RegionId	string	必須	リージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-chengdu
PrefixListId	string	必須	プレフィックスリストの ID。	pl-x1j1k5ykzqlixdcy****

レスポンスフィールド

フィールド	型	説明	例
	object
CreationTime	string	プレフィックスリストが作成された時間。	2021-02-20T07:11Z
MaxEntries	integer	プレフィックスリストの最大エントリ数。	10
RequestId	string	リクエスト ID。	38793DB8-A4B2-4AEC-BFD3-111234E9188D
Description	string	プレフィックスリストの説明。	This is description.
AddressFamily	string	プレフィックスリストの IP アドレスファミリ。有効な値： IPv4 IPv6	IPv4
PrefixListName	string	プレフィックスリストの名前。	PrefixListNameSample
PrefixListId	string	プレフィックスリストの ID。	pl-x1j1k5ykzqlixdcy****
Entries	object
Entry	array<object>	プレフィックスリストのエントリに関する詳細。
	object
Description	string	エントリ N の説明。	Description Sample 01
Cidr	string	エントリ N の CIDR ブロック。	192.168.1.0/24

例

成功レスポンス

JSONJSON

{
  "CreationTime": "2021-02-20T07:11Z",
  "MaxEntries": 10,
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D",
  "Description": "This is description.",
  "AddressFamily": "IPv4",
  "PrefixListName": "PrefixListNameSample",
  "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
  "Entries": {
    "Entry": [
      {
        "Description": "Description Sample 01",
        "Cidr": "192.168.1.0/24"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidPrefixListId.NotFound	The specified prefix list was not found.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.

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

変更履歴

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