Gunakan API ListInstances untuk kueri detail instans - Simple Application Server - Alibaba Cloud - Simple Application Server

Mengkueri detail satu atau beberapa instans di wilayah tertentu.

Deskripsi operasi

Mengkueri detail satu atau beberapa instans di wilayah tertentu, termasuk nama server, alamat IP publik, alamat IP internal, waktu pembuatan, dan waktu kedaluwarsa.

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

swas-open:ListInstances

get

Instans.

acs:swas-open:{#regionId}:{#accountId}:instance/*

*Instans.

acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah server aplikasi sederhana.	cn-hangzhou
InstanceIds	string	No	ID instans server aplikasi sederhana. Nilai dapat berupa array JSON yang terdiri dari hingga 100 ID instans. Pisahkan beberapa ID dengan koma (,). Catatan Jika Anda menentukan parameter InstanceIds dan PublicIpAddresses sekaligus, pastikan ID instans dan alamat IP publik yang ditentukan milik server aplikasi sederhana yang sama. Jika tidak, tanggapan kosong akan dikembalikan.	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]
ChargeType	string	No	Metode penagihan instans. Nilai valid: PrePaid: langganan. Saat ini, hanya metode penagihan langganan yang didukung. Nilai default: PrePaid.	PrePaid
PublicIpAddresses	string	No	Alamat IP publik server aplikasi sederhana. Nilai dapat berupa array JSON yang terdiri dari hingga 100 alamat IP publik. Pisahkan beberapa alamat IP dengan koma (,). Catatan Jika Anda menentukan parameter InstanceIds dan PublicIpAddresses sekaligus, pastikan ID instans dan alamat IP publik yang ditentukan milik server aplikasi sederhana yang sama. Jika tidak, tanggapan kosong akan dikembalikan.	["42.1..", "42.2.."]
PageNumber	integer	No	Nomor halaman daftar server aplikasi sederhana. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman dalam kueri berhalaman. Nilai maksimum: 100. Nilai default: 10.	10
Status	string	No	Status instans. Nilai valid: Pending: Instans sedang disiapkan. Starting: Instans sedang dimulai. Running: Instans sedang berjalan. Stopping: Instans sedang dihentikan. Stopped: Instans telah dihentikan. Resetting: Instans sedang direset. Upgrading: Instans sedang ditingkatkan. Disabled: Instans tidak tersedia.	Running
Tag	array<object>	No	Tag instans.
	object	No	Tag.
Key	string	No	Kunci tag instans. Panjang kunci tag harus 1 hingga 64 karakter. Nilai valid untuk N: 1 hingga 20.	TestKey
Value	string	No	Nilai tag instans. Panjang nilai tag harus 1 hingga 64 karakter. Nilai valid untuk N: 1 hingga 20.	TestValue
ResourceGroupId	string	No	ID kelompok sumber daya tempat server aplikasi sederhana berada.	rg-aek2bti7cf7****
InstanceName	string	No	Nama server aplikasi sederhana. Anda dapat menggunakan wildcard tanda bintang (*) untuk pencarian fuzzy.	test
PlanType	string	No	Tipe paket. Nilai valid: NORMAL: serbaguna. CAPACITY: dioptimalkan untuk penyimpanan. PREVIOUS: generasi sebelumnya. MULTI_IP: multi-IP publik. INTERNATIONAL: internasional. Catatan Untuk informasi selengkapnya, lihat Keluarga instans.	NORMAL

Elemen respons

Element	Type	Description	Example
	object	Informasi instans.
Instances	array<object>	Array informasi server aplikasi sederhana.
	array<object>	Array informasi server aplikasi sederhana.
