幫助中心
首頁 IPv6 Gateway 開發參考 API參考 API目錄 IPv6網關 DescribeIpv6Addresses - 查詢IPv6地址清單

DescribeIpv6Addresses - 查詢IPv6地址清單

更新時間：
Copy as MD

查詢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 個字元，不能以http://或https://開頭。

test
AddressType

string

否

IPv6 地址的類型，取值：

  • IPv6Address（預設值）：代表查詢單 IPv6 IP 的 IPv6 執行個體。

  • IPv6Prefix：代表查詢首碼網段的 IPv6 執行個體。

IPv6Address
AssociatedInstanceId

string

否

要查詢的 IPv6 地址關聯的執行個體 ID。

i-2ze72wuqj4y3jl4f****
AssociatedInstanceType

string

否

要查詢的 IPv6 地址所關聯的執行個體類型，取值：

  • EcsInstance：VPC 類型的 ECS。

  • NetworkInterface：輔助彈性網卡 ENI。

EcsInstance
NetworkType

string

否

要查詢的 IPv6 地址的通訊能力類型，取值：

  • Private：私網通訊類型。

  • Public：公網通訊類型。

Private
VpcId

string

否

要查詢的 IPv6 地址所在的 VPC ID。

vpc-bp15zckdt37pq72zv****
VSwitchId

string

否

要查詢的 IPv6 地址所在的交換器 ID。

vsw-25navfgbue4g****
Ipv6InternetBandwidthId

string

否

開通公網頻寬後，要查詢的 IPv6 地址對應的公網頻寬執行個體 ID。

ipv6bw-uf6hcyzu65v98v3du****
IncludeReservationData

boolean

否

是否包含未生效的訂購資料，取值：

  • false（預設值）：不包含未生效的訂購資料。

  • true：包含未生效的訂購資料。

false
ResourceGroupId

string

否

IPv6 網關所屬的資源群組 ID。

rg-bp67acfmxazb4ph****
Tag

array<object>

否

標籤列表。列表元素最大數量：20。

object

否

資源的標籤集合。

Key

string

否

資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。

一個標籤鍵最多支援 128 個字元，不能以aliyun和acs:開頭，不能包含http://或者https://。

FinanceDept
Value

string

否

資源的標籤值。最多支援輸入 20 個標籤值。一旦傳入該值，可以為空白字串。

一個標籤值最多支援 128 個字元，必須以字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短劃線（-），不能以aliyun和acs:開頭，不能包含http://或者https://。

yunke
PageNumber

integer

否

列表的頁碼，預設值：1。

1
PageSize

integer

否

分頁查詢時每頁的行數，最大值：50；預設值：10。

10
RegionId

string

是

要查詢的 IPv6 地址所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。

cn-huhehaote
ServiceManaged

boolean

否

是否為受管理的執行個體。取值：

  • true：是受管理的執行個體。

  • false：不是受管理的執行個體。

不填預設查詢所有執行個體。

false

返回參數

名稱

類型

描述

樣本值

object

PageSize

integer

分頁查詢時每頁的行數，最大值為 50，預設值為 10。

10
RequestId

string

請求 ID。

AA4486A8-B6AE-469E-AB09-820EF8ECFA2B
PageNumber

integer

列表的頁碼，預設值為 1。

1
TotalCount

integer

列表條目數。

2
Ipv6Addresses

object

Ipv6Address

array<object>

IPv6 地址的詳細資料。

array<object>

Ipv6 地址的詳細資料。

VpcId

string

IPv6 地址所在的 VPC ID。

vpc-bp15zckdt37pq72zv****
Status

string

IPv6 地址的狀態，取值：

  • Pending：配置中。

  • Available：可用。

Available
Ipv6AddressId

string

IPv6 地址的執行個體 ID。

ipv6-2zen5j4axcp5l5qyy****
AllocationTime

string

IPv6 地址的建立時間。

2020-12-20T14:56:09Z
Ipv6AddressName

string

IPv6 地址的執行個體名稱。

test
Ipv6AddressDescription

string

IPv6 地址的執行個體描述。

test
AssociatedInstanceType

string

IPv6 地址關聯的執行個體類型。

EcsInstance
AssociatedInstanceId

