全部產品
Search
文件中心

Enterprise Distributed Application Service:InstallAgent - 安裝 Agent

更新時間:Dec 22, 2025

使用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

object

ExecutionResult

array<object>

執行結果

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
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情