文档

UpsertCollectionPolicy - 创建云产品日志采集的采集规则

更新时间:

创建云产品日志采集的采集规则,从而实现云产品日志的自动化采集。

接口说明

该接口服务地址只能是华东 2(上海)或新加坡。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /collectionpolicy

请求参数

名称类型必填描述示例值
bodyobject

请求结构体。

policyNamestring

规则名称,最短 3 个字符,最长 63 个字符,必须以字母开头。

your_log_policy
productCodestring

产品编码。

oss
dataCodestring

日志类型编码。

access_log
enabledboolean

是否开启。

true
policyConfigobject

采集规则配置。

resourceModestring

资源采集模式。如果配置 all 表示会采集账号下的全部实例到默认日志库,如果配置 attributeMode 表示会按照实例地域属性和资源标签进行过滤,如果配置 instanceMode 表示会按照实例 ID 进行过滤。

all
resourceTagsobject

资源标签,当且仅当 resourceMode 为 attributeMode 时有效。 如果资源标签过滤项为空,表示无需按照资源标签过滤,实例全部满足资源标签这一过滤条件,否则只采集资源标签属性全部满足该资源标签配置的实例。 资源标签和实例所属的地域集合,共同作用,只有全部满足时才会采集该实例对象。

{"tag1":"value1",“tag2":"value2"}
regionsarray

实例所属的地域集合,当且仅当 resourceMode 为 attributeMode 时有效,支持通配符。如果地域集合过滤项为空数组,表示无需按照地域过滤,实例全部满足地域集合这一过滤条件,否则只采集地域属性在该地域集合中的实例。实例所属的地域集合和资源标签,共同作用,只有全部满足时才会采集该实例对象。

string

地域 ID。

cn-hangzhou
instanceIdsarray

实例 ID 集合,当且仅当 resourceMode 为 instanceMode 时有效。只采集实例 ID 在该实例 ID 集合中的实例。

string

实例 ID。

your-test-bucket1
centralizeEnabledboolean

是否开启中心化转投,默认 false。

false
centralizeConfigobject

中心化转投配置。

destRegionstring

中心化转投目的地域。

cn-beijing
destProjectstring

中心化转投目的项目,其地域属性应和 destRegion 保持一致。

your-sls-project-in-beijing
destLogstorestring

中心化转投目的日志库,其地域属性应和 destRegion 保持一致,并且归属 destProject 下。

your-sls-logstore-in-beijing
destTTLinteger

中心化转投目的天数,当且仅当中心化转投目的日志库不存在首次创建时有效。

your-sls-logstore-ttl
dataConfigobject

当且仅当日志类型为全局日志类型时支持配置,例如 productCode 为 sls 时的场景,表示首次配置时全局日志将被采集到对应地域等。

dataRegionstring

当且仅当日志类型为全局日志类型时支持配置,例如 productCode 为 sls 时的场景,表示首次配置时全局日志将被采集到对应地域。

cn-beijing
resourceDirectoryobject

资源目录配置,账号必须已经开通资源目录,且为管理员或者委派管理员身份

accountGroupTypestring

支持该资源目录下,全选模式 all 和自定义模式 custom

all,custom
membersarray

当资源目录配置为 custom 模式时,对应的成员账号列表

string

成员账号阿里云 Uid

165***********50

返回参数

名称类型描述示例值
headersobject
Content-Typestring

返回的响应体的内容格式。

Content-Lengthstring

响应内容长度。

Datestring

返回响应的时间。

Connectionstring

是否长链接。取值包括: close:不是长链接,则每个 HTTP 请求都会重新建立 TCP 连接。 keep-alive:长链接,TCP 连接建立后保持连接状态,节省连接所需时间和带宽。

x-log-requestidstring

服务端产生的标识,该请求的唯一 ID。

Serverstring

服务器名称。

示例

正常返回示例

JSON格式

{}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-19API 内部配置变更,不影响调用查看变更详情