1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
API for obtaining the status history of the CVM
Default interface request rate limit: 20 times per second.
Interface update time: 2022-08-27 21:47:02.
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: DescribeAgentStatusHistory |
| 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 | The value is fixed to "monitor". Example: monitor |
| StartTime | Yes | No | Datetime_iso | Start time of the time range to query. Example: 2023-04-02T16:04:00+08:00 |
| UnInstanceIDs | Yes | No | Array of String | The IDs of the instances you want to restart. Example: lhins-eqecz |
| EndTime | No | No | Datetime_iso | End time of the query. Example: 2023-04-02T15:04:00+08:00 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Data | Array of DescribeAgentStatusHistoryData | CVM status information list. 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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| FailedOperation | Operation failed. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation | Unsupported operation. |
| FailedOperation | Operation failed. |