文档首页/云备份 CBR/API参考/API/可保护性/查询agent状态 - CheckAgent
更新时间：2025-12-05 GMT+08:00
查看PDF
分享

查询agent状态 - CheckAgent

功能介绍

检查应用一致性Agent状态

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

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

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

URI

POST /v3/{project_id}/agent/check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

agent_status

是

Array of ProtectableAgentStatusResource objects

查询参数列表

表3 ProtectableAgentStatusResource

参数

是否必选

参数类型

描述

resource_id

是

String

待检查资源ID，格式为UUID。默认取值不涉及。可根据待备份的资源类型查询对应的资源情况。

resource_name

否

String

待检查资源name

resource_type

是

String

待检查的资源类型，默认取值不涉及。取值范围如下：

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

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

agent_status

Array of ProtectableAgentStatus objects

状态列表

表5 ProtectableAgentStatus

参数

参数类型

描述

code

Integer

agent无法连接的错误码

installed

Boolean

agent是否安装

is_old

Boolean

agent是否为老版本

message

String

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

错误码

请参见错误码。

父主题：可保护性

相关文档