tencent cloud

APIs

DescribeAuditInstanceList

Download
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-05-21 10:44:05

1. API Description

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

Query the audit instance list

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: DescribeAuditInstanceList.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-guangzhou, ap-shanghai, ap-shanghai-fsi.
Product Yes String

Product name: postgres

AuditSwitch Yes Integer

Whether to enable

Enumeration value:

  • 0: Not enabled
  • 1: Enabled
Limit Yes Integer

Pagination limit

Offset No Integer

Page offset amount

Filters.N No Array of Filter

Instance filtering parameters

Input parameter limitation: Supported filter criteria: InstanceId-instance ID, InstanceName-instance name

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

Instance count


Note: This field may return null, indicating that no valid values can be obtained.
Items Array of AuditInstanceInfo

Instance log information


Note: This field may return null, indicating that no valid values can be obtained.
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 Querying the Audit Instance List

Query the audit instance list

Input Example

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

{
    "Product": "postgres",
    "AuditSwitch": 0,
    "Limit": 10,
    "Offset": 0
}

Output Example

{
    "Response": {
        "Items": [],
        "TotalCount": 0,
        "RequestId": "60b1c1b9-dd93-46d0-b4de-83af5d5d00c5"
    }
}

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
FailedOperation.DBError Database access failed.
InvalidParameter.ExceptionParam Parameter exception.
InvalidParameter.InvalidParameterError Invalid parameters.
OperationDenied.AccountOperationDenied No user permissions.
OperationDenied.AuditFileOverQuotaError Download task limit exceeded.
OperationDenied.InternalTradeErrorErr Billing failure.
OperationDenied.ResourceNotFundError The instance does not exist.
UnknownParameter.CreateAuditLogFileError Error creating an audit log file.
UnknownParameter.HttpError Service exception. please retry later.
UnknownParameter.InternalInnerServiceError Internal service exception. Please retry later.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백