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

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

调试

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

请求头

请求语法

POST /pop/v5/ecss/install_agent HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
ClusterId String b3e3f77b-462e-****-****-bec8727a4dc8

集群 ID

InstanceIds String 2ze7s2v0b789k60pk1af

实例 ID,如instanceId1,instanceId2

DoAsync Boolean true

已不再使用

返回数据

名称 类型 示例值 描述
Code Integer 200

Code 码

ExecutionResultList Array

执行结果

ExecutionResult
FinishedTime String 2019-11-10T07:02:17Z

安装结束时间

InstanceId String i-2ze7s2v0b789k60pk1af

实例 ID

InvokeRecordStatus String Finished

安装状态

Status String OK

命令执行状态信息

Success Boolean true

是否安装成功

Message String success

信息

RequestId String b197-40ab-9155-7ca7

唯一请求ID

示例

请求示例

POST /pop/v5/ecss/install_agent HTTP/1.1
公共请求头
{
  "ClusterId": "b3e3f77b-462e-****-****-bec8727a4dc8"
  "InstanceIds": "2ze7s2v0b789k60pk1af"
}

正常返回示例

XML 格式

<ExecutionResultList>
    <ExecutionResult>
        <InvokeRecordStatus>Finished</InvokeRecordStatus>
        <Status>OK</Status>
        <FinishedTime>2019-11-10T07:02:17Z</FinishedTime>
        <InstanceId>i-2ze7s2v0b789k60pk1af</InstanceId>
        <Success>true</Success>
    </ExecutionResult>
</ExecutionResultList>
<Message>success</Message>
<Code>200</Code>

JSON 格式

{
	"ExecutionResultList": {
		"ExecutionResult": [
			{
				"InvokeRecordStatus": "Finished",
				"Status": "OK",
				"FinishedTime": "2019-11-10T07:02:17Z",
				"InstanceId": "i-2ze7s2v0b789k60pk1af",
				"Success": true
			}
		]
	},
	"Message": "success",
	"Code": 200
}

错误码

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

注意事项

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

  • 使用 Java SDK 时,Client 端代码中使用该接口时设置读取超时时间方法:
    java
    InstallAgentRequest request = new InstallAgentRequest();
    request.setSysReadTimeout(30000);  //单位毫秒,客户端 API 接口程序等待 POP API网关返回数据的超时时间.
    request.setClusterId(clusterId);
    ........
    
  • 使用 Python SDK 时,Client 端代码中使用该接口时设置读取超时时间方法:
    python
    request = InstallAgentRequest()
    request.set_read_timeout(30000)
    request.set_ClusterId(clusterId)