GetAgentTask - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Mengambil status eksekusi Tugas instalasi Agen.

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

sysom:GetAgentTask

get

*Semua sumber daya.

*

None

Sintaks permintaan

GET /api/v1/am/agent/get_agent_task HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
task_id	string	No	ID Tugas.	42172120177e4b3abd6fabb3a6b5e2dd

Elemen respons

Element	Type	Description	Example
	object	Skema Tanggapan.
RequestId	string	ID permintaan, yang dapat digunakan untuk diagnostik end-to-end.	2E75336A-0DB2-5263-B201-A6488EC97B50
code	string	Kode status. `code == Success` menunjukkan bahwa otorisasi berhasil. Kode status lainnya menunjukkan bahwa otorisasi gagal. Jika otorisasi gagal, periksa bidang `Paket` untuk informasi kesalahan mendetail.	Success
data	object	Data yang dikembalikan.
jobs	array<object>	Daftar subtugas.
	object	Detail subtugas.
error	string	Jika Tugas gagal, bidang ini berisi penyebab kegagalan.	Deprecated (misused)
errorCode	string	Kode kesalahan untuk kegagalan subtugas. Nilai valid: Empty: Tugas berjalan secara normal. INSTANCE_NOT_SUPPORTED: Tipe instans tidak didukung. INSTANCE_NOT_EXISTS: Instans tidak ada. INSTANCE_RELEASED: Instans telah dirilis. INSTANCE_NOT_RUNNING: Instans tidak berjalan. INSTANCE_NOT_OWNED: Instans tidak dimiliki oleh akun saat ini. AGENT_ALREADY_INSTALLED: Agen telah terinstal. AGENT_NOT_INSTALLED: Agen tidak terinstal. AGENT_SAME_VERSION: Versi sama. HAS_RUNNING_JOB: Tugas yang sedang berjalan sudah ada. RPM_LOCK_HELD: Kunci RPM sedang dipegang. DISK_SPACE_INSUFFICIENT: Ruang disk tidak mencukupi. NODE_LOAD_HIGH: Beban node tinggi. COMMAND_FAILED: Eksekusi perintah gagal. CLIENT_NOT_RUNNING: Agen Asisten Cloud tidak berjalan. CLIENT_NOT_RESPONSE: Agen Asisten Cloud tidak merespons. DELIVERY_TIMEOUT: Pengiriman perintah habis waktu. EXECUTION_TIMEOUT: Eksekusi perintah habis waktu. TASK_CONCURRENCY_LIMIT: Batas konkurensi tugas telah tercapai.	DISK_SPACE_INSUFFICIENT
errorMessage	string	Deskripsi mendetail penyebab kegagalan subtugas. Nilai valid: Tipe instans tidak didukung. Instans tidak ada. Instans telah dirilis. Instans tidak berjalan. Instans tidak dimiliki oleh akun saat ini. Agen telah terinstal. Agen tidak terinstal. Versi Agen sama. Tidak diperlukan Peningkatan. Tugas yang sedang berjalan ada. Coba lagi nanti. Kunci RPM sedang dipegang. Coba lagi nanti. Ruang disk tidak mencukupi. Beban node terlalu tinggi. Coba lagi nanti. Eksekusi perintah gagal. Coba lagi nanti. Agen Asisten Cloud tidak berjalan. Agen Asisten Cloud tidak merespons. Pengiriman perintah habis waktu. Eksekusi perintah habis waktu. Batas konkurensi tugas telah tercapai.	Insufficient disk space
instance	string	ID Instans.	i-2zehme0rs1tc090fdl3n
params	any	Parameter subtugas.	{ "agent_version": "3.5.0-beta", "opt": "install", "agent_id": "74a86327-3170-412c-8fd67-da3389ec56a9", "install_type": "InstallAndUpgrade" }
region	string	ID Wilayah.	cn-hangzhou
result	string	Hasil eksekusi subtugas.	Deprecated (misused)
status	string	Status subtugas. Nilai valid: Created: Dibuat. Running: Berjalan. Success: Tugas berhasil. Fail: Tugas gagal.	Running
status	string
task_id	string	ID Tugas.	c41d8e3506224184a714682fea86d22d
message	string	Paket kesalahan. Jika `code == Success`, bidang ini kosong. Jika tidak, bidang ini berisi Paket kesalahan permintaan.	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict

Contoh

Respons sukses

JSONformat

{
  "RequestId": "2E75336A-0DB2-5263-B201-A6488EC97B50",
  "code": "Success",
  "data": {
    "jobs": [
      {
        "error": "Deprecated (misused)",
        "errorCode": "DISK_SPACE_INSUFFICIENT",
        "errorMessage": "The disk space is insufficient",
        "instance": "i-2zehme0rs1tc090fdl3n",
        "params": "{\n    \"agent_version\": \"3.5.0-beta\",\n    \"opt\": \"install\",\n    \"agent_id\": \"74a86327-3170-412c-8fd67-da3389ec56a9\",\n    \"install_type\": \"InstallAndUpgrade\"\n}",
        "region": "cn-hangzhou",
        "result": "Deprecated (misused)",
        "status": "Running"
      }
    ],
    "status": "",
    "task_id": "c41d8e3506224184a714682fea86d22d"
  },
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	SysomOpenAPI.AgentNotExists	Agent not exists.
400	SysomOpenAPI.AgentTaskNotFound	Agent task not found.
400	SysomOpenAPI.AgentVersionNotExists	Agent version not exists.
400	SysomOpenAPI.InstanceNotExists	Instance not exists.
400	SysomOpenAPI.InvalidParameter	Invalid parameters passed when calling the interface.
400	SysomOpenAPI.MissingParameter	Missing parameters.
400	SysomOpenAPI.NoAgentInstalled	No SysOM Agent version available.
400	SysomOpenAPI.NotAuthorizedInstance	Instance not authorized.
400	SysomOpenAPI.NotOwnInstance	Not own current instance.
400	SysomOpenAPI.NotOwnTask	Diagnosis result does not belong to the current account.
400	SysomOpenAPI.NotSupportedAgentVersion	Unsupported sysom agent version.
400	SysomOpenAPI.ServerError	Server error, please correct the code according to the error message.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.