すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeVpcs

    ドキュメントセンター

    PolarDB:DescribeVpcs

    最終更新日:Dec 11, 2025

    1 つ以上の 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:DescribeVpcs

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ZoneId

    string

    任意

    ゾーンの ID。

    説明

    DescribeRegions 操作を呼び出してゾーンを照会できます。

    cn-hangzhou-i
    Product

    string

    任意

    クラウドプロダクトの名前。

    VPN
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効値：

    • 30

    • 50

    • 100

    デフォルト値：30。

    30
    PageNumber

    integer

    任意

    ページ番号。値は 0 より大きい整数で、整数データ型の最大値を超えないようにする必要があります。デフォルト値：1。

    3
    ResourceGroupId

    string

    任意

    VPC が属するリソースグループの ID。

    rg-acfmzh544n3j3bi
    VpcId

    string

    任意

    VPC の ID。

    説明

    DescribeVpcs 操作を呼び出して VPC の詳細を照会できます。

    vpc-*************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PageNumber

    integer

    返されたページのページ番号。デフォルト値は 1 です。

    2
    PageSize

    integer

    1 ページあたりに返されるエントリ数。有効値：

    • 30

    • 50

    • 100

      30

    50
    RequestId

    string

    リクエスト ID。

    11FDB5A0-84F5-5361-B729-5770B0AEB9D5
    TotalCount

    integer

    エントリの総数。

    50
    Vpcs

    array<object>

    VPC のリスト。

    array<object>

    VPC の詳細。

    AliUid

    string

    Alibaba Cloud アカウントの ID。

    1868512340232755
    Bid

    string

    アカウントが Finance Cloud アカウント、Alibaba Gov Cloud アカウント、またはパブリッククラウドアカウントであるかどうかを示します。

    26842
    CidrBlock

    string

    VPC の IPv4 CIDR ブロック。

    57.100.6.59/32
    GmtCreate

    string

    VPC が作成された時刻。

    2021-04-18T15:02:37Z

    GmtModified

    string

    VPC が最後に変更された時刻。

    2021-04-18T15:02:37Z

    IsDefault

    boolean

    VPC がデフォルト VPC であるかどうかを示します。有効値：

    • true：VPC はデフォルト VPC です。

    • false：VPC はデフォルト VPC ではありません。

    true
    RegionNo

    string

    VPC が属するリージョンの ID。

    cn-chengdu-wt97-a01
    Status

    string

    VPC のステータス。有効値：

    • Pending：VPC は設定中です。

    • Available：VPC はアクティブです。

    Pending
    VSwitchs

    array<object>

    vSwitch のリスト。

    object

    vSwitch の詳細。

    CidrBlock

    string

    vSwitch の IPv4 CIDR ブロック。

    47.118.126.0/25
    GmtCreate

    string

    vSwitch が作成された時刻。

    2021-04-18T15:02:37Z
    GmtModified

    string

    vSwitch が最後に変更された時刻。

    2021-04-18T15:02:37Z
    IsDefault

    boolean

    vSwitch がデフォルトの vSwitch であるかどうかを示します。有効値：

    • true：vSwitch はデフォルトの vSwitch です。

    • false：vSwitch はデフォルトの vSwitch ではありません。

    false
    IzNo

    string

    vSwitch が属するゾーン。

    cn-shenzhen-f
    Status

    string

    vSwitch のステータス。有効値：

    • Pending：vSwitch は設定中です。

    • Available：vSwitch はアクティブです。

    Pending
    VSwitchId

    string

    vSwitch の ID。

    vsw-uf6fus5py6hbvxqwzwnk8
    VSwitchName

    string

    vSwitch の名前。

    default-sw
    VpcId

    string

    VPC の ID。

    説明

    DescribeVpcs 操作を呼び出して VPC の詳細を照会できます。

    vpc-bp16efwqjzyumc23c647v
    VpcName

    string

    VPC の名前。

    vpc-e2e-10341f3

    例

    成功レスポンス

    JSONJSON

    {
  "PageNumber": 2,
  "PageSize": 50,
  "RequestId": "11FDB5A0-84F5-5361-B729-5770B0AEB9D5",
  "TotalCount": 50,
  "Vpcs": [
    {
      "AliUid": "1868512340232755",
      "Bid": "26842",
      "CidrBlock": "57.100.6.59/32",
      "GmtCreate": "2021-04-18T15:02:37Z\n",
      "GmtModified": "2021-04-18T15:02:37Z\n",
      "IsDefault": true,
      "RegionNo": "cn-chengdu-wt97-a01",
      "Status": "Pending",
      "VSwitchs": [
        {
          "CidrBlock": "47.118.126.0/25",
          "GmtCreate": "2021-04-18T15:02:37Z",
          "GmtModified": "2021-04-18T15:02:37Z",
          "IsDefault": false,
          "IzNo": "cn-shenzhen-f",
          "Status": "Pending",
          "VSwitchId": "vsw-uf6fus5py6hbvxqwzwnk8",
          "VSwitchName": "default-sw"
        }
      ],
      "VpcId": "vpc-bp16efwqjzyumc23c647v",
      "VpcName": "vpc-e2e-10341f3"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 PARAMETER_MUST_NOT_NULL Miss mandatory parameter.

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

    変更履歴

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