ListInstances - Simple Application Server

Topik ini menjelaskan cara mengkueri detail satu atau beberapa instans di wilayah tertentu.

Deskripsi operasi

Detail tersebut mencakup 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

Instance

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

*Instance

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah dari instans Simple Application Server.	cn-hangzhou
InstanceIds	string	No	ID instans Simple Application Server. Nilainya dapat berupa array JSON yang berisi hingga 100 ID instans. Pisahkan beberapa ID dengan koma (,). Catatan Jika Anda menentukan parameter `InstanceIds` dan `PublicIpAddresses`, pastikan ID dan alamat IP publik tersebut milik server yang sama. Jika tidak, nilai kosong akan dikembalikan.	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]
ChargeType	string	No	Metode penagihan. Valid: PrePaid. Server hanya mendukung metode penagihan langganan. Bawaan: PrePaid	PrePaid
PublicIpAddresses	string	No	Alamat IP publik server. Nilainya dapat berupa array JSON yang berisi hingga 100 alamat IP publik. Pisahkan beberapa alamat IP dengan koma (,). Catatan Jika Anda menentukan parameter `InstanceIds` dan `PublicIpAddresses`, pastikan ID dan alamat IP publik tersebut milik server yang sama. Jika tidak, nilai kosong akan dikembalikan.	["42.1..", "42.2.."]
PageNumber	integer	No	Nomor halaman dari daftar instans Simple Application Server. Bawaan: 1	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Maksimum: 100. Bawaan: 10	10
Status	string	No	Status instans. Valid: Pending: Instans sedang dipersiapkan. Starting: Instans sedang dinyalakan. 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 server.
	object	No	Sebuah tag.
Key	string	No	Kunci tag N. Panjang kunci tag maksimal 64 karakter. Nilai valid untuk N: 1 hingga 20.	TestKey
Value	string	No	Nilai tag N. Panjang nilai tag maksimal 64 karakter. Nilai valid untuk N: 1 hingga 20.	TestValue
ResourceGroupId	string	No	ID kelompok sumber daya tempat server berada.	rg-aek2bti7cf7****
InstanceName	string	No	Nama server. Mendukung pencocokan fuzzy menggunakan karakter wildcard asterisk (*).	test
PlanType	string	No	Tipe paket. Valid: NORMAL: tujuan umum. CAPACITY: kapasitas tinggi. PREVIOUS: generasi sebelumnya. MULTI_IP: beberapa alamat IP publik. INTERNATIONAL: internasional. Catatan Untuk informasi selengkapnya, lihat Instance families.	NORMAL

Elemen respons

Element	Type	Description	Example
	object	Informasi tentang instans.
Instances	array<object>	Array yang berisi informasi tentang server.
	array<object>	Array yang berisi informasi tentang server.
Status	string	Status instans. Valid: Pending: Instans sedang dipersiapkan. Starting: Instans sedang dinyalakan. 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 saat server dibuat. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	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 mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu dalam UTC.	2021-05-08T16:00:00Z
InstanceName	string	Nama server.	test-InstanceName
BusinessStatus	string	Status server. Valid: Normal: Server normal. Expired: Server telah kedaluwarsa. Overdue: Pembayaran untuk server tertunda.	Normal
DdosStatus	string	Status perlindungan DDoS. Valid: Normal: Instans tidak sedang mengalami serangan DDoS. BlackHole: Lubang Hitam Diaktifkan. Defense: Pembersihan.	Normal
ImageId	string	ID citra.	fe9c66133a9d4688872869726b52****
DisableReason	string	Alasan server dinonaktifkan. Valid: FINANCIAL: Instans terkunci karena pembayaran tertunda. SECURITY: Instans terkunci karena alasan keamanan. EXPIRED: Instans telah kedaluwarsa.	EXPIRED
Combination	boolean	Menunjukkan apakah server merupakan bundle.	false
CombinationInstanceId	string	ID bundle.	com-f6c9a22****45b5b8de68ad608af1ba
Uuid	string	UUID instans.	41f30524-5df7-49c9-9c6e-32****489001
ResourceSpec	object	Spesifikasi sumber daya.
DiskCategory	string	Tipe disk. Valid: ESSD: SSD yang disempurnakan (ESSD) pada tingkat kinerja (PL) 0. SSD: SSD standar. CLOUD_EFFICIENCY: disk ultra.	ESSD
Cpu	integer	Jumlah vCPU.	2
Bandwidth	integer	Bandwidth. Satuan: Mbit/s.	200
DiskSize	integer	Ukuran disk. Satuan: GiB.	60
Memory	number	Ukuran memori. Satuan: GiB.	2
Flow	number	Kuota transfer data. Nilai 0 menunjukkan bahwa instans berbasis bandwidth. Nilai bukan nol menunjukkan bahwa instans berbasis paket kuota transfer data.	818
Image	object	Deskripsi citra.
OsType	string	Tipe OS.	windows
ImageName	string	Nama citra.	test-custom-1686536882356
ImageVersion	string	Versi citra.	V3.5
ImageType	string	Tipe citra. Valid: system: Citra OS. app: gambar aplikasi. custom: custom image.	system
ImageIconUrl	string	URL ikon citra.	https://img.alicdn.com/imgextra/i3/O**1vdh9651ReKqWNMI2I_!!6000000002136**-24-24.svg
ImageContact	string	Penyedia citra.	https://selfs****e.console.aliyun.com/ticket/createIndex
Tags	array<object>	Tag server.
	object	Sebuah tag.
