tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAuditPolicies

Last updated: 2024-11-20 11:15:31

    1. API Description

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

    This API is used to query the audit policies of a TencentDB instance.

    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: DescribeAuditPolicies.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceId No String Instance ID in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB console.
    PolicyId No String Audit policy ID.
    PolicyName No String Audit policy name. Fuzzy match query is supported.
    Limit No Integer Number of entries per page. Value range: 1-100. Default value: 20.
    Offset No Integer Pagination offset
    RuleId No String Audit rule ID, which can be used to query its associated audit policies.
    Note: At least one of the parameters (“RuleId”, “PolicyId”, PolicyId”, or “PolicyName”) must be passed in.
    InstanceName No String Instance name

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible audit policies
    Items Array of AuditPolicy Audit policy details
    Note: This field may return null, indicating that no valid value was found.
    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 policies

    Input Example

    https://cdb.intl.tencentcloudapi.com/?Action=DescribeAuditPolicies
&InstanceId=cdb-qwerasdf
&PolicyId=cdbpolicy-asdfqwer
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "TotalCount": 1,
        "Items": [
            {
                "PolicyId": "cdbpolicy-asdfqwer"
                "Status": "running",
                "InstanceId": "cdb-qwerasdf",
                "InstanceName": "test",
                "CreateTime": "2019-03-20 17:09:13",
                "ModifyTime": "2019-03-20 17:09:13",
                "PolicyName": "audit_policy_1",
                "RuleId": "cdbrule-asdfqwer",
                "RuleName": "audit1"
            }
        ]
    }
}

    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.DatabaseAccessError Internal database error.
    InternalError.InnerCommonError Internal service error
    InternalError.ServerError Internal error of the system.
    InternalError.TransactionBeginError Operation failed
    InternalError.UnknownError Unknown error
    InvalidParameter.ControllerNotFoundError This API was not found.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value
    MissingParameter Missing parameter
    MissingParameter.MissingParamError Required parameters are missing.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy