DescribeEipAddresses - Elastic IP Address - Alibaba Cloud Documentation Center

Menanyakan elastic IP addresses (EIPs) yang dibuat di wilayah tertentu.

Deskripsi operasi

Operasi ini mengambil informasi mengenai EIP yang dibuat di wilayah tertentu, termasuk bandwidth maksimum, metode penagihan, dan jenis instans yang saat ini terhubung ke setiap EIP. Jika Anda sering melakukan deep paging atau melewati halaman, kode kesalahan Throttling.DeepPageSkip mungkin dikembalikan. Untuk menghindarinya, 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:DescribeEipAddresses

list

*Address.

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

vpc:tag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah EIP.	cn-hangzhou.
IncludeReservationData	boolean	No	Menentukan apakah akan menyertakan data langganan yang belum berlaku. Nilai yang valid:	false.
Status	string	No	Status EIP. Nilai yang valid:	Available.
EipAddress	string	No	Alamat IP EIP yang akan ditanyakan.	47.75.XX.XX
AllocationId	string	No	ID instans EIP yang akan ditanyakan.	eip-2zeerraiwb7ujxscd****
SegmentInstanceId	string	No	ID instans kelompok EIP berurutan.	eipsg-t4nr90yik5oy38xdy****
ResourceGroupId	string	No	ID kelompok sumber daya tempat EIP tersebut berada.	rg-acfmxazb4pcdvf****
PageNumber	integer	No	Nomor halaman daftar. Nilai default: 1.	10
PageSize	integer	No	Jumlah entri per halaman dalam kueri terpaginasi. Nilai maksimum: 100. Nilai default: 10.	10
ISP	string	No	Jenis jalur. Nilai yang valid:	BGP.
Filter.1.Key	string	No	Kunci filter untuk menanyakan sumber daya. Nilainya harus CreationStartTime, yang menentukan waktu mulai saat sumber daya dibuat.	CreationStartTime.
Filter.2.Key	string	No	Kunci filter untuk menanyakan sumber daya. Nilainya harus CreationEndTime, yang menentukan waktu akhir saat sumber daya dibuat.	CreationEndTime.
Filter.1.Value	string	No	Nilai filter untuk menanyakan sumber daya. Tentukan nilai dalam UTC dengan format `YYYY-MM-DDThh:mmZ`.	2023-01-01T01:00Z
Filter.2.Value	string	No	Nilai filter untuk menanyakan sumber daya. Tentukan nilai dalam UTC dengan format `YYYY-MM-DDThh:mmZ`.	2023-01-06T02:00Z
LockReason	string	No	Jenis penguncian. Nilai yang valid:	financial.
AssociatedInstanceType	string	No	Jenis instans sumber daya cloud yang akan diasosiasikan. Nilai yang valid:	EcsInstance.
AssociatedInstanceId	string	No	ID instans sumber daya cloud.	i-2zebb08phyccdvf****
ChargeType	string	No	Metode penagihan EIP. Nilai yang valid:	PostPaid.
DryRun	boolean	No	Menentukan apakah hanya akan menjalankan dry run. Nilai yang valid:	false.
EipName	string	No	Nama EIP.	EIP-01
Tag	array<object>	No	Tag yang digunakan untuk memfilter EIP.
	object	No	Tag yang digunakan untuk memfilter EIP.
Key	string	No	Kunci tag. Anda dapat menentukan hingga 20 kunci tag. Kunci tag tidak boleh berupa string kosong.	FinanceDept.
Value	string	No	Nilai tag. Anda dapat menentukan hingga 20 nilai tag. Nilai tag boleh berupa string kosong.	FinanceJoshua.
SecurityProtectionEnabled	boolean	No	Menentukan apakah Anti-DDoS (Enhanced) diaktifkan. Nilai yang valid:	false.
PublicIpAddressPoolId	string	No	ID kolam alamat IP tempat EIP yang akan ditanyakan berada.	pippool-2vc0kxcedhquybdsz****
ServiceManaged	boolean	No	Menentukan apakah instans tersebut merupakan instans terkelola. Nilai yang valid:	false.

Elemen respons

Element	Type	Description	Example
	object	Daftar informasi yang dikembalikan.
