1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
Obtains the monitoring data of a cloud product. After you specify your product namespace, object dimension description, and monitoring metrics, you can obtain the corresponding monitoring data.
Highest frequency of calls that can be made per second/minute: 20/1200.
If you call excessive metrics and objects in a short period of time, the system may fail to pull data because frequency is limited. We recommend that you balance your requests by time.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-11-30 19:22:03.
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: GetMonitorData |
| 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 |
| Namespace | Yes | No | String | Namespace. Example: QCE/CVM |
| MetricName | Yes | No | String | Metric name. Example: CpuUsage |
| Period | No | No | Uint64 | cycle, Example: 60 |
| StartTime | No | No | Datetime_iso | Start time. Sample value: 2018-09-22T19:51:23+08:00. Example: 2019-03-24T10:51:23+08:00 |
| EndTime | No | No | Datetime_iso | End time. Sample value: 2018-09-22T20:51:23+08:00. By default, the system uses the current time as the parameter value. The time corresponding to the value of EndTime cannot be earlier than that of StartTime. Example: 2019-03-24T20:51:23+08:00 |
| Instances | Yes | No | Array of Instance | Combination of instance object dimensions, a group of key-value pairs. Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Period | Uint64 | Statistical period. Example: 300 |
| MetricName | String | Metric name. Example: cpu_usage |
| DataPoints | Array of DataPoint | Data point array. Example:View |
| StartTime | Datetime | Start time. Example: 2019-03-24T10:50:00+08:00 |
| EndTime | Datetime | End time. Example: 2019-03-24T20:50:00+08:00 |
| 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 |
|---|---|
| InvalidParameterValue | Invalid parameter value. |
| InternalError | Internal error. |