Domain name for API request: dbbrain.tencentcloudapi.com.
This API is used to query the instance list.
A maximum of 20 requests can be initiated per second for this API.
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: 2021-05-27. |
Region | No | String | Common Params. This parameter is not required for this API. |
Product | Yes | String | Service type. Valid values: dcdb (TDSQL for MySQL), mariadb (TencentDB for MariaDB). |
NodeRequestType | Yes | String | Use the value of Product for this parameter, such as dcdb and mariadb . |
AuditSwitch | No | Integer | Audit status. Valid values: 0 (Not enabled), 1 (Enabled). Default value: 0 . |
Offset | No | Integer | The offset. Default value: 0 . |
Limit | No | Integer | The number of queried items. Default value: 20 . Max value: 100 . |
Filters.N | No | Array of AuditInstanceFilter | Filters for querying instances |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | The number of eligible instances. Note: This field may return null , indicating that no valid values can be obtained. |
Items | Array of AuditInstance | Instance details |
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. |
This example shows you how to query the list of instances for which to enable audit.
https://dbbrain.tencentcloudapi.com/?Action= DescribeAuditInstanceList
&Product=dcdb
&NodeRequestType=dcdb
&AuditSwitch=0
&Offset=0
&Limit=50
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"RequestId": "b39db780-0b49-11ee-8525-17d65d16bdaf",
"Items": [
{
"BillingConfirmed": 1,
"AuditStatus": "ON",
"ColdLogExpireDay": 23,
"InstanceId": "tdsql-lq5ue8p7",
"LogExpireDay": 30,
"CreateTime": "2023-06-08 19:48:19",
"HotLogSize": 0,
"HotLogExpireDay": 7,
"BillingAmount": 0,
"ColdLogSize": 0,
"InstanceInfo": {
"InstanceName": "DBbrainTest_fanzhi_MySQL8.0",
"AuditStatus": 1,
"AppId": 251009273,
"InstanceId": "tdsql-lq5ue8p7",
"ResourceTags": [
"abc"
],
"ProjectId": 0,
"Region": "ap-guangzhou"
}
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
AuthFailure | Error with CAM signature/authentication. |
FailedOperation | Operation failed. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
LimitExceeded | The quota limit is exceeded. |
MissingParameter | Missing parameter. |
OperationDenied | Operation denied. |
OperationDenied.UserHasNoStrategy | Error with CAM authentication. |
ResourceNotFound | The resource does not exist. |
UnauthorizedOperation | The operation is unauthorized. |
UnknownParameter | Unknown parameter. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?