PageSize	integer	Jumlah entri per halaman.	10
RequestId	string	ID permintaan.	4EC47282-1B74-4534-BD0E-403F3EE64CAF.
PageNumber	integer	Nomor halaman saat ini.	10
TotalCount	integer	Total jumlah entri.	1
EipAddresses	object
EipAddress	array<object>	Detail EIP.
	array<object>	Detail EIP.
ReservationActiveTime	string	Waktu aktif perpanjangan dalam format `YYYY-MM-DDThh:mm:ssZ`.	2021-05-23T16:00:00Z
Status	string	Status EIP.	Available.
ReservationOrderType	string	Jenis pesanan perpanjangan.	RENEWCHANGE.
AllocationTime	string	Waktu pembuatan EIP dalam format `YYYY-MM-DDThh:mm:ssZ`.	2021-04-23T01:37:38Z
Netmode	string	Jenis jaringan. Nilainya adalah public, yang menunjukkan Internet.	public.
ChargeType	string	Metode penagihan EIP. Nilai yang valid:	PostPaid.
Description	string	Deskripsi EIP.	abc.
Mode	string	Mode asosiasi. Nilai yang valid:	NAT.
SegmentInstanceId	string	ID instans kelompok EIP berurutan.	eipsg-t4nr90yik5oy38xd****
ReservationInternetChargeType	string	Jenis penagihan perpanjangan.	PayByBandwidth.
BandwidthPackageId	string	ID instans Internet Shared Bandwidth tempat EIP ditambahkan.	cbwp-bp1ego3i4j07ccdvf****
IpAddress	string	Alamat IP EIP.	47.75.XX.XX
Bandwidth	string	Bandwidth puncak EIP. Satuan: Mbps.	5
ReservationBandwidth	string	Bandwidth perpanjangan. Satuan: Mbps.	12
EipBandwidth	string	Bandwidth EIP sebelum ditambahkan ke atau setelah dihapus dari instans Internet Shared Bandwidth. Satuan: Mbps.	101
Name	string	Nama EIP.	EIP-01
PrivateIpAddress	string	Alamat IP pribadi dari instans network interface card (NIC) secondary tempat EIP disambungkan.	192.168.XX.XX
InstanceRegionId	string	ID wilayah sumber daya yang saat ini diasosiasikan dengan EIP.	cn-hangzhou.
DeletionProtection	boolean	Menunjukkan apakah perlindungan penghapusan diaktifkan.	true.
InstanceId	string	ID instans yang saat ini diasosiasikan dengan EIP.	i-bp15zckdt37cdvf****
SecondLimited	boolean	Menunjukkan apakah Pembatasan bandwidth secondary dikonfigurasi.	false.
InstanceType	string	Jenis instans yang saat ini diasosiasikan dengan EIP.	EcsInstance.
HDMonitorStatus	string	Menunjukkan apakah Pemantauan tingkat detik diaktifkan untuk EIP.	false.
RegionId	string	ID wilayah EIP.	cn-hangzhou.
BandwidthPackageBandwidth	string	Bandwidth instans Internet Shared Bandwidth tempat EIP ditambahkan. Satuan: Mbps.	50
ServiceManaged	integer	Menentukan apakah instans tersebut merupakan instans terkelola. Nilai yang valid:	0
ExpiredTime	string	Waktu kedaluwarsa dalam format `YYYY-MM-DDThh:mm:ssZ`.	2021-05-23T02:00:00Z
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmxazcdxs****
AllocationId	string	ID instans EIP.	eip-2zeerraiwb7ujcdvf****
InternetChargeType	string	Metode penagihan EIP.	PayByBandwidth.
BusinessStatus	string	Status bisnis instans EIP.	Normal.
BandwidthPackageType	string	Jenis bandwidth. Hanya CommonBandwidthPackage (Internet Shared Bandwidth) yang dikembalikan.	CommonBandwidthPackage.
HasReservationData	string	Menunjukkan apakah data perpanjangan tersedia.	false.
ISP	string	Jenis jalur.	BGP.
OperationLocks	object
LockReason	array<object>	Detail penguncian.
	object	Detail penguncian.
