Referensi API & Parameter DescribeVSwitchList - PolarDB - Alibaba Cloud - PolarDB

Mengambil informasi tentang vSwitch.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeVSwitchList

none

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID region tempat vSwitch berada. Catatan Panggil DescribeRegions untuk meminta ID semua region yang mendukung vSwitch.	cn-hangzhou
VpcId	string	No	ID virtual private cloud (VPC). Catatan Panggil DescribeVpcs untuk melihat detail VPC.	vpc-25cdvfeq58pl****
VSwitchIds	array	No	Daftar vSwitch di VPC.
	string	No	ID vSwitch.	vsw-uf6quheh6ok8nbtj4****
ZoneId	string	No	ID zona tempat vSwitch berada.	cn-hangzhou-g
PageNumber	integer	No	Nomor halaman. Nilai harus berupa bilangan bulat yang lebih besar dari 0. Tidak boleh melebihi nilai maksimum tipe data Integer.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 30 50 100 Nilai default: 30.	30

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	6A2EE5B4-CC9F-46E1-A747-E43BC9******
TotalCount	integer	Jumlah total entri.	1
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman. Nilai yang valid: 30 50 100 Nilai default: 30.	30
VSwitchs	array<object>	Daftar vSwitch.
	object	Detail vSwitch.
CidrBlock	string	Blok CIDR vSwitch.	172.16.0.0/24
Description	string	Deskripsi vSwitch.	vSwitchDescription
IsDefault	boolean	Menunjukkan apakah vSwitch adalah vSwitch default. Nilai yang valid: true: vSwitch adalah vSwitch default. false: vSwitch bukan vSwitch default.	true
IzNo	string	ID zona tempat vSwitch berada.	cn-hangzhou-b
Status	string	Status vSwitch. Nilai yang valid: Pending: vSwitch sedang dikonfigurasi. Available: vSwitch tersedia.	Available
VSwitchId	string	ID vSwitch.	vsw-25bcdxs7pv1****
VSwitchName	string	Nama vSwitch.	vSwitch
AvailableIpAddressCount	integer	Jumlah alamat IP yang tersedia di vSwitch.	1
VpcId	string	ID VPC.	vpc-bp1vbkkyt7apvy4j*****
ShareType	string	Tipe berbagi.	Public
ResourceGroupId	string	ID grup sumber daya.	rg-************
OwnerId	string	ID akun Alibaba Cloud yang memiliki sumber daya.	177563751276****

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message
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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.