All Products
Search

This Product

    Alibaba Cloud Linux:GetAgent

    Document Center

    Alibaba Cloud Linux:GetAgent

    Last Updated:Sep 11, 2026

    Retrieves the details of a specific component.

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

    get

    *All Resource

    *

    		 None None

    Request syntax

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    agent_id

    string

    No

    The component ID.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID, which can be used for end-to-end diagnostics.

    2024-09-14T20:46:08
    code

    string

    The status code.

    • code == Success indicates that the authorization is successful.

    • Other status codes indicate that the authorization failed. Check the message field for the detailed fault information.

    Success
    data

    object

    The returned data.

    created_at

    string

    The time when the component was created.

    2024-09-14T20:46:08
    description

    string

    The description of the component.

    SysOM Agent
    id

    string

    The component ID.

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

    string

    The name of the component.

    SysOM
    support_arch

    string

    The supported architecture.

    x86
    type

    string

    The agent type.

    control
    updated_at

    string

    The time when the component was last updated.

    2024-09-14T20:46:08
    versions

    array<object>

    The version information of the component.

    object

    The version information of the component.

    created_at

    string

    The time when the agent version was created.

    2024-09-14T20:46:08
    install_script

    string

    The installation script for this agent version.

    sysom.sh install
    uninstall_script

    string

    The uninstallation script for this agent version.

    sysom.sh uninstall
    updated_at

    string

    The time when the agent version was last updated.

    2024-09-14T20:46:08
    upgrade_script

    string

    The upgrade script for this agent version.

    sysom.sh upgrade
    version

    string

    The version number of the agent.

    3.4.0-1
    message

    string

    The error message.

    • If code == Success, this field is empty.

    • Otherwise, this field contains the error information of the request.

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

    Examples

    Success response

    JSON format

    {
  "RequestId": "2024-09-14T20:46:08",
  "code": "Success",
  "data": {
    "created_at": "2024-09-14T20:46:08",
    "description": "SysOM Agent",
    "id": "74a86327-3170-412c-8e67-da3389ec56a9",
    "name": "SysOM",
    "support_arch": "x86",
    "type": "control",
    "updated_at": "2024-09-14T20:46:08",
    "versions": [
      {
        "created_at": "2024-09-14T20:46:08",
        "install_script": "sysom.sh install",
        "uninstall_script": "sysom.sh uninstall",
        "updated_at": "2024-09-14T20:46:08",
        "upgrade_script": "sysom.sh upgrade",
        "version": "3.4.0-1"
      }
    ]
  },
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.