UpgradeAgent - 更新组件 - Alibaba Cloud Linux

接口说明

调用本接口更新 Agent 是异步的，调用接口后会返回一个 task_id，可以凭借该 ID 调用 GetAgentTask 接口获取任务的执行情况。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

sysom:UpgradeAgent

update

*全部资源

*

无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 Body
agent_id	string	是	要更新的组件 ID	74a86327-3170-412c-8e67-da3389ec56a9
agent_version	string	是	要更新的组件版本	3.4.0-1
instances	array<object>	是	要更新组件的实例列表
	object	是	实例信息
instance	string	是	实例 ID。	i-wz9b9vucz1iubsz8sjqo
region	string	是	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，可用于全链路诊断	B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
code	string	状态码 `code == Success` 则代表授权成功；其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；	Success
data	object	返回数据
task_id	string	任务 ID。	391f5aeba2054f66b3aaef0136142fe2
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict

示例

正常返回示例

JSON格式

{
  "RequestId": "B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7",
  "code": "Success",
  "data": {
    "task_id": "391f5aeba2054f66b3aaef0136142fe2"
  },
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict"
}

错误码

HTTP status code	错误码	错误信息	描述
400	SysomOpenAPI.RegionNotSupport	Region not supported.	地域不支持。

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

变更历史

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