Creates a machine group.


Host consists of a project name and a Log Service endpoint. You must specify a project in Host.

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 Location Required Example Description
Object Body No

The body of the request.

projectName String Body Yes ali-test-project

The name of the project.

groupName String Body Yes test-machine-group

The name of the machine group. The name must meet the following requirements:

  • The name of each machine group in a project must be unique.
  • The name can contain only lowercase letters, digits, hyphens (-), and underscores (_).
  • The name must start and end with a lowercase letter or a digit.
  • The name must be 3 to 128 characters in length.
machineIdentifyType String Body Yes ip

The type of the machine group identifier. Valid values:

  • ip: The machine group uses IP addresses as identifiers.
  • userdefined: The machine group uses custom identifiers.
groupAttribute Object Body Yes

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.

groupType String Body No ""

The type of the machine group. The parameter can be left empty.

Response parameters

Parameter Type Example Description
Server String nginx

The name of the server.

Content-Length String 0

The length of the response body.

Connection String close

Indicates whether the connection is persistent. Valid values:

  • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.
  • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.
Date String Sun, 27 May 2018 08:25:04 GMT

The time at which the response is returned.

x-log-requestid String 5B0A6B60BB6EE39764D458B5

The unique ID of the request. The ID is generated by Log Service.


Sample requests

POST /machinegroups HTTP/1.1

  "projectName" : "ali-test-project",
  "groupName" : "test-machine-group",
  "machineIdentifyType" : "ip",
  "groupAttribute" : {
    "groupTopic" : "testtopic",
    "externalName" : "testgroup"
  "machineList" : [ ],
  "groupType" : ""

Sample success responses

JSON format

HTTP/1.1 200 OK

Error codes

For a list of error codes, visit the API Error Center.

HTTP status code

Error code

Error message




groupName already exists.

The error message returned because the machine group already exists.



invalid group resource json.

The error message returned because a specified parameter is invalid.



Project does not exist.

The error message returned because the specified project does not exist.



Specified Server Error Message.

The error message returned because an internal server error has occurred.

For more information, see Common error codes.