DescribeEvents

Last updated: 2021-11-24 17:29:02

1. API Description

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

This API is used to query CloudAudit logs.

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 parameter. The value used for this API: DescribeEvents.
Version Yes String Common parameter. The value used for this API: 2019-03-19.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
StartTime Yes Integer Start timestamp in seconds (cannot be 90 days after the current time).
EndTime Yes Integer End timestamp in seconds (the time range for query is less than 30 days).
NextToken No Integer Credential for viewing more logs.
MaxResults No Integer Max number of returned logs (up to 50).
LookupAttributes.N No Array of LookupAttribute Search criterion. Valid values: RequestId, EventName, ActionType (write/read), PrincipalId (sub-account), ResourceType, ResourceName, AccessKeyId, SensitiveAction, ApiErrorCode, and CamErrorCode.
IsReturnLocation No Integer Whether to return the IP location. 1: yes, 0: no.

3. Output Parameters

Parameter Name Type Description
ListOver Boolean Whether the logset ends.
NextToken Integer Credential for viewing more logs.
Events Array of Event Logset.
Note: null may be returned for this field, indicating that no valid values can be obtained.
TotalCount Integer Total number of events.
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 CloudAudit logs

Input Example

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

{
    "StartTime": 1610613170,
    "EndTime": 1610699570,
    "MaxResults": 1
}

Output Example

{
  "Response": {
    "ListOver": false,
    "TotalCount": 1,
    "Events": [
      {
        "CloudAuditEvent": "{\"userIdentity\":{\"principalId\":\"100000000000\",\"accountId\":\"100000000000\",\"secretId\":\"xxx\",\"type\":\"Root\",\"userName\":\"root\",\"sessionContext\":\"{\\\"token\\\": \\\"xxx\\\", \\\"userIp\\\": \\\"163.177.68.30\\\", \\\"uin\\\": 100000000000, \\\"ownerUin\\\": 100000000000, \\\"appId\\\": 1000000000, \\\"expireTime\\\": \\\"2021-01-15 17:35:55\\\", \\\"mfa\\\": 0, \\\"mfaExpireTime\\\": \\\"0000-00-00 00:00:00\\\", \\\"interfaceName\\\": \\\"\\\", \\\"hasPolicyFilter\\\": 0, \\\"policyFilter\\\": \\\"\\\", \\\"extraInfo\\\": \\\"\\\"}\"},\"@timestamp\":\"2021-01-15T07:35:59.115042\",\"onlyRecordNotSeen\":\"0\",\"eventRegion\":\"ap-guangzhou\",\"eventVersion\":2,\"errorCode\":\"0\",\"errorMessage\":\"permission verify\",\"requestID\":\"c8c04477-eb9e-4703-84ae-f8758c6084ff\",\"eventID\":\"c8c04477-eb9e-4703-84ae-f8758c6084ff\",\"apiVersion\":\"3.0\",\"eventType\":\"ConsoleCall\",\"actionType\":\"Read\",\"authMode\":\"0\",\"isRisk\":\"0\",\"ruleId\":\"0\",\"httpMethod\":\"POST\",\"apiErrorCode\":\"0\",\"apiErrorMessage\":\"\",\"userAgent\":\"SDK_NODEJS_0.2.1\",\"eventTime\":1610696155,\"updateEsTime\":16106961641644206,\"sensitiveAction\":\"\",\"eventPlatform\":\"0\",\"sourceIPAddress\":\"9.83.55.32\",\"resourceType\":\"cloudaudit\",\"eventName\":\"LookUpEvents\",\"eventSource\":\"cloudaudit.ap-chongqing.api.tencentyun.com\",\"requestParameters\":\"{\\\"Region\\\": \\\"ap-guangzhou\\\", \\\"SecretId\\\": \\\"xxx\\\", \\\"Timestamp\\\": \\\"1610696155\\\", \\\"Nonce\\\": \\\"11289\\\", \\\"RequestClient\\\": \\\"SDK_NODEJS_0.2.1\\\", \\\"StartTime\\\": \\\"1610121600\\\", \\\"EndTime\\\": \\\"1610726399\\\", \\\"MaxResults\\\": \\\"20\\\", \\\"Mode\\\": \\\"standard\\\", \\\"Version\\\": \\\"2019-03-19\\\", \\\"Action\\\": \\\"LookUpEvents\\\", \\\"RequestOperator\\\": \\\"100000000000\\\", \\\"Token\\\": \\\"xxx\\\", \\\"RequestSource\\\": \\\"MC\\\", \\\"seqId\\\": \\\"1be35142-f784-64d4-4502-a1250702edcd\\\"}\",\"resources\":\"[\\\"*\\\"]\",\"resourceName\":\"\",\"cloudapi\":1,\"auth\":1,\"signature\":0}",
        "EventName": "LookUpEvents",
        "EventTime": 1610696155,
        "SecretId": "xxx",
        "ErrorCode": "0",
        "RequestID": "c8c04477-eb9e-4703-84ae-f8758c6084ff",
        "SourceIPAddress": "9.83.55.32",
        "EventSource": "cloudaudit.ap-chongqing.api.tencentyun.com",
        "EventRegion": "ap-guangzhou",
        "Resources": {
          "ResourceName": "",
          "ResourceType": "cloudaudit"
        },
        "Username": "root",
        "ResourceTypeCn": "CloudAudit",
        "EventNameCn": "",
        "ResourceRegion": ""
      }
    ],
    "NextToken": 16106961641644206,
    "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.