功能介绍
修改客户端状态
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v3/{project_id}/agents/{agent_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
agent_id |
是 |
String |
客户端ID |
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
created_at |
String |
客户端创建时间 |
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 |
客户端主机所在的操作系统 |
status |
String |
客户端状态 |
last_active_time |
String |
客户端上次激活时间 |
paths |
客户端的备份路径 |
请求示例
更新客户端状态为卸载
PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents/79bd9daa-884f-4f84-b8fe-235d58cd927d { "agent" : { "status" : "uninstall" } }
响应示例
状态码: 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" } ] } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。