Panggil DescribeInstances untuk mengkueri detail instans-ENS-Alibaba Cloud - ENS

Mengambil detail satu atau beberapa instance.

Deskripsi operasi

Frekuensi pemanggilan API: 800 kali per detik.

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 wilayah.	cn-beijing-cmcc
InstanceId	string	No	ID instans.	i-5iqczfxps7csjrxeca****
EnsRegionIds	string	No	Daftar ID edge zone. Parameter ini berupa array JSON terformat yang berisi hingga 100 ID yang dipisahkan koma (,).	["cn-suzhou-telecom","cn-chengdu-telecom"]
InstanceIds	string	No	Daftar ID instans. Parameter ini berupa array JSON terformat yang berisi hingga 100 ID yang dipisahkan koma (,).	["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 daftar status instans. Nilai dimulai dari 1.	1
PageSize	string	No	Jumlah entri per halaman untuk kueri terpaginasi. Nilai maksimum: 100.	10
Status	string	No	Status instance. Nilai yang valid: Running: Sedang berjalan. Stopped: Dihentikan. Expired: Kedaluwarsa.	Running
OrderByParams	string	No	Parameter pengurutan dalam format JSON.	{ "InstanceNameSort": "asc", "ExpireTimeSort": "asc", "CreationTimeSort": "desc", "EnsRegionId": "desc" }
EnsServiceId	string	No	ID Edge Node Service. Anda dapat menggunakan ID ini untuk menanyakan instans yang dibuat di bawah layanan tepi.	ens-20190730202316s****
InstanceResourceType	string	No	Tipe filter. Nilai yang valid:	EnsService
SearchKey	string	No	Kata kunci pencarian. Mendukung parameter seperti ip, InstanceName, dan InstanceId.	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 internal.	47.100.XX.XX
Tags	array<object>	No	Tag sumber daya. Operasi ini tidak mengembalikan informasi tag. Gunakan parameter ini bersama dengan API dalam kategori tag.
	object	No	Kumpulan tag instans. Operasi ini tidak mengembalikan informasi tag. Gunakan parameter ini bersama dengan API dalam kategori tag.
Key	string	No	Kunci tag instans. Nilai N yang valid: 1 hingga 20.	tag
Value	string	No	Nilai tag instans. Nilai N yang valid: 1 hingga 20.	2
InstanceType	string	No	Tipe instans.	ens.se1.tiny
ServiceStatus	array	No	Status bisnis instans, yang tidak mewakili status berjalan aktual instans.
	string	No	Status layanan instans. Ini tidak mewakili status berjalan aktual instans. Expired Arrears (pembayaran tertunda)	Expired
EipAddresses	array	No	Daftar alamat EIP yang digunakan untuk memfilter instans.
	string	No	Daftar alamat EIP yang digunakan untuk memfilter instans.	120.XX.XX.10
VpdId	string	No	ID jaringan VPD.	vpd-5s7xxxxxxx
VpdVSwitchId	string	No	ID vSwitch VPD.	vsw-5s7xxxxxxx

Elemen respons

Element	Type	Description	Example
	object
Code	integer	Kode bisnis yang dikembalikan. Nilai 0 menunjukkan keberhasilan.	0
PageSize	integer	Jumlah entri per halaman yang ditentukan dalam permintaan.	60
PageNumber	integer	Nomor halaman daftar instans.	1
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Jumlah total instans yang dikembalikan.	2
Instances	object
Instance	array<object>	Array objek InstanceAttributesType yang berisi informasi instans.
	array<object>	Skema Respons
CreationTime	string	Waktu saat instans dibuat. Waktu dalam UTC dan menggunakan format ISO 8601: `yyyy-MM-ddTHH:mm:ssZ`.	2019-07-26T06:40:43Z
Status	string	Status instans. Nilai yang valid: `Running`: Instans sedang berjalan. `Expired`: Instans telah kedaluwarsa. `Stopped`: Instans dihentikan.	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`: Bare metal Smart NIC `pc_bmi`: Instans bare metal heterogen `pc_vm`: Mesin virtual heterogen `arm_bmi`: Komputasi ARM	x86_vm
InstanceResourceType	string	Tipe sumber daya instans. Nilai yang valid: `EnsInstance`: Instans mandiri. `EnsService`: Instans layanan tepi. `BuildMachine`: Mesin pembuat image. `EnsPostPaidInstance`: Instans mandiri berbayar sesuai penggunaan.	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, berupa huruf, angka, dan tanda hubung (-). Tidak boleh mengandung titik (.) atau hanya terdiri dari angka. Untuk tipe instans lainnya (seperti Linux), hostname harus terdiri dari 2 hingga 64 karakter. Anda dapat menggunakan titik (.) untuk memisahkan nama menjadi segmen. Setiap segmen dapat terdiri dari huruf, angka, dan tanda hubung (-).	testHostName
InstanceId	string	ID instans.	i-instanc****
InternetMaxBandwidthIn	integer	Bandwidth publik masuk maksimum. Satuan: Mbit/s.	40
InternetMaxBandwidthOut	integer	Bandwidth publik keluar maksimum. Satuan: Mbit/s.	100
EnsRegionId	string	ID wilayah instans.	cn-hangzhou-telecom
Cpu	string	Jumlah core vCPU.	2
ExpiredTime	string	Waktu kedaluwarsa. Waktu dalam UTC dan menggunakan format ISO 8601: `yyyy-MM-ddTHH:mm:ssZ`.	2119-07-13T02:38:57Z
InstanceName	string	Nama instans.	i-5itef0f28t17bcdw9deu6meub
Disk	integer	Ukuran total disk. Satuan: MiB.	71680
OSName	string	Nama image.	centos 6.8 x86_64
Memory	integer	Ukuran memori. Satuan: MB.	2048
ImageId	string	ID image.	m-****
DataDisk	object
DataDisk	array<object>	Informasi tentang disk data.
	object	Detail disk data.
device_type	string	Kategori disk. Nilai yang valid: file: Disk lokal. pangu: Efficiency Cloud Disk. local_hdd: HDD lokal.	pangu
disk_type	string	Tipe cloud disk atau disk lokal. Nilai yang valid: system: sistem disk. data: data disk.	system
Size	integer	Ukuran disk. Satuan: MiB.	51200
DiskName	string	Nama disk.	DiskName
uuid	string	UUID.	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	Ukuran disk. Satuan: MiB.	20480
DiskId	string	ID disk.	d-5ip4c2dhmas0vjd5u1r****
Category	string	Kategori cloud disk atau disk lokal. Nilai yang valid: file: Disk lokal. pangu: Efficiency Cloud Disk. local_hdd: HDD lokal.	file
name	string	Nama disk.	name
DiskSize	integer	Ukuran disk. Satuan: GiB.	100
EncryptKeyId	string	ID kunci KMS yang digunakan untuk cloud disk.	0e478b7a-4262-4802-b8cb-00d3fxxxxx
Encrypted	boolean	Menunjukkan apakah cloud disk dienkripsi.	true
PublicIpAddresses	object
PublicIpAddress	array<object>	Informasi tentang alamat IP publik.
	object	Informasi tentang alamat IP publik.
Ip	string	Alamat IP.	119.147.xx.xx
GateWay	string	Gateway.	119.147.xx.xx
Isp	string	ISP.	unicom
PrivateIpAddresses	object
PrivateIpAddress	array<object>	Informasi tentang alamat IP pribadi instans.
	object
Ip	string	Alamat IP.	119.147.xx.xx
GateWay	string	Gateway.	119.147.xx.xx
Isp	string	ISP.	cmcc
SecurityGroupIds	object
SecurityGroupId	array	ID security group.
	string	ID security group.	sg-5kyicq2kfcapxrdds6ta****
InnerIpAddress	object
IpAddress	array	Alamat IP pribadi instans.
	string	Alamat IP pribadi instans.	10.170.xx.xx
PublicIpAddress	object
IpAddress	array	Alamat IP publik.
	string	Alamat IP publik.	119.147.xx.xx
SystemDisk	object	Detail disk sistem.
device_type	string	Kategori disk. Nilai yang valid: file: Disk lokal. pangu: Efficiency Cloud Disk. local_hdd: HDD lokal.	pangu
disk_type	string	Jenis disk cloud atau disk lokal. Nilai yang valid: system: system disk. data: data disk.	system
Size	integer	Ukuran disk. Satuan: MiB.	51200
DiskName	string	Nama disk.	DiskName
uuid	string	UUID.	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	kapasitas disk. Satuan: MiB.	20480
DiskId	string	ID disk.	d-5ip4c2dhmas0rn7rt0p9****
Category	string	Kategori cloud disk atau disk lokal. Nilai yang valid: file: Disk lokal. pangu: Efficiency Cloud Disk. local_hdd: HDD lokal.	file
name	string	Nama disk.	DiskName
NetworkAttributes	object	Informasi jaringan.
NetworkId	string	ID jaringan.	n-2zeuphj08tt7q3brd****
VSwitchId	string	ID VSwitch.	vsw-2zeh0r1pabwtg6wcs****
PrivateIpAddress	object
IpAddress	array	Informasi tentang alamat IP pribadi instans.
	string	Alamat IP pribadi instans. Anda hanya dapat menentukan satu alamat IP pribadi. Alamat IP harus merupakan alamat yang tersedia dalam Blok CIDR VSwitch (`VSwitchId`) yang ditentukan.	172.17..
Tags	object
Tags	array<object>	Tag instans. Penting Operasi ini tidak mengembalikan informasi tag. Untuk mengambil tag, Anda harus memanggil API tagging khusus.
	object	Informasi tag. Penting Operasi ini tidak mengembalikan informasi tag. Untuk mengambil tag, Anda harus memanggil API tagging khusus.
TagValue	string	Nilai tag.	value1
TagKey	string	Kunci tag.	key1
AutoReleaseTime	string	Waktu saat instans dilepas secara otomatis.	2023-06-28T14:38:52Z
SpotStrategy	string	Kebijakan penawaran untuk spot instans.	NoSpot
KeyPairName	string	Nama pasangan kunci.	TestKeyPairName
NetworkInterfaces	object
NetworkInterfaces	array<object>	Daftar antarmuka jaringan elastis.
	array<object>	Detail antarmuka jaringan elastis.
Type	string	Tipe antarmuka jaringan elastis. Nilai yang valid: `Primary`: Antarmuka jaringan utama. `Secondary`: Antarmuka jaringan sekunder.	Primary
MacAddress	string	Alamat MAC antarmuka jaringan elastis.	00:16:XXX:XXX:60:0a
PrimaryIpAddress	string	Alamat IP pribadi utama.	10.XXX.XXX.25
NetworkInterfaceId	string	ID antarmuka jaringan elastis.	eni-53afk8a0t5lklbi8m7j8iczdg
PrivateIpSets	object
PrivateIpSet	array<object>	Koleksi objek `PrivateIpSet`.
	object	Koleksi 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 adalah alamat IP pribadi utama. `false`: Alamat IP adalah alamat IP pribadi sekunder.	true
Ipv6Sets	object
Ipv6Set	array<object>	Koleksi alamat IPv6 yang ditetapkan ke antarmuka jaringan elastis.
	object	Koleksi alamat IPv6 yang ditetapkan ke antarmuka jaringan elastis.
Ipv6Address	string	Alamat IPv6 yang ditetapkan ke antarmuka jaringan elastis.	2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6
VpdVSwitchId	string		vsw-5s7xxxxxxx
VpdId	string		vpd-5s7xxxxxxx
ServiceStatus	string	Status layanan instans, bukan status berjalan.	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"
                  }
                ]
              },
              "VpdVSwitchId": "vsw-5s7xxxxxxx",
              "VpdId": "vpd-5s7xxxxxxx"
            }
          ]
        },
        "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.