DescribeHaVips - Virtual Private Cloud - Alibaba Cloud Documentation Center

Mengkueri alamat IP virtual ketersediaan tinggi (HaVip) di wilayah tertentu.

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:DescribeHaVips

get

*HaVip

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah HaVip. Anda dapat memanggil operasi DescribeRegions untuk mendapatkan ID wilayah.	cn-hangzhou
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman dalam kueri penomoran halaman. Nilai maksimum: 50. Nilai default: 10.	10
Filter	array<object>	No	Detail kondisi filter.
	object	No	Detail kondisi filter.
Key	string	No	Kondisi filter. Anda dapat menentukan hingga 5 kondisi filter. Nilai valid N: 1 hingga 5. Kondisi filter yang didukung: VpcId: ID virtual private cloud (VPC). VSwitchId: ID vSwitch. Status: Status HaVip. HaVipId: ID HaVip. HaVipAddress: Alamat IP HaVip. Anda dapat menentukan beberapa nilai untuk setiap kondisi filter. Nilai dievaluasi menggunakan operator OR. Sumber daya dianggap cocok dengan kondisi filter parameter jika cocok dengan setidaknya satu nilai. Beberapa kondisi filter dievaluasi menggunakan operator AND. Sumber daya hanya dikembalikan jika cocok dengan kondisi filter semua parameter.	HaVipId
Value	array	No	Nilai kondisi filter yang ditentukan. Nilai valid N: 1 hingga 5.	havip-bp19o63nequs01i8d****
	string	No	Nilai filter yang ditentukan untuk kondisi filter. Anda dapat menentukan beberapa nilai filter untuk satu kondisi filter. Nilai dievaluasi menggunakan operator OR. Sumber daya cocok dengan kondisi filter jika cocok dengan setidaknya satu nilai filter.	Active
ResourceGroupId	string	No	ID kelompok sumber daya tempat HaVip berada.	rg-bp67acfmxazb4ph****
Tags	array<object>	No	Daftar tag.
	object	No	Daftar tag.
Key	string	No	Kunci tag sumber daya. Anda dapat menentukan hingga 20 kunci tag. Jika Anda menentukan parameter ini, Anda tidak dapat memasukkan 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 memasukkan 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	Jumlah entri per halaman.
PageSize	integer	Jumlah entri per halaman.	10
RequestId	string	ID permintaan.	33E480C5-B46F-4CA5-B6FD-D77C746E86AB
PageNumber	integer	Nomor halaman saat ini.	1
TotalCount	integer	Jumlah total entri.	1
HaVips	object
HaVip	array<object>	Detail HaVip.
	array<object>	Detail HaVip.
VpcId	string	ID VPC tempat HaVip berada.	vpc-bp1kcm36tevkpms97****
Status	string	Status HaVip. Nilai valid: Creating: HaVip sedang dibuat. Available: HaVip tersedia. Deleting: HaVip sedang dihapus.	Available
HaVipId	string	ID HaVip.	havip-bp149uyvut73dpld****
AssociatedInstanceType	string	Tipe instans yang dilampirkan ke HaVip. Nilai valid: EcsInstance: Instance ECS. NetworkInterface: Instans pengontrol antarmuka jaringan elastis (NIC).	EcsInstance
CreateTime	string	Waktu pembuatan HaVip. Waktu ditampilkan dalam UTC dan mengikuti standar ISO 8601 dalam format YYYY-MM-DDThh:mm:ssZ.	2021-07-03T14:25:26Z
ChargeType	string	Parameter ini tidak valid dan mengembalikan nilai kosong.	none
RegionId	string	ID wilayah tempat HaVip berada.	cn-hangzhou
VSwitchId	string	ID vSwitch tempat HaVip berada.	vsw-bp1pkt1fba8e824ez****
IpAddress	string	Alamat IP privat HaVip.	192.168.24.5
Description	string	Deskripsi HaVip.	My HaVip
MasterInstanceId	string	ID instans instans utama yang dilampirkan ke HaVip.	i-bp145q7glnuzdvz****
Name	string	Nama HaVip.	test
AssociatedEipAddresses	object
associatedEipAddresse	array	Daftar EIP yang terkait dengan HaVip.
	string	EIP yang terkait dengan HaVip.	121.12.XX.XX
AssociatedInstances	object
associatedInstance	array	Informasi tentang instans yang terkait dengan HaVip.
	string	ID instans yang dilampirkan ke HaVip.	i-bp145q7glnuzdvzu21****
ResourceGroupId	string	ID kelompok sumber daya tempat HaVip berada.	rg-bp67acfmxazb4ph****
Tags	object
Tag	array<object>	Daftar tag.
	object	Daftar tag.
Key	string	Kunci tag.	FinanceDept
Value	string	Nilai tag.	FinanceJoshua

Contoh

Respons sukses

JSONformat

{
  "PageSize": 10,
  "RequestId": "33E480C5-B46F-4CA5-B6FD-D77C746E86AB",
  "PageNumber": 1,
  "TotalCount": 1,
  "HaVips": {
    "HaVip": [
      {
        "VpcId": "vpc-bp1kcm36tevkpms97****",
        "Status": "Available",
        "HaVipId": "havip-bp149uyvut73dpld****",
        "AssociatedInstanceType": "EcsInstance",
        "CreateTime": "2021-07-03T14:25:26Z",
        "ChargeType": "none",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-bp1pkt1fba8e824ez****",
        "IpAddress": "192.168.24.5",
        "Description": "My HaVip",
        "MasterInstanceId": "i-bp145q7glnuzdvz****",
        "Name": "test",
        "AssociatedEipAddresses": {
          "associatedEipAddresse": [
            "121.12.XX.XX"
          ]
        },
        "AssociatedInstances": {
          "associatedInstance": [
            "i-bp145q7glnuzdvzu21****"
          ]
        },
        "ResourceGroupId": "rg-bp67acfmxazb4ph****",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.	Anda tidak memiliki izin untuk melakukan operasi pada HaVip. Ajukan izin di Pusat Kuota.
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	RegionId yang ditentukan tidak ada. Periksa apakah layanan ini tersedia di wilayah yang ditentukan.
400	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.