查詢IPv6地址列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vpc:DescribeIpv6Addresses | list | *Ipv6InternetBandwidth acs:vpc:{#regionId}:{#accountId}:vpc/* |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 要查詢的 IPv6 地址所在的地域 ID。您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-huhehaote |
Ipv6AddressId | string | 否 | 要查詢的 IPv6 地址 ID。每次調用最多可以輸入 20 個 IPv6 地址 ID,以半角逗號(,)分隔。 | ipv6-2zen5j4axcp5l5qyy**** |
Ipv6Address | string | 否 | 要查詢的 IPv6 地址。 | 2408:XXXX:153:3921:851c:c435:7b12:1c5f |
Name | string | 否 | 要查詢的 IPv6 地址的名稱。 名稱長度為 0-128 個字符,不能以 | test |
AddressType | string | 否 | IPv6 地址的類型,取值:
| IPv6Address |
AssociatedInstanceId | string | 否 | 要查詢的 IPv6 地址關聯的實例 ID。 | i-2ze72wuqj4y3jl4f**** |
AssociatedInstanceType | string | 否 | 要查詢的 IPv6 地址所關聯的實例類型,取值:
| EcsInstance |
NetworkType | string | 否 | 要查詢的 IPv6 地址的通信能力類型,取值:
| Private |
VpcId | string | 否 | 要查詢的 IPv6 地址所在的 VPC ID。 | vpc-bp15zckdt37pq72zv**** |
VSwitchId | string | 否 | 要查詢的 IPv6 地址所在的交換機 ID。 | vsw-25navfgbue4g**** |
Ipv6InternetBandwidthId | string | 否 | 開通公網帶寬后,要查詢的 IPv6 地址對應的公網帶寬實例 ID。 | ipv6bw-uf6hcyzu65v98v3du**** |
IncludeReservationData | boolean | 否 | 是否包含未生效的訂購數據,取值:
| false |
ResourceGroupId | string | 否 | IPv6 網關所屬的資源組 ID。 | rg-bp67acfmxazb4ph**** |
Tag | array<object> | 否 | 標簽列表。列表元素最大數量:20。 | |
object | 否 | 資源的標簽集合。 | ||
Key | string | 否 | 資源的標簽鍵。最多支持輸入 20 個標簽鍵。如需傳入該值,則不能輸入空字符串。 一個標簽鍵最多支持 128 個字符,不能以 | FinanceDept |
Value | string | 否 | 資源的標簽值。最多支持輸入 20 個標簽值。一旦傳入該值,可以為空字符串。 一個標簽值最多支持 128 個字符,必須以字母或中文開頭,可包含數字、半角句號(.)、下劃線(_)和短劃線(-),不能以 | yunke |
PageNumber | integer | 否 | 列表的頁碼,默認值:1。 | 1 |
PageSize | integer | 否 | 分頁查詢時每頁的行數,最大值:50;默認值:10。 | 10 |
ServiceManaged | boolean | 否 | 是否為托管實例。取值:
不填默認查詢所有實例。 | false |
返回參數
示例
正常返回示例
JSON
格式
{
"PageSize": 10,
"RequestId": "AA4486A8-B6AE-469E-AB09-820EF8ECFA2B",
"PageNumber": 1,
"TotalCount": 2,
"Ipv6Addresses": {
"Ipv6Address": [
{
"VpcId": "vpc-bp15zckdt37pq72zv****",
"Status": "Available",
"Ipv6AddressId": "ipv6-2zen5j4axcp5l5qyy****",
"AllocationTime": "2020-12-20T14:56:09Z",
"Ipv6AddressName": "test",
"Ipv6AddressDescription": "test",
"AssociatedInstanceType": "EcsInstance",
"AssociatedInstanceId": "i-2ze72wuqj4y3jl4f****",
"NetworkType": "Private",
"Ipv6Address": "2408:XXXX:153:3921:851c:c435:7b12:1c5f",
"AddressType": "IPv6Address",
"Ipv6Isp": "BGP",
"VSwitchId": "vsw-25navfgbue4g****",
"Ipv6GatewayId": "ipv6gw-2zewg0l66s73b4k2q****",
"RealBandwidth": 5,
"Ipv6InternetBandwidth": {
"InternetChargeType": "PayByTraffic",
"BusinessStatus": "Normal",
"Bandwidth": 5,
"Ipv6InternetBandwidthId": "ipv6bw-hp3b35oq1fj50kbv****",
"InstanceChargeType": "PostPaid",
"HasReservationData": false,
"ReservationInternetChargeType": "PayByTraffic",
"ReservationOrderType": "RENEW",
"ReservationActiveTime": "2021-05-23T16:00:00Z",
"ReservationBandwidth": 12
},
"ResourceGroupId": "rg-bp67acfmxazb4ph****",
"Tags": {
"Tag": [
{
"Key": "FinanceDept",
"Value": "yunke"
}
]
},
"ServiceManaged": 1
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.Ipv6Address | The param of %s is illegal. | 您指定的ipv6地址非法,請檢查您的輸入是否正確 |
400 | IllegalParam.NetworkType | The param of %s is illegal. | 您輸入的NetworkType非法,請檢查您的輸入是否正確 |
400 | IllegalParam.AddressType | The specified AddressType is illegal. | 指定的入參AddressType非法 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-06-28 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-03-14 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-05-29 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |