更新时间:2024-06-21 GMT+08:00

查询agent状态

功能介绍

检查应用一致性Agent状态

调用方法

请参见如何调用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

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

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

SDK代码示例

SDK代码示例如下。

Java

查询云服务器资源agent状态

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cbr.v1.region.CbrRegion;
import com.huaweicloud.sdk.cbr.v1.*;
import com.huaweicloud.sdk.cbr.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class CheckAgentSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CbrClient client = CbrClient.newBuilder()
                .withCredential(auth)
                .withRegion(CbrRegion.valueOf("<YOUR REGION>"))
                .build();
        CheckAgentRequest request = new CheckAgentRequest();
        ProtectableAgentReq body = new ProtectableAgentReq();
        List<ProtectableAgentStatusResource> listbodyAgentStatus = new ArrayList<>();
        listbodyAgentStatus.add(
            new ProtectableAgentStatusResource()
                .withResourceId("6c0e29fc-5eaa-4f76-af9e-cc79895f70d7")
                .withResourceName("ecs-8f7b")
                .withResourceType("OS::Nova::Server")
        );
        body.withAgentStatus(listbodyAgentStatus);
        request.withBody(body);
        try {
            CheckAgentResponse response = client.checkAgent(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

查询云服务器资源agent状态

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcbr.v1.region.cbr_region import CbrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcbr.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = CbrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CbrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CheckAgentRequest()
        listAgentStatusbody = [
            ProtectableAgentStatusResource(
                resource_id="6c0e29fc-5eaa-4f76-af9e-cc79895f70d7",
                resource_name="ecs-8f7b",
                resource_type="OS::Nova::Server"
            )
        ]
        request.body = ProtectableAgentReq(
            agent_status=listAgentStatusbody
        )
        response = client.check_agent(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

查询云服务器资源agent状态

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cbr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cbr.NewCbrClient(
        cbr.CbrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CheckAgentRequest{}
	resourceNameAgentStatus:= "ecs-8f7b"
	var listAgentStatusbody = []model.ProtectableAgentStatusResource{
        {
            ResourceId: "6c0e29fc-5eaa-4f76-af9e-cc79895f70d7",
            ResourceName: &resourceNameAgentStatus,
            ResourceType: "OS::Nova::Server",
        },
    }
	request.Body = &model.ProtectableAgentReq{
		AgentStatus: listAgentStatusbody,
	}
	response, err := client.CheckAgent(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码