文档首页/ 云备份 CBR/ API参考/ API/ 可保护性/ 查询agent状态 - CheckAgent
更新时间：2026-07-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询agent状态 - CheckAgent

功能介绍

检查应用一致性Agent状态

授权信息

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

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

URI

POST /v3/{project_id}/agent/check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

agent_status

是

Array of ProtectableAgentStatusResource objects

参数解释：

查询参数列表

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 ProtectableAgentStatusResource

参数

是否必选

参数类型

描述

resource_id

是

String

参数解释：

待检查资源ID，格式为UUID，可根据待备份的资源类型查询对应的资源

约束限制：

资源类型需要与resource_type保持一致

取值范围：

不涉及

默认取值：

不涉及

resource_name

否

String

参数解释：

待检查资源名称

约束限制：

需要与待检查资源ID相对应

取值范围：

不涉及

默认取值：

不涉及

resource_type

是

String

参数解释：

待检查的资源类型

约束限制：

需要与待检查资源ID相对应

取值范围：

  • OS::Nova::Server：保护的资源为云服务器

  • OS::Ironic::BareMetalServer：保护的资源为裸金属服务器

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

agent_status

Array of ProtectableAgentStatus objects

状态列表
表5 ProtectableAgentStatus

参数

参数类型

描述

code

Integer

参数解释：

agent无法连接的错误码，具体参考错误码

取值范围：

不涉及

installed

Boolean

参数解释：

agent是否安装

取值范围：

-true：已安装

-false：未安装

is_old

Boolean

参数解释：

agent是否为老版本

取值范围：

-true：是老版本

-false：不是老版本

message

String

参数解释：

agent无法连接的错误信息，可能为未找到对应agent等，具体参考错误码

取值范围：

不涉及

resource_id

String

参数解释：

资源ID，格式为UUID

取值范围：

不涉及

version

String

参数解释：

agent版本号

取值范围：

不涉及

请求示例

查询云服务器资源agent状态

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agent/check

{
  "agent_status" : [ {
    "resource_id" : "6c0e29fc-5eaa-4f76-af9e-cc79895f70d7",
    "resource_name" : "ecs-8f7b",
    "resource_type" : "OS::Nova::Server"
  } ]
}

响应示例

状态码：200

OK

{
  "agent_status" : [ {
    "resource_id" : "6c0e29fc-5eaa-4f76-af9e-cc79895f70d7",
    "installed" : false
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 可保护性

相关文档