DescribeVSwitches - Virtual Private Cloud - Alibaba Cloud Documentation Center

Mengambil informasi tentang jaringan yang dapat dihubungkan, yang dikelola oleh vSwitch.

Deskripsi operasi

Operasi DescribeVSwitches dapat mengembalikan kode kesalahan Throttling.DeepPageSkip saat terjadi halaman dalam (deep paging) atau pelewatan halaman yang terlalu sering. Kurangi frekuensi kueri atau gunakan paginasi berurutan.

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

vpc:DescribeVSwitches

list

*VSwitch.

acs:vpc:{#regionId}:{#accountId}:vswitch/*

vpc:VPC

None

Parameter permintaan

Parameter	Type	Required	Description	Example
VpcId	string	No	ID VPC tempat vSwitch yang ingin Anda tanyakan berada. Catatan Tentukan setidaknya salah satu parameter RegionId atau VpcId.	vpc-25cdvfeq58pl****
VSwitchId	string	No	ID vSwitch yang ingin Anda tanyakan.	vsw-23dscddcffvf3****
ZoneId	string	No	ID zona tempat vSwitch berada. Anda dapat memanggil operasi DescribeZones untuk menanyakan ID zona tersebut.	cn-hangzhou-d.
RegionId	string	No	ID wilayah tempat vSwitch berada. Anda dapat memanggil operasi DescribeRegions untuk menanyakan ID wilayah tersebut. Catatan Tentukan setidaknya salah satu parameter RegionId atau VpcId.	cn-hangzhou.
VSwitchName	string	No	Nama vSwitch. Nama harus terdiri dari 1 hingga 128 karakter dan tidak boleh dimulai dengan `http://` atau `https://`.	vSwitch.
DryRun	boolean	No	Menentukan apakah akan melakukan dry run. Nilai yang valid: true: melakukan dry run. Sistem memeriksa parameter yang diperlukan, sintaksis permintaan, dan pembatasan bisnis. Jika pemeriksaan gagal, kesalahan yang sesuai dikembalikan. Jika pemeriksaan berhasil, kode kesalahan `DryRunOperation` dikembalikan. false (default): melakukan dry run dan mengirim permintaan. Jika pemeriksaan berhasil, kode status HTTP 2xx dikembalikan dan operasi dilakukan.	true.
IsDefault	boolean	No	Menentukan apakah akan menanyakan vSwitch default di wilayah yang ditentukan. Nilai yang valid: true: menanyakan vSwitch default di wilayah yang ditentukan. false: tidak menanyakan vSwitch default di wilayah yang ditentukan. Jika Anda tidak menentukan parameter ini, sistem akan menanyakan semua vSwitch di wilayah yang ditentukan.	true.
RouteTableId	string	No	ID tabel rute.	vtb-bp145q7glnuzdvzu2****
ResourceGroupId	string	No	ID kelompok sumber daya tempat vSwitch berada.	rg-bp67acfmxazb4ph****
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman untuk kueri berpaginasi. Nilai maksimum: 50. Nilai default: 10.	10
VSwitchOwnerId	integer	No	ID akun Alibaba Cloud kepemilikan sumber daya.	2546073170691****
EnableIpv6	boolean	No	Menentukan apakah akan menanyakan vSwitch yang memiliki Blok CIDR IPv6 diaktifkan di wilayah yang ditentukan. Nilai yang valid: true: menanyakan vSwitch yang memiliki Blok CIDR IPv6 diaktifkan di wilayah yang ditentukan. false: tidak menanyakan vSwitch yang memiliki Blok CIDR IPv6 diaktifkan di wilayah yang ditentukan. Jika Anda tidak menentukan parameter ini, sistem akan menanyakan semua vSwitch di wilayah yang ditentukan.	false.
Tag	array<object>	No	Tag sumber daya.
	object	No	Tag.
Key	string	No	Kunci tag sumber daya. Anda dapat menentukan hingga 20 kunci tag. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag maksimal 128 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Tidak boleh mengandung `http://` atau `https://`.	FinanceDept.
Value	string	No	Nilai tag sumber daya. Anda dapat menentukan hingga 20 nilai tag. Nilai tag boleh berupa string kosong. Panjang nilai tag maksimal 128 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Tidak boleh mengandung `http://` atau `https://`.	FinanceJoshua.

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
PageSize	integer	Jumlah entri per halaman.	10
RequestId	string	ID permintaan.	9A572171-4E27-40D1-BD36-D26C9E71E29E
PageNumber	integer	Nomor halaman.	1
TotalCount	integer	Total jumlah entri yang dikembalikan.	1
VSwitches	object
VSwitch	array<object>	Detail vSwitch.
	array<object>	Struktur vSwitch.
VpcId	string	ID VPC tempat vSwitch berada.	vpc-257gcdcdq64****
Status	string	Status vSwitch. Nilai yang valid: Pending: sedang dikonfigurasi. Available: tersedia.	Available.
CreationTime	string	Waktu saat vSwitch dibuat.	2022-01-18T12:43:57Z
IsDefault	boolean	Menunjukkan apakah vSwitch merupakan vSwitch default. Nilai yang valid: true: vSwitch adalah vSwitch default. false: vSwitch bukan vSwitch default.	true.
AvailableIpAddressCount	integer	Jumlah alamat IP yang tersedia di vSwitch.	1
NetworkAclId	string	ID ACL jaringan.	nacl-a2do9e413e0spzasx****
OwnerId	integer	ID akun Alibaba Cloud kepemilikan sumber daya.	25346073170691****
VSwitchId	string	ID vSwitch.	vsw-25bcdxs7pv1****
CidrBlock	string	Blok CIDR IPv4 vSwitch.	172.16.0.0/24
Description	string	Deskripsi vSwitch.	VSwitchDescription.
ResourceGroupId	string	ID kelompok sumber daya tempat vSwitch berada.	rg-acfmxazb4ph6aiy****
ZoneId	string	Zona tempat vSwitch berada.	cn-hangzhou-d.
Ipv6CidrBlock	string	Blok CIDR IPv6 vSwitch.	2408:4002:10c4:4e03::/64
VSwitchName	string	Nama vSwitch.	vSwitch.
ShareType	string	Jenis berbagi vSwitch. Jika nilainya kosong, vSwitch adalah vSwitch privat. Jika nilainya Shared, vSwitch adalah vSwitch bersama. Jika nilainya Sharing, vSwitch sedang dibagikan ke akun lain.	Shared.
EnabledIpv6	boolean	Menunjukkan apakah Blok CIDR IPv6 diaktifkan untuk vSwitch. Nilai yang valid: true: diaktifkan. false: tidak diaktifkan.	true.
Tags	object
Tag	array<object>	Informasi tag vSwitch.
	object	Struktur informasi tag.
Key	string	Kunci tag vSwitch.	department.
Value	string	Nilai tag vSwitch.	dev.
RouteTable	object	Informasi tabel rute.
RouteTableId	string	ID tabel rute yang terkait dengan vSwitch.	vrt-bp145q7glnuzdv****
RouteTableType	string	Jenis tabel rute yang terkait dengan vSwitch. Nilai yang valid: System: tabel rute sistem. Custom: tabel rute kustom.	System.

Contoh

Respons sukses

JSONformat

{
  "PageSize": 10,
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "PageNumber": 1,
  "TotalCount": 1,
  "VSwitches": {
    "VSwitch": [
      {
        "VpcId": "vpc-257gcdcdq64****",
        "Status": "Available.",
        "CreationTime": "2022-01-18T12:43:57Z",
        "IsDefault": true,
        "AvailableIpAddressCount": 1,
        "NetworkAclId": "nacl-a2do9e413e0spzasx****",
        "OwnerId": 0,
        "VSwitchId": "vsw-25bcdxs7pv1****",
        "CidrBlock": "172.16.0.0/24",
        "Description": "VSwitchDescription.",
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "ZoneId": "cn-hangzhou-d.",
        "Ipv6CidrBlock": "2408:4002:10c4:4e03::/64",
        "VSwitchName": "vSwitch.",
        "ShareType": "Shared.",
        "EnabledIpv6": true,
        "Tags": {
          "Tag": [
            {
              "Key": "department.",
              "Value": "dev."
            }
          ]
        },
        "RouteTable": {
          "RouteTableId": "vrt-bp145q7glnuzdv****",
          "RouteTableType": "System."
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Forbidden.VpcNotFound	Specified VPC can not found.	VPC yang ditentukan tidak ada. Periksa apakah VPC sudah benar.
400	InvalidTagKey	The tag keys are not valid.	Indeks tag tidak valid.
400	InvalidTagValue	The tag values are not valid.	Nilai tag tidak valid.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	Parameter OwnerAccount yang ditentukan tidak valid.
400	IllegalParam.OwnerId	The specified parameter VSwitchOwnerId is not valid.
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	Jumlah ID VPC melebihi batas.
400	InvalidVSwitchIdNumber.NotSupported	The number of vSwitchIds exceeds the limit.
400	Throttling.DeepPageSkip	Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination.	Frekuensi pelewatan halaman paginasi dalam telah memicu pembatasan kecepatan. Kurangi frekuensi pelewatan halaman paginasi dalam, atau gunakan paginasi berurutan.
404	InvalidVSwitchId.NotFound	VSwitch not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.