DescribeRdsVpcs - PolarDB - Alibaba Cloud Documentation Center

Queries the list of VPCs for PolarDB-X.

Operation description

Queries the list of virtual private clouds (VPCs) available under your account. You can use this operation to select an appropriate network environment when creating or managing database instances.

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

polardbx:DescribeRdsVpcs

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. > You can call the DescribeRegions operation to query the regions supported by PolarDB-X, including region IDs.	cn-zhangjiakou
ZoneId	string	No	The zone ID.	cn-beijing-h

Response elements

Element	Type	Description	Example
	object
Vpcs	object	The VPC information.
Vpc	array<object>	The VPC information.
	array<object>	The VPC information.
Status	string	The VPC status.	True
VpcName	string	The name of the VPC.	cloud_auto_test
VpcId	string	The ID of the VPC.	vpc-2zekldxxy28nobay7o1f3
IsDefault	boolean	Indicates whether the VPC is the default VPC. Valid values: true: The VPC is the default VPC. false: The VPC is not the default VPC.	False
CidrBlock	string	The IPv4 CIDR block of the VPC.	47.121.246.0/24
RegionNo	string	The region in which the VPC resides.	cn-shanghai
GmtCreate	string	The time when the VPC was created.	Mon May 12 10:13:14 CST 2025
AliUid	string	The Alibaba Cloud account ID.	314****36
VSwitchs	array<object>	The vSwitch information of the VPC.
	object	The vSwitch information of the VPC.
Status	string	The vSwitch status.	Available
VSwitchId	string	The vSwitch ID.	vsw-8vbkwmpn****4nrd639ih
IsDefault	boolean	Indicates whether the vSwitch is the default vSwitch.	false
CidrBlock	string	The vSwitch CIDR block.	10.0.0.0/24
GmtCreate	string	The time when the vSwitch was created. The value is a UNIX timestamp accurate to milliseconds.	1574156944000
GmtModified	string	The time when the vSwitch was last modified. The value is a UNIX timestamp.	2025-09-03T19:19:13+08:00
IzNo	string	The zone ID.	cn-beijing-g
VSwitchName	string	The name of the vSwitch.	cloud_auto_g
GmtModified	string	The time when the VPC was last modified.	2024-09-29 17:47:56
Bid	string	The VPC ID.	26842
RequestId	string	The request ID.	4C1A7CFB-9F73-5041-8C74-27626E58985A

Examples

Success response

JSON format

{
  "Vpcs": {
    "Vpc": [
      {
        "Status": "True",
        "VpcName": "cloud_auto_test",
        "VpcId": "vpc-2zekldxxy28nobay7o1f3",
        "IsDefault": true,
        "CidrBlock": "47.121.246.0/24",
        "RegionNo": "cn-shanghai",
        "GmtCreate": "Mon May 12 10:13:14 CST 2025",
        "AliUid": "314****36",
        "VSwitchs": [
          {
            "Status": "Available",
            "VSwitchId": "vsw-8vbkwmpn****4nrd639ih",
            "IsDefault": false,
            "CidrBlock": "10.0.0.0/24",
            "GmtCreate": "1574156944000",
            "GmtModified": "2025-09-03T19:19:13+08:00",
            "IzNo": "cn-beijing-g",
            "VSwitchName": "cloud_auto_g"
          }
        ],
        "GmtModified": "2024-09-29 17:47:56",
        "Bid": "26842"
      }
    ]
  },
  "RequestId": "4C1A7CFB-9F73-5041-8C74-27626E58985A"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.