You need to enable JavaScript to run this app.
导航

DescribeHostGroups

最近更新时间2023.11.22 17:29:24

首次发布时间2022.05.11 11:26:48

调用 DescribeHostGroups 接口获取所有机器组。

使用说明

本接口用于查看该地域下所有机器组。支持分页查询、按机器组名称或机器组Id模糊查询。调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。

URI

请求方法
GET

URI

https://tls-{Region}.ivolces.com/DescribeHostGroups

传输协议

HTTPS

URI请求参数

参数
参数类型
是否必选
示例值
说明

HostGroupId

String

可选

66*********

机器组的 ID,支持模糊查询。

HostGroupName

String

可选

mgn1

机器组的名称,支持模糊查询。

PageNumber

Integer

可选

1

分页查询时的页码。默认为 1,即从第一页数据开始返回。

PageSize

Integer

可选

20

分页大小。默认为 20,最大为 100。

AutoUpdate

Bool

可选

true

是否开启了自动升级功能。

  • true:开启
  • false:关闭。

HostIdentifier

String

可选

test

机器组标识,不支持模糊查询。

ServiceLogging

Boolean

可选

true

是否已开启服务日志功能。

  • true:开启
  • false:关闭。

IamProjectName

String

可选

default

根据机器组所属的 IAM 项目名称进行筛选。精确匹配。

响应参数

参数
参数类型
示例值
说明

Total

Integer

2

机器组数量。

HostGroupHostsRulesInfos

Array of HostGroupHostsRulesInfo

/

机器组信息列表。详细信息请参考 HostGroupHostsRulesInfo

示例

请求示例

GET https://tls-{Region}.ivolces.com/DescribeHostGroups?HostGroupId=662*********&HostGroupName=mgn1&PageNumber=1&PageSize=20 HTTP/1.1
...

响应示例

以采集模式为单行全文模式为例:

HTTP/1.1 200 OK
Content-Type: application/json
...
{
    "Total": 1,
    "HostGroupHostsRulesInfo": {
        "HostGroupInfo": {
            "HostGroupId": "0fda**********",
            "HostGroupName": "mgn1",
            "HostGroupType": "IP",
            "HostCount": 2,
            "NormalHeartbeatStatusCount": 1,
            "AbnormalHeartbeatStatusCount": 1,
            "RuleCount": 1, 
            "AutoUpdate": true,
            "UpdateStartTime": "00:00",
            "UpdateEndTime": "02:00",
            "AgentLatestVersion": "1.0.8",
            "CreateTimestamp": "2021-08-18 13:32:23",
            "ModifyTimestamp": "2021-08-18 13:32:23",
            "ServiceLogging": true,
            "IamProjectName": "default"
        },
        "HostInfos": [
            {
                "Ip": "127.0.0.1",
                "LogCollectorVersion": "logcollector-1.0.3",
                "HeartbeatStatus": 0
            },
            {
                "Ip": "127.0.0.2",
                "LogCollectorVersion": "logcollector-1.0.3",
                "HeartbeatStatus": 1
            }
        ],
        "RuleInfos": [
            {
                "TopicId": "faf6*******",
                "TopicName": "tn1",
                "RuleId": "faf********",
                "RuleName": "testname",
                "Paths": [
                    "/data/nginx/log/*/*/*.log"
                ],
                "ExcludePaths":[
                    {
                        "Type": "File",
                        "Value": "/data/nginx/log/*/*/exclude.log"
                    },
                    {
                        "Type": "Path",
                        "Value": "/data/nginx/log/*/exclude/"
                    }
                ],
                "LogType": "minimalist_log",
                "ExtractRule": {
                    "FilterKeyRegex": [
                        {
                            "Key": "__content__",
                            "Regex": ".*ERROR.*"
                        }
                    ]
                },
                "LogSample": "2018-05-22 15:35:53.850 INFO XXXX",
                "UserDefineRule": {
                    "ParsePathRule": {
                        "PathSample": "/data/nginx/log/dabaad5f-7a10/tls/app.log",
                        "Regex": "\\/data\\/nginx\\/log\\/(\\w+)-(\\w+)\\/tls\\/app\\.log",
                        "Keys": ["instance-id", "pod-name"]
                    },
                    "ShardHashKey": {
                        "HashKey": "3C"
                    },
                    "EnableRawLog": true,
                    "RawLogKey": "raw",
                    "Fields": {
                        "ClusterID":"dabaad5f-7a10-4771-b3ea-d821f73e****"
                    },
                    "Advanced": {
                        "CloseInactive": 10
                    }
                },
                "CreateTime": "2021-08-18T13:32:23Z",
                "ModifyTime": "2021-08-18T13:32:23Z"
            }
        ]
    }
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码