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.
URI
POST /v3/{project_id}/agent/check
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
agent_status |
Yes |
Array of ProtectableAgentStatusResource objects |
Query parameter list |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
resource_id |
Yes |
String |
ID of the resource to be checked. It is in UUID format. You can query the resource status 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. OS::Nova::Server: The resource is an ECS. OS::Ironic::BareMetalServer: The resource is a bare metal server. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
agent_status |
Array of ProtectableAgentStatus objects |
Status list |
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. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot