Gunakan DescribeApplicationInstances untuk kueri instans aplikasi - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Mengambil daftar instans aplikasi.

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

sae:DescribeApplicationInstances

get

*全部资源

*

None

Sintaks permintaan

GET /pop/v1/sam/app/describeApplicationInstances HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
AppId	string	Yes	ID aplikasi.	d700e680-aa4d-4ec1-afc2-6566b5ff****
GroupId	string	Yes	ID kelompok aplikasi. Panggil operasi DescribeApplicationGroups untuk mendapatkan ID.	b2a8a925-477a-4ed7-b825-d5e22500****
CurrentPage	integer	No	Nomor halaman yang akan dikembalikan.	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan pada setiap halaman. Nilai default: 10. Nilai harus berada dalam rentang (0, 1000000000).	10
Reverse	boolean	No	Menentukan Pesanan pengurutan instans aplikasi. Instans diurutkan terlebih dahulu berdasarkan status berjalan, lalu berdasarkan ID instans. Nilai valid: true: Instans diurutkan dalam Pesanan menurun. false: Instans diurutkan dalam Pesanan menaik. Status instans dalam Pesanan menaik: Error: Terjadi kesalahan saat instans dimulai. CrashLoopBackOff: Kontainer gagal dimulai dan memasuki loop crash-restart. ErrImagePull: Terjadi kesalahan saat menarik gambar kontainer untuk instans. ImagePullBackOff: Sistem berulang kali mencoba dan gagal menarik gambar kontainer. Pending: Instans menunggu untuk dijadwalkan. Unknown: Terjadi pengecualian yang tidak diketahui. Terminating: Instans sedang dihentikan. NotFound: Instans tidak dapat ditemukan. PodInitializing: Instans sedang diinisialisasi. Init:0/1: Instans sedang diinisialisasi. Running: Instans sedang berjalan.	true
InstanceId	string	No	ID instans aplikasi.	demo-faaca66c-5959-45cc-b3bf-d26093b2e9c0******
PipelineId	string	No	ID batch. Panggil operasi DescribeChangeOrder untuk mendapatkan ID.	85750d48-6cfc-4dbf-8ea0-840397******

Elemen respons

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The message returned for the request.	success
TraceId	string	The trace ID used to query request details.	0a98a02315955564772843261e****
Data	object	The information about the application instances.
CurrentPage	integer	The current page number.	1
TotalSize	integer	The total number of instances.	10
PageSize	integer	The number of entries returned per page.	10
Instances	array<object>	The list of application instances.
	array<object>	The details of an application instance.
CreateTimeStamp	integer	The timestamp when the instance started to be created. Unit: milliseconds.	1558442609000
VSwitchId	string	The zone where the instance is located.	vsw-***
InstanceContainerStatus	string	The running status of the instance. Valid values: Error: An error occurred during instance startup. CrashLoopBackOff: The container failed to start, encountered an error during startup, and failed again after a restart. ErrImagePull: An error occurred when the system pulled the container image for the instance. ImagePullBackOff: The container image could not be obtained. Pending: The instance is waiting to be scheduled. Unknown: An unknown exception occurred. Terminating: The instance is being stopped. NotFound: The instance cannot be found. PodInitializing: The instance is being initialized. Init:0/1: The instance is being initialized. Running: The instance is running.	Running
InstanceHealthStatus	string	The health check status. Valid values: WithoutHealthCheckConfig: No liveness and readiness health checks are configured. WithoutLivenessConfig: No liveness health check is configured. WithoutReadinessConfig: No readiness health check is configured. NotCheckedYet: The instance is undergoing or waiting for a health check. LivenessUnhealthy: The liveness health check failed. The instance is unhealthy. ReadinessUnhealthy: The readiness health check failed. The instance is unhealthy. Unhealthy: Both the liveness and readiness health checks failed. The instance is unhealthy. Healthy: The health check passed. The instance is healthy.	WithoutHealthCheckConfig
InstanceContainerRestarts	integer	The number of times the instance has been restarted.	0
GroupId	string	The ID of the group to which the instance belongs.	b2a8a925-477a-4ed7-b825-d5e22500****
InstanceContainerIp	string	The internal IP address of the instance.	192.168.X.X
InstanceId	string	The instance ID.	b2a8a925-477a-4ed7-b825-d5e22500****
ImageUrl	string	The address of the image repository. Catatan If you deploy the application using a JAR or WAR package, the image generated by the SAE platform cannot be downloaded.	registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0
PackageVersion	string	The version information.	1609939496200
Timestamp	integer	The timestamp.	1750061980000
Eip	string	The Elastic IP Address (EIP).	8.129.XX.XXX
FinishTimeStamp	integer	The timestamp when the instance creation was complete. Unit: milliseconds.	1642757283000
DebugStatus	boolean	Indicates whether the instance is being debugged. Valid values: True: Yes. False: No.	False
SidecarContainersStatus	array<object>	The status of the sidecar containers.
	object	The status of the sidecar containers.
ContainerId	string	The ID of the sidecar container.	sidecar-test-01
ContainerStatus	string	The status of the container.	Running
ImageUrl	string	The image address.	registry.cn-beijing.aliyuncs.com/sae-dev-test/******
MainContainerStatus	string	The status of the main container.	Running
UnhealthyMessage	string	If the health check of the application instance fails, this field returns the specific cause or error message. If the health check is successful, this field is empty.
TrafficStatus	string
Tags	array<object>
	object
Key	string
Value	string
ErrorCode	string	The error code. Valid values: This parameter is not returned for successful requests. This parameter is returned for failed requests. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code or POP error code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: A client error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 10,
    "PageSize": 10,
    "Instances": [
      {
        "CreateTimeStamp": 1558442609000,
        "VSwitchId": "vsw-***",
        "InstanceContainerStatus": "Running",
        "InstanceHealthStatus": "WithoutHealthCheckConfig",
        "InstanceContainerRestarts": 0,
        "GroupId": "b2a8a925-477a-4ed7-b825-d5e22500****",
        "InstanceContainerIp": "192.168.X.X",
        "InstanceId": "b2a8a925-477a-4ed7-b825-d5e22500****",
        "ImageUrl": "registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0",
        "PackageVersion": "1609939496200",
        "Timestamp": 1750061980000,
        "Eip": "8.129.XX.XXX",
        "FinishTimeStamp": 1642757283000,
        "DebugStatus": true,
        "SidecarContainersStatus": [
          {
            "ContainerId": "sidecar-test-01",
            "ContainerStatus": "Running",
            "ImageUrl": "registry.cn-beijing.aliyuncs.com/sae-dev-test/******"
          }
        ],
        "MainContainerStatus": "Running",
        "UnhealthyMessage": "",
        "TrafficStatus": "",
        "Tags": [
          {
            "Key": "",
            "Value": ""
          }
        ]
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.