1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
Default frequency limit on API requests: 50 requests/second.
Default metric limit for a single tenant: 100 metrics.
A maximum of 30 metric/value pairs are reported at a time. When the request returns an error, all metrics/values in the request will not be saved.
The reported timestamp is the timestamp expected to be saved. It is recommended to create a timestamp with the number of minutes expressed in integers.
The time range of the timestamp must be between the current time and 300 seconds ago.
Data of the same IP metric pair should be reported in chronological order based on minutes.
Default interface request rate limit: 50 times per second.
Interface update time: 2019-12-13 19:17:02.
The interface only verifies the signature but does not authenticate.
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: PutMonitorData |
| 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 |
| AnnounceIp | No | No | String | IP specified by yourself when reporting data. Example: 10.0.0.1 |
| AnnounceTimestamp | No | No | Uint64 | Timestamp specified by yourself when reporting data. Example: 1569379988 |
| Metrics | Yes | No | Array of MetricDatum | A set of metrics and data. Example:View |
| AnnounceInstance | No | No | String | IP or product instance ID specified by yourself when reporting data . Example: 10.0.0.1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| 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. |
| InvalidParameter.InvalidParameterParam | Invalid parameter. |
| InvalidParameter.InvalidParameter | Invalid parameter. |
| InvalidParameter | Invalid parameter. |
| InternalError.ExeTimeout | Execution timed out. |
| FailedOperation | Operation failed. |
| MissingParameter | Missing parameter. |
| UnknownParameter | Unknown parameter error. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation | Unsupported operation. |
| ResourceNotFound | The resource does not exist. |
| LimitExceeded | The quota limit has been reached. |
| ResourceUnavailable | The resource is unavailable. |
| FailedOperation | Operation failed. |
| DryRunOperation | DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful. |
| LimitExceeded.MetricQuotaExceeded | Quota limit on metrics is reached. Requests containing unregistered metrics are prohibited. |
| FailedOperation.ServiceNotEnabled | The service is not enabled and can be used only after being enabled. |