文档首页/ 云备份 CBR/ API参考/ API/ 文件应用备份/ 查询指定客户端 - ShowAgent
更新时间：2026-10-20 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询指定客户端 - ShowAgent

功能介绍

查询指定客户端

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v3/{project_id}/agents/{agent_id}

表1 路径参数

参数

是否必选

参数类型

描述

agent_id

是

String

参数解释：

客户端ID，用于标识备份客户端的唯一标识符，获取方法请参见查询客户端列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

agent

Agent object

参数解释：

客户端详情，返回客户端的完整信息，包括客户端标识、主机信息、状态等

取值范围：

不涉及
表4 Agent

参数

参数类型

描述

created_at

String

参数解释：

客户端创建时间，格式为YYYY-MM-DDTHH:MM:SS.ffffff

取值范围：

不涉及

updated_at

String

参数解释：

客户端更新时间，格式为YYYY-MM-DDTHH:MM:SS.ffffff

取值范围：

不涉及

agent_id

String

参数解释：

客户端ID，用于标识备份客户端的唯一标识符

取值范围：

不涉及

agent_version

String

参数解释：

客户端版本号

取值范围：

不涉及

agent_type

String

参数解释：

客户端类型

取值范围：

native：本地客户端，客户端安装在本地。

cloud：云上客户端，客户端安装在云端。

host_name

String

参数解释：

客户端所在的主机名

取值范围：

不涉及

host_nickname

String

参数解释：

客户端所在的主机昵称

取值范围：

不涉及

host_ip

String

参数解释：

客户端所在主机的IP

取值范围：

不涉及

host_os

String

参数解释：

客户端主机所在的操作系统

取值范围：

不涉及

status

String

参数解释：

客户端状态

取值范围：

normal:正常状态，表示客户端可以正常使用。

abnormal：异常状态，表示系统监测出系统有异常需要修复，此时部分功能可能受阻。

uninstall：卸载状态，表示客户端已被卸载或客户端正在升级过程中。

last_active_time

String

参数解释：

客户端上次激活时间，格式为YYYY-MM-DDTHH:MM:SS.ffffff

取值范围：

不涉及

paths

Array of Path objects

参数解释：

客户端的备份路径，包含路径ID、路径状态、目录详情等属性

取值范围：

不涉及
表5 Path

参数

参数类型

描述

id

String

参数解释：

路径ID

取值范围：

不涉及

status

String

参数解释：

路径状态

取值范围：

available：可用状态，表示文件备份路径状态正常，可以使用。

remove：移除状态，表示文件备份路径状态已被移除，无法使用。

agent_id

String

参数解释：

该路径所属于的客户端ID

取值范围：

不涉及

dir_path

String

参数解释：

路径详情

取值范围：

不涉及

exclude_paths

String

参数解释：

排除目录列表，多个路径之间以英文逗号分隔。

取值范围：

不涉及

说明：
该特性目前处于公测阶段,部分Region可能无法使用。

请求示例

GET https://{endpoint}/v3/{project_id}/agents/{agent_id}

响应示例

状态码：200

{
  "agent": {
    "created_at": 2022-01-30T09:28:09.334+00:00,
    "updated_at": 2022-01-30T09:28:09.334+00:00,
    "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.960+00:00,
    "paths": [
      {
        "id": "5684b0fb-44c8-4c70-bb59-b03ec2738360",
        "agent_id": "0cba3ff9-f836-4178-9ce8-91dc8026321c",
        "dir_path": "/opt/huaweicloud/cbragent/lib",
        "status": "available",
        "exclude_paths": "*.txt,/opt/huaweicloud/cbragent/lib/test"
      },
      {
        "id": "1ad949d5-c955-4995-8c28-60fc8b110a21",
        "agent_id": "0cba3ff9-f836-4178-9ce8-91dc8026321c",
        "dir_path": "/opt/backup",
        "status": "available",
        "exclude_paths": "*.txt,/opt/huaweicloud/cbragent/lib/test"
      }
    ]
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 文件应用备份

相关文档