DescribeVpcs - Virtual Private Cloud - Alibaba Cloud Documentation Center

Mengkueri VPC yang telah dibuat.

Deskripsi operasi

Operasi DescribeVpcs dapat mengembalikan kode kesalahan Throttling.DeepPageSkip selama halaman dalam dan pelewatan halaman yang sering dilakukan. Kurangi frekuensi kueri atau gunakan penomoran halaman 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:DescribeVpcs

list

VPC

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

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VPCId}

vpc:tag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
VpcId	string	No	ID VPC. Anda dapat menentukan hingga 20 ID VPC. Pisahkan beberapa ID VPC dengan koma (,).	vpc-bp1b1xjllp3ve5yze****
RegionId	string	Yes	ID wilayah VPC. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	cn-hangzhou
VpcName	string	No	Nama VPC.	Vpc-1
IsDefault	boolean	No	Apakah akan mengkueri VPC default di wilayah yang ditentukan. Nilai valid: true (default): Mengkueri VPC default di wilayah yang ditentukan. false: Tidak mengkueri VPC default.	false
DryRun	boolean	No	Apakah akan menjalankan dry run untuk permintaan. Nilai valid: true: Mengirim permintaan pemeriksaan dan tidak mengkueri status Sumber daya. Sistem memeriksa apakah Pasangan Kunci Akses Anda valid, apakah Pengguna RAM memiliki otorisasi, dan apakah parameter yang diperlukan telah ditentukan. Jika pemeriksaan gagal, sistem mengembalikan error. Jika pemeriksaan berhasil, sistem mengembalikan kode kesalahan `DryRunOperation`. false (default): Mengirim permintaan normal dan mengkueri status Sumber daya setelah pemeriksaan berhasil dan kode status HTTP 2xx dikembalikan.	false
ResourceGroupId	string	No	ID kelompok sumber daya tempat VPC berada.	rg-acfmxvfvazb4p****
PageNumber	integer	No	Nomor halaman daftar. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman untuk penomoran halaman. Nilai maksimum: 50. Nilai default: 10.	10
VpcOwnerId	integer	No	ID akun Alibaba Cloud VPC.	253460731706911258
DhcpOptionsSetId	string	No	ID set opsi DHCP.	dopt-o6w0df4epg9zo8isy****
EnableIpv6	boolean	No	Apakah akan mengkueri VPC yang memiliki Blok CIDR IPv6 diaktifkan di wilayah yang ditentukan. Secara default, parameter ini kosong, yang berarti VPC tidak difilter berdasarkan apakah Blok CIDR IPv6 diaktifkan. Nilai valid: false: Blok CIDR IPv6 tidak diaktifkan. true: Blok CIDR IPv6 diaktifkan.	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. Jika Anda menentukan parameter ini, Anda tidak dapat menentukan string kosong. Panjang kunci tag dapat mencapai 128 karakter. Tidak dapat dimulai dengan `aliyun` atau `acs:`, dan tidak dapat mengandung `http://` atau `https://`.	FinanceDept
Value	string	No	Nilai tag Sumber daya. Anda dapat menentukan hingga 20 nilai tag. Jika Anda menentukan parameter ini, Anda dapat menentukan string kosong. Panjang nilai tag dapat mencapai 128 karakter. Tidak dapat dimulai dengan `aliyun` atau `acs:`, dan tidak dapat mengandung `http://` atau `https://`.	FinanceJoshua

Elemen respons

Element	Type	Description	Example
	object	Informasi yang dikembalikan.
PageSize	integer	Jumlah entri per halaman untuk penomoran halaman.	10
RequestId	string	ID permintaan.	C6532AA8-D0F7-497F-A8EE-094126D441F5
PageNumber	integer	Nomor halaman daftar.	1
TotalCount	integer	Jumlah total entri.	2
Vpcs	object
Vpc	array<object>	Detail VPC.
	array<object>	Detail VPC.
CreationTime	string	Pengatur waktu pembuatan VPC. Waktu ditampilkan dalam UTC dan mengikuti standar ISO 8601 dalam format YYYY-MM-DDThh:mm:ssZ.	2021-04-18T15:02:37Z
Status	string	Status VPC. Nilai valid: Pending: VPC sedang dikonfigurasi. Available: VPC tersedia.	Available
VpcId	string	ID VPC.	vpc-bp1qpo0kug3a20qqe****
IsDefault	boolean	Apakah VPC merupakan VPC default di wilayah tersebut. Nilai valid: true: VPC merupakan VPC default di wilayah tersebut. false: VPC bukan VPC default di wilayah tersebut.	false
OwnerId	integer	ID akun Alibaba Cloud VPC.	253460731706911258
RegionId	string	ID wilayah VPC.	cn-hangzhou
VpcName	string	Nama VPC.	vpc1
VRouterId	string	ID vRouter.	vrt-bp1jcg5cmxjbl9xgc****
DhcpOptionsSetStatus	string	Status set opsi DHCP. Nilai valid: Available: Set opsi DHCP tersedia. InUse: Set opsi DHCP sedang digunakan. Deleted: Set opsi DHCP dihapus. Pending: Set opsi DHCP sedang dikonfigurasi.	Available
CidrBlock	string	Blok CIDR IPv4 VPC.	192.168.0.0/16
Description	string	Deskripsi VPC.	This is my VPC.
ResourceGroupId	string	ID kelompok sumber daya tempat VPC berada.	rg-acfmxazb4ph****
DhcpOptionsSetId	string	ID set opsi DHCP.	dopt-o6w0df4epg9zo8isy****
Ipv6CidrBlock	string	Blok CIDR IPv6 VPC.	2408:XXXX:0:a600::/56
CenStatus	string	Status VPC yang terhubung ke Cloud Enterprise Network (CEN). Parameter ini hanya mengembalikan Attached ketika VPC terhubung ke Instans CEN.	Attached
Tags	object
Tag	array<object>	Informasi tag VPC.
	object	Informasi tag VPC.
