tencent cloud

APIs

DescribeConfigRecorder

Download
Focus Mode
Font Size
Last updated: 2026-10-19 15:48:11

1. API Description

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

This API is used to query monitoring 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: DescribeConfigRecorder.
Version Yes String Common Params. The value used for this API: 2022-08-02.
Region No String Common Params. This parameter is not required.

3. Output Parameters

Parameter Name Type Description
Items Array of UserConfigResource List of user monitoring resources.
Status Integer Valid values: 0 (disabled) and 1 (enabled).
TriggerCount Integer Number of snapshots on the current day.
OpenCount Integer Number of times monitoring is enabled on the current day.
UpdateCount Integer Number of times the monitoring scope is modified on the current day
CreateTime String Creation time.
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 This API is used to query monitoring details.

Input Example

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

{}

Output Example

{
    "Response": {
        "Items": [
            {
                "Product": "abc",
                "ProductName": "abc",
                "ResourceType": "abc",
                "ResourceTypeName": "abc",
                "UpdateTime": "abc"
            }
        ],
        "Status": 1,
        "TriggerCount": 1,
        "OpenCount": 1,
        "UpdateCount": 1,
        "CreateTime": "abc",
        "RequestId": "abc"
    }
}

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
InvalidParameter Parameter error.
ResourceNotFound.RecorderIsNotExist Monitoring information not found.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback