1. 接口描述
接口请求域名: cloudaudit.tencentcloudapi.com 。
创建操作审计跟踪集
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateEventsAuditTrack。 |
Version | 是 | String | 公共参数,本接口取值:2019-03-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Name | 是 | String | 跟踪集名称,仅支持大小写字母、数字、-以及_的组合,3-48个字符 示例值:audit_test |
Status | 是 | Integer | 跟踪集状态(未开启:0;开启:1) 示例值:1 |
Storage | 是 | Storage | 数据投递存储(目前支持 cos、cls) 示例值:cos |
Filters | 是 | Filter | 数据过滤条件 示例值:{"ResourceFields":[{"ResourceType":"cam","ActionType":"*","EventNames":["AddSubAccount","AddSubAccountCheckingMFA"]},{"ResourceType":"cvm","ActionType":"*","EventNames":["*"]},{"ResourceType":"tke","ActionType":"*","EventNames":["*"]}]} |
TrackForAllMembers | 否 | Integer | 是否开启将集团成员操作日志投递到集团管理账号或者可信服务管理账号(0:未开启,1:开启,只能集团管理账号或者可信服务管理账号开启此项功能) 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TrackId | Integer | 跟踪集 ID 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建操作审计跟踪集
输入示例
POST / HTTP/1.1
Host: cloudaudit.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEventsAuditTrack
<公共请求参数>
{
"Name": "test_track",
"Status": 1,
"Storage": {
"StorageType": "cos",
"StorageRegion": "ap-guangzhou",
"StorageName": "audit_test",
"StoragePrefix": "audit_config",
"StorageAccountId": "2345345",
"StorageAppId": "23456546"
},
"Filters": {
"ResourceFields": [
{
"ResourceType": "cam",
"ActionType": "Read",
"EventNames": [
"ConsoleLogin"
]
}
]
},
"TrackForAllMembers": 1
}
输出示例
{
"Response": {
"TrackId": 1,
"RequestId": "7f9b29d-be2c-4061-afb2-b43fdd72"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.CheckClsTopicIsExistFailed | 检查cls日志主题是否存在失败。 |
FailedOperation.CheckCosBucketIsExistFailed | 检查cos桶是否存在失败。 |
FailedOperation.GetClsTopicFailed | 拉取cls日志主题失败。 |
FailedOperation.GetCosBucketListFailed | 拉取cos存储桶列表失败。 |
InternalError | 内部错误。 |
InternalError.SearchError | 内部错误,请联系开发人员 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.AliasAlreadyExists | 别名已经存在 |
InvalidParameterValue.CosRegionError | 操作审计目前不支持输入的cos地域 |
LimitExceeded.OverAmount | 超过跟踪集的最大值 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.CosNotExist | cos桶不存在。 |