All Products
Search
Document Center

PolarDB:DescribeVSwitches

Last Updated:Jun 10, 2026

Melakukan kueri satu atau beberapa 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:DescribeVSwitches

get

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

RegionId

string

No

ID region dari vSwitch.

cn-hangzhou

VpcId

string

No

ID virtual private cloud (VPC) tempat vSwitch berada.

Catatan

Tentukan minimal salah satu dari parameter VpcId dan DedicatedHostGroupId.

vpc-25cdvfeq58pl****

ZoneId

string

No

ID zona dari vSwitch.

cn-hangzhou-d

DedicatedHostGroupId

string

No

ID dari dedicated cluster.

Catatan

Tentukan minimal salah satu dari parameter VpcId dan DedicatedHostGroupId.

dhg-4n****

PageNumber

integer

No

Nomor halaman dari daftar. Nilai default adalah 1.

1

PageSize

integer

No

Jumlah entri yang dikembalikan pada setiap halaman untuk kueri berhalaman. Nilai maksimum adalah 50. Nilai default adalah 50.

50

ResourceGroupId

string

No

ID dari resource group tempat vSwitch berada.

rg-bp67acfmxazb4ph****

Elemen respons

Element

Type

Description

Example

object

RequestId

string

ID permintaan.

9A572171-4E27-40D1-BD36-D26C9E71E29E

TotalCount

integer

Jumlah entri dalam daftar.

1

PageNumber

integer

Nomor halaman saat ini.

1

PageSize

integer

Jumlah entri pada halaman saat ini.

10

VSwitchs

array<object>

Daftar vSwitch.

object

CidrBlock

string

Blok CIDR IPv4 dari vSwitch.

172.16.0.0/24

Description

string

Deskripsi dari 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

Zona tempat NAT Gateway berada.

cn-hangzhou-b

Status

string

Status dari vSwitch. Nilai yang valid:

  • Pending: vSwitch sedang dikonfigurasi.

  • Available: vSwitch aktif.

Available

VSwitchId

string

ID dari vSwitch.

vsw-25bcdxs7pv1****

VSwitchName

string

Nama dari vSwitch.

vSwitch

AvailableIpAddressCount

integer

Jumlah alamat IP yang tersedia di vSwitch.

1

Contoh

Respons sukses

JSONformat

{
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "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
    }
  ]
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.