GetAgent - 获取组件详情 - Alibaba Cloud Linux

获取某个组件的详情

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sysom:GetAgent

get

*全部资源

*

无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
agent_id	string	否	组件 ID	74a86327-3170-412c-8e67-da3389ec56a9

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，可用于全链路诊断	2024-09-14T20:46:08
code	string	状态码 `code == Success` 则代表授权成功；其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；	Success
data	object	返回数据。
created_at	string	组件创建时间	2024-09-14T20:46:08
description	string	组件描述	SysOM Agent
id	string	组件 ID	74a86327-3170-412c-8e67-da3389ec56a9
name	string	组件名称	SysOM
support_arch	string	支持的架构	x86
type	string	Agent 类型	control
updated_at	string	更新时间	2024-09-14T20:46:08
versions	array<object>	组件版本信息
	object	组件版本信息
created_at	string	Agent 版本创建时间	2024-09-14T20:46:08
install_script	string	Agent 该版本的安装脚本	sysom.sh install
uninstall_script	string	Agent 该版本的卸载脚本	sysom.sh uninstall
updated_at	string	Agent 版本的更新时间	2024-09-14T20:46:08
upgrade_script	string	Agent 该版本的更新脚本	sysom.sh upgrade
version	string	Agent 版本号	3.4.0-1
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。