更新时间:2024-05-10 GMT+08:00
分享

查询客户端列表

功能介绍

查询客户端列表

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/agents

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

agent_id

String

客户端ID

limit

String

每页显示条目数,正整数

最小长度:1

最大长度:1000

offset

Integer

偏移值,正整数

status

String

状态

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

agents

Array of Agent objects

客户端实例列表

count

Integer

客户端个数

limit

Integer

每页显示的条目数量

offset

Integer

偏移量,表示从此偏移量开始查询

表5 Agent

参数

参数类型

描述

created_at

String

客户端创建时间

updated_at

String

客户端更新时间

agent_id

String

客户端ID

agent_version

String

客户端版本号

agent_type

String

客户端类型

host_name

String

客户端所在的主机名

host_nickname

String

客户端所在的主机昵称

host_ip

String

客户端所在主机的IP

host_os

String

客户端主机所在的操作系统

status

String

客户端状态

last_active_time

String

客户端上次激活时间

paths

Array of Path objects

客户端的备份路径

表6 Path

参数

参数类型

描述

id

String

路径ID

status

String

路径状态,有available和remove两种状态

agent_id

String

该路径所属于的客户端ID

dir_path

String

路径详情

请求示例

GET  https://{endpoint}/v3/{project_id}/agents

响应示例

状态码: 200

OK

{
  "count" : 2,
  "limit" : 1000,
  "offset" : 0,
  "agents" : [ {
    "created_at" : "2022-01-30T09:28:09.334+00:00",
    "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114",
    "host_name" : "eBackup",
    "host_ip" : "18.9.158.36",
    "status" : "normal",
    "last_active_time" : "2022-01-30T09:28:08.960+00:00"
  }, {
    "created_at" : "2022-01-14T06:47:17.524+00:00",
    "updated_at" : "2022-01-28T05:01:32.739+00:00",
    "agent_id" : "fb711278-e872-4224-b442-8dafc36a543d",
    "host_name" : "ecs-00001",
    "host_ip" : "10.10.0.1",
    "status" : "normal",
    "last_active_time" : "2022-01-28T05:01:32.000+00:00",
    "paths" : [ {
      "id" : "6c3d1ed6-b7d7-4e27-94ee-321431e84c5c",
      "dir_path" : "/home/hcp",
      "status" : "available",
      "agent_id" : "fb711278-e872-4224-b442-8dafc36a543d"
    }, {
      "id" : "e2af0fdd-9644-4db8-986e-5a6a2395c390",
      "dir_path" : "/opt/workspace",
      "status" : "available",
      "agent_id" : "fb711278-e872-4224-b442-8dafc36a543d"
    } ]
  } ]
}

SDK代码示例

SDK代码示例如下。

Java

 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
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 ListAgentSolution {

    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();
        ListAgentRequest request = new ListAgentRequest();
        request.withLimit("<limit>");
        request.withOffset(<offset>);
        request.withStatus("<status>");
        request.withAgentId();
        try {
            ListAgentResponse response = client.listAgent(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

 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
# 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 = ListAgentRequest()
        request.limit = "<limit>"
        request.offset = <offset>
        request.status = "<status>"
        request.agent_id = 
        response = client.list_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

 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
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.ListAgentRequest{}
	limitRequest:= "<limit>"
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	statusRequest:= "<status>"
	request.Status = &statusRequest
	response, err := client.ListAgent(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品