調(diào)用DescribePrefixLists查詢一個(gè)或多個(gè)前綴列表的信息。
接口說明
請求參數(shù)AddressFamily、PrefixListId.N和PrefixListName類似于過濾器，為邏輯與（AND）關(guān)系。如果某一參數(shù)為空，則過濾器不起作用。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個(gè)操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:DescribePrefixLists | get | *PrefixList acs:ecs:{#regionId}:{#accountId}:prefixlist/{#PrefixListId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-chengdu |
| PrefixListName | string | 否 | 前綴列表的名稱。 | PrefixListNameSample |
| NextToken | string | 否 | 查詢憑證（Token）。取值為上一次調(diào)用該接口返回的 | AAAAAdDWBF2**** |
| MaxResults | integer | 否 | 分頁查詢時(shí)每頁行數(shù)。 最大值：100。 默認(rèn)值：10。 | 10 |
| AddressFamily | string | 否 | 前綴列表的地址族。取值范圍：
默認(rèn)值：空，查詢所有前綴列表信息。 | IPv4 |
| PrefixListId | array | 否 | 前綴列表 ID。N 的取值范圍：0~100。 | |
| string | 否 | 前綴列表 ID。N 的取值范圍：0~100。 | pl-x1j1k5ykzqlixdcy**** |
返回參數(shù)
示例
正常返回示例
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****"
}
]
}
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter | %s | 無效的參數(shù)。 |
| 400 | LimitExceed.PrefixListId | The specified number of PrefixListId exceeds the limit. | PrefixListId的數(shù)量超出限制。 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定的地域 ID 不存在。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2023-11-13 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |