1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
This API is used to query monitoring data by dimension conditions.
Default interface request rate limit: 20 times per second.
Interface update time: 2021-04-21 15:13:52.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeStatisticData |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-07-24 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| Module | Yes | No | String | Module. The value is fixed to "monitor". Example: monitor |
| Namespace | Yes | No | String | Namespace. Supported value: QCE/TKE. Example: QCE/TKE2 |
| MetricNames | Yes | No | Array of String | List of metric names. Example: ["K8sPodCpuCoreUsed"] |
| Conditions | No | No | Array of MidQueryCondition | Dimension condition. The = and in operators are supported. Example:View |
| Period | No | No | Uint64 | Statistical period in seconds. Default value: 300. Example: 300 |
| StartTime | No | No | String | Start time, which is the current time by default, such as 2020-12-08T19:51:23+08:00. Example: 2020-11-24T15:15:50+08:00 |
| EndTime | No | No | String | End time, which is the current time by default, such as 2020-12-08T19:51:23+08:00. Example: 2020-11-24T15:25:50+08:00 |
| GroupBys | No | No | Array of String | groupBy by the specified dimension. Example: ["K8sPodCpuCoreUsed"] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Period | Uint64 | Statistical period. Example: 300 |
| StartTime | String | Start time. Example: 2020-11-24 15:15:00 |
| EndTime | String | End time. Example: 2020-11-24 15:25:00 |
| Data | Array of MetricData | Monitoring data Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| AuthFailure.UnauthorizedOperation | The request is not authorized. Please refer to the CAM documentation for the description of authentication. |
| InvalidParameterValue.InvalDashboardNameExists | The dashboard name already exists. |
| FailedOperation | Operation failed. |
| FailedOperation.DbRecordUpdateFailed | Failed to update the database record. |
| InvalidParameter.InvalidParameter | Invalid parameter. |
| MissingParameter | Missing parameter. |
| FailedOperation.DataQueryFailed | Failed to query the data. |
| InvalidParameter.InvalidParameterParam | Invalid parameter. |
| UnauthorizedOperation | Unauthorized operation. |
| FailedOperation.DbTransactionCommitFailed | Failed to submit the database transaction. |
| InvalidParameter | Invalid parameter. |
| FailedOperation.DataTableNotFound | The data table doesn't exist. |
| FailedOperation.DbRecordDeleteFailed | Failed to delete the database record. |
| ResourceInsufficient | Insufficient resource. |
| FailedOperation.DbQueryFailed | Failed to query the database. |
| FailedOperation.DimQueryRequestFailed | Failed to query the service in the request dimension. |
| ResourceInUse | The resource is in use. |
| ResourceNotFound | The resource does not exist. |
| FailedOperation.DbRecordCreateFailed | Failed to create the database record. |
| InternalError | Internal error. |
| LimitExceeded | The quota limit has been reached. |
| FailedOperation.DataColumnNotFound | The data table field doesn't exist. |
| FailedOperation.DbTransactionBeginFailed | Failed to start the database transaction. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.VersionMismatch | Inconsistent versions. |
| UnknownParameter | Unknown parameter error. |