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

Mengkueri detail satu atau beberapa instans server aplikasi sederhana di wilayah tertentu.

Deskripsi operasi

Mengkueri detail satu atau beberapa instans server aplikasi sederhana di wilayah tertentu, termasuk nama server, alamat IP publik, alamat IP privat, 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 server aplikasi sederhana.	cn-hangzhou
InstanceIds	string	No	ID instans server aplikasi sederhana. Nilainya dapat berupa array JSON yang terdiri dari hingga 100 ID instans. Pisahkan beberapa ID dengan koma (,). Catatan Jika Anda menentukan `InstanceIds` dan `PublicIpAddresses`, ID instans dan alamat IP publik harus milik server aplikasi sederhana yang sama. Jika tidak, hasil kosong akan dikembalikan.	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]
ChargeType	string	No	Metode penagihan instans. Nilai valid: PrePaid. Hanya langganan yang didukung. Nilai default: PrePaid.	PrePaid
PublicIpAddresses	string	No	Alamat IP publik server aplikasi sederhana. Nilainya dapat berupa array JSON yang terdiri dari hingga 100 alamat IP publik. Pisahkan beberapa alamat dengan koma (,). Catatan Jika Anda menentukan `InstanceIds` dan `PublicIpAddresses`, ID instans dan alamat IP publik harus milik server aplikasi sederhana yang sama. Jika tidak, hasil 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 untuk paginasi. Nilai maksimum: 100. Nilai default: 10	10
Status	string	No	Status instans. Nilai valid: Pending: sedang disiapkan. Starting: memulai. Running: berjalan. Stopping: menghentikan. Stopped: terhenti. Resetting: sedang diatur ulang. Upgrading: sedang ditingkatkan. Disabled: 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 N: 1 hingga 20.	TestKey
Value	string	No	Nilai tag instans. Panjang nilai tag harus 1 hingga 64 karakter. Nilai valid N: 1 hingga 20.	TestValue
ResourceGroupId	string	No	ID kelompok sumber daya server aplikasi sederhana.	rg-aek2bti7cf7****
InstanceName	string	No	Nama instans server aplikasi sederhana. Karakter wildcard (*) didukung untuk Pencocokan kabur.	test
PlanType	string	No	Tipe paket. Nilai valid: NORMAL: tujuan umum. CAPACITY: dioptimalkan untuk penyimpanan. PREVIOUS: generasi sebelumnya. MULTI_IP: beberapa alamat IP publik. INTERNATIONAL: internasional. Catatan Untuk informasi lebih lanjut, 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: sedang disiapkan. Starting: memulai. Running: berjalan. Stopping: menghentikan. Stopped: terhenti. Resetting: sedang diatur ulang. Upgrading: sedang ditingkatkan. Disabled: tidak tersedia.	Running
CreationTime	string	Waktu pembuatan. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC+0.	2021-03-08T05:31:06Z
InnerIpAddress	string	Alamat IP privat.	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 ditampilkan dalam UTC+0.	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: status filtering blackhole. Defense: status Pembersihan lalu lintas.	Normal
ImageId	string	ID image.	fe9c66133a9d4688872869726b52****
DisableReason	string	Alasan resource dinonaktifkan. Nilai valid: FINANCIAL: terkunci karena Pembayaran tertunda. SECURITY: terkunci karena alasan keamanan. EXPIRED: instans telah kedaluwarsa.	EXPIRED
Combination	boolean	Menunjukkan apakah instans menggunakan 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	The disk type. Valid: ESSD: an enhanced SSD (ESSD) at performance level (PL) 0. SSD: a standard SSD. CLOUD_EFFICIENCY: an ultra disk.	ESSD
Cpu	integer	The number of vCPUs.	2
Bandwidth	integer	The bandwidth. Unit: Mbit/s.	200
DiskSize	integer	The disk size. Unit: GiB.	60
Memory	number	The memory size. Unit: GiB.	2
Flow	number	The data transfer quota. A value of 0 indicates that the instance is a bandwidth-based instance. A non-zero value indicates that the instance is a data transfer plan-based instance.	818
Image	object	Informasi image.
OsType	string	The OS type.	windows
ImageName	string	The image name.	test-custom-1686536882356
ImageVersion	string	The image version.	V3.5
ImageType	string	The image type. Valid: system: OS image. app: application image. custom: custom image.	system
ImageIconUrl	string	The URL of the image icon.	https://img.alicdn.com/imgextra/i3/O**1vdh9651ReKqWNMI2I_!!6000000002136**-24-24.svg
ImageContact	string	The image provider.	https://selfs****e.console.aliyun.com/ticket/createIndex
Tags	array<object>	Tag instans.
	object	Tag.
Key	string	The key of the tag.	TestKey
Value	string	The value of the tag.	TestValue
Disks	array<object>	Array informasi disk untuk server aplikasi sederhana.
	array<object>	Informasi disk.
CreationTime	string	The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-02-24T02:20:10Z
Status	string	The disk status. Valid: ReIniting: The disk is being initialized. Creating: The disk is being created. In_use: The disk is in use. Available: The disk is to be mounted. Attaching: The disk is being attached. Detaching: The disk is being detached.	In_use
Device	string	The device name of the disk in the server.	/dev/xvda
Size	integer	The disk size. Unit: GiB.	50
DiskName	string	The disk name.	SystemDisk
DiskChargeType	string	The billing method of the disk.	PrePaid
DiskType	string	The disk type. Valid: system: system disk. data: data disk.	system
Category	string	The disk type. Valid: ESSD: an enhanced SSD (ESSD) at performance level (PL) 0. SSD: a standard SSD. CLOUD_EFFICIENCY: an ultra disk.	ESSD
DiskId	string	The disk ID.	d-bp14wq0149cpp2x****
RegionId	string	The region ID.	cn-hangzhou
Remark	string	The remarks of the disk.	remark
DiskTags	array<object>	The tags of the disk.
	object	The tag information.
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue
ResourceGroupId	string	The ID of the resource group to which the disk belongs.	rg-aek2bti7cf7****
ResourceGroupId	string	ID kelompok sumber daya instans.	rg-aekz7jmhg5s****
NetworkAttributes	array<object>	Informasi jaringan.
	object	Informasi jaringan.
PublicIpAddress	string	The public IP address.	116.62.XX.XX
PrivateIpAddress	string	The private IP address.	72.25.XX.XX
PeakBandwidth	integer	The peak bandwidth of the public network. Unit: Mbit/s.	200
PublicIpDdosStatus	string	The DDoS protection status of the public IP address.	normal
PlanType	string	Tipe paket. Nilai valid: NORMAL: tujuan umum. CAPACITY: dioptimalkan untuk penyimpanan. PREVIOUS: generasi sebelumnya. MULTI_IP: beberapa alamat IP publik. INTERNATIONAL: internasional. Catatan Untuk informasi lebih lanjut, lihat Keluarga instans.	NORMAL
CommodityCode	string
TotalCount	integer	Jumlah total instans yang dikembalikan.	1
RequestId	string	ID permintaan.	20758A-585D-4A41-A9B2-28DA8F4F****
PageSize	integer	Jumlah entri per halaman untuk paginasi.	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.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",
      "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.