Status	string	Status instans. Nilai valid: Pending: Instans sedang disiapkan. Starting: Instans sedang dimulai. Running: Instans sedang berjalan. Stopping: Instans sedang dihentikan. Stopped: Instans telah dihentikan. Resetting: Instans sedang direset. Upgrading: Instans sedang ditingkatkan. Disabled: Instans tidak tersedia.	Running
CreationTime	string	Waktu pembuatan. Waktu ditampilkan dalam UTC sesuai standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ.	2021-03-08T05:31:06Z
InnerIpAddress	string	Alamat IP internal.	172.26.XX.XX
ChargeType	string	Metode penagihan.	PrePaid
InstanceId	string	ID instans.	2ad1ae67295445f598017499dc****
PlanId	string	ID paket.	swas.s2.c2m2s50b4t08
PublicIpAddress	string	Alamat IP publik.	42.1.XX.XX
RegionId	string	ID wilayah.	cn-hangzhou
ExpiredTime	string	Waktu kedaluwarsa. Waktu ditampilkan dalam UTC sesuai standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ.	2021-05-08T16:00:00Z
InstanceName	string	Nama server.	test-InstanceName
BusinessStatus	string	Status server. Nilai valid: Normal: Normal. Expired: Kedaluwarsa. Overdue: Pembayaran tertunda.	Normal
DdosStatus	string	Status DDoS. Nilai valid: Normal: Normal. BlackHole: Filter blackhole diaktifkan. Defense: Trafik sedang disaring.	Normal
ImageId	string	ID image.	fe9c66133a9d4688872869726b52****
DisableReason	string	Alasan resource dinonaktifkan. Nilai valid: FINANCIAL: Resource terkunci karena pembayaran tertunda. SECURITY: Resource terkunci karena alasan keamanan. EXPIRED: Instans telah kedaluwarsa.	EXPIRED
Combination	boolean	Apakah paket merupakan paket kombinasi.	false
CombinationInstanceId	string	ID instans paket kombinasi.	com-f6c9a22****45b5b8de68ad608af1ba
Uuid	string	UUID instans.	41f30524-5df7-49c9-9c6e-32****489001
ResourceSpec	object	Spesifikasi resource.
DiskCategory	string	Kategori cloud disk. Nilai valid: ESSD: ESSD pada tingkat kinerja (PL) 0. SSD: SSD standar. CLOUD_EFFICIENCY: Disk ultra.	ESSD
Cpu	integer	Jumlah vCPU.	2
Bandwidth	integer	Bandwidth. Unit: Mbit/s.	200
DiskSize	integer	Ukuran cloud disk. Unit: GiB.	60
Memory	number	Ukuran memori. Unit: GiB.	2
Flow	number	Kuota transfer data. Nilai 0 menunjukkan instans berbasis bandwidth. Nilai bukan nol menunjukkan instans berbasis paket transfer data.	818
Image	object	Informasi image.
OsType	string	Tipe sistem operasi.	windows
ImageName	string	Nama image.	test-custom-1686536882356
ImageVersion	string	Versi image.	V3.5
ImageType	string	Tipe image. Nilai valid: system: image sistem. app: gambar aplikasi. custom: gambar kustom.	system
ImageIconUrl	string	URL ikon image.	https://img.alicdn.com/imgextra/i3/O**1vdh9651ReKqWNMI2I_!!6000000002136**-24-24.svg
ImageContact	string	Penyedia image.	https://selfs****e.console.alibabacloud.com/ticket/createIndex
Tags	array<object>	Tag instans.
	object	Tag.
Key	string	Kunci tag instans.	TestKey
Value	string	Nilai tag instans.	TestValue
Disks	array<object>	Array informasi cloud disk untuk server aplikasi sederhana.
	array<object>	Informasi cloud disk.
CreationTime	string	Waktu pembuatan instans. Waktu ditampilkan dalam UTC sesuai standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ.	2023-02-24T02:20:10Z
Status	string	Status cloud disk. Nilai valid: ReIniting: Cloud disk sedang diinisialisasi. Creating: Cloud disk sedang dibuat. In_use: Cloud disk sedang digunakan. Available: Cloud disk tidak terpasang. Attaching: Cloud disk sedang dipasang. Detaching: Cloud disk sedang dilepas.	In_use
Device	string	Nama perangkat cloud disk pada server.	/dev/xvda
Size	integer	Ukuran cloud disk. Unit: GiB.	50
DiskName	string	Nama cloud disk.	SystemDisk
DiskChargeType	string	Metode penagihan cloud disk.	PrePaid
DiskType	string	Tipe disk. Nilai valid: system: Tipe disk sistem. data: Tipe disk data.	system
Category	string	Kategori cloud disk. Nilai valid: ESSD: ESSD pada tingkat kinerja (PL) 0. SSD: SSD standar. CLOUD_EFFICIENCY: Disk ultra.	ESSD
DiskId	string	ID cloud disk.	d-bp14wq0149cpp2x****
RegionId	string	ID wilayah.	cn-hangzhou
Remark	string	Keterangan cloud disk.	remark
DiskTags	array<object>	Informasi tag cloud disk.
	object	Informasi tag.
