Domain name for API request: mariadb.tencentcloudapi.com.
This API is used to view the current performance data of a database instance.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: mariadb.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: DescribeDBPerformance. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID in the format of tdsql-ow728lmc. |
| StartTime | Yes | Date | Start date in the format of yyyy-mm-dd |
| EndTime | Yes | Date | End date in the format of yyyy-mm-dd |
| MetricName | No | String | Name of pulled metric. Valid values: long_query, select_total, update_total, insert_total, delete_total, mem_hit_rate, disk_iops, conn_active, is_master_switched, slave_delay |
| Parameter Name | Type | Description |
|---|---|---|
| LongQuery | MonitorData | Number of slow queries |
| SelectTotal | MonitorData | Number of SELECT operations |
| UpdateTotal | MonitorData | Number of UPDATE operations |
| InsertTotal | MonitorData | Number of INSERT operations |
| DeleteTotal | MonitorData | Number of DELETE operations |
| MemHitRate | MonitorData | Cache hit rate |
| DiskIops | MonitorData | Number of disk IOs per second |
| ConnActive | MonitorData | Number of active connections |
| IsMasterSwitched | MonitorData | Whether primary/secondary switch occurred. 1: yes, 0: no |
| SlaveDelay | MonitorData | primary/secondary delay |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://mariadb.tencentcloudapi.com/?Action=DescribeDBPerformance
&InstanceId=tdsql-ige1a5k3
&StartTime=2018-03-19
&EndTime=2018-03-19
&<Common request parameters>
{
"Response": {
"UpdateTotal": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"DiskIops": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"ConnActive": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"MemHitRate": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"SelectTotal": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"LongQuery": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"DeleteTotal": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"InsertTotal": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"RequestId": "124581ec-1937-4847-bdea-1a2949e4af9b",
"IsMasterSwitched": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
},
"SlaveDelay": {
"EndTime": "2018-03-24 23:59:59",
"Data": [
1,
1,
1
],
"StartTime": "2018-03-24 00:00:00"
}
}
}
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 |
|---|---|
| FailedOperation.OssOperationFailed | Failed to request the backend API. |
| InternalError.CamAuthFailed | CAM authentication request failed. |
| InternalError.GetInstanceDetailFailed | Failed to get the instance details. |
| InternalError.InnerSystemError | Internal system error. |
| InvalidParameter.GenericParameterError | An error occurred while verifying parameter validity. |
| InvalidParameter.InstanceNotFound | Failed to find the requested instance. |
| InvalidParameterValue.ShardNotExist | The shard does not exist. |
| ResourceNotFound.NoInstanceFound | The specified database instance was not found. |
| ResourceUnavailable.InstanceStatusAbnormal | Incorrect database instance status. Operations are not allowed. |
| UnauthorizedOperation.PermissionDenied | You have no permission to manipulate this API or resource. |
Was this page helpful?