Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Protection/ Querying the Agent Status
Updated on 2025-11-03 GMT+08:00
View PDF
Share

Querying the Agent Status

Function

This API is used to check the Agent status required by application-consistent.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v3/{project_id}/agent/check

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

agent_status

Yes

Array of ProtectableAgentStatusResource objects

Query parameter list
Table 3 ProtectableAgentStatusResource

Parameter

Mandatory

Type

Description

resource_id

Yes

String

ID of the resource to be checked. It is in UUID format. Default value: N/A You can query the resource ID based on the type of the resource to be backed up.

resource_name

No

String

Name of the resource to be checked

resource_type

Yes

String

Type of the resource to be checked. Default value: N/A The value can be:

OS::Nova::Server: The resource is an ECS.

OS::Ironic::BareMetalServer: The resource is a bare metal server.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

agent_status

Array of ProtectableAgentStatus objects

Status list
Table 5 ProtectableAgentStatus

Parameter

Type

Description

code

Integer

Error code returned upon an Agent connection failure

installed

Boolean

Whether the Agent is installed

is_old

Boolean

Whether the installed Agent is of an earlier version

message

String

Error information that explains why the Agent cannot be connected

resource_id

String

Resource ID, in UUID format. Default value: N/A

version

String

Agent version ID

Example Requests

Querying the agent status of a cloud server

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"
  } ]
}

Example Responses

Status code: 200

OK

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

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Protection