GetAgentTask - Alibaba Cloud Linux

取得 Agent 安裝任務執行狀態。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sysom:GetAgentTask

get

*全部資源。

*

無

請求文法

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

請求參數

名稱	類型	必填	描述	樣本值
task_id	string	否	任務 ID。	42172120177e4b3abd6fabb3a6b5e2dd

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID，可用於全鏈路診斷。	2E75336A-0DB2-5263-B201-A6488EC97B50
code	string	狀態碼 `code == Success` 則代表授權成功；其它狀態碼代表授權失敗，授權失敗時查看 `message` 欄位取得詳細的錯誤資訊。	Success
data	object	回傳資料。
jobs	array<object>	子任務清單。
	object	子任務詳情。
error	string	當任務執行失敗時，此欄位會回傳導致任務失敗的錯誤原因。	已廢棄（誤用）
errorCode	string	子任務執行失敗原因的代碼，可能值：空：任務執行正常。 INSTANCE_NOT_SUPPORTED：執行個體類型不支援 INSTANCE_NOT_EXISTS：執行個體不存在 INSTANCE_RELEASED：執行個體已釋放 INSTANCE_NOT_RUNNING：執行個體不在執行中 INSTANCE_NOT_OWNED：執行個體不屬於當前帳號 AGENT_ALREADY_INSTALLED：Agent 已安裝 AGENT_NOT_INSTALLED：Agent 未安裝 AGENT_SAME_VERSION：版本相同 HAS_RUNNING_JOB：有執行中的任務 RPM_LOCK_HELD：RPM lock 被佔用 DISK_SPACE_INSUFFICIENT：磁碟空間不足 NODE_LOAD_HIGH：節點負載高 COMMAND_FAILED：命令執行失敗 CLIENT_NOT_RUNNING：雲端助手 Agent 未執行 CLIENT_NOT_RESPONSE：雲端助手 Agent 無回應 DELIVERY_TIMEOUT：命令傳送逾時 EXECUTION_TIMEOUT：命令執行逾時 TASK_CONCURRENCY_LIMIT：任務併發達上限	DISK_SPACE_INSUFFICIENT
errorMessage	string	子任務執行失敗原因的詳情，可能值：執行個體類型不支援執行個體不存在執行個體已釋放執行個體不在執行中執行個體不屬於當前帳號 Agent 已安裝 Agent 未安裝 Agent 版本相同，無需升級存在執行中的任務，請稍後重試 RPM lock 被佔用，請稍後重試磁碟空間不足節點負載過高，請稍後重試命令執行失敗，請稍後重試雲端助手 Agent 未執行雲端助手 Agent 無回應命令傳送逾時命令執行逾時任務併發數達到上限	磁碟空間不足
instance	string	執行個體 ID。	i-2zehme0rs1tc090fdl3n
params	any	子任務參數。	{ "agent_version": "3.5.0-beta", "opt": "install", "agent_id": "74a86327-3170-412c-8fd67-da3389ec56a9", "install_type": "InstallAndUpgrade" }
region	string	地域 ID。	cn-hangzhou
result	string	子任務執行結果。	已廢棄（誤用）
status	string	子任務狀態： Created：已建立 Running：正在執行 Success：任務執行成功 Fail：任務執行失敗	Running
status	string
task_id	string	任務 ID。	c41d8e3506224184a714682fea86d22d
message	string	錯誤資訊。如果 `code == Success`，則本欄位為空；否則本欄位包含請求錯誤資訊。	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2E75336A-0DB2-5263-B201-A6488EC97B50",
  "code": "Success",
  "data": {
    "jobs": [
      {
        "error": "已廢棄（誤用）",
        "errorCode": "DISK_SPACE_INSUFFICIENT",
        "errorMessage": "磁碟空間不足",
        "instance": "i-2zehme0rs1tc090fdl3n",
        "params": "{\n    \"agent_version\": \"3.5.0-beta\",\n    \"opt\": \"install\",\n    \"agent_id\": \"74a86327-3170-412c-8fd67-da3389ec56a9\",\n    \"install_type\": \"InstallAndUpgrade\"\n}",
        "region": "cn-hangzhou",
        "result": "已廢棄（誤用）",
        "status": "Running"
      }
    ],
    "status": "",
    "task_id": "c41d8e3506224184a714682fea86d22d"
  },
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	SysomOpenAPI.AgentNotExists	Agent not exists.
400	SysomOpenAPI.AgentTaskNotFound	Agent task not found.
400	SysomOpenAPI.AgentVersionNotExists	Agent version not exists.
400	SysomOpenAPI.InstanceNotExists	Instance not exists.
400	SysomOpenAPI.InvalidParameter	Invalid parameters passed when calling the interface.
400	SysomOpenAPI.MissingParameter	Missing parameters.
400	SysomOpenAPI.NoAgentInstalled	No SysOM Agent version available.
400	SysomOpenAPI.NotAuthorizedInstance	Instance not authorized.
400	SysomOpenAPI.NotOwnInstance	Not own current instance.
400	SysomOpenAPI.NotOwnTask	Diagnosis result does not belong to the current account.
400	SysomOpenAPI.NotSupportedAgentVersion	Unsupported sysom agent version.
400	SysomOpenAPI.ServerError	Server error, please correct the code according to the error message.

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

變更歷史

更多資訊，參考變更詳情。