LockReason	string	Jenis penguncian.	financial.
Tags	object
Tag	array<object>	Daftar tag yang diasosiasikan dengan EIP.
	object	Daftar tag yang diasosiasikan dengan EIP.	"Tag": [ { "Value": "000", "Key": "yyy" }, { "Value": "111","Key": "kkk" }
Key	string	Kunci tag EIP.	KeyTest.
Value	string	Nilai tag EIP.	ValueTest.
SecurityProtectionTypes	object
SecurityProtectionType	array	Tingkat perlindungan keamanan.
	string	Tingkat perlindungan keamanan.	AntiDDoS_Enhanced.
PublicIpAddressPoolId	string	ID kolam alamat IP tempat EIP berada.	pippool-2vc0kxcedhquybdsz****
VpcId	string	ID VPC yang memiliki fitur gateway IPv4 diaktifkan dan berada di wilayah yang sama dengan EIP.	vpc-bp15zckdt37pq72zv****
Zone	string	Zona EIP.	ap-southeast-1-lzdvn-cb.
BizType	string	Jenis bisnis EIP.	CloudBox.
ServiceID	integer	ID akun layanan cloud terkelola.	18726XXXXXXX.

Contoh

Respons sukses

JSONformat

{
  "PageSize": 10,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF.",
  "PageNumber": 10,
  "TotalCount": 1,
  "EipAddresses": {
    "EipAddress": [
      {
        "ReservationActiveTime": "2021-05-23T16:00:00Z",
        "Status": "Available.",
        "ReservationOrderType": "RENEWCHANGE.",
        "AllocationTime": "2021-04-23T01:37:38Z",
        "Netmode": "public.",
        "ChargeType": "PostPaid.",
        "Description": "abc.",
        "Mode": "NAT.",
        "SegmentInstanceId": "eipsg-t4nr90yik5oy38xd****",
        "ReservationInternetChargeType": "PayByBandwidth.",
        "BandwidthPackageId": "cbwp-bp1ego3i4j07ccdvf****",
        "IpAddress": "47.75.XX.XX",
        "Bandwidth": "5",
        "ReservationBandwidth": "12",
        "EipBandwidth": "101",
        "Name": "EIP-01",
        "PrivateIpAddress": "192.168.XX.XX",
        "InstanceRegionId": " cn-hangzhou.",
        "DeletionProtection": true,
        "InstanceId": "i-bp15zckdt37cdvf****",
        "SecondLimited": true,
        "InstanceType": "EcsInstance.",
        "HDMonitorStatus": "false.",
        "RegionId": "cn-hangzhou.",
        "BandwidthPackageBandwidth": "50",
        "ServiceManaged": 0,
        "ExpiredTime": "2021-05-23T02:00:00Z",
        "ResourceGroupId": "rg-acfmxazcdxs****",
        "AllocationId": "eip-2zeerraiwb7ujcdvf****",
        "InternetChargeType": "PayByBandwidth.",
        "BusinessStatus": "Normal.",
        "BandwidthPackageType": "CommonBandwidthPackage.",
        "HasReservationData": "false.",
        "ISP": "BGP.",
        "OperationLocks": {
          "LockReason": [
            {
              "LockReason": "financial."
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "KeyTest.",
              "Value": "ValueTest."
            }
          ]
        },
        "SecurityProtectionTypes": {
          "SecurityProtectionType": [
            "AntiDDoS_Enhanced."
          ]
        },
        "PublicIpAddressPoolId": "pippool-2vc0kxcedhquybdsz****",
        "VpcId": "vpc-bp15zckdt37pq72zv****",
        "Zone": "ap-southeast-1-lzdvn-cb.",
        "BizType": "CloudBox.",
        "ServiceID": 0
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidIAssociatedInstanceType.ValueNotSupported	The specified value of AssociatedInstanceType is not supported.	Nilai AssociatedInstanceType tidak valid. Periksa apakah parameter ini sudah benar.
400	InvalidChargeType.ValueNotSupported	The specified ChargeType is not supported.
400	InvalidAliuid	User Id is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	ID kelompok sumber daya tidak ada.
400	InstanceType.Invalid	InstanceType is not null
400	InstanceIdLength.Exceed	InstanceId length is exceed
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	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.	Operasi tidak didukung. ID kelompok sumber daya tidak didukung di Cloud Keuangan.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	Parameter OwnerAccount yang ditentukan tidak valid.
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	InvalidFilterValue	The specified FilterValue is not supported.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.
404	InvalidFilterKey.NotFound	The specified Filterkey is not supported.
404	InvalidLockReason.NotFound	The specified LockReason is not found

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.