Creates a machine group.
Usage notes
- Host consists of a project name and a 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 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 Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access 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 IP addresses or custom identifiers of the servers from which logs need to be collected are obtained. For more information, see Create an IP address-based machine group and Create a custom identifier-based machine group.
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 |
log:CreateMachineGroup | acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName} |
Debugging
Request headers
This operation uses only common request headers. For more information, see Common request headers.
Request syntax
POST /machinegroups HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
project | String | Host | Yes | ali-test-project | The name of the project. |
Object | Body | Yes | The request body parameters. | ||
groupName | String | Body | Yes | test-machine-group | The name of the machine group. The name must meet the following requirements:
|
machineIdentifyType | String | Body | Yes | ip | The type of the machine group identifier. Valid values:
|
groupType | String | Body | No | "" | The type of the machine group. The parameter can be left empty. |
groupAttribute | Object | Body | No | The attribute of the machine group. | |
groupTopic | String | Body | No | testtopic | The topic of the machine group. |
externalName | String | Body | No | testgroup | The identifier of the external management system on which the machine group depends. |
machineList | Array of String | Body | Yes | 192.168.XX.XX | The identifiers of the servers. Enter the IP addresses or custom identifiers based on the type of the machine group. |
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. |
Examples
Sample requests
POST /machinegroups HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
{
"groupName" : "test-machine-group",
"machineIdentifyType" : "ip",
"groupType" : "",
"groupAttribute" : {
"groupTopic" : "testtopic",
"externalName" : "testgroup"
},
"machineList" : [ "192.168.XX.XX" ]
}
Sample success responses
JSON
format
HTTP/1.1 200 OK
Error codes
For a list of error codes, see Service error codes.
HttpStatusCode | ErrorCode | ErrorMessage | Description |
400 | MachineGroupAlreadyExist | groupName already exists. | The machine group already exists. |
400 | InvalidParameter | invalid group resource json. | A specified parameter is invalid. |
404 | ProjectNotExist | Project does not exist. | The specified project does not exist. |
500 | InternalServerError | Specified Server Error Message. | An internal server error has occurred. |
For more information, see Common error codes.