華為云計算 云知識 注冊客戶端RegisterAgent
注冊客戶端RegisterAgent

 

功能介紹

注冊客戶端,安裝時候由Agent調用,無需手動注冊。

調試

您可以在API Explorer中調試該接口,支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調試功能。

URI

POST /v3/{project_id}/agents

表1 路徑參數

參數

是否必選

參數類型

描述

project_id

String

項目ID

請求參數

表2 請求Header參數

參數

是否必選

參數類型

描述

X-Auth-Token

String

用戶Token。 通過調用 IAM 服務獲取用。

表3 請求Body參數

參數

是否必選

參數類型

描述

agent

AgentRegister object

客戶端注冊參數

表4 AgentRegister

參數

是否必選

參數類型

描述

agent_id

String

客戶端ID

host_name

String

客戶端所在的主機名

host_ip

String

客戶端所在主機的IP

host_os

String

客戶端所在主機的操作系統(tǒng)

host_nickname

String

客戶端所在主機的主機別名

agent_version

String

客戶端版本

agent_type

String

客戶端類型,分本地客戶端和云上客戶端(cloud/native)

響應參數

狀態(tài)碼: 200

表5 響應Body參數

參數

參數類型

描述

agent

Agent object

客戶端詳情

表6 Agent

參數

參數類型

描述

created_at

String

客戶端創(chuàng)建時間

updated_at

String

客戶端更新時間

agent_id

String

客戶端ID

agent_version

String

客戶端版本號

agent_type

String

客戶端類型

host_name

String

客戶端所在的主機名

host_nickname

String

客戶端所在的主機昵稱

host_ip

String

客戶端所在主機的IP

host_os

String

客戶端主機所在的操作系統(tǒng)

status

String

客戶端狀態(tài)

last_active_time

String

客戶端上次激活時間

paths

Array of Path objects

客戶端的備份路徑

表7 Path

參數

參數類型

描述

id

String

路徑ID

status

String

路徑狀態(tài),有available和remove兩種狀態(tài)

agent_id

String

該路徑所屬于的客戶端ID

dir_path

String

路徑詳情

請求示例

注冊客戶端由agent安裝時自動觸發(fā),無需客戶手動調用。

 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents

{
  "agent" : {
    "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114",
    "host_name" : "ecs-00002",
    "host_ip" : "10.10.0.2",
    "host_os" : "linux",
    "agent_version" : "1.0.0",
    "agent_type" : "native"
  }
}

響應示例

狀態(tài)碼: 200

OK

{
  "agent" : {
    "created_at" : "2022-01-30T09:28:09.334153",
    "updated_at" : "2022-01-30T09:28:09.334153",
    "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114",
    "agent_version" : "1.0.0",
    "agent_type" : "native",
    "host_name" : "ecs-0001",
    "host_nickname" : "",
    "host_ip" : "192.168.10.144",
    "host_os" : "linux",
    "status" : "normal",
    "last_active_time" : "2022-01-30T09:28:08.959908"
  }
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

錯誤碼

請參見錯誤碼。