Key	string	Kunci tag.	TestKey
Value	string	Nilai tag.	TestValue
Disks	array<object>	Array yang berisi informasi tentang disk instans Simple Application Server.
	array<object>	Informasi disk.
CreationTime	string	Waktu saat instans dibuat. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2023-02-24T02:20:10Z
Status	string	Status disk. Valid: ReIniting: Disk sedang diinisialisasi. Creating: Disk sedang dibuat. In_use: Disk sedang digunakan. Available: Disk siap dipasang. Attaching: Disk sedang disambungkan. Detaching: Disk sedang dilepas.	In_use
Device	string	Nama perangkat disk di server.	/dev/xvda
Size	integer	Ukuran disk. Satuan: GiB.	50
DiskName	string	Nama disk.	SystemDisk
DiskChargeType	string	Metode penagihan disk.	PrePaid
DiskType	string	Tipe disk. Valid: system: sistem disk. data: data disk.	system
Category	string	Tipe disk. Valid: ESSD: SSD yang disempurnakan (ESSD) pada tingkat kinerja (PL) 0. SSD: SSD standar. CLOUD_EFFICIENCY: disk ultra.	ESSD
DiskId	string	ID disk.	d-bp14wq0149cpp2x****
RegionId	string	ID wilayah.	cn-hangzhou
Remark	string	Keterangan disk.	remark
DiskTags	array<object>	Tag disk.
	object	Informasi tag.
Key	string	Kunci tag.	TestKey
Value	string	Nilai tag.	TestValue
ResourceGroupId	string	ID kelompok sumber daya tempat disk berada.	rg-aek2bti7cf7****
ResourceGroupId	string	ID kelompok sumber daya tempat instans berada.	rg-aekz7jmhg5s****
NetworkAttributes	array<object>	Informasi jaringan.
	object	Informasi jaringan.
PublicIpAddress	string	Alamat IP publik.	116.62.XX.XX
PrivateIpAddress	string	Alamat IP pribadi.	72.25.XX.XX
PeakBandwidth	integer	Bandwidth puncak jaringan publik. Satuan: Mbit/s.	200
PublicIpDdosStatus	string	Status perlindungan DDoS untuk alamat IP publik.	normal
PlanType	string	Tipe paket. Valid: NORMAL: tujuan umum. CAPACITY: kapasitas tinggi. PREVIOUS: generasi sebelumnya. MULTI_IP: beberapa alamat IP publik. INTERNATIONAL: internasional. Catatan Untuk informasi selengkapnya, lihat Instance families.	NORMAL
TotalCount	integer	Jumlah total instans yang dikueri.	1
RequestId	string	ID permintaan.	20758A-585D-4A41-A9B2-28DA8F4F****
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
PageNumber	integer	Nomor halaman dari daftar instans Simple Application Server.	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.aliyun.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"
    }
  ],
  "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.
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.