调用CreateMachineGroup接口创建一个机器组。
接口说明
- Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。
-
已创建并获取AccessKey。更多信息,请参见访问密钥。
阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权。
- 已明确您查询日志所属的Project名称、所属地域等。如何查询,请参见管理Project。
- 已获取采集日志的机器IP地址或者自定义标识机器组。更多信息,请参见创建IP地址机器组和创建用户自定义标识机器组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /machinegroups HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
project | String | Host | 是 | ali-test-project | Project名称。 |
Object | Body | 是 | 请求体参数。 |
||
groupName | String | Body | 是 | test-machine-group | 机器组名称。其命名规则如下:
|
machineIdentifyType | String | Body | 是 | ip | 机器标识类型。
|
groupType | String | Body | 否 | "" | 机器组类型,可选值为空。 |
groupAttribute | Object | Body | 否 | 机器组的属性。 |
|
groupTopic | String | Body | 否 | testtopic | 机器组的日志主题。 |
externalName | String | Body | 否 | testgroup | 机器组所依赖的外部管理系统标识。 |
machineList | Array of String | Body | 是 | 192.168.XX.XX | 机器标识,根据机器组类型填写IP地址或者用户自定义标识。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Server | String | nginx | 服务器名称。 |
Content-Type | String | application/json | 响应内容类型。支持application/json、application/x-protobuf两种类型。 |
Content-Length | String | 0 | 响应内容长度。 |
Connection | String | close | 是否长链接。取值包括:
|
Date | String | Sun, 27 May 2018 08:25:04 GMT | 当前返回响应的时间。 |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 | 服务端产生的标识,该请求的唯一ID。 |
示例
请求示例
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" ]
}
正常返回示例
JSON
格式
HTTP/1.1 200 OK
错误码
访问错误中心查看更多错误码。
HttpStatusCode |
ErrorCode |
ErrorMessage |
错误码描述 |
---|---|---|---|
400 |
MachineGroupAlreadyExist |
groupName already exists. |
机器组已存在。 |
400 |
InvalidParameter |
invalid group resource json. |
无效机器组参数。 |
404 |
ProjectNotExist |
Project does not exist. |
Project不存在。 |
500 |
InternalServerError |
Specified Server Error Message. |
内部服务调用错误。 |
更多信息,请参见通用错误码。