調(diào)用ListPublicIpAddressPools接口查詢可使用的IP地址池信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
vpc:ListPublicIpAddressPools | get | *PublicIpAddressPool acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/* |
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PublicIpAddressPoolIds | array | 否 | IP 地址池的實(shí)例 ID 列表。 您最多可輸入 100 個(gè) IP 地址池的實(shí)例 ID。 | |
string | 否 | IP 地址池的實(shí)例 ID 列表。 您最多可輸入 100 個(gè) IP 地址池的實(shí)例 ID。 | pippool-6wetvn6fumkgycssx**** | |
Status | string | 否 | IP 地址池實(shí)例狀態(tài)。取值:
| Created |
MaxResults | integer | 否 | 本次讀取的最大數(shù)據(jù)記錄數(shù)量。取值范圍:10~100。默認(rèn)值:10。 | 10 |
NextToken | string | 否 | 是否擁有下一次查詢的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
Isp | string | 否 | 線路類型。取值:
關(guān)于 BGP(多線)線路和 BGP(多線)_精品線路的更多信息,請(qǐng)參見 EIP 線路類型。 如果您是單線帶寬的白名單用戶,您還可以選擇以下類型:
如果您是杭州金融云用戶,該字段必填,取值:BGP_FinanceCloud。 | BGP |
Name | string | 否 | 地址池實(shí)例的名稱。 名稱長(zhǎng)度為 0-128 個(gè)字符,不能以 | AddressPoolName |
DryRun | boolean | 否 | 是否只預(yù)檢此次請(qǐng)求。取值:
| false |
ResourceGroupId | string | 否 | IP 地址池所屬的資源組 ID。 | rg-acfmxazb4pcdvf**** |
Tags | array<object> | 否 | 標(biāo)簽列表。 | |
object | 否 | 標(biāo)簽列表。 | ||
Key | string | 否 | 資源的標(biāo)簽鍵。最多支持輸入 20 個(gè)標(biāo)簽鍵。如需傳入該值,則不能輸入空字符串。 一個(gè)標(biāo)簽鍵最多支持 128 個(gè)字符,不能以 | FinanceDept |
Value | string | 否 | 資源的標(biāo)簽值。最多支持輸入 20 個(gè)標(biāo)簽值。如需傳入該值,可以輸入空字符串。 最多支持 128 個(gè)字符,不能以 | FinanceJoshua |
RegionId | string | 是 | 要查詢的 IP 地址池所在的地域 ID。 您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-chengdu |
SecurityProtectionEnabled | boolean | 否 | 是否開啟 DDoS 防護(hù)(增強(qiáng)版)。取值:
| true |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"TotalCount": 1,
"PublicIpAddressPoolList": [
{
"PublicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****",
"RegionId": "cn-chengdu",
"CreationTime": "2022-05-10T01:37:38Z",
"Isp": "BGP",
"Name": "AddressPoolName",
"Status": "Created",
"Description": "AddressPoolDescription",
"TotalIpNum": 100,
"UsedIpNum": 20,
"IpAddressRemaining": true,
"UserType": "admin",
"OwnerId": 0,
"ShareType": "Shared",
"ResourceGroupId": "rg-acfmxazb4pcdvf****",
"Tags": [
{
"Key": "FinanceDept",
"Value": "FinanceDept"
}
],
"BizType": "CloudBox",
"Zones": [
"ap-southeast-1-lzdvn-cb"
],
"SecurityProtectionTypes": [
"AntiDDoS_Enhanced"
],
"BusinessStatus": "Normal"
}
]
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.Isp | The param of Isp [%s] is illegal. | 參數(shù) Isp 不合法,請(qǐng)根據(jù)請(qǐng)求參數(shù)規(guī)定重新輸入。 |
400 | IllegalParam.NextToken | The specified NextToken is invalid. | 參數(shù)NextToken非法. |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-08-08 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2024-07-31 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2024-06-06 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2024-05-27 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2024-01-22 | OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2023-08-08 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2023-05-15 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |