Panggil DescribeInstances untuk mengkueri detail instans-ENS-Alibaba Cloud

Mengambil detail satu atau beberapa instance.

Deskripsi operasi

Laju Permintaan API: 800 permintaan per detik.
Laju Permintaan Pengguna Tunggal: 100 permintaan per detik.
Parameter permintaan berfungsi sebagai filter dan digabungkan menggunakan logika AND. Parameter kosong diabaikan. Namun, jika parameter InstanceIds berupa array JSON kosong, API akan menerapkan filter tersebut dan mengembalikan daftar kosong.

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

ens:DescribeInstances

list

*Instance

acs:ens:*:{#accountId}:instance/{#InstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	ID node edge.	cn-beijing-cmcc
InstanceId	string	No	ID instans.	i-5iqczfxps7csjrxeca****
EnsRegionIds	string	No	Array JSON ID node edge. Anda dapat menentukan hingga 100 ID.	["cn-suzhou-telecom","cn-chengdu-telecom"]
InstanceIds	string	No	Array JSON ID instans. Anda dapat menentukan hingga 100 ID.	["i-5iqczfxps7csjrxeca07**", "i-5iqczfxps7csjrxeca07**"]
InstanceName	string	No	Nama instans.	TestName
ImageId	string	No	ID image.	centos_6_08_64_20G_alibase_****
PageNumber	integer	No	Nomor halaman. Halaman dimulai dari 1. Nilai default: 1.	1
PageSize	string	No	Jumlah entri per halaman. Nilai maksimum: 100. Nilai default: 10.	10
Status	string	No	Status instans. Nilai yang valid: `Running` `Stopped` `Expired`	Running
OrderByParams	string	No	Urutan pengurutan hasil, ditentukan dalam format JSON. Anda dapat mengurutkan berdasarkan nama instans, waktu kedaluwarsa, ID node edge, atau waktu pembuatan.	{ "InstanceNameSort": "asc", "ExpireTimeSort": "asc", "CreationTimeSort": "desc", "EnsRegionId": "desc" }
EnsServiceId	string	No	ID layanan edge. Gunakan parameter ini untuk menemukan instans yang dibuat oleh layanan tersebut.	ens-20190730202316s****
InstanceResourceType	string	No	Jenis resource untuk difilter. Nilai yang valid: `EnsInstance`: instans yang dibeli secara individual. `EnsService`: instans yang dibuat oleh layanan edge. `BuildMachine`: mesin build. `EnsPostPaidInstance`: instans post-paid yang dibeli secara individual.	EnsService
SearchKey	string	No	Kata kunci pencarian. Anda dapat mencari berdasarkan Alamat IP, Nama Instans, atau ID Instans.	Joshua
NetworkId	string	No	ID jaringan.	n-2zeuphj08tt7q3brd****
VSwitchId	string	No	ID vSwitch.	vsw-2zeh0r1pabwtg6wcs****
SecurityGroupId	string	No	ID security group.	sg-5kyicq2kfcapxrdds6tar7jqb
IntranetIp	string	No	Alamat IP pribadi.	47.100.XX.XX
Tags	array<object>	No	Tag untuk memfilter resource. Anda dapat menentukan hingga 20 tag. Operasi ini menggunakan tag tersebut untuk pemfilteran tetapi tidak menyertakannya dalam respons. Untuk mengelola tag, gunakan operasi API tag khusus.
	object	No	Pasangan kunci-nilai tag.
Key	string	No	Kunci tag.	tag
Value	string	No	Nilai tag.	2
InstanceType	string	No	Tipe instans.	ens.se1.tiny
ServiceStatus	array	No	Status layanan instans. Ini tidak merepresentasikan status runtime aktual instans.
	string	No	Nilai yang valid: `Expired`: instans telah kedaluwarsa. `Arrears`: instans memiliki pembayaran tertunda.	Expired
EipAddresses	array	No
	string	No

Elemen respons

Element	Type	Description	Example
	object
Code	integer	Kode respons. Nilai 0 menunjukkan permintaan berhasil.	0
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	60
PageNumber	integer	Nomor halaman dari halaman yang dikembalikan.	1
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Jumlah total instans yang sesuai dengan kueri.	2
Instances	object
Instance	array<object>	Daftar instans dan detailnya.
	array<object>	Detail instans.
CreationTime	string	Waktu pembuatan instans. Waktu ditampilkan dalam UTC dan mengikuti standar ISO 8601, diformat sebagai yyyy-MM-ddTHH:mm:ssZ.	2019-07-26T06:40:43Z
Status	string	Status instans. Nilai yang valid: Running Expired Stopped	Running
SpecName	string	Tipe instans.	ens.sn1.stiny
InstanceTypeFamily	string	Famili tipe instans. Nilai yang valid: `x86_vm`: komputasi x86 `x86_pm`: Bare Metal x86 `x86_bmi`: instans Bare Metal x86 `x86_bm`: instans Bare Metal dengan smart NIC `pc_bmi`: instans Bare Metal heterogen `pc_vm`: mesin virtual heterogen `arm_bmi`: komputasi ARM	x86_vm
InstanceResourceType	string	Jenis resource instans. Nilai yang valid: `EnsInstance`: Instans yang dibeli secara individual. `EnsService`: Instans yang dibuat oleh layanan edge. `BuildMachine`: Mesin yang digunakan untuk membuat image. `EnsPostPaidInstance`: Instans post-paid yang dibeli secara individual.	EnsService
HostName	string	Hostname instans. Titik (.) atau tanda hubung (-) tidak boleh menjadi karakter pertama atau terakhir, dan tidak boleh digunakan secara berurutan. Untuk instans Windows, hostname harus terdiri dari 2 hingga 15 karakter, tidak boleh mengandung titik (.), dan tidak boleh hanya terdiri dari angka. Boleh mengandung huruf kapital, huruf kecil, angka, dan tanda hubung (-). Untuk jenis instans lain seperti Linux, hostname harus terdiri dari 2 hingga 64 karakter dan boleh mengandung beberapa titik (.). Setiap segmen yang dipisahkan oleh titik boleh mengandung huruf kapital, huruf kecil, angka, dan tanda hubung (-).	testHostName
InstanceId	string	ID instans.	i-instanc****
InternetMaxBandwidthIn	integer	Bandwidth publik masuk maksimum, dalam Mbit/s.	40
InternetMaxBandwidthOut	integer	Bandwidth publik keluar maksimum, dalam Mbit/s.	100
EnsRegionId	string	ID wilayah tempat instans berada.	cn-hangzhou-telecom
Cpu	string	Jumlah vCPU.	2
ExpiredTime	string	Waktu kedaluwarsa. Waktu ditampilkan dalam UTC dan mengikuti standar ISO 8601, diformat sebagai yyyy-MM-ddTHH:mm:ssZ.	2119-07-13T02:38:57Z
InstanceName	string	Nama instans.	i-5itef0f28t17bcdw9deu6meub
Disk	integer	Total ukuran disk, dalam MiB.	71680
OSName	string	Nama sistem operasi.	centos 6.8 x86_64
Memory	integer	Ukuran memori, dalam MiB.	2048
ImageId	string	ID image.	m-****
DataDisk	object	Disk data.
DataDisk	array<object>	Daftar disk data.
	object	Detail disk data.
device_type	string	Bidang tambahan untuk `Category`. Nilai yang valid: file: disk lokal pangu: Ultra Disk local_hdd: HDD lokal	pangu
disk_type	string	Jenis disk. Nilai yang valid: system: disk sistem data: disk data	system
Size	integer	Ukuran disk, dalam MiB.	51200
DiskName	string	Nama disk.	DiskName
uuid	string	UUID disk.	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	Ukuran disk, dalam MiB.	20480
DiskId	string	ID disk.	d-5ip4c2dhmas0vjd5u1r****
Category	string	Kategori disk. Nilai yang valid: file: disk lokal pangu: Ultra Disk local_hdd: HDD lokal	file
name	string	Nama disk.	name
DiskSize	integer	Ukuran disk, dalam GiB.	100
EncryptKeyId	string	ID kunci KMS yang digunakan untuk disk.	0e478b7a-4262-4802-b8cb-00d3fxxxxx
Encrypted	boolean	Menunjukkan apakah disk dienkripsi.	true
PublicIpAddresses	object	Alamat IP publik.
PublicIpAddress	array<object>	Daftar alamat IP publik.
	object	Detail alamat IP publik.
Ip	string	Alamat IP publik.	119.147.xx.xx
GateWay	string	Gateway.	119.147.xx.xx
Isp	string	Penyedia layanan internet (ISP).	unicom
PrivateIpAddresses	object	Alamat IP pribadi.
PrivateIpAddress	array<object>	Daftar alamat IP pribadi.
	object	Detail alamat IP pribadi.
Ip	string	Alamat IP pribadi.	119.147.xx.xx
GateWay	string	Gateway.	119.147.xx.xx
Isp	string	ISP.	cmcc
SecurityGroupIds	object	ID security group yang terkait dengan instans.
SecurityGroupId	array	Daftar ID security group.
	string	ID security group.	sg-5kyicq2kfcapxrdds6ta****
InnerIpAddress	object	Alamat IP pribadi.
IpAddress	array	Daftar alamat IP pribadi instans.
	string	Alamat IP pribadi instans.	10.170.xx.xx
PublicIpAddress	object	Alamat IP publik.
IpAddress	array	Daftar alamat IP publik.
	string	Alamat IP publik.	119.147.xx.xx
SystemDisk	object	Detail disk sistem.
device_type	string	Bidang tambahan untuk `Category`. Nilai yang valid: file: disk lokal pangu: Ultra Disk local_hdd: HDD lokal	pangu
disk_type	string	Jenis disk. Nilai yang valid: system: disk sistem data: disk data	system
Size	integer	Ukuran disk, dalam MiB.	51200
DiskName	string	Nama disk.	DiskName
uuid	string	UUID disk.	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	Ukuran disk, dalam MiB.	20480
DiskId	string	ID disk.	d-5ip4c2dhmas0rn7rt0p9****
Category	string	Kategori disk. Nilai yang valid: file: disk lokal pangu: Ultra Disk local_hdd: HDD lokal	file
name	string	Nama disk.	DiskName
NetworkAttributes	object	Atribut jaringan.
NetworkId	string	ID jaringan.	n-2zeuphj08tt7q3brd****
VSwitchId	string	ID VSwitch.	vsw-2zeh0r1pabwtg6wcs****
PrivateIpAddress	object
IpAddress	array	Informasi jaringan pribadi instans.
	string	Alamat IP pribadi instans. Maksimal satu alamat IP pribadi dapat ditentukan. Alamat IP harus merupakan alamat yang tersedia dalam Blok CIDR VSwitch (VSwitchId).	172.17..
Tags	object
Tags	array<object>	Kumpulan tag untuk instans. Penting API ini saat ini tidak mengembalikan informasi tag. Gunakan API ini bersama API di direktori Tag.
	object	Informasi tag. Penting API ini saat ini tidak mengembalikan informasi tag. Gunakan API di bagian Tag untuk mendapatkan informasi tag.
TagValue	string	Nilai Tag	value1
TagKey	string	Kunci tag instans.	key1
AutoReleaseTime	string	Waktu pelepasan otomatis instans.	2023-06-28T14:38:52Z
SpotStrategy	string	Strategi instans preemptible.	NoSpot
KeyPairName	string	Nama pasangan kunci.	TestKeyPairName
NetworkInterfaces	object
NetworkInterfaces	array<object>	Informasi tentang Elastic Network Interface (ENI).
	array<object>	Array objek Elastic Network Interface (ENI).
Type	string	Jenis elastic network interface (ENI). Nilai yang valid: Primary: ENI primer. Secondary: ENI sekunder.	Primary
MacAddress	string	Alamat MAC Elastic Network Interface (ENI).	00:16:XXX:XXX:60:0a
PrimaryIpAddress	string	Alamat IP pribadi utama.	10.XXX.XXX.25
NetworkInterfaceId	string	ID Elastic Network Interface (ENI).	eni-53afk8a0t5lklbi8m7j8iczdg
PrivateIpSets	object
PrivateIpSet	array<object>	Kumpulan objek PrivateIpSet.
	object	Array objek PrivateIpSet.
PrivateIpAddress	string	Alamat IP pribadi.	192.XXX.XXX.130
Primary	boolean	Menunjukkan apakah alamat IP adalah alamat IP pribadi utama. Nilai yang valid: true: Alamat IP pribadi utama. false: Alamat IP pribadi sekunder.	true
Ipv6Sets	object
Ipv6Set	array<object>	Alamat IPv6 yang ditetapkan ke Elastic Network Interface (ENI).
	object	Kumpulan alamat IPv6 yang ditetapkan ke Elastic Network Interface (ENI).
Ipv6Address	string	Alamat IPv6 yang ditetapkan ke Elastic Network Interface (ENI).	2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6
ServiceStatus	string	Status layanan instans. Ini tidak merepresentasikan status running aktual instans.	Expired
DeletionProtection	boolean

Contoh

Respons sukses

JSONformat

{
  "Code": 0,
  "PageSize": 60,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 2,
  "Instances": {
    "Instance": [
      {
        "CreationTime": "2019-07-26T06:40:43Z",
        "Status": "Running",
        "SpecName": "ens.sn1.stiny",
        "InstanceTypeFamily": "x86_vm",
        "InstanceResourceType": "EnsService",
        "HostName": "testHostName",
        "InstanceId": "i-instanc****",
        "InternetMaxBandwidthIn": 40,
        "InternetMaxBandwidthOut": 100,
        "EnsRegionId": "cn-hangzhou-telecom",
        "Cpu": "2",
        "ExpiredTime": "2119-07-13T02:38:57Z",
        "InstanceName": "i-5itef0f28t17bcdw9deu6meub",
        "Disk": 71680,
        "OSName": "centos 6.8 x86_64",
        "Memory": 2048,
        "ImageId": "m-****",
        "DataDisk": {
          "DataDisk": [
            {
              "device_type": "pangu",
              "disk_type": "system",
              "Size": 51200,
              "DiskName": "DiskName",
              "uuid": "5431f898-1323-4e64-8ce1-6cad50ed****",
              "storage": 20480,
              "DiskId": "d-5ip4c2dhmas0vjd5u1r****",
              "Category": "file",
              "name": "name",
              "DiskSize": 100,
              "EncryptKeyId": "0e478b7a-4262-4802-b8cb-00d3fxxxxx",
              "Encrypted": true
            }
          ]
        },
        "PublicIpAddresses": {
          "PublicIpAddress": [
            {
              "Ip": "119.147.xx.xx",
              "GateWay": "119.147.xx.xx",
              "Isp": "unicom"
            }
          ]
        },
        "PrivateIpAddresses": {
          "PrivateIpAddress": [
            {
              "Ip": "119.147.xx.xx",
              "GateWay": "119.147.xx.xx",
              "Isp": "cmcc"
            }
          ]
        },
        "SecurityGroupIds": {
          "SecurityGroupId": [
            "sg-5kyicq2kfcapxrdds6ta****"
          ]
        },
        "InnerIpAddress": {
          "IpAddress": [
            "10.170.xx.xx"
          ]
        },
        "PublicIpAddress": {
          "IpAddress": [
            "119.147.xx.xx"
          ]
        },
        "SystemDisk": {
          "device_type": "pangu",
          "disk_type": "system",
          "Size": 51200,
          "DiskName": "DiskName",
          "uuid": "5431f898-1323-4e64-8ce1-6cad50ed****",
          "storage": 20480,
          "DiskId": "d-5ip4c2dhmas0rn7rt0p9****",
          "Category": "file",
          "name": "DiskName"
        },
        "NetworkAttributes": {
          "NetworkId": "n-2zeuphj08tt7q3brd****",
          "VSwitchId": "vsw-2zeh0r1pabwtg6wcs****",
          "PrivateIpAddress": {
            "IpAddress": [
              "172.17.**.**"
            ]
          }
        },
        "Tags": {
          "Tags": [
            {
              "TagValue": "value1",
              "TagKey": "key1"
            }
          ]
        },
        "AutoReleaseTime": "2023-06-28T14:38:52Z",
        "SpotStrategy": "NoSpot",
        "KeyPairName": "TestKeyPairName",
        "NetworkInterfaces": {
          "NetworkInterfaces": [
            {
              "Type": "Primary",
              "MacAddress": "00:16:XXX:XXX:60:0a",
              "PrimaryIpAddress": "10.XXX.XXX.25",
              "NetworkInterfaceId": "eni-53afk8a0t5lklbi8m7j8iczdg",
              "PrivateIpSets": {
                "PrivateIpSet": [
                  {
                    "PrivateIpAddress": "192.XXX.XXX.130",
                    "Primary": true
                  }
                ]
              },
              "Ipv6Sets": {
                "Ipv6Set": [
                  {
                    "Ipv6Address": "2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6"
                  }
                ]
              }
            }
          ]
        },
        "ServiceStatus": "Expired",
        "DeletionProtection": false
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.