Key	string	Kunci tag.	TestKey
Value	string	Nilai tag.	TestValue
ResourceGroupId	string	ID kelompok sumber daya tempat cloud disk berada.	rg-aek2bti7cf7****
ResourceGroupId	string	ID kelompok sumber daya tempat instans berada.	rg-aekz7jmhg5s****
NetworkAttributes	array<object>	Atribut jaringan.
	object	Atribut jaringan.
PublicIpAddress	string	Alamat IP publik.	116.62.XX.XX
PrivateIpAddress	string	Alamat IP privat.	72.25.XX.XX
PeakBandwidth	integer	Bandwidth publik puncak. Unit: Mbit/s.	200
PublicIpDdosStatus	string	Status DDoS alamat IP publik.	normal
PlanType	string	Tipe paket. Nilai valid: NORMAL: tujuan umum. CAPACITY: dioptimalkan untuk penyimpanan. PREVIOUS: generasi sebelumnya. MULTI_IP: multi-IP publik. INTERNATIONAL: internasional. Catatan Untuk informasi selengkapnya, lihat Instance families.	NORMAL
CommodityCode	string	Kode komoditas instans.
TotalCount	integer	Jumlah total instans yang dikembalikan.	1
RequestId	string	ID permintaan.	20758A-585D-4A41-A9B2-28DA8F4F****
PageSize	integer	Pengaturan jumlah entri per halaman untuk paging dalam kueri berhalaman.	10
PageNumber	integer	Nomor halaman daftar server aplikasi sederhana.	1

Contoh

Respons sukses

JSONformat

{
  "Instances": [
    {
      "Status": "Running",
      "CreationTime": "2021-03-08T05:31:06Z",
      "InnerIpAddress": "172.26.XX.XX",
      "ChargeType": "PrePaid",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "PlanId": "swas.s2.c2m2s50b4t08",
      "PublicIpAddress": "42.1.XX.XX",
      "RegionId": "cn-hangzhou",
      "ExpiredTime": "2021-05-08T16:00:00Z",
      "InstanceName": "test-InstanceName",
      "BusinessStatus": "Normal",
      "DdosStatus": "Normal",
      "ImageId": "fe9c66133a9d4688872869726b52****",
      "DisableReason": "EXPIRED",
      "Combination": false,
      "CombinationInstanceId": "com-f6c9a22****45b5b8de68ad608af1ba",
      "Uuid": "41f30524-5df7-49c9-9c6e-32****489001",
      "ResourceSpec": {
        "DiskCategory": "ESSD",
        "Cpu": 2,
        "Bandwidth": 200,
        "DiskSize": 60,
        "Memory": 2,
        "Flow": 818
      },
      "Image": {
        "OsType": "windows",
        "ImageName": "test-custom-1686536882356",
        "ImageVersion": "V3.5",
        "ImageType": "system",
        "ImageIconUrl": "https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg",
        "ImageContact": "https://selfs****e.console.alibabacloud.com/ticket/createIndex"
      },
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Disks": [
        {
          "CreationTime": "2023-02-24T02:20:10Z",
          "Status": "In_use",
          "Device": "/dev/xvda",
          "Size": 50,
          "DiskName": "SystemDisk",
          "DiskChargeType": "PrePaid",
          "DiskType": "system",
          "Category": "ESSD",
          "DiskId": "d-bp14wq0149cpp2x****",
          "RegionId": "cn-hangzhou",
          "Remark": "remark",
          "DiskTags": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ],
          "ResourceGroupId": "rg-aek2bti7cf7****"
        }
      ],
      "ResourceGroupId": "rg-aekz7jmhg5s****",
      "NetworkAttributes": [
        {
          "PublicIpAddress": "116.62.XX.XX",
          "PrivateIpAddress": "72.25.XX.XX",
          "PeakBandwidth": 200,
          "PublicIpDdosStatus": "normal"
        }
      ],
      "PlanType": "NORMAL",
      "CommodityCode": ""
    }
  ],
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "PageSize": 10,
  "PageNumber": 1
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidChargeType.ValueNotSupported	The specified parameter ChargeType is invalid.
400	InvalidPublicIpAddresses.ValueNotSupported	The specified parameter PublicIpAddresses is invalid.
400	InvalidPublicIpAddresses	The specified parameter PublicIpAddresses value is not valid.
500	InternalError	An error occurred while processing your request.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.