華為云計(jì)算 云知識(shí) 注冊(cè)客戶端RegisterAgent
注冊(cè)客戶端RegisterAgent

 

功能介紹

注冊(cè)客戶端,安裝時(shí)候由Agent調(diào)用,無(wú)需手動(dòng)注冊(cè)。

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

POST /v3/{project_id}/agents

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID

請(qǐng)求參數(shù)

表2 請(qǐng)求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。 通過(guò)調(diào)用 IAM 服務(wù)獲取用。

表3 請(qǐng)求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

agent

AgentRegister object

客戶端注冊(cè)參數(shù)

表4 AgentRegister

參數(shù)

是否必選

參數(shù)類型

描述

agent_id

String

客戶端ID

host_name

String

客戶端所在的主機(jī)名

host_ip

String

客戶端所在主機(jī)的IP

host_os

String

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

host_nickname

String

客戶端所在主機(jī)的主機(jī)別名

agent_version

String

客戶端版本

agent_type

String

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

響應(yīng)參數(shù)

狀態(tài)碼: 200

表5 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

agent

Agent object

客戶端詳情

表6 Agent

參數(shù)

參數(shù)類型

描述

created_at

String

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

updated_at

String

客戶端更新時(shí)間

agent_id

String

客戶端ID

agent_version

String

客戶端版本號(hào)

agent_type

String

客戶端類型

host_name

String

客戶端所在的主機(jī)名

host_nickname

String

客戶端所在的主機(jī)昵稱

host_ip

String

客戶端所在主機(jī)的IP

host_os

String

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

status

String

客戶端狀態(tài)

last_active_time

String

客戶端上次激活時(shí)間

paths

Array of Path objects

客戶端的備份路徑

表7 Path

參數(shù)

參數(shù)類型

描述

id

String

路徑ID

status

String

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

agent_id

String

該路徑所屬于的客戶端ID

dir_path

String

路徑詳情

請(qǐng)求示例

注冊(cè)客戶端由agent安裝時(shí)自動(dòng)觸發(fā),無(wú)需客戶手動(dòng)調(diào)用。

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

響應(yīng)示例

狀態(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

錯(cuò)誤碼

請(qǐng)參見(jiàn)錯(cuò)誤碼