DescribeVSwitchList API リファレンスとパラメータ - PolarDB

vSwitch の情報を取得します。

今すぐお試しください

この 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:DescribeVSwitchList

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	vSwitch が存在するリージョンの ID。説明 DescribeRegions を呼び出して、vSwitch をサポートするすべてのリージョンの ID をクエリします。	cn-hangzhou
VpcId	string	任意	VPC (virtual private cloud) の ID。説明 DescribeVpcs を呼び出して、VPC の詳細を表示します。	vpc-25cdvfeq58pl****
VSwitchIds	array	任意	VPC 内の vSwitch のリスト。
	string	任意	vSwitch の ID。	vsw-uf6quheh6ok8nbtj4****
ZoneId	string	任意	vSwitch が存在するゾーンの ID。	cn-hangzhou-g
PageNumber	integer	任意	ページ番号。値は 0 より大きい整数である必要があります。Integer データ型の最大値を超えることはできません。	1
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値: 30 50 100 デフォルト値: 30。	30

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	6A2EE5B4-CC9F-46E1-A747-E43BC9******
TotalCount	integer	エントリの総数。	1
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。有効な値: 30 50 100 デフォルト値: 30。	30
VSwitchs	array<object>	vSwitch のリスト。
	object	vSwitch の詳細。
CidrBlock	string	vSwitch の CIDR ブロック。	172.16.0.0/24
Description	string	vSwitch の説明。	vSwitchDescription
IsDefault	boolean	vSwitch がデフォルトの vSwitch であるかどうかを示します。有効な値: true: vSwitch はデフォルトの vSwitch です。 false: vSwitch はデフォルトの vSwitch ではありません。	true
IzNo	string	vSwitch が存在するゾーンの ID。	cn-hangzhou-b
Status	string	vSwitch のステータス。有効な値: Pending: vSwitch は設定中です。 Available: vSwitch は利用可能です。	Available
VSwitchId	string	vSwitch の ID。	vsw-25bcdxs7pv1****
VSwitchName	string	vSwitch の名前。	vSwitch
AvailableIpAddressCount	integer	vSwitch で利用可能な IP アドレスの数。	1
VpcId	string	VPC の ID。	vpc-bp1vbkkyt7apvy4j*****
ShareType	string	共有タイプ。	Public
ResourceGroupId	string	リソースグループの ID。	rg-************
OwnerId	string	リソースを所有する Alibaba Cloud アカウントの ID。	177563751276****

例

成功レスポンス

JSONJSON

{
  "RequestId": "6A2EE5B4-CC9F-46E1-A747-E43BC9******",
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "VSwitchs": [
    {
      "CidrBlock": "172.16.0.0/24",
      "Description": "vSwitchDescription\t\n",
      "IsDefault": true,
      "IzNo": "cn-hangzhou-b\t\n",
      "Status": "Available",
      "VSwitchId": "vsw-25bcdxs7pv1****\t\n",
      "VSwitchName": "vSwitch",
      "AvailableIpAddressCount": 1,
      "VpcId": "vpc-bp1vbkkyt7apvy4j*****",
      "ShareType": "Public",
      "ResourceGroupId": "rg-************",
      "OwnerId": "177563751276****"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidVSwitchId.NotFound	Specified virtual switch is not found in specified VPC.
400	IncorrecttVpcId	The specified parameter VPCId is not valid.
400	InvalidIzNo.NotSupported	Specified VPC zone is not supported.
400	MissingParameter.RegionId	The parameter RegionId is mandatory.

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

変更履歴

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