调用InstallAgent接口安装Agent_企业级分布式应用服务(EDAS)-阿里云帮助中心

使用ECS自带的云助手安装EDAS Agent（将ECS导入EDAS）。

接口说明

使用该接口将 ECS 导入 EDAS 时，不会重装系统，推荐使用该接口将 ECS 导入 EDAS。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
edas:ManageCluster	none	*Cluster `acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}`	无	无

请求语法

POST /pop/v5/ecss/install_agent HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID	b3e3f77b-462e-**-**-bec8727a4dc8
InstanceIds	string	是	实例 ID，如 instanceId1,instanceId2	2ze7s2v0b789k60pk1af
DoAsync	boolean	否	已不再使用	true

返回参数

名称	类型	描述	示例值
	object
Code	integer	Code 码	200
Message	string	信息	success
RequestId	string	唯一请求 ID	b197-40ab-9155-7ca7
ExecutionResultList	array<object>	执行结果
ExecutionResult	object
Status	string	命令执行状态信息	OK
FinishedTime	string	安装结束时间	20**-11-10T07:02:17Z
InstanceId	string	实例 ID	i-2ze7s2v0b789k*******
InvokeRecordStatus	string	命令执行状态。取值范围： Running：运行中。定时执行：未手动停止定时执行命令前，执行状态一直为进行中。单次执行：一旦有进行中的命令进程，总的执行状态就为进行中。 Finished：已完成。定时执行：命令进程不可能为执行完成。单次执行：所有实例全部完成执行。或者手动停止部分实例的命令进程，其余实例全部执行完成。 Success：单次执行的命令：命令执行完成，且退出码为 0。定时执行的命令：上一次执行成功且退出码为 0，且指定的执行时间已结束。 Failed：执行失败。定时执行：命令进程不可能为执行失败。单次执行：所有实例全部执行失败。 PartialFailed：部分执行失败。定时执行：命令进程不可能为部分失败。单次执行：部分实例有执行失败的命令进程，则总执行状态为部分失败。 Stopped：命令执行已停止。 Stopping：正在停止执行的命令。	Finished
Success	boolean	是否安装成功	true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "RequestId": "b197-40ab-9155-7ca7",
  "ExecutionResultList": {
    "ExecutionResult": [
      {
        "Status": "OK",
        "FinishedTime": "20**-11-10T07:02:17Z",
        "InstanceId": "i-2ze7s2v0b789k*******",
        "InvokeRecordStatus": "Finished",
        "Success": true
      }
    ]
  }
}

错误码

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

注意事项

该接口在实际执行中，会遇到在 API 接口 Client 程序端在连接 API 网关超时（默认 10 秒）的情况，所以，用户在使用该接口时，须手工设置调用该接口时读取 POP API 网关返回的数据的超时时间（推荐设置为 30 秒，因 POP API 网关到接口 Server 端的服务处理时间最长即为 30 秒）：

使用 Java SDK 时，Client 端代码中使用该接口时设置读取超时时间方法：

InstallAgentRequest request = new InstallAgentRequest();
request.setSysReadTimeout(30000);  //单位毫秒，客户端 API 接口程序等待 POP API 网关返回数据的超时时间.
request.setClusterId(clusterId);
........

使用 Python SDK 时，Client 端代码中使用该接口时设置读取超时时间方法：

request = InstallAgentRequest()
request.set_read_timeout(30000)
request.set_ClusterId(clusterId)