Key	string	Kunci tag yang terpasang pada VPC.	FinanceDept
Value	string	Nilai tag yang terpasang pada VPC.	FinanceJoshua
Ipv6CidrBlocks	object
Ipv6CidrBlock	array<object>	Informasi Blok CIDR IPv6 VPC.
	object	Informasi Blok CIDR IPv6 VPC.
Ipv6Isp	string	Tipe Blok CIDR IPv6 VPC. Nilai valid: BGP: Alibaba Cloud BGP IPv6. ChinaMobile: China Mobile (single line). ChinaUnicom: China Unicom (single line). ChinaTelecom: China Telecom (single line). Catatan Jika Anda ditambahkan ke daftar putih bandwidth single-line, Anda dapat mengatur parameter ini ke ChinaTelecom, ChinaUnicom, atau ChinaMobile.	BGP
Ipv6CidrBlock	string	Blok CIDR IPv6 VPC.	2408:XXXX:0:a600::/56
VSwitchIds	object
VSwitchId	array	Daftar vSwitch di VPC yang dikueri. Anda dapat mengkueri hingga 300 vSwitch yang paling baru dibuat di VPC. Untuk mengkueri semua vSwitch di VPC, panggil operasi DescribeVSwitches.
	string	Daftar vSwitch di VPC yang dikueri. Anda dapat mengkueri hingga 300 vSwitch yang paling baru dibuat di VPC. Untuk mengkueri semua vSwitch di VPC, panggil operasi DescribeVSwitches.	vsw-bp1nhbnpv2blyz8dl****
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	Informasi Blok CIDR sekunder.
	string	Blok CIDR sekunder VPC.	192.168.20.0/24
UserCidrs	object
UserCidr	array	Daftar Blok CIDR pengguna.
	string	Daftar Blok CIDR pengguna.	10.0.0.0/8
NatGatewayIds	object
NatGatewayIds	array	ID gerbang NAT.
	string	ID gerbang NAT.	nat-245xxxftwt45bg****
RouterTableIds	object
RouterTableIds	array	Informasi tabel rute.
	string	ID tabel rute.	vtb-bp1krxxzp0c29fmon****
EnabledIpv6	boolean	Apakah IPv6 diaktifkan. Nilai valid: false: IPv6 dinonaktifkan. true: IPv6 diaktifkan.	false
DnsHostnameStatus	string	Apakah hostname DNS diaktifkan.	DISABLED

Contoh

Respons sukses

JSONformat

{
  "PageSize": 10,
  "RequestId": "C6532AA8-D0F7-497F-A8EE-094126D441F5",
  "PageNumber": 1,
  "TotalCount": 2,
  "Vpcs": {
    "Vpc": [
      {
        "CreationTime": "2021-04-18T15:02:37Z",
        "Status": "Available",
        "VpcId": "vpc-bp1qpo0kug3a20qqe****",
        "IsDefault": false,
        "OwnerId": 253460731706911260,
        "RegionId": "cn-hangzhou",
        "VpcName": "vpc1",
        "VRouterId": "vrt-bp1jcg5cmxjbl9xgc****",
        "DhcpOptionsSetStatus": "Available",
        "CidrBlock": "192.168.0.0/16",
        "Description": "This is my VPC.",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "DhcpOptionsSetId": "dopt-o6w0df4epg9zo8isy****",
        "Ipv6CidrBlock": "2408:XXXX:0:a600::/56",
        "CenStatus": "Attached",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "Ipv6CidrBlocks": {
          "Ipv6CidrBlock": [
            {
              "Ipv6Isp": "BGP",
              "Ipv6CidrBlock": "2408:XXXX:0:a600::/56"
            }
          ]
        },
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp1nhbnpv2blyz8dl****"
          ]
        },
        "SecondaryCidrBlocks": {
          "SecondaryCidrBlock": [
            "192.168.20.0/24"
          ]
        },
        "UserCidrs": {
          "UserCidr": [
            "10.0.0.0/8"
          ]
        },
        "NatGatewayIds": {
          "NatGatewayIds": [
            "nat-245xxxftwt45bg****"
          ]
        },
        "RouterTableIds": {
          "RouterTableIds": [
            "vtb-bp1krxxzp0c29fmon****"
          ]
        },
        "EnabledIpv6": false,
        "DnsHostnameStatus": "DISABLED"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	Jumlah ID VPC melebihi batas.
400	InvalidAliuid	User Id is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	ID kelompok sumber daya tidak ada.
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	InvalidResourceGroupId.NotFound	The Specified ResourceGroupId not exists.
400	OperationUnsupported.ResourceGroupId	%s
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	Parameter OwnerAccount yang ditentukan tidak valid.
400	IllegalParam.OwnerId	The specified parameter VpcOwnerId is not valid.
400	InvalidAccount.NotFound	The account is invalid.	Operasi gagal karena akun pemanggil yang digunakan tidak valid.
400	Throttling.DeepPageSkip	Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination.	Jumlah lompatan halaman dalam telah memicu pembatasan kecepatan. Kurangi frekuensi lompatan halaman dalam atau gunakan paginasi berurutan sebagai gantinya.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	Parameter TagKey yang ditentukan duplikat.
500	InternalError	The request processing has failed due to some unknown error.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.