tencent cloud

文档反馈

DescribeAuditTrack

最后更新时间:2023-01-04 11:45:00

1. API Description

Domain name for API request: cloudaudit.tencentcloudapi.com.

This API is used to query the CloudAudit tracking set details.

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: DescribeAuditTrack.
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.
TrackId Yes Integer Tracking set ID

3. Output Parameters

Parameter Name Type Description
Name String Tracking set name
ActionType String Tracking set event type (Read: Read; Write: Write; *: All)
ResourceType String The product to which the tracking set event belongs, such as cos, or * that indicates all products
Status Integer Tracking set status (0: Not enabled; 1: Enabled)
EventNames Array of String The list of API names of tracking set events (*: All)
Storage Storage Storage type of shipped data. Valid values: cos, cls.
CreateTime String Creation time of the tracking set
TrackForAllMembers Integer Whether to enable the feature of shipping organization members’ operation logs to the organization admin account or the trusted service admin account
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the CloudAudit tracking set details

Input Example

POST / HTTP/1.1
Host: cloudaudit.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAuditTrack
<Common request parameters>

{
    "TrackId": 1
}

Output Example

{
    "Response": {
        "Name": "audit",
        "ActionType": "Read",
        "ResourceType": "audit",
        "EventNames": [
            "LookUpEvents"
        ],
        "Storage": {
            "StorageName": "audit-cos",
            "StoragePrefix": "test",
            "StorageRegion": "ap-guangzhou",
            "StorageType": "cos"
        },
        "TrackForAllMembers": 1,
        "Status": 1,
        "CreateTime": "2021-01-14 14:43:38",
        "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.

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
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue.AliasAlreadyExists The alias already exists.
LimitExceeded.OverAmount The maximum number of tracking sets has been exceeded.
ResourceNotFound.AuditNotExist The tracking set does not exist.