Tüm Ürünler
Search

Bu Ürün

    :GetAgentTask

    Belge Merkezi

    :GetAgentTask

    Son Güncelleme:Oct 03, 2026

    Bir Agent kurulum görevinin yürütme durumunu getirir.

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

    get

    *All Resource

    *

    		 None None

    Request syntax

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    task_id

    string

    No

    Görev kimliği.

    42172120177e4b3abd6fabb3a6b5e2dd

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt şeması.

    RequestId

    string

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

    2E75336A-0DB2-5263-B201-A6488EC97B50
    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. Yetkilendirme başarısız olursa, ayrıntılı hata bilgisi için message alanını kontrol edin.

    Success
    data

    object

    Döndürülen veriler.

    jobs

    array<object>

    Alt görevlerin listesi.

    object

    Alt görev ayrıntıları.

    error

    string

    Görev başarısız olursa, bu alan başarısızlığın nedenini içerir.

    Deprecated (misused)
    errorCode

    string

    Alt görev başarısızlığına ait hata kodu. Geçerli değerler:

    • Empty: Görev normal şekilde çalışıyor.

    • INSTANCE_NOT_SUPPORTED: Örnek türü desteklenmiyor.

    • INSTANCE_NOT_EXISTS: Örnek mevcut değil.

    • INSTANCE_RELEASED: Örnek serbest bırakıldı.

    • INSTANCE_NOT_RUNNING: Örnek çalışmıyor.

    • INSTANCE_NOT_OWNED: Örnek mevcut hesaba ait değil.

    • AGENT_ALREADY_INSTALLED: Agent zaten kurulu.

    • AGENT_NOT_INSTALLED: Agent kurulu değil.

    • AGENT_SAME_VERSION: Sürüm aynı.

    • HAS_RUNNING_JOB: Zaten çalışan bir görev var.

    • RPM_LOCK_HELD: RPM kilidi tutuluyor.

    • DISK_SPACE_INSUFFICIENT: Yetersiz disk alanı.

    • NODE_LOAD_HIGH: Düğüm yükü yüksek.

    • COMMAND_FAILED: Komut yürütme işlemi başarısız oldu.

    • CLIENT_NOT_RUNNING: Cloud Assistant Agent çalışmıyor.

    • CLIENT_NOT_RESPONSE: Cloud Assistant Agent yanıt vermiyor.

    • DELIVERY_TIMEOUT: Komut teslimi zaman aşımına uğradı.

    • EXECUTION_TIMEOUT: Komut yürütme işlemi zaman aşımına uğradı.

    • TASK_CONCURRENCY_LIMIT: Görev eşzamanlılık sınırına ulaşıldı.

    DISK_SPACE_INSUFFICIENT
    errorMessage

    string

    Alt görev başarısızlığı nedeninin ayrıntılı açıklaması. Geçerli değerler:

    • Örnek türü desteklenmiyor.

    • Örnek mevcut değil.

    • Örnek serbest bırakıldı.

    • Örnek çalışmıyor.

    • Örnek mevcut hesaba ait değil.

    • Agent zaten kurulu.

    • Agent kurulu değil.

    • Agent sürümü aynı. Yükseltme gerekmiyor.

    • Çalışan bir görev var. Daha sonra tekrar deneyin.

    • RPM kilidi tutuluyor. Daha sonra tekrar deneyin.

    • Yetersiz disk alanı.

    • Düğüm yükü çok yüksek. Daha sonra tekrar deneyin.

    • Komut yürütme işlemi başarısız oldu. Daha sonra tekrar deneyin.

    • Cloud Assistant Agent çalışmıyor.

    • Cloud Assistant Agent yanıt vermiyor.

    • Komut teslimi zaman aşımına uğradı.

    • Komut yürütme işlemi zaman aşımına uğradı.

    • Görev eşzamanlılık sınırına ulaşıldı.

    Insufficient disk space
    instance

    string

    Örnek kimliği.

    i-2zehme0rs1tc090fdl3n
    params

    any

    Alt görev parametreleri.

    { "agent_version": "3.5.0-beta", "opt": "install", "agent_id": "74a86327-3170-412c-8fd67-da3389ec56a9", "install_type": "InstallAndUpgrade" }
    region

    string

    Bölge kimliği.

    cn-hangzhou
    result

    string

    Alt görev yürütme sonucu.

    Deprecated (misused)
    status

    string

    Alt görev durumu. Geçerli değerler:

    • Created: Oluşturuldu.

    • Running: Çalışıyor.

    • Success: Görev başarılı oldu.

    • Fail: Görev başarısız oldu.

    Running
    status

    string

    task_id

    string

    Görev kimliği.

    c41d8e3506224184a714682fea86d22d
    message

    string

    Hata mesajı.

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

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

    SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict

    Examples

    Success response

    JSON format

    {
  "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"
}

    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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.