1. 接口描述
接口请求域名： cdb.tencentcloudapi.com 。
本接口(DescribeAuditRules)用于查询用户在当前地域的审计规则。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAuditRules。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| RuleId | 否 | String | 审计规则 ID。 示例值：rule_123 |
| RuleName | 否 | String | 审计规则名称。支持按审计规则名称进行模糊匹配查询。 示例值：rule_name |
| Limit | 否 | Integer | 分页大小参数。默认值为 20，最小值为 1，最大值为 100。 示例值：1 |
| Offset | 否 | Integer | 分页偏移量。默认值为0。 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的审计规则个数。 示例值：1 |
| Items | Array of AuditRule | 审计规则详情。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询审计规则
输入示例
https://cdb.tencentcloudapi.com/?Action=DescribeAuditRules
&RuleId="cdbrule-qwerasdf"
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 1,
"Items": [
{
"RuleId": "cdbrule-qwerasdf",
"CreateTime": "2019-03-20 17:09:13",
"ModifyTime": "2019-03-20 17:09:13",
"RuleName": "audit1",
"Description": "audit_test",
"AuditAll": true
}
]
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.DatabaseAccessError | 数据库内部错误。 |
| InternalError.InnerCommonError | 内部服务错误。 |
| InternalError.ServerError | 系统内部错误。 |
| InvalidParameter.ControllerNotFoundError | 未找到该接口。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
| OperationDenied.AuditRuleNotExistError | 审计规则不存在。 |
