Tüm Ürünler
Search

Bu Ürün

    :InstallAgent

    Belge Merkezi

    :InstallAgent

    Son Güncelleme:Oct 03, 2026

    Belirtilen bir örneğe aracı kurar.

    Operation description

    Bu işlemi çağırarak aracı kurma işlemi eşzamansız olarak gerçekleştirilir. Bu işlem çağrıldıktan sonra bir task_id döndürülür. Görevin çalıştırma durumunu sorgulamak için bu kimliği kullanarak GetAgentTask işlemini çağırabilirsiniz.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    sysom:InstallAgent

    none

    *All Resource

    *

    		 None None

    Request syntax

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    body

    object

    No

    İstek gövdesi.

    agent_id

    string

    Yes

    Kurulacak aracının kimliği.

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

    string

    Yes

    Kurulacak aracının sürümü.

    3.4.0-1
    install_type

    string

    Yes

    Kurulum türü. Geçerli değerler:

    • InstallAndUpgrade: Aracı mevcut değilse kurar, mevcutsa günceller.

    • OnlyInstallNotHasAgent: Aracı mevcut değilse kurar, mevcutsa hiçbir işlem yapmaz.

    • OnlyUpgradeHasAgent: Aracı mevcut değilse hiçbir işlem yapmaz, mevcutsa günceller.

    • OnlyInstallWithoutStart: Hizmeti başlatmadan yalnızca aracıyı kurar.

    InstallAndUpgrade
    instances

    array<object>

    Yes

    Aracının kurulacağı örneklerin listesi.

    object

    Yes

    Örnek bilgileri.

    instance

    string

    Yes

    Örnek kimliği.

    i-wz9b9vucz1iubsz8sjqo
    region

    string

    Yes

    Bölge kimliği.

    cn-hangzhou

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt şeması.

    RequestId

    string

    Uçtan uca tanılama için kullanılabilecek istek kimliği.

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

    string

    Durum kodu.

    • code == Success yetkilendirmenin başarılı olduğunu gösterir.

    • Diğer durum kodları yetkilendirmenin başarısız olduğunu gösterir. Ayrıntılı hata bilgileri için message alanını kontrol edin.

    Success
    data

    object

    Yanıt verileri.

    task_id

    string

    Görev kimliği.

    Görevin çalıştırma durumunu sorgulamak için bu görev kimliğini kullanarak GetAgentTask işlemini çağırabilirsiniz.

    26b3cd97389c43dcad6bc4901c36fcec
    message

    string

    Hata mesajı.

    • code == Success ise bu alan boştur.

    • Aksi takdirde, bu alan istek hata mesajını içerir.

    ""

    Examples

    Success response

    JSON format

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

    Error codes

    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.
    400 SysomOpenAPI.ServiceRoleNotExists Service role does not exist, please init the sysom service first.
    400 SysomOpenAPI.RegionNotSupport Region not supported.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.