Creates a machine group.

Description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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

ParameterTypePositionRequiredExampleDescription
projectStringHostYesali-test-project

The name of the project.

ObjectBodyYes

The body of the request.

groupNameStringBodyYestest-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.
machineIdentifyTypeStringBodyYesip

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.
groupTypeStringBodyNo""

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

groupAttributeObjectBodyNo

The attribute of the machine group.

groupTopicStringBodyNotesttopic

The topic of the machine group.

externalNameStringBodyNotestgroup

The identifier of the external management system on which the machine group depends.

machineListArray of StringBodyYes192.168.XX.XX

The machine identifiers. Enter the IP addresses or custom identifiers based on the type of the machine group.

Response parameters

ParameterTypeExampleDescription
ServerStringnginx

The name of the server.

Content-TypeStringapplication/json

The type of the response body. Valid values: application/json and application/x-protobuf.

Content-LengthString0

The length of the response body.

ConnectionStringclose

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.
DateStringSun, 27 May 2018 08:25:04 GMT

The time at which the response was returned.

x-log-requestidString5B0A6B60BB6EE39764D458B5

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

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, visit the API Error Center.

HTTP status code

Error code

Error message

Description

400

MachineGroupAlreadyExist

groupName already exists.

The error message returned because the machine group already exists.

400

InvalidParameter

invalid group resource json.

The error message returned because a specified parameter is invalid.

404

ProjectNotExist

Project does not exist.

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

500

InternalServerError

Specified Server Error Message.

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

For more information, see Common error codes.