DescribeRdsVpcs API Reference & Response Fields - ApsaraDB for MongoDB

Retrieves a list of VPCs.

Operation description

Queries available VPCs in a specified region and zone. Use this before creating an ApsaraDB for MongoDB instance to select a VPC.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ZoneId	string	No	The zone ID.	cn-beijing-l
ResourceGroupId	string	No	The resource group ID.	rg-acfmyiu4ekp****

Response elements

Element	Type	Description	Example
	object
Vpcs	object	A list of VPCs.
Vpc	array<object>	VPC details.
	array<object>
Status	string	The status of the VPC. A value of Available indicates that the VPC is available.	Available
VpcName	string	The name of the VPC.	vpc-name
VpcId	string	The ID of the VPC.	vpc-bp*******************
IsDefault	boolean	Indicates whether the VPC is the default VPC. Valid values: true false	true
CidrBlock	string	The CIDR block of the VPC.	10...0/8
RegionNo	string	The region ID.	cn-hangzhou
GmtCreate	string	This parameter is deprecated. No value is returned.	null
AliUid	string	This parameter is deprecated. No value is returned.	null
VSwitchs	array<object>	A list of vSwitches.
	object
Status	string	The status of the vSwitch. A value of Available indicates that the vSwitch is available.	Available
VSwitchId	string	The ID of the vSwitch.	vsw-bp*******************
IsDefault	boolean	Indicates whether the vSwitch is the default vSwitch. Valid values: true: The vSwitch is the default vSwitch. false: The vSwitch is not the default vSwitch.	true
CidrBlock	string	The CIDR block of the vSwitch.	10...0/24
GmtCreate	string	This parameter is deprecated. No value is returned.	null
GmtModified	string	This parameter is deprecated. No value is returned.	null
IzNo	string	The ID of the zone where the vSwitch is located.	cn-hangzhou-i
VSwitchName	string	The name of the vSwitch.	vsw-name
GmtModified	string	This parameter is deprecated. No value is returned.	null
Bid	string	This parameter is deprecated. No value is returned.	null
RequestId	string	The request ID.	53924AF0-1628-5AA2-9C95-D4**********

Examples

Success response

JSON format

{
  "Vpcs": {
    "Vpc": [
      {
        "Status": "Available",
        "VpcName": "vpc-name\n",
        "VpcId": "vpc-bp*******************\n",
        "IsDefault": true,
        "CidrBlock": "10.**.**.0/8\n",
        "RegionNo": "cn-hangzhou\n",
        "GmtCreate": "null",
        "AliUid": "null",
        "VSwitchs": [
          {
            "Status": "Available",
            "VSwitchId": "vsw-bp*******************\n",
            "IsDefault": true,
            "CidrBlock": "10.**.**.0/24\n",
            "GmtCreate": "null\n",
            "GmtModified": "null",
            "IzNo": "cn-hangzhou-i\n",
            "VSwitchName": "vsw-name\n"
          }
        ],
        "GmtModified": "null\n",
        "Bid": "null\n"
      }
    ]
  },
  "RequestId": "53924AF0-1628-5AA2-9C95-D4**********\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.