文档

ListCollectionPolicies - 列出云产品日志采集的采集规则

更新时间:

列出云产品日志采集的采集规则。

接口说明

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

调试

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

授权信息

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

请求语法

GET /collectionpolicy HTTP/1.1

请求参数

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

产品编码。

oss
dataCodestring

日志类型编码。

access_log
policyNamestring

规则名称。

your_log_policy
sizeinteger

分页查询时,设置的每页行数。默认值为 50,最多返回 100 个 规则信息。

50
offsetinteger

查询开始行,默认值为 0。

0
instanceIdstring

实例 ID。如果配置实例 ID,则可以根据实例 ID 反向查询实例命中的规则,必须和 productCode、dataCode 结合使用。

your-test-bucket1
centralProjectstring

中心化转投目的 Project。如果配置中心化转投目的 Project,则可以根据 Project 反向查询有多少规则配置了中心化转投到该 centralProejct 下。

your-central-project1

返回参数

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

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

Serverstring

服务器名称。

Content-Lengthstring

响应内容长度。

Datestring

返回响应的时间。

Connectionstring

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

x-log-requestidstring

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

object

返回结构体。

totalCountinteger

总数据条数。

1
currentCountinteger

当前页数据条数。

1
dataarray<object>

当前查询条件下按照分页配置返回的规则数据。

object

规则详情。

productCodestring

产品编码。

oss
dataCodestring

日志类型编码。

access_log
policyNamestring

规则名称。

your_log_policy
enabledboolean

是否开启。

true
policyConfigobject

采集规则配置。

resourceModestring

资源采集模式。

all
regionsarray

实例所属的地域集合。

string

地域 ID。

cn-hangzhou
instanceIdsarray

实例 ID 集合。

string

实例 ID。

your-test-bucket1
resourceTagsobject

资源标签。

{"tag1":"value1","tag2":"value2"}
centralizeEnabledboolean

是否开启中心化转投。

false
centralizeConfigobject

中心化转投配置。

destRegionstring

中心化转投目的地域。

cn-beijing
destProjectstring

中心化转投目的项目。

your-sls-project-in-beijing
destLogstorestring

中心化转投目的日志库。

your-sls-logstore-in-beijing
destTTLinteger

中心化转投目的存储天数。

0
resourceDirectoryobject

资源目录配置, 如有配置,否则为空

accountGroupTypestring

在该资源目录下,全选模式 all 或自定义模式 custom

all,custom
membersarray

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

string

阿里云账号 Uid

165***********50
dataConfigobject

当且仅当日志类型为全局日志类型时支持配置,例如 productCode 为 sls 时的场景。否则为空。

dataRegionstring

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

cn-hangzhou
dataProjectstring

当且仅当日志类型为全局日志类型时有效,例如 productCode 为 sls 时的场景,如果为空,表示日志被采集到该账号在特定 dataRegion 下的默认专属的 Project 中。

""
internalPolicyboolean

是否是内置规则策略,内置规则不允许修改、删除。

false
policyUidstring

规则所属的账号阿里云账号 Uid,如果该规则由资源目录管理员或者资源目录委派管理员创建,则为其阿里云账号 Uid。

148***********50
statisticsarray<object>

当前查询条件下返回的统计数据。

object

按照 productCode 的规则统计结果

productCodestring

产品编码。

oss
policySourceListarray<object>

规则来源列表。

object

规则来源对象。

policyUidstring

规则所属的账号阿里云账号 Uid,如果该规则由资源目录管理员或者资源目录委派管理员创建,则为其阿里云账号 Uid。

148***********50
policyNamestring

规则名称

policy_name1_from148

示例

正常返回示例

JSON格式

{
  "totalCount": 1,
  "currentCount": 1,
  "data": [
    {
      "productCode": "oss",
      "dataCode": "access_log",
      "policyName": "your_log_policy",
      "enabled": true,
      "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-hangzhou",
        "dataProject": "\"\""
      },
      "internalPolicy": false,
      "policyUid": "148***********50"
    }
  ],
  "statistics": [
    {
      "productCode": "oss",
      "policySourceList": [
        {
          "policyUid": "148***********50",
          "policyName": "policy_name1_from148"
        }
      ]
    }
  ]
}

错误码

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

变更历史

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