GetCollectionPolicy - 获取云产品日志采集的采集规则 - 日志服务

调用GetCollectionPolicy获取对应的规则。

接口说明

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

调试

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

调试

授权信息

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

请求语法

GET /collectionpolicy/{policyName} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
policyName	string	是	规则名称。	your_log_policy
productCode	string	否	产品编码。	oss
dataCode	string	否	日志类型编码。	access_log

返回参数

名称	类型	描述	示例值
headers	object
Content-Length	string	响应内容长度。
Content-Type	string	返回的响应体的内容格式。
x-log-requestid	string	服务端产生的标识，该请求的唯一 ID。
Server	string	服务器名称。
Date	string	返回响应的时间。
Connection	string	是否长链接。取值包括： close：不是长链接，则每个 HTTP 请求都会重新建立 TCP 连接。 keep-alive：长链接，TCP 连接建立后保持连接状态，节省连接所需时间和带宽。
	object	返回结构体。
collectionPolicy	object	返回规则。
policyName	string	规则名称。	your_log_policy
enabled	boolean	是否开启。	true
productCode	string	产品编码。	oss
dataCode	string	日志类型编码。	access_log
policyConfig	object	采集规则配置。
resourceMode	string	资源采集模式。	all
regions	array	实例所属的地域集合，支持通配符。
	string	地域 ID。	cn-hangzhou
instanceIds	array	实例 ID 集合。
	string	实例 ID。	your-test-bucket1
resourceTags	object	资源标签。	{"tag1":"value1","tag2":"value2"}
centralizeEnabled	boolean	是否开启中心化存储。	false
centralizeConfig	object	中心化转投配置。
destRegion	string	中心化转投目的地域。	cn-beijing
destProject	string	中心化转投目的项目。	your-sls-project-in-beijing
destLogstore	string	中心化转投目的日志库。	your-sls-logstore-in-beijing
destTTL	integer	中心化转投目的天数。	0
resourceDirectory	object	资源目录配置, 如有配置，否则为空
accountGroupType	string	在该资源目录下，全选模式 all 或自定义模式 custom	all,custom
members	array	当资源目录配置为 custom 模式时，对应的成员账号列表
	string	阿里云账号 Uid	165***********50
dataConfig	object	当且仅当日志类型为全局日志类型时支持的配置，例如 productCode 为 sls 时的场景。否则为空。
dataRegion	string	当且仅当日志类型为全局日志类型时支持的配置，例如 productCode 为 sls 时的场景，表示首次配置时全局日志将被采集到对应地域。	cn-beijing
dataProject	string	当且仅当日志类型为全局日志类型时有效，例如 productCode 为 sls 时的场景，如果为空，表示日志被采集到该账号在特定 dataRegion 下的默认专属的 Project 中。	""
internalPolicy	boolean	是否是内置规则策略，内置规则不允许修改、删除。	false
policyUid	string	规则所属的账号阿里云账号 Uid，如果该规则由资源目录管理员或者资源目录委派管理员创建，则为其阿里云账号 Uid。	148***********50

示例

正常返回示例

JSON格式

{
  "collectionPolicy": {
    "policyName": "your_log_policy",
    "enabled": true,
    "productCode": "oss",
    "dataCode": "access_log",
    "policyConfig": {
      "resourceMode": "all",
      "regions": [
        "cn-hangzhou"
      ],
      "instanceIds": [
        "your-test-bucket1\n"
      ],
      "resourceTags": {
        "tag1": "value1",
        "tag2": "value2"
      }
    },
    "centralizeEnabled": false,
    "centralizeConfig": {
      "destRegion": "cn-beijing\n",
      "destProject": "your-sls-project-in-beijing\n",
      "destLogstore": "your-sls-logstore-in-beijing\n",
      "destTTL": 0
    },
    "resourceDirectory": {
      "accountGroupType": "all,custom",
      "members": [
        "165***********50"
      ]
    },
    "dataConfig": {
      "dataRegion": "cn-beijing",
      "dataProject": "\"\""
    },
    "internalPolicy": false,
    "policyUid": "148***********50\n"
  }
}

错误码

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

变更历史

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