请求参数
Body 参数:
属性名称 | 类型 | 是否必须 | 描述 |
groupName | string | 是 | 机器分组名称,project 下唯一 |
groupType | string | 否 | 机器分组类型,默认为空 |
machineIdentifyType | string | 是 | 机器标识类型,分为 ip 和 userdefined 两种 |
groupAttribute | object | 是 | 机器分组的属性,默认为空 |
machineList | array | 是 | 具体的机器标识,可以是 ip 或 userdefined-id |
属性名称 | 类型 | 是否必须 | 描述 |
groupTopic | string | 否 | 机器分组的 topic,默认为空 |
externalName | string | 否 | 机器分组所依赖的外部管理标识,默认为空 |
HTTP 状态码 | ErrorCode | ErrorMessage |
400 | GroupAlreadyExist | group {GroupName} already exist |
400 | InvalidParameter | invalid group resource json |
500 | InternalServerError | Internal server error |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
根据您提供的信息,这是关于阿里云日志服务(Log Service)中创建或更新机器分组(Machine Group)的API请求参数和响应说明的描述。下面我将为您详细解释各个部分的含义,并提供一个请求示例。
groupName
(字符串,是):机器分组的名称,在所属项目(project)下必须唯一。groupType
(字符串,否):机器分组类型,默认为空。这个字段可以根据实际需求填写特定的分组类型。machineIdentifyType
(字符串,是):机器标识类型,支持 ip
和 userdefined
两种。用于指定机器如何被识别。groupAttribute
(对象,是):机器分组的属性,默认为空。包含以下可选属性:
groupTopic
(字符串,否):机器分组的 topic,默认为空。externalName
(字符串,否):机器分组所依赖的外部管理标识,默认为空。machineList
(数组,是):具体的机器标识列表,元素可以是 IP 地址或用户自定义标识(依据 machineIdentifyType
)。没有特别指定的请求头,但需要遵循阿里云 Log Service API 的公共请求头规范,这通常包括认证信息(如 AccessKeyId、Signature 等),具体请参考公共请求头文档。
同样,没有特有响应头,响应遵循阿里云 Log Service API 的公共响应头格式,例如包含请求ID等信息,详情见公共响应头文档。
HTTP状态码为200表示操作成功,具体的成功或错误信息会通过响应体或者错误码来传达。
除了通用错误码外,还可能遇到特定于该操作的错误码,例如: - 400 GroupAlreadyExist:表示尝试创建的分组名已存在。 - 400 InvalidParameter:请求中的JSON格式不正确或包含无效参数。 - 500 InternalServerError:服务器内部错误。
请求示例(假设使用的是HTTP POST方法,且已设置好公共请求头如Authorization等):
POST https://log-cn-hangzhou.aliyuncs.com/api/v1/machinegroups
{
"groupName": "test_group",
"machineIdentifyType": "ip",
"groupAttribute": {},
"machineList": ["192.168.1.1", "192.168.1.2"]
}
在这个示例中,我们向阿里云日志服务发送一个创建机器分组的请求,分组名为test_group
,采用IP地址作为机器标识类型,并指定了两个IP地址作为该分组的成员。请注意,实际请求时还需添加正确的认证信息到请求头中。