文档首页/ 应用运维管理 AOM/ API参考/ API/ UniAgent管理/ 查询UniAgent主机列表信息
更新时间:2024-11-01 GMT+08:00
分享

查询UniAgent主机列表信息

功能介绍

该接口用于查询执行过安装UniAgent任务的主机列表信息。该接口仅支持白名单用户使用,如有需求可通过提交工单申请使用。

调用方法

请参见如何调用API

URI

POST /v1/uniagent-console/agent-list/all

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

最小长度:1

最大长度:40960

Content-Type

String

指定类型为application/json。

枚举值:

  • application/json
表2 请求Body参数

参数

是否必选

参数类型

描述

page

Long

分页查询的起始页数(第几页)。默认值:1。

page_size

Long

每页查询数量,默认20。每页最多支持查询100条数据。

ecs_id_list

Array of strings

ecs ID列表信息。最多支持传入100条数据。

agent_id_list

Array of strings

agent ID列表信息。最多支持传入100条数据。

coc_cmdb_id_list

Array of strings

cmdb ID列表信息。最多支持传入100条数据。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

page

Long

页码,默认1。

page_size

Long

每页数量,默认20。

total_count

Long

总数量。

data_list

Array of AgentInfoResult objects

主机列表信息。

表4 AgentInfoResult

参数

参数类型

描述

inner_ip

String

机器 IP。

import_ip

String

机器导入IP。

agent_id

String

agent ID。

host_name

String

主机名。

os_type

String

操作系统。

agent_state

String

UniAgent状态。

project_id

String

所属project ID。

version

String

UniAgent版本。

is_hw_cloud_host

String

是否华为云机器。

vpc_id

String

VPC ID。

cmdb_id

String

CMDB ID。

ecs_id

String

ECS ID,唯一值。

domain_id

String

机器所属domain ID。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

最小长度:0

最大长度:1024

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

最小长度:0

最大长度:1024

请求示例

查询agent列表信息

https://{Endpoint}/v1/uniagent-console/agent-list/all

{
  "page" : 1,
  "page_size" : 10
}

响应示例

状态码: 200

OK 请求响应成功。

{
  "page" : 1,
  "page_size" : 1,
  "total_count" : 20,
  "data_list" : [ {
    "inner_ip" : "1.2.3.4",
    "import_ip" : "1.2.3.4",
    "agent_id" : "xxxxxx",
    "host_name" : "test0222",
    "os_type" : "LINUX",
    "agent_state" : "ONLINE",
    "project_id" : 1234565,
    "version" : "1.0.0",
    "is_hw_cloud_host" : false,
    "vpc_id" : null,
    "cmdb_id" : 123456,
    "ecs_id" : 123456,
    "domain_id" : 123456
  } ]
}

状态码: 400

BadRequest 非法请求。建议直接修改该请求,不要重试该请求。

{
  "error_code" : "AOM.32000003",
  "error_msg" : "Invalid parameter."
}

状态码: 403

Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

{
  "error_code" : "AOM.32000002",
  "error_msg" : "No permission."
}

SDK代码示例

SDK代码示例如下。

查询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
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.aom.v4.region.AomRegion;
import com.huaweicloud.sdk.aom.v4.*;
import com.huaweicloud.sdk.aom.v4.model.*;


public class ShowAgentInfosSolution {

    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);

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowAgentInfosRequest request = new ShowAgentInfosRequest();
        AgentInfoParam body = new AgentInfoParam();
        body.withPageSize(10L);
        body.withPage(1L);
        request.withBody(body);
        try {
            ShowAgentInfosResponse response = client.showAgentInfos(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());
        }
    }
}

查询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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v4.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.v4 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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = ShowAgentInfosRequest()
        request.body = AgentInfoParam(
            page_size=10,
            page=1
        )
        response = client.show_agent_infos(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

查询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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v4/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 := aom.NewAomClient(
        aom.AomClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowAgentInfosRequest{}
	pageSizeAgentInfoParam:= int64(10)
	pageAgentInfoParam:= int64(1)
	request.Body = &model.AgentInfoParam{
		PageSize: &pageSizeAgentInfoParam,
		Page: &pageAgentInfoParam,
	}
	response, err := client.ShowAgentInfos(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK 请求响应成功。

400

BadRequest 非法请求。建议直接修改该请求,不要重试该请求。

403

Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

错误码

请参见错误码

相关文档