DescribeRdsVpcs API リファレンス - PolarDB

VPC のリストを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeRdsVpcs

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 > DescribeRegions 操作を呼び出して、利用可能なリージョンを照会できます。	cn-hangzhou
ZoneId	string	任意	ゾーンの ID。	cn-hangzhou-k
ResourceGroupId	string	任意	リソースグループの ID。	rg-************

レスポンスフィールド

フィールド	型	説明	例
	object
Vpcs	object	VPC のリスト。
Vpc	array<object>	VPC の詳細。
	array<object>	VPC の詳細。
Status	string	VPC のステータス。有効な値： Pending：VPC は設定中です。 Available：VPC は利用可能です。	Available
VpcName	string	VPC の名前。	fc-webide
VpcId	string	VPC の ID。	vpc-*************
IsDefault	boolean	VPC がデフォルト VPC であるかどうかを示します。	true
CidrBlock	string	VPC の CIDR ブロック。	10.21.0.0/16
RegionNo	string	リージョン ID。	cn-hangzhou
GmtCreate	string	VPC が作成された時刻。	2025-08-28T02:25:41Z
AliUid	string	Alibaba Cloud アカウントの ID。	1485293698******
VSwitchs	array<object>	VPC 内の vSwitch の詳細。
	object	vSwitch の詳細。
Status	string	vSwitch のステータス。Available は vSwitch が利用可能であることを示します。	Available
VSwitchId	string	vSwitch の ID。	vsw-**********
IsDefault	boolean	vSwitch がデフォルト vSwitch であるかどうかを示します。有効な値： true：vSwitch はデフォルト vSwitch です。 false：vSwitch はデフォルト vSwitch ではありません。	true
CidrBlock	string	vSwitch の CIDR ブロック。	192.168.7.0/24
GmtCreate	string	vSwitch が作成された時刻。	2025-05-12 18:17:25
GmtModified	string	vSwitch が最後に変更された時刻。	2025-01-07T15:10:32+08:00
IzNo	string	ゾーンの ID。	cn-hangzhou-k
VSwitchName	string	vSwitch の名前。	test
GmtModified	string	VPC が最後に変更された時刻。	2025-04-30T09:41:14+08:00
Bid	string	アカウントのビジネスタイプ。このパラメーターは、アカウントが Finance Cloud アカウント、Alibaba Gov Cloud アカウント、またはパブリッククラウドアカウントであるかどうかを示します。	26842
RequestId	string	リクエスト ID。	B45E8D29-EA17-5141-AE09-F7A399760C9E

例

成功レスポンス

JSONJSON

{
  "Vpcs": {
    "Vpc": [
      {
        "Status": "Available",
        "VpcName": "fc-webide",
        "VpcId": "vpc-*************",
        "IsDefault": true,
        "CidrBlock": "10.21.0.0/16",
        "RegionNo": "cn-hangzhou",
        "GmtCreate": "2025-08-28T02:25:41Z",
        "AliUid": "1485293698******",
        "VSwitchs": [
          {
            "Status": "Available",
            "VSwitchId": "vsw-**********",
            "IsDefault": true,
            "CidrBlock": "192.168.7.0/24",
            "GmtCreate": "2025-05-12 18:17:25",
            "GmtModified": "2025-01-07T15:10:32+08:00",
            "IzNo": "cn-hangzhou-k",
            "VSwitchName": "test"
          }
        ],
        "GmtModified": "2025-04-30T09:41:14+08:00",
        "Bid": "26842"
      }
    ]
  },
  "RequestId": "B45E8D29-EA17-5141-AE09-F7A399760C9E"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。