tencent cloud

DescribeAccessKeyAlarm
Last updated:2026-01-29 15:40:49
DescribeAccessKeyAlarm
Last updated: 2026-01-29 15:40:49

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

List of alarm records for access keys.

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: DescribeAccessKeyAlarm.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
Filter No Filter Filter.
MemberId.N No Array of String Group Account Member ID
AccessKeyID No Integer Access key ID.
SourceIPID No Integer ID of the source IP.
SubUin No String Account UIN

3. Output Parameters

Parameter Name Type Description
Data Array of AccessKeyAlarm Alarm list.
Total Integer Total number.
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 Access Key Alarm Record List

Input Example

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

{}

Output Example

{
    "Response": {
        "Data": [
            {
                "AccessKey": "TEMP_AK",
                "AccessKeyID": 10093,
"AccessKeyRemark": "Temporary Key"
                "AlarmRuleID": 94865,
                "AlarmType": 0,
                "AppID": 1200001,
                "Date": "2025-03-13",
                "ID": 10185,
                "LastAlarmTime": "2025-03-13 16:50:44",
                "Level": 5,
"Name": "Suspicious IP Calling High-risk API"
                "Nickname": "name",
                "Status": 0,
                "SubNickname": "name",
                "SubUin": "10000**",
                "Tag": [],
                "Type": 2,
                "Uin": "10000**"
            }
        ],
        "RequestId": "1249df92-930b-4574-a517-45dc70580764",
        "Total": 1
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback