DescribeCloudAssistantStatus - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri apakah Asisten Cloud Agent terinstal pada satu atau beberapa instans. Jika Asisten Cloud Agent terinstal, operasi ini juga mengembalikan jumlah total eksekusi perintah, jumlah eksekusi yang sedang berlangsung, dan pengatur waktu eksekusi perintah terbaru.

Deskripsi operasi

Panggil operasi ini untuk mengkueri status Asisten Cloud pada instans. Jika CloudAssistantStatus bernilai true, Anda dapat menjalankan perintah atau mengirim file. Hal ini sangat penting untuk instans yang baru dibuat.
Saat melakukan kueri berhalaman pada halaman pertama, tetapkan hanya MaxResults untuk membatasi jumlah entri yang dikembalikan. Nilai NextToken dalam tanggapan digunakan sebagai kredensial untuk mengkueri halaman berikutnya. Saat melakukan kueri berhalaman pada halaman berikutnya, tetapkan NextToken ke nilai yang diperoleh dari tanggapan sebelumnya 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:DescribeCloudAssistantStatus

get

*Instance.

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah instans. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
OSType	string	No	Tipe sistem operasi instans. Nilai valid: Windows Linux FreeBSD	Windows
PageNumber	integer	No	Catatan Parameter ini akan segera ditinggalkan. Gunakan NextToken dan MaxResults untuk melakukan operasi paginasi.	1
PageSize	integer	No	Catatan Parameter ini akan segera ditinggalkan. Gunakan NextToken dan MaxResults untuk melakukan operasi paginasi.	10
MaxResults	integer	No	Jumlah maksimum entri per halaman untuk kueri berhalaman. Jika InstanceId ditetapkan, parameter ini akan diabaikan. Nilai maksimum: 50. Nilai default: 10.	10
NextToken	string	No	Token paginasi. Tetapkan parameter ini ke nilai NextToken yang dikembalikan dalam pemanggilan API sebelumnya.	AAAAAdDWBF2
InstanceId	array	No	Daftar ID instans.	i-bp1iudwa5b1tqa****
	string	No	Daftar ID instans, yang dapat mencakup ID Instans ECS dan ID Instans terkelola. Anda dapat menentukan hingga 100 ID instans.	i-bp1iudwa5b1tqa****

Elemen respons

Element	Type	Description	Example
	object
InstanceCloudAssistantStatusSet	object
InstanceCloudAssistantStatus	array<object>	Kumpulan hasil status instalasi Asisten Cloud untuk instans.
	object
ActiveTaskCount	integer	Jumlah tugas Asisten Cloud yang sedang berjalan pada instans.	0
CloudAssistantStatus	string	Apakah Asisten Cloud berjalan pada instans. Nilai valid: true: Heartbeat terdeteksi dalam 2 menit terakhir. false: Heartbeat tidak terdeteksi dalam 2 menit terakhir.	true
CloudAssistantVersion	string	Nomor versi Asisten Cloud Agent. Nilai ini kosong jika Asisten Cloud Agent tidak terinstal atau tidak berjalan.	2.2.0.106
InstanceId	string	ID instans.	i-bp1iudwa5b1tqa****
InvocationCount	integer	Jumlah tugas Asisten Cloud yang telah selesai pada instans.	2
LastHeartbeatTime	string	Pengatur waktu heartbeat terbaru dari Asisten Cloud. Nilai ini diperbarui kira-kira setiap menit dengan fluktuasi acak hingga 5 detik (minimum 55 detik, maksimum 65 detik). Pengatur waktu mengikuti standar ISO 8601 dalam UTC.	2021-03-15T09:00:00Z
LastInvokedTime	string	Pengatur waktu eksekusi perintah terbaru. Pengatur waktu mengikuti standar ISO 8601 dalam UTC.	2021-03-15T08:00:00Z
OSType	string	Tipe sistem operasi instans. Nilai valid: Windows Linux FreeBSD	Linux
SupportSessionManager	boolean	Apakah Asisten Cloud pada instans mendukung fitur manajemen sesi. Jika tidak didukung, versi Asisten Cloud sudah usang. Perbarui klien ke versi terbaru. Versi minimum Asisten Cloud yang mendukung manajemen sesi adalah sebagai berikut: Linux: 2.2.3.189 Windows: 2.1.3.189	true
NextToken	string	Token paginasi yang dikembalikan dalam pemanggilan ini.	AAAAAdDWBF2
PageNumber	integer	Nomor halaman saat ini.	1
PageSize	integer	Jumlah entri per halaman.	1
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Jumlah total instans.	1

Contoh

Respons sukses

JSONformat

{
  "InstanceCloudAssistantStatusSet": {
    "InstanceCloudAssistantStatus": [
      {
        "ActiveTaskCount": 0,
        "CloudAssistantStatus": "true",
        "CloudAssistantVersion": "2.2.0.106",
        "InstanceId": "i-bp1iudwa5b1tqa****",
        "InvocationCount": 2,
        "LastHeartbeatTime": "2021-03-15T09:00:00Z",
        "LastInvokedTime": "2021-03-15T08:00:00Z",
        "OSType": "Linux",
        "SupportSessionManager": true
      }
    ]
  },
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	RegionId.ApiNotSupported	The api is not supported in this region.	Pemanggilan API tidak didukung di wilayah tertentu. Periksa apakah nilai parameter RegionId benar.
400	MissingParam.InstanceId	The parameter instanceId is missing or empty.	ID instans kosong.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	Parameter MaxResults yang ditentukan tidak valid.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	Terjadi kesalahan saat mengirim permintaan. Coba lagi nanti.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.	Jumlah instans target melebihi batas atas.
403	Operation.Forbidden	The operation is not permitted.	Operasi tidak diizinkan.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	RegionId yang ditentukan tidak ada. Periksa apakah produk tersedia di wilayah ini.
404	InvalidInstance.NotFound	The specified instance does not exist.	Instans yang ditentukan tidak ada.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.