Queries the machine groups of a specified project.
Usage notes
Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
An AccessKey pair is created and obtained. For more information, see AccessKey pair.
The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.
The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see Manage a project.
Authentication resources
The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.
Action | Resource |
|
|
Debugging
Request headers
This operation does not have operation-specific request headers and uses only common request headers. For more information, see Common request parameters.
Request syntax
GET /machinegroups HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
project | String | Host | Yes | ali-test-project | The name of the project. |
offset | Integer | Query | No | 1 | The line from which the query starts. Default value: 0. |
size | Integer | Query | No | 10 | The number of entries to return on each page. Maximum value: 500. |
groupName | String | Query | No | test-machine-group | The name of the machine group. This parameter is used to filter machine groups. Partial match is supported. |
Response parameters
Parameter | Type | Example | Description |
Server | String | nginx | The name of the server. |
Content-Type | String | application/json | The type of the response body. Valid values: application/json and application/x-protobuf. |
Content-Length | String | 0 | The length of the response body. |
Connection | String | close | Indicates whether the connection is persistent. Valid values:
|
Date | String | Sun, 27 May 2018 08:25:04 GMT | The time when the response was returned. |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 | The request ID. |
count | Integer | 1 | The number of machine groups that are returned on the current page. |
total | Integer | 1 | The total number of machine groups that meet the query conditions. |
machinegroups | Array of String | test-group | The machine groups that are returned. |
Examples
Sample requests
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
Sample success responses
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"count" : 1,
"total" : 1,
"machinegroups" : [ "test-group" ]
}
Error codes
For a list of error codes, see Service error codes.
HTTP status code | Error code | Error message | Description |
500 | InternalServerError | internal server error. | An internal server error has occurred. |
For more information, see Common error codes.