Queries a list of machine groups to which a Logtail configuration is applied.
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 pairs.
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.
The name of the required Logtail configuration is obtained. For more information, see ListConfig.
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 uses only common request headers and does not have operation-specific request headers. For more information, see Common request parameters.
Request syntax
GET /configs/{configName}/machinegroups HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
project | String | Host | Yes | ali-test-project | The name of the project. |
configName | String | Path | Yes | logtail-config-sample | The name of the Logtail configuration. |
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 | 2 | The number of returned machine groups. |
machinegroups | Array of String | sample-group1 | The name of the machine group. |
Examples
Sample requests
GET /configs/logtail-config-sample/machinegroups HTTP/1.1
Host:ali-project-test.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
Sample success responses
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"count" : 2,
"machinegroups" : [ "sample-group1" ]
}
Error codes
For a list of error codes, see Service error codes.
HttpStatusCode | ErrorCode | ErrorMessage | Description |
404 | ProjectNotExist | Project does not exist. | The specified project does not exist. |
404 | ConfigNotExist | Config confiName does not exist. | The specified Logtail configuration does not exist. |
500 | InternalServerError | Specified Server Error Message. | An internal server error has occurred. |
For more information, see Common error codes.