All Products
Search
Document Center

AnalyticDB for PostgreSQL:DescribeRdsVpcs

Last Updated:Mar 03, 2024

Queries a list of VPCs.

Operation description

When you create an AnalyticDB for PostgreSQL instance, you can call this operation to query the available VPCs within a specified region or zone.

Limits

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:DescribeRdsVpcsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
ZoneIdstringNo

The ID of the zone.

cn-hangzhou-h
ResourceGroupIdstringNo

The ID of the resource group to which the instance belongs.

rg-bp67acfmxazb4p****

Response parameters

ParameterTypeDescriptionExample
object
Vpcsobject

Details of the VPCs.

Vpcobject []

Details of the VPC.

Statusstring

The state of the VPC. If Available is returned, the VPC is available.

Available
VpcNamestring

The name of the VPC.

vpc-name
VpcIdstring

The ID of VPC.

vpc-bp*******************
IsDefaultboolean

Indicates whether the VPC is the default VPC. Valid values:

  • true
  • false
true
CidrBlockstring

The CIDR block of the VPC.

10.**.**.0/8
RegionNostring

The ID of the region.

cn-hangzhou
GmtCreatestring

An invalid parameter. It is no longer returned when you call this operation.

null
AliUidstring

An invalid parameter. It is no longer returned when you call this operation.

null
VSwitchsobject []

Details of the vSwitches.

Statusstring

The state of the vSwitch. If Available is returned, the vSwitch is available.

Available
VSwitchIdstring

The ID of the vSwitch.

vsw-bp*******************
IsDefaultboolean

Indicates whether the vSwitch is the default vSwitch. Valid values:

  • true
  • false
true
CidrBlockstring

The CIDR block of the vSwitch.

10.**.**.0/24
GmtCreatestring

An invalid parameter. It is no longer returned when you call this operation.

null
GmtModifiedstring

An invalid parameter. It is no longer returned when you call this operation.

null
IzNostring

The ID of the zone to which the vSwitch belongs.

cn-hangzhou-i
VSwitchNamestring

The name of the vSwitch.

vsw-name
GmtModifiedstring

An invalid parameter. It is no longer returned when you call this operation.

null
Bidstring

An invalid parameter. It is no longer returned when you call this operation.

null
RequestIdstring

The ID of the request.

53924AF0-1628-5AA2-9C95-D4**********

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.