ListPluginStatus - Elastic Compute Service - Alibaba Cloud Documentation Center

Memanggil operasi ListPluginStatus untuk mengkueri status plug-in Asisten Cloud pada instans.

Deskripsi operasi

Versi Agen Asisten Cloud pada instans harus setidaknya versi berikut untuk mengkueri status plug-in Asisten Cloud pada instans:
- Linux: 2.2.3.344.
- Windows: 2.1.3.344.
Saat mengkueri halaman pertama, Anda hanya perlu menetapkan MaxResults untuk membatasi jumlah entri yang dikembalikan. Nilai NextToken yang dikembalikan dalam tanggapan digunakan sebagai token untuk mengkueri halaman berikutnya. Saat mengkueri halaman berikutnya, tetapkan parameter NextToken ke nilai NextToken yang dikembalikan dalam tanggapan sebelumnya sebagai token kueri, dan tetapkan MaxResults untuk membatasi jumlah entri yang dikembalikan.

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

ecs:ListPluginStatus

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah Alibaba Cloud terbaru.	cn-hangzhou
InstanceId	array	No	ID instans. Maksimal 50 instans dapat ditentukan dalam satu permintaan. Nilai valid N: 1 hingga 50.
	string	No	ID instans. Maksimal 50 instans dapat ditentukan dalam satu permintaan. Nilai valid N: 1 hingga 50.	i-bp1iudwa5b1tqa****
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent list of Alibaba Cloud regions.	cn-hangzhou
Name	string	No	Nama plug-in. Semua set karakter didukung. Nama tidak boleh melebihi 255 karakter. Jika parameter ini tidak ditentukan, status plug-in yang terinstal pada instans akan dikueri. Catatan Jika parameter ini tidak ditentukan, hanya satu ID instans yang dapat ditentukan. Jika parameter ini ditentukan, status plug-in yang ditentukan pada instans akan dikueri.	testPluginName
PageNumber	integer	No	Catatan Parameter ini akan segera dihentikan penggunaannya. Kami menyarankan Anda menggunakan NextToken dan MaxResults untuk melakukan kueri berhalaman.	1
PageSize	integer	No	Catatan Parameter ini akan segera dihentikan penggunaannya. Kami menyarankan Anda menggunakan NextToken dan MaxResults untuk melakukan kueri berhalaman.	10
MaxResults	integer	No	Jumlah entri maksimum per halaman dalam kueri berhalaman. Nilai maksimum: 50. Nilai default: 10.	10
NextToken	string	No	Token kueri. Tetapkan nilai ke nilai NextToken yang dikembalikan dalam pemanggilan API sebelumnya.	AAAAAdDWBF2

Elemen respons

Element	Type	Description	Example
	object
PageSize	integer	Jumlah entri per halaman.	10
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	Nomor halaman dari halaman yang dikembalikan.	1
TotalCount	integer	Jumlah entri yang memenuhi kondisi kueri.	1
NextToken	string	Token kueri yang dikembalikan dalam pemanggilan ini.	AAAAAdDWBF2
InstancePluginStatusSet	object
InstancePluginStatus	array<object>	Status plug-in pada instans.
	array<object>	Status plug-in pada instans.
InstanceId	string	The ID of the instance.	i-xxxxx
PluginStatusSet	object
PluginStatus	array<object>	The queried Cloud Assistant plug-ins.
	object
PluginStatus	string	The state of the Cloud Assistant plug-in. Valid values: NotInstalled: The plug-in is not installed. Installed: The one-time plug-in is installed. Running: The long-running plug-in is running. Stopped: The long-running plug-in is not running. Crashed: The plug-in is abnormal. Removed: The plug-in is uninstalled. Unknown: The state of the plug-in is unknown.	Running
PluginVersion	string	The version of the plug-in.	1.1
PluginName	string	The name of the plug-in.	testName
FirstHeartbeatTime	string	The first time when Cloud Assistant reported the state of the plug-in.	2020-01-19T09:15:46Z
LastHeartbeatTime	string	The last time when Cloud Assistant reported the state of the plug-in.	2020-01-19T09:15:46Z

Contoh

Respons sukses

JSONformat

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "TotalCount": 1,
  "NextToken": "AAAAAdDWBF2",
  "InstancePluginStatusSet": {
    "InstancePluginStatus": [
      {
        "InstanceId": "i-xxxxx",
        "PluginStatusSet": {
          "PluginStatus": [
            {
              "PluginStatus": "Running",
              "PluginVersion": "1.1",
              "PluginName": "testName",
              "FirstHeartbeatTime": "2020-01-19T09:15:46Z",
              "LastHeartbeatTime": "2020-01-19T09:15:46Z"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	RegionId.ApiNotSupported	The api is not supported in this region.
400	InvalidParam.PageNumber	The specified parameter PageNumber is invalid.
400	InvalidParam.PageSize	The specified parameter PageSize is invalid.
400	PluginName.MissingValue	The plugin name must be specified when the number of InstanceIds is not 1.
400	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.
500	InternalError.Dispatch	An error occurred when you dispatched the request.
403	Operation.Forbidden	The operation is not permitted.
404	InvalidInstance.NotFound	The specified instance does not exist.
404	InvalidPluginName.NotFound	The specified plugin name does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.