All Products
Search

This Product

    :CreateMachineGroup

    Document Center

    :CreateMachineGroup

    Last Updated:Apr 25, 2024

    Creates a machine group.

    Operation description

    Usage notes

    Host consists of a project name and a Simple 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.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    log:CreateMachineGroupWrite
    • Project
      acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}
    • log:TLSVersion
    		none

    Request syntax

    POST /machinegroups

    Request parameters

    ParameterTypeRequiredDescriptionExample
    projectstringYes

    The name of the project.

    		ali-test-project
    bodyobjectYes

    The information about the machine group.

    groupNamestringYes

    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.
    • It can contain only lowercase letters, digits, hyphens (-), and underscores (_).
    • It must start and end with a lowercase letter or a digit.
    • It must be 3 to 128 characters in length.
    		test-machine-group
    machineIdentifyTypestringYes

    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.
    		ip
    groupTypestringNo

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

    		""
    groupAttributeobjectNo

    The attributes of the machine group.

    groupTopicstringNo

    The log topic of the machine group.

    		testtopic
    externalNamestringNo

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

    		testgroup
    machineListarrayYes

    The identifiers of machine group.

    • If you set machineIdentifyType to ip, enter the IP address of the machine.
    • If you set machineIdentifyType to userdefined, enter a custom identifier.
    stringNo

    The machine identifier. Enter an IP address or a custom identifier based on the type of the machine group.

    		192.168.XX.XX

    Response parameters

    ParameterTypeDescriptionExample
    headersobject
    Serverstring

    The name of the server.

    		nginx
    Content-Typestring

    The format in which the response body is returned. Valid values: application/json and application/x-protobuf.

    		application/json
    Content-Lengthstring

    The length of the response body.

    		0
    Connectionstring

    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.
    		close
    Datestring

    The time when the response was returned.

    		Sun, 27 May 2018 08:25:04 GMT
    x-log-requestidstring

    The request ID.

    		5B0A6B60BB6EE39764D458B5

    Examples

    Sample success responses

    JSONformat

    {}

    Error codes

    For a list of error codes, visit the Service error codes.