華為云計算 云知識 修改客戶端UpdateAgent
修改客戶端UpdateAgent

 

功能介紹

修改客戶端狀態(tài)

調(diào)試

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

URI

PUT /v3/{project_id}/agents/{agent_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

agent_id

String

客戶端ID

project_id

String

項目ID

請求參數(shù)

表2 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。 通過調(diào)用 IAM 服務獲取用戶Token接口獲?。憫㈩^中X-Subject-Token的值)。

表3 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

agent

AgentUpdate object

待更新的agent參數(shù)

表4 AgentUpdate

參數(shù)

是否必選

參數(shù)類型

描述

status

String

客戶端狀態(tài),當前只支持卸載,由客戶端被卸載時自動觸發(fā)

枚舉值:

  • uninstall

響應參數(shù)

狀態(tài)碼: 200

表5 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

agent

Agent object

客戶端詳情

表6 Agent

參數(shù)

參數(shù)類型

描述

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

參數(shù)

參數(shù)類型

描述

id

String

路徑ID

status

String

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

agent_id

String

該路徑所屬于的客戶端ID

dir_path

String

路徑詳情

請求示例

更新客戶端狀態(tài)為卸載

PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents/79bd9daa-884f-4f84-b8fe-235d58cd927d

{
  "agent" : {
    "status" : "uninstall"
  }
}

響應示例

狀態(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" : "uninstall",
    "last_active_time" : "2022-01-30T09:28:08.959908",
    "paths" : [ {
      "id" : "5684b0fb-44c8-4c70-bb59-b03ec2738360",
      "agent_id" : "0cba3ff9-f836-4178-9ce8-91dc8026321c",
      "dir_path" : "/opt/huaweicloud/cbragent/lib",
      "status" : "available"
    }, {
      "id" : "1ad949d5-c955-4995-8c28-60fc8b110a21",
      "agent_id" : "0cba3ff9-f836-4178-9ce8-91dc8026321c",
      "dir_path" : "/opt/backup",
      "status" : "available"
    } ]
  }
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

錯誤碼

請參見錯誤碼。