- Product Introduction
- Overview
- Strengths
- Features
- Use Cases
- CloudAudit-Enabled Services and APIs
- Overview
- Computing
- Container
- Network
- Storage
- Database
- CDN and Acceleration
- Serverless
- Middleware
- Video Services
- Video Services
- Big Data Platform
- Security Management
- Data Security
- Application Security
- Management and Audit
- Cloud Resource Management
- Management and Support
- Cloud Communications
- Gaming Services
- Education Services
- Purchase Guide
- Getting Started
- API Documentation
- Operation Guide
- PHP SDK Documentation
- FAQs
- Contact Us
- Glossary
- Product Introduction
- Overview
- Strengths
- Features
- Use Cases
- CloudAudit-Enabled Services and APIs
- Overview
- Computing
- Container
- Network
- Storage
- Database
- CDN and Acceleration
- Serverless
- Middleware
- Video Services
- Video Services
- Big Data Platform
- Security Management
- Data Security
- Application Security
- Management and Audit
- Cloud Resource Management
- Management and Support
- Cloud Communications
- Gaming Services
- Education Services
- Purchase Guide
- Getting Started
- API Documentation
- Operation Guide
- PHP SDK Documentation
- FAQs
- Contact Us
- Glossary
1. API Description
Domain name for API request: cloudaudit.intl.tencentcloudapi.com.
This API is used to create a tracking set.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateAuditTrack. |
| Version | Yes | String | Common Params. The value used for this API: 2019-03-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-hongkong, ap-seoul, ap-singapore, ap-tokyo, eu-frankfurt. |
| Name | Yes | String | Tracking set name, which can only contain 3-48 letters, digits, hyphens, and underscores. |
| ActionType | Yes | String | Tracking set event type (Read: Read; Write: Write; *: All) |
| ResourceType | Yes | String | The product to which the tracking set event belongs. The value can be a single product such as cos, or * that indicates all products. |
| Status | Yes | Integer | Tracking set status (0: Not enabled; 1: Enabled) |
| EventNames.N | Yes | Array of String | The list of API names of tracking set events. When ResourceType is *, the value of EventNames must be *. When ResourceType is a specified product, the value of EventNames can be *. When ResourceType is cos or cls, up to 10 APIs are supported. |
| Storage | Yes | Storage | Storage type of shipped data. Valid values: cos, cls. |
| TrackForAllMembers | No | Integer | Whether to enable the feature of shipping organization members’ operation logs to the organization admin account or the trusted service admin account (0: Not enabled; 1: Enabled. This feature can only be enabled by the organization admin account or the trusted service admin account) |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TrackId | Integer | Tracking set ID |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Creating a tracking set
Input Example
POST / HTTP/1.1
Host: cloudaudit.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAuditTrack
<Common request parameters>
{
"Name": "audit",
"ActionType": "Read",
"ResourceType": "audit",
"Status": 1,
"TrackForAllMembers": 1,
"EventNames": [
"LookUpEvents",
"DeleteAudit"
],
"Storage": {
"StorageType": "cos",
"StorageRegion": "ap-guangzhou",
"StorageName": "audit-cos",
"StoragePrefix": "test"
}
}
Output Example
{
"Response": {
"TrackId": 1,
"RequestId": "2d4a7fba-bba8-452e-a99e-ccf11fdaa583"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.CheckClsTopicIsExistFailed | Failed to check whether the CLS log topic exists |
| FailedOperation.CheckCosBucketIsExistFailed | Failed to check whether the COS bucket exists |
| FailedOperation.GetClsTopicFailed | Failed to pull the CLS log topic |
| FailedOperation.GetCosBucketListFailed | Failed to pull the COS bucket list |
| InternalError | Internal error. |
| InternalError.SearchError | An internal error occurred. Submit a ticket for assistance. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue.AliasAlreadyExists | The alias already exists. |
| InvalidParameterValue.CosRegionError | CloudAudit currently does not support the entered COS region. |
| LimitExceeded.OverAmount | The maximum number of tracking sets has been exceeded. |
| ResourceNotFound | The resource doesn’t exist. |
| ResourceNotFound.CosNotExist |
Yes
No
Was this page helpful?