All Products
Search

This Product

    Virtual Private Cloud:DescribeIpv6Addresses

    Document Center

    Virtual Private Cloud:DescribeIpv6Addresses

    Last Updated:Aug 28, 2026

    Queries IPv6 addresses in a region.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    vpc:DescribeIpv6Addresses

    list

    *Ipv6InternetBandwidth

    acs:vpc:{#regionId}:{#accountId}:vpc/*

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. Call DescribeRegions to query available regions.

    cn-huhehaote
    Ipv6AddressId

    string

    No

    The IPv6 address ID. Specify up to 20 IDs, separated by commas (,).

    ipv6-2zen5j4axcp5l5qyy****
    Ipv6Address

    string

    No

    The IPv6 address that you want to query.

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

    string

    No

    The IPv6 address name.

    Must be 0 to 128 characters. Cannot start with http:// or https://.

    test
    AddressType

    string

    No

    The type of IP address. Valid values:

    • IPv6Address (default): a single IPv6 address.

    • IPv6Prefix: IPv6 prefix CIDR blocks.

    IPv6Address
    AssociatedInstanceId

    string

    No

    The ID of the instance that is assigned the IPv6 address.

    i-2ze72wuqj4y3jl4f****
    AssociatedInstanceType

    string

    No

    The type of instance associated with the IPv6 address. Valid values:

    • EcsInstance: ECS instance in a VPC

    • NetworkInterface: secondary ENI

    EcsInstance
    NetworkType

    string

    No

    The type of communication supported by the IPv6 address. Valid values:

    • Private

    • Public

    Private
    VpcId

    string

    No

    The ID of the VPC to which the IPv6 address belongs.

    vpc-bp15zckdt37pq72zv****
    VSwitchId

    string

    No

    The ID of the vSwitch to which the IPv6 address belongs.

    vsw-25navfgbue4g****
    Ipv6InternetBandwidthId

    string

    No

    The Internet bandwidth ID of the IPv6 address.

    ipv6bw-uf6hcyzu65v98v3du****
    IncludeReservationData

    boolean

    No

    Specifies whether to return information about pending orders. Valid values:

    • false (default)

    • true

    false
    ResourceGroupId

    string

    No

    The ID of the resource group to which the IPv6 gateway belongs.

    rg-bp67acfmxazb4ph****
    Tag

    array<object>

    No

    The tag list.

    object

    No

    The tag list.

    Key

    string

    No

    The tag key. Specify up to 20 tag keys. Cannot be an empty string.

    Maximum length: 128 characters. Cannot start with aliyun or acs:, or contain http:// or https://.

    FinanceDept
    Value

    string

    No

    The tag value. Can be an empty string.

    Maximum length: 128 characters. Cannot start with aliyun or acs:, or contain http:// or https://.

    Each tag key has one tag value. Specify up to 20 tag values.

    yunke
    PageNumber

    integer

    No

    The page number. Default value: 1.

    1
    PageSize

    integer

    No

    The number of entries per page. Maximum value: 50. Default value: 10.

    10
    RegionId

    string

    Yes

    The region ID. Call DescribeRegions to query available regions.

    cn-huhehaote
    ServiceManaged

    boolean

    No

    Indicates whether the instance is managed. Valid values:

    • true

    • false

    If not specified, all instances are queried.

    false

    Response elements

    Element

    Type

    Description

    Example

    object

    PageSize

    integer

    The number of entries per page. Maximum: 50. Default: 10.

    10
    RequestId

    string

    The request ID.

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

    integer

    The page number. Default: 1.

    1
    TotalCount

    integer

    The number of returned entries.

    2
    Ipv6Addresses

    object

    Ipv6Address

    array<object>

    The details of the IPv6 address.

    array<object>

    VpcId

    string

    The ID of the VPC to which the IPv6 address belongs.

    vpc-bp15zckdt37pq72zv****
    Status

    string

    The status of the IPv6 address.

    • Pending

    • Available

    Available
    Ipv6AddressId

    string

    The ID of the IPv6 address.

    ipv6-2zen5j4axcp5l5qyy****
    AllocationTime

    string

    The time when the IPv6 address was created.

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

    string

    The name of the IPv6 address.

    test
    Ipv6AddressDescription

    string

    The description of the IPv6 address.

    test
    AssociatedInstanceType

    string

    The type of instance associated with the IPv6 address.

    EcsInstance
    AssociatedInstanceId

    string

    The ID of the instance associated with the IPv6 address.

    i-2ze72wuqj4y3jl4f****
    NetworkType

    string

    The type of connection supported by the IPv6 address. Valid values:

    • Private

    • Public

    Private
    Ipv6Address

    string

    The IPv6 address.

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

    string

    The type of IPv6 address. Valid values:

    • IPv6Address (default): a single IPv6 address.

    • IPv6Prefix: an IPv6 prefix CIDR block.

    IPv6Address
    Ipv6Isp

    string

    The ISP of the IPv6 address. Valid values:

    • BGP (default)

    • ChinaMobile

    • ChinaUnicom

    • ChinaTelecom

    BGP
    VSwitchId

    string

    The ID of the vSwitch to which the IPv6 address belongs.

    vsw-25navfgbue4g****
    Ipv6GatewayId

    string

    The ID of the IPv6 gateway to which the IPv6 address belongs.

    ipv6gw-2zewg0l66s73b4k2q****
    RealBandwidth

    integer

    The peak bandwidth of the IPv6 address.

    5
    Ipv6InternetBandwidth

    object

    The Internet bandwidth of the IPv6 address.

    InternetChargeType

    string

    The billing method of the Internet bandwidth of the IPv6 address. Valid values:

    • PayByTraffic

    • PayByBandwidth

    PayByTraffic
    BusinessStatus

    string

    The status of the Internet bandwidth of the IPv6 address. Valid values:

    • Normal

    • FinancialLocked

    • SecurityLocked

    Normal
    Bandwidth

    integer

    The dedicated Internet bandwidth of the IPv6 address. Unit: Mbit/s.

    5
    Ipv6InternetBandwidthId

    string

    The Internet bandwidth ID of the IPv6 address.

    ipv6bw-hp3b35oq1fj50kbv****
    InstanceChargeType

    string

    The billing method of the IPv6 Internet bandwidth.

    Only PostPaid (pay-as-you-go) is returned.

    PostPaid
    HasReservationData

    boolean

    Indicates whether renewal data is included. Valid values:

    • false

    • true: returned only when IncludeReservationData is set to true and some orders have not taken effect.

    false
    ReservationInternetChargeType

    string

    The metering method that is used after the renewal takes effect.

    • PayByTraffic

    • PayByBandwidth

    PayByTraffic
    ReservationOrderType

    string

    The type of the renewal order. Only RENEW may be returned, which indicates that the order is placed for service renewal.

    RENEW
    ReservationActiveTime

    string

    The time when the renewal takes effect. Format: YYYY-MM-DDThh:mm:ssZ.

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

    integer

    The maximum bandwidth after the renewal takes effect. Unit: Mbit/s.

    12
    ResourceGroupId

    string

    The ID of the resource group to which the IPv6 gateway belongs.

    rg-bp67acfmxazb4ph****
    Tags

    object

    Tag

    array<object>

    The tag list.

    object

    The tag list.

    Key

    string

    The tag key. Specify up to 20 tag keys. Cannot be an empty string.

    Maximum length: 128 characters. Cannot start with aliyun or acs:, or contain http:// or https://.

    FinanceDept
    Value

    string

    The tag value. Can be an empty string.

    Maximum length: 128 characters. Cannot start with aliyun or acs:, or contain http:// or https://.

    Each tag key has one tag value. Specify up to 20 tag values.

    yunke
    ServiceManaged

    integer

    Indicates whether the instance is managed. Valid values:

    • 1: yes

    • 0: no

    1

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 IllegalParam.Ipv6Address The param of %s is illegal. The IPv6 address is invalid.
    400 IllegalParam.NetworkType The param of %s is illegal. Invalid NetworkType value.
    400 IllegalParam.AddressType The specified AddressType is illegal. The specified input AddressType is illegal.
    400 IllegalParamSize.AssociatedInstanceId The param size of AssociatedInstanceId is illegal. Illegal parameter AssociatedInstanceId length
    400 MissingParam.AssociatedInstanceId The param of AssociatedInstanceId is missing when AssociatedInstanceType is specified. Missing parameter AssociatedInstanceId

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.