创建云产品日志采集的采集规则,从而实现云产品日志的自动化采集。
接口说明
该接口服务地址只能是华东 2(上海)或新加坡。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求语法
POST /collectionpolicy HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 请求结构体。 | |
policyName | string | 是 | 规则名称,最短 3 个字符,最长 63 个字符,必须以字母开头。 | your_log_policy |
productCode | string | 是 | 产品编码。 | oss |
dataCode | string | 是 | 日志类型编码。 | access_log |
enabled | boolean | 是 | 是否开启。 | true |
policyConfig | object | 是 | 采集规则配置。 | |
resourceMode | string | 是 | 资源采集模式。如果配置 all 表示会采集账号下的全部实例到默认日志库,如果配置 attributeMode 表示会按照实例地域属性和资源标签进行过滤,如果配置 instanceMode 表示会按照实例 ID 进行过滤。 | all |
resourceTags | object | 否 | 资源标签,当且仅当 resourceMode 为 attributeMode 时有效。 如果资源标签过滤项为空,表示无需按照资源标签过滤,实例全部满足资源标签这一过滤条件,否则只采集资源标签属性全部满足该资源标签配置的实例。 资源标签和实例所属的地域集合,共同作用,只有全部满足时才会采集该实例对象。 | {"tag1":"value1",“tag2":"value2"} |
regions | array | 否 | 实例所属的地域集合,当且仅当 resourceMode 为 attributeMode 时有效,支持通配符。如果地域集合过滤项为空数组,表示无需按照地域过滤,实例全部满足地域集合这一过滤条件,否则只采集地域属性在该地域集合中的实例。实例所属的地域集合和资源标签,共同作用,只有全部满足时才会采集该实例对象。 | |
string | 否 | 地域 ID。 | cn-hangzhou | |
instanceIds | array | 否 | 实例 ID 集合,当且仅当 resourceMode 为 instanceMode 时有效。只采集实例 ID 在该实例 ID 集合中的实例。 | |
string | 否 | 实例 ID。 | your-test-bucket1 | |
centralizeEnabled | boolean | 否 | 是否开启中心化转投,默认 false。 | false |
centralizeConfig | object | 否 | 中心化转投配置。 | |
destRegion | string | 否 | 中心化转投目的地域。 | cn-beijing |
destProject | string | 否 | 中心化转投目的项目,其地域属性应和 destRegion 保持一致。 | your-sls-project-in-beijing |
destLogstore | string | 否 | 中心化转投目的日志库,其地域属性应和 destRegion 保持一致,并且归属 destProject 下。 | your-sls-logstore-in-beijing |
destTTL | integer | 否 | 中心化转投目的天数,当且仅当中心化转投目的日志库不存在首次创建时有效。 | your-sls-logstore-ttl |
dataConfig | object | 否 | 当且仅当日志类型为全局日志类型时支持配置,例如 productCode 为 sls 时的场景,表示首次配置时全局日志将被采集到对应地域等。 | |
dataRegion | string | 否 | 当且仅当日志类型为全局日志类型时支持配置,例如 productCode 为 sls 时的场景,表示首次配置时全局日志将被采集到对应地域。 | cn-beijing |
resourceDirectory | object | 否 | 资源目录配置,账号必须已经开通资源目录,且为管理员或者委派管理员身份 | |
accountGroupType | string | 否 | 支持该资源目录下,全选模式 all 和自定义模式 custom | all,custom |
members | array | 否 | 当资源目录配置为 custom 模式时,对应的成员账号列表 | |
string | 否 | 成员账号阿里云 Uid | 165***********50 |
返回参数
错误码的详细说明请参见管理新版日志审计规则。
示例
正常返回示例
JSON
格式
{}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-19 | API 内部配置变更,不影响调用 | 查看变更详情 |