All Products
Search
Document Center

AnalyticDB for PostgreSQL:DescribeRdsVSwitchs

Last Updated:Mar 03, 2024

Queries a list of vSwitches.

Operation description

When you create AnalyticDB for PostgreSQL instances, you can call this operation to query the details of vSwitches 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:DescribeRdsVSwitchsRead
  • 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 and zone list.
cn-hangzhou
VpcIdstringNo

The virtual private cloud (VPC) ID of the instance.

Note
  • You can call the DescribeRdsVpcs operation to query the available VPC IDs.

  • This parameter must be specified.

vpc-bp*******************
ZoneIdstringNo

The ID of the zone.

Note You can call the DescribeRegions operation to query the most recent region list and zone list.
cn-hangzhou-h
ResourceGroupIdstringNo

This parameter is no longer used.

rg-bp67acfmxazb4p****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B0BA251D-6854-5A99-A964-3C**********
VSwitchesobject

Details of the vSwitches.

VSwitchobject []

Details of the vSwitch.

Statusstring

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

Available
IsDefaultboolean

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

  • true
  • false
false
VSwitchIdstring

The ID of the vSwitch.

vsw-bp*******************
CidrBlockstring

The CIDR block of the vSwitch.

192.**.**.0/24
RegionNostring

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

null
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
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
IzNostring

The ID of the zone.

cn-hangzhou-h
VSwitchNamestring

The name of the vSwitch.

vsw-name

Examples

Sample success responses

JSONformat

{
  "RequestId": "B0BA251D-6854-5A99-A964-3C**********",
  "VSwitches": {
    "VSwitch": [
      {
        "Status": "Available",
        "IsDefault": false,
        "VSwitchId": "vsw-bp*******************",
        "CidrBlock": "192.**.**.0/24",
        "RegionNo": "null",
        "GmtCreate": "null",
        "AliUid": "null",
        "GmtModified": "null",
        "Bid": "null",
        "IzNo": "cn-hangzhou-h",
        "VSwitchName": "vsw-name"
      }
    ]
  }
}

Error codes

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