创建云产品日志采集的采集规则,从而实现云产品日志的自动化采集。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
log:UpsertCollectionPolicy | Write |
|
| 无 |
请求语法
POST /collectionpolicy
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 时有效。 如果资源标签过滤项为空,表示无需按照资源标签过滤,实例全部满足资源标签这一过滤条件,否则只采集资源标签属性全部满足该资源标签配置的实例。 资源标签和实例所属的地域集合,共同作用,只有全部满足时才会采集该实例对象。 | |
regions | array | 否 | 实例所属的地域集合,当且仅当 resourceMode 为 attributeMode 时有效,支持通配符。如果地域集合过滤项为空数组,表示无需按照地域过滤,实例全部满足地域集合这一过滤条件,否则只采集地域属性在该地域集合中的实例。实例所属的地域集合和资源标签,共同作用,只有全部满足时才会采集该实例对象。 | |
string | 否 | 地域 ID。 | cn-hangzhou | |
instanceIds | array | 否 | 实例 ID 集合,当且仅当 resourceMode 为 instanceMode 时有效。只采集实例 ID 在该实例 ID 集合中的实例。 | |
string | 否 | 实例 ID。 | your-test-bucket1 | |
centralizeEnabled | boolean | 否 | 是否开启中心化转投,默认 false。 | false |
attribute | object | 否 | 规则属性。 | |
app | string | 否 | 规则所属的应用。 | your-app-name |
policyGroup | string | 否 | 规则所属的组名。 | your-policy-group |
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 |
返回参数
示例
正常返回示例
JSON
格式
{
"message": "successful"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2023-10-19 | API 内部配置变更,不影响调用 | 看变更集 | ||
|