DescribeIpv6Addresses - Virtual Private Cloud - Alibaba Cloud ドキュメントセンター

リージョン内の IPv6 アドレスをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	IPv6 アドレスをクエリするリージョンの ID を指定します。最新のリージョンリストは、DescribeRegions 操作を呼び出して確認できます。	cn-huhehaote
Ipv6AddressId	string	任意	クエリする IPv6 アドレスの ID を指定します。1 回の API リクエストで最大 20 個の IPv6 アドレス ID を入力できます。複数の 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	任意	IP アドレスのタイプを指定します。有効値： IPv6Address (デフォルト)：単一の IPv6 アドレスをクエリするための IPv6 インスタンスを示します。 IPv6Prefix：プレフィックス CIDR ブロックをクエリするための IPv6 インスタンスを示します。	IPv6Address
AssociatedInstanceId	string	任意	IPv6 アドレスが割り当てられているインスタンスの ID を指定します。	i-2ze72wuqj4y3jl4f****
AssociatedInstanceType	string	任意	IPv6 アドレスに関連付けられたインスタンスのタイプを指定します。有効値： EcsInstance：VPC 内の Elastic Compute Service (ECS) インスタンス NetworkInterface：セカンダリエラスティックネットワークインターフェース (ENI)	EcsInstance
NetworkType	string	任意	IPv6 アドレスがサポートする通信タイプを指定します。有効値： Private Public	Private
VpcId	string	任意	IPv6 アドレスが属する VPC の ID を指定します。	vpc-bp15zckdt37pq72zv****
VSwitchId	string	任意	IPv6 アドレスが属する vSwitch の ID を指定します。	vsw-25navfgbue4g****
Ipv6InternetBandwidthId	string	任意	IPv6 アドレス用に購入したインターネット帯域幅の ID を指定します。	ipv6bw-uf6hcyzu65v98v3du****
IncludeReservationData	boolean	任意	保留中の注文情報を返すかどうかを指定します。有効値： false (デフォルト) true	false
ResourceGroupId	string	任意	IPv6 ゲートウェイが属するリソースグループの ID を指定します。	rg-bp67acfmxazb4ph****
Tag	array<object>	任意	タグリストを指定します。
	object	任意	タグリストを指定します。
Key	string	任意	タグキー N を指定します。最大 20 個のタグキーを指定できます。タグキーは空文字列であってはいけません。タグキーの長さは最大 128 文字です。aliyun または acs: で始まってはならず、http:// または https:// を含んではいけません。	FinanceDept
Value	string	任意	タグ値 N を指定します。タグ値の長さは最大 128 文字です。空文字列であってもかまいません。aliyun または acs: で始まってはならず、http:// または https:// を含んではいけません。各タグキーには 1 つのタグ値が対応します。一度に最大 20 個のタグ値を指定できます。	yunke
PageNumber	integer	任意	ページ番号を指定します。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数を指定します。最大値：50。デフォルト値：10。	10
RegionId	string	必須	IPv6 アドレスをクエリするリージョンの ID を指定します。最新のリージョンリストは、DescribeRegions 操作を呼び出して確認できます。	cn-huhehaote
ServiceManaged	boolean	任意	インスタンスが管理されているかどうかを示します。有効値： true false このパラメーターを指定しない場合、すべてのインスタンスがクエリされます。	false

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	1 ページあたりに返されるエントリ数を示します。最大値：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>
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 アドレスの ISP を示します。有効値： BGP (デフォルト) ChinaMobile ChinaUnicom ChinaTelecom	BGP
VSwitchId	string	IPv6 アドレスが属する vSwitch の 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 アドレスの専用インターネット帯域幅を示します。単位：Mbit/s。	5
Ipv6InternetBandwidthId	string	IPv6 アドレスのインターネット帯域幅 ID を示します。	ipv6bw-hp3b35oq1fj50kbv****
InstanceChargeType	string	IPv6 アドレスのインターネット帯域幅の課金方法を示します。 PostPaid のみが返される可能性があります。これは従量課金を示します。	PostPaid
HasReservationData	boolean	更新データが含まれているかどうかを示します。有効値： false true true は、IncludeReservationData が 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	更新が適用された後の最大帯域幅です。単位：Mbit/s。	12
ResourceGroupId	string	IPv6 ゲートウェイが属するリソースグループの ID を示します。	rg-bp67acfmxazb4ph****
Tags	object
Tag	array<object>	タグリストを示します。
	object	タグリストを示します。
Key	string	タグキーを示します。最大 20 個のタグキーを指定できます。タグキーは空文字列であってはいけません。タグキーの長さは最大 128 文字です。`aliyun` または `acs:` で始まってはならず、`http://` または `https://` を含んではいけません。	FinanceDept
Value	string	タグ値を示します。タグ値の長さは最大 128 文字です。空文字列であってもかまいません。`aliyun` または `acs:` で始まってはならず、`http://` または `https://` を含んではいけません。各タグキーには 1 つのタグ値が対応します。一度に最大 20 個のタグ値を指定できます。	yunke
ServiceManaged	integer	インスタンスが管理されているかどうかを示します。有効値： 1：はい 0：いいえ	1

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ
400	IllegalParam.Ipv6Address	The param of %s is illegal.
400	IllegalParam.NetworkType	The param of %s is illegal.
400	IllegalParam.AddressType	The specified AddressType is illegal.
400	IllegalParamSize.AssociatedInstanceId	The param size of AssociatedInstanceId is illegal.
400	MissingParam.AssociatedInstanceId	The param of AssociatedInstanceId is missing when AssociatedInstanceType is specified.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。