数据加速器 GooseFS 创建扫描规则

1. 接口描述

接口请求域名： goosefs.tencentcloudapi.com 。

创建数据洞察任务

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreatePolicyRule。
Version	是	String	公共参数，本接口取值：2022-05-19。
Region	否	String	公共参数，此参数为可选参数。
FileSystemId	是	String	文件系统id 示例值：x-c60-0q62fdo7
ScanDir	是	String	扫描目录示例值：/test_policy/
Name	是	String	规则名称示例值：policy_now
Execution	是	ExecutionPlan	执行计划
PolicyRuleSet.N	否	Array of PolicyRuleOperator	过滤规则
EnableManifest	否	Boolean	是否输出清单示例值：true
Manifest	否	ManifestAttr	清单配置

3. 输出参数

参数名称	类型	描述
RuleId	String	规则id 示例值：1786020012996
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建扫描规则

输入示例

POST / HTTP/1.1
Host: goosefs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePolicyRule
<公共请求参数>

{
    "FileSystemId": "x-c60-0q62fdo7",
    "ScanDir": "/test_policy/",
    "Name": "policy_now",
    "Execution": {
        "ExecuteMode": "scheduled",
        "ExecuteAt": "2026-08-06T21:30:00",
        "WaitTime": 12
    },
    "PolicyRuleSet": [
        {
            "Key": "FILE_SIZE",
            "Operator": ">",
            "Value": "0"
        }
    ],
    "EnableManifest": true,
    "Manifest": {
        "Bucket": "goosefsx-test-1252246555",
        "Prefix": "policy",
        "Attributes": [
            "FILE_SIZE"
        ],
        "Region": "ap-shanghai"
    }
}

输出示例

{
    "Response": {
        "RuleId": "1786020012996",
        "RequestId": "4c328927-f95e-40f0-9e14-2462a19e4027"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

创建扫描规则

本页目录：