1. 接口描述
接口请求域名: goosefs.tencentcloudapi.com 。
列出所有的扫描规则
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribePolicyRule。 |
| Version | 是 | String | 公共参数,本接口取值:2022-05-19。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| FileSystemId | 是 | String | 文件系统ID 示例值:x-c60-0q62fdo7 |
| Offset | 是 | Integer | 偏移量 示例值:0 |
| Limit | 是 | Integer | 最大返回数量 示例值:10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PolicyRuleTaskList | Array of PolicyRuleTaskAttribute | 规则任务详情 |
| TotalCount | Integer | 任务总数 示例值:11 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列出扫描规则
输入示例
POST / HTTP/1.1
Host: goosefs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePolicyRule
<公共请求参数>
{
"FileSystemId": "x-c60-0q62fdo7",
"Offset": 0,
"Limit": 10
}
输出示例
{
"Response": {
"PolicyRuleTaskList": [
{
"CreateTime": "2026-08-06T20:40:12+08:00",
"EnableManifest": true,
"Execution": {
"ExecuteAt": "2026-08-06T21:30:00",
"ExecuteMode": "scheduled",
"ExecutePeriod": null,
"WaitTime": 12
},
"Manifest": {
"Attributes": [
"FILE_SIZE"
],
"Bucket": "goosefsx-test-1252246555",
"Prefix": "policy",
"Region": "ap-shanghai"
},
"ModifyTime": "2026-08-06T20:40:12+08:00",
"Name": "policy_now",
"PolicyRuleSet": [
{
"Key": "FILE_SIZE",
"Operator": ">",
"Value": "0"
}
],
"RuleId": "1786020012996",
"ScanDir": "/test_policy/",
"Status": 0
}
],
"TotalCount": 11,
"RequestId": "0fbfbc3a-9d33-47e1-85af-b846e93a157f"
}
}
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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。