All Products
Search

This Product

    Alibaba Cloud Linux:InstallAgentWithType

    Document Center

    Alibaba Cloud Linux:InstallAgentWithType

    Last Updated:Sep 11, 2026

    Menginstal Agen pada instans tertentu.

    Deskripsi operasi

    Memanggil operasi ini untuk menginstal Agen bersifat asinkron. Setelah pemanggilan, task_id akan dikembalikan. Anda dapat menggunakan ID ini untuk memanggil operasi GetAgentTask guna memeriksa status eksekusi tugas.

    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:InstallAgentWithType

    create

    *Semua sumber daya.

    *

    		 None None

    Sintaks permintaan

    POST /api/v1/am/agent/installAgent HTTP/1.1

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    body

    object

    No

    Badan permintaan.

    Tag

    array<object>

    No

    object

    No

    Key

    string

    No

    Value

    string

    No

    agentId

    string

    Yes

    ID komponen yang akan diinstal.

    74a86327-3170-412c-8e67-da3389ec56a9
    agentVersion

    string

    Yes

    Versi komponen yang akan diinstal.

    3.4.0-1
    configId

    string

    No

    ID konfigurasi komponen yang akan diinstal.

    f0078fbb-4213-11f0-a19b-00163e4ae208
    instanceType

    string

    Yes

    Tipe instans.

    ecs
    instances

    array<object>

    Yes

    Daftar instans tempat komponen akan diinstal.

    object

    Yes

    Informasi instans.

    instance

    string

    Yes

    ID instans.

    i-wz9b9vucz1iubsz8sjqo
    region

    string

    Yes

    ID wilayah.

    cn-hangzhou

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema Respons.

    code

    string

    Kode status.

    • code == Success menunjukkan bahwa otorisasi berhasil.

    • Kode status lainnya menunjukkan bahwa otorisasi gagal. Periksa bidang Paket untuk informasi kesalahan mendetail.

    Success
    data

    object

    Data tanggapan.

    taskId

    string

    ID tugas.

    Anda dapat menggunakan ID tugas ini untuk memanggil operasi GetAgentTask guna memeriksa status eksekusi tugas.

    26b3cd97389c43dcad6bc4901c36fcec
    message

    string

    ID permintaan.

    ""
    requestId

    string

    ID permintaan, yang dapat digunakan untuk diagnostik end-to-end.

    1D8887FC-4BDB-5A1C-AB19-135C29A9E481

    Contoh

    Respons sukses

    JSONformat

    {
  "code": "Success",
  "data": {
    "taskId": "26b3cd97389c43dcad6bc4901c36fcec"
  },
  "message": "\"\"",
  "requestId": "1D8887FC-4BDB-5A1C-AB19-135C29A9E481"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    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.