文档

ListMachineGroup

更新时间:

调用ListMachineGroup接口列出目标Project下的机器组。

接口说明

  • Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。
  • 已创建并获取AccessKey。更多信息,请参见访问密钥

    阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权

  • 已明确您查询日志所属的Project名称、所属地域等。如何查询,请参见管理Project

鉴权资源

下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息,用于为RAM用户或RAM角色授予调用此API的权限。

动作(Action)

授权策略中的资源描述方式(Resource)

log:ListMachineGroup acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /machinegroups HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
project String Host ali-test-project

Project名称。

offset Integer Query 1

查询开始行。默认值为0。

size Integer Query 10

分页查询时,设置的每页行数。最大值为500。

groupName String Query test-machine-group

机器组名称。用于过滤机器组,支持部分匹配。

返回数据

名称 类型 示例值 描述
Server String nginx

服务器名称。

Content-Type String application/json

响应内容类型。支持application/json、application/x-protobuf两种类型。

Content-Length String 0

响应内容长度。

Connection String close

是否长链接。取值包括:

  • close:不是长链接,则每个HTTP请求都会重新建立TCP连接。
  • keep-alive:长链接,TCP连接建立后保持连接状态,节省连接所需时间和带宽。
Date String Sun, 27 May 2018 08:25:04 GMT

返回响应的时间。

x-log-requestid String 5B0A6B60BB6EE39764D458B5

服务端产生的标识,该请求的唯一ID。

count Integer 1

当前页返回的机器组数。

total Integer 1

符合查询条件的机器组总数。

machinegroups Array of String test-group

机器组名称。

示例

请求示例

GET /machinegroups?offset=1&size=10&groupName=test-machine-group HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "count" : 1,
  "total" : 1,
  "machinegroups" : [ "test-group" ]
}

错误码

访问错误中心查看更多错误码。

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

500

InternalServerError

internal server error.

内部服务调用错误。

更多信息,请参见错误码对照表

  • 本页导读 (1)
文档反馈