DescribePrefixLists - 查詢首碼列表 - Elastic Compute Service

調用DescribePrefixLists查詢一個或多個首碼列表的資訊。

介面說明

請求參數AddressFamily、PrefixListId.N和PrefixListName類似於過濾器，為邏輯與（AND）關係。如果某一參數為空白，則過濾器不起作用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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	否	查詢憑證（Token）。取值為上一次調用該介面返回的`NextToken`參數值，初次調用介面時無需設定該參數。	AAAAAdDWBF2****
MaxResults	integer	否	分頁查詢時每頁行數。最大值：100。預設值：10。	10
AddressFamily	string	否	首碼列表的地址族。取值範圍： IPv4。 IPv6。預設值：空，查詢所有首碼列表資訊。	IPv4
PrefixListId	array	否	首碼列表 ID。N 的取值範圍：0~100。	pl-x1j1k5ykzqlixdcy****
	string	否	首碼列表 ID。N 的取值範圍：0~100。	pl-x1j1k5ykzqlixdcy****
ResourceGroupId	string	否	首碼列表所屬的企業資源組 ID。	rg-bp67acfmxazb4p****
Tag	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	首碼列表的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，則不允許為空白字串。最多支援 128 個字元，不能以 aliyun 和 acs:開頭，不能包含`http://或者 https://`。	TestKey
Value	string	否	首碼列表的標籤值。N 的取值範圍：1~20。該值可以為空白字串。最多支援 128 個字元，不能包含`http://或 https://`。	TestValue

返回參數

名稱	類型	描述	樣本值
	object
NextToken	string	本次調用返回的查詢憑證（Token）。當該傳回值為空白時，表示無更多返回的資料資訊。	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	首碼列表的地址族。可能值： IPv4。 IPv6。	IPv4
PrefixListName	string	首碼列表的名稱。	PrefixListNameSample
PrefixListId	string	首碼列表 ID。	pl-x1j1k5ykzqlixdcy****
Tags	object
Tag	array<object>	標籤列表。
	object	標籤列表。
TagValue	string	首碼列表的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，則不允許為空白字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	TestKey
TagKey	string	首碼列表的標籤值。N 的取值範圍：1~20。該值可以為空白字串。最多支援 128 個字元，不能包含`http://或 https://`。	TestValue
ResourceGroupId	string	首碼列表所屬的企業資源組 ID。	rg-bp67acfmxazb4p****

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
400	InvalidParameter	%s	無效的參數。
400	LimitExceed.PrefixListId	The specified number of PrefixListId exceeds the limit.	PrefixListId的數量超出限制。
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定的地區 ID 不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。