All Products
Search
Document Center

Simple Log Service:ListMachineGroup

Last Updated:Nov 13, 2024

Queries the machine groups of a project.

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ListMachineGroupget
  • Project
    acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*
  • log:TLSVersion
none

Request syntax

GET /machinegroups HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
projectstringYes

The name of the project.

aliyun-test-project
offsetintegerNo

The line from which the query starts. Default value: 0.

1
sizeintegerNo

The number of entries per page. Maximum value: 500.

10
groupNamestringNo

The name of the machine group. This parameter is used to filter machine groups. Partial match is supported.

test-machine-group

Response parameters

ParameterTypeDescriptionExample
headersobject
Serverstring

The name of the server.

nginx
Content-Typestring

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

application/json
Content-Lengthstring

The content 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
object

Schema of Response

countinteger

The number of machine groups that are returned on the current page.

2
totalinteger

The total number of machine groups that meet the query conditions.

2
machinegroupsarray

The machine groups that meet the query conditions.

string

The name of the machine group.

test-group

Examples

Sample success responses

JSONformat

{
  "count": 2,
  "total": 2,
  "machinegroups": [
    "test-group"
  ]
}

Error codes

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