DescribeRdsVpcs - PolarDB

PolarDB-X 端查詢 VPC 清單的 API。

介面說明

該介面用於取得使用者帳號下可用於執行個體的專有網路（VPC）清單，以便在建立或管理資料庫執行個體時選擇合適的網路環境。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:DescribeRdsVpcs

none

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	執行個體所在地域。>您可以呼叫 describeregions 介面檢視 polardb-x 支援的地域詳情，包括地域 ID。	cn-zhangjiakou
ZoneId	string	否	可用區 ID。	cn-beijing-h

返回參數

名稱	類型	描述	樣本值
	object
Vpcs	object	VPC 資訊。
Vpc	array<object>	VPC 資訊。
	array<object>	VPC 資訊。
Status	string	VPC 狀態。	True
VpcName	string	VPC 的名稱。	cloud_auto_test
VpcId	string	VPC 的 ID。	vpc-2zekldxxy28nobay7o1f3
IsDefault	boolean	是否是預設 VPC。取值範圍如下：true：是預設 VPCfalse：非預設 VPC。	False
CidrBlock	string	VPC 的 IPv4 網段。	47.121.246.0/24
RegionNo	string	VPC 所在的地域。	cn-shanghai
GmtCreate	string	建立 VPC 的時間點。	Mon May 12 10:13:14 CST 2025
AliUid	string	阿里雲帳號 ID。	314****36
VSwitchs	array<object>	VPC 的交換機資訊。
	object	VPC 的交換機資訊。
Status	string	交換機狀態。	Available
VSwitchId	string	交換機 ID。	vsw-8vbkwmpn****4nrd639ih
IsDefault	boolean	是否是預設交換機。	false
CidrBlock	string	交換機網段。	10.0.0.0/24
GmtCreate	string	建立時間，精確到毫秒的 Unix 時間戳。	1574156944000
GmtModified	string	最後修改時間（時間戳）。	2025-09-03T19:19:13+08:00
IzNo	string	可用區 ID。	cn-beijing-g
VSwitchName	string	交換機名稱。	cloud_auto_g
GmtModified	string	最後修改 VPC 的時間。	2024-09-29 17:47:56
Bid	string	專有網路 ID。	26842
RequestId	string	請求 ID。	4C1A7CFB-9F73-5041-8C74-27626E58985A

樣本

正常返回樣本

JSON格式

{
  "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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。