string

IPv6 地址關聯的執行個體 ID。

i-2ze72wuqj4y3jl4f****
NetworkType

string

IPv6 地址的通訊能力類型，取值：

  • Private：私網通訊類型。

  • Public：公網通訊類型 。

Private
Ipv6Address

string

IPv6 地址。

2408:XXXX:153:3921:851c:c435:7b12:1c5f
AddressType

string

IPv6 地址的類型，取值：

  • IPv6Address（預設值）：代表當前執行個體是單個 IPv6 IP。

  • IPv6Prefix：代表當前執行個體是 IPv6 Cidr。

IPv6Address
Ipv6Isp

string

IPv6 地址的服務電訊廠商，取值：

  • BGP（預設值）：阿里雲 BGP IPv6。

  • ChinaMobile：中國移動（單線）。

  • ChinaUnicom：中國聯通（單線）。

  • ChinaTelecom：中國電信（單線）。

BGP
VSwitchId

string

IPv6 地址所在的交換器的 ID。

vsw-25navfgbue4g****
Ipv6GatewayId

string

IPv6 地址的所屬 IPv6 網關執行個體 ID。

ipv6gw-2zewg0l66s73b4k2q****
RealBandwidth

integer

IPv6 地址的實際頻寬峰值。

5
Ipv6InternetBandwidth

object

IPv6 地址的公網頻寬資訊。

InternetChargeType

string

IPv6 地址的公網頻寬的計費方式，取值：

  • PayByTraffic：按使用流量計費。

  • PayByBandwidth：按固定頻寬計費。

PayByTraffic
BusinessStatus

string

IPv6 地址的公網頻寬的商業狀態，取值：

  • Normal：正常。

  • FinancialLocked：欠費鎖定。

  • SecurityLocked：安全鎖定。

Normal
Bandwidth

integer

IPv6 地址的獨享公網頻寬，單位：Mbps。

5
Ipv6InternetBandwidthId

string

IPv6 地址的公網頻寬執行個體 ID。

ipv6bw-hp3b35oq1fj50kbv****
InstanceChargeType

string

IPv6 地址的公網頻寬的付費方式，取值：

PostPaid：後付費。

PostPaid
HasReservationData

boolean

是否有續約資料。

  • false：無續約資料。

  • true：有續約資料。只有在入參 IncludeReservationData 為 true，且有未生效訂購資料時才會為 true。

false
ReservationInternetChargeType

string

續約付費類型。

  • PayByTraffic：按使用流量計費。

  • PayByBandwidth：按固定頻寬計費。

PayByTraffic
ReservationOrderType

string

續約訂單類型。取值：RENEW，表示續約訂單。

RENEW
ReservationActiveTime

string

續約生效時間，格式為YYYY-MM-DDThh:mm:ssZ。

2021-05-23T16:00:00Z
ReservationBandwidth

integer

續約頻寬。單位：Mbps。

12
ResourceGroupId

string

IPv6 網關所屬的資源群組 ID。

rg-bp67acfmxazb4ph****
Tags

object

Tag

array<object>

標籤列表。

object

標籤列表資訊。

Key

string

資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。

一個標籤鍵最多支援 128 個字元，不能以aliyun和acs:開頭，不能包含http://或者https://。

FinanceDept
Value

string

標籤的標籤值。

標籤值最多支援 128 個字元，可以為空白字串，不能以aliyun和acs:開頭，不能包含http://或者https://。

一個標籤鍵對應一個標籤值。一次最多支援輸入 20 個標籤值。

yunke
ServiceManaged

integer

是否為受管理的執行個體。取值：

  • 1：是受管理的執行個體。

  • 0：不是受管理的執行個體。

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非法
400 IllegalParamSize.AssociatedInstanceId The param size of AssociatedInstanceId is illegal. 參數AssociatedInstanceId長度非法
400 MissingParam.AssociatedInstanceId The param of AssociatedInstanceId is missing when AssociatedInstanceType is specified. 參數AssociatedInstanceId缺失

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

變更歷史

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

上一篇：DescribeIpv6EgressOnlyRules下一篇：DescribeIpv6GatewayAttribute - 查詢指定IPv6網關的詳細資料