调用GetCollectionPolicy获取指定的云产品日志采集规则-日志服务-阿里云-日志服务(SLS)-阿里云帮助中心

调用GetCollectionPolicy获取对应的规则。

接口说明

该接口服务地址只能是华东 2（上海）、新加坡、河源专属云汽车合规（cn-heyuan-acdr-1）。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

log:GetCollectionPolicy

get

*CollectionPolicy

acs:log::{#accountId}:collectionpolicy/{#policyName}

log:TLSVersion

无

请求语法

GET /collectionpolicy/{policyName} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
policyName	string	是	规则名称。	your_log_policy

请求参数

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

返回参数

名称	类型	描述	示例值
	object	返回结构体。
collectionPolicy	object	返回规则。
centralizeConfig	object	中心化转投配置。
destLogstore	string	中心化转投目的日志库。	your-sls-logstore-in-beijing
destProject	string	中心化转投目的项目。	your-sls-project-in-beijing
destRegion	string	中心化转投目的地域。	cn-beijing
destTTL	integer	中心化转投目的天数。	0
centralizeEnabled	boolean	是否开启中心化存储。	false
dataCode	string	日志类型编码。	access_log
dataConfig	object	当且仅当日志类型为全局日志类型时支持的配置，例如 productCode 为 sls 时的场景。否则为空。
dataProject	string	当且仅当日志类型为全局日志类型时有效，例如 productCode 为 sls 时的场景，如果为空，表示日志被采集到该账号在特定 dataRegion 下的默认专属的 Project 中。	""
dataRegion	string	当且仅当日志类型为全局日志类型时支持的配置，例如 productCode 为 sls 时的场景，表示首次配置时全局日志将被采集到对应地域。	cn-beijing
enabled	boolean	是否开启。	true
internalPolicy	boolean	是否是内置规则策略，内置规则不允许修改、删除。	false
policyConfig	object	采集规则配置。
instanceIds	array	实例 ID 集合。
	string	实例 ID。	your-test-bucket1
regions	array	实例所属的地域集合，支持通配符。
	string	地域 ID。	cn-hangzhou
resourceMode	string	资源采集模式。	all
resourceTags	object	资源标签。	{"tag1":"value1","tag2":"value2"}
policyName	string	规则名称。	your_log_policy
policyUid	string	规则所属的账号阿里云账号 Uid，如果该规则由资源目录管理员或者资源目录委派管理员创建，则为其阿里云账号 Uid。	148***********50
productCode	string	产品编码。	oss
resourceDirectory	object	资源目录配置, 如有配置，否则为空
accountGroupType	string	在该资源目录下，全选模式 all 或自定义模式 custom	all,custom
members	array	当资源目录配置为 custom 模式时，对应的成员账号列表
	string	阿里云账号 Uid	165***********50

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。