1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
API for obtaining a dashboard list
Default interface request rate limit: 20 times per second.
Interface update time: 2022-08-27 21:53:11.
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: DescribeUnifyDashboards |
| 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 |
| IsStarred | No | No | String | Whether to add to "Favorite". Example: false |
| Keyword | No | No | String | The keyword for search. Example: dadceqe231cx |
| IsFolder | No | No | String | Whether it is a folder. Example: false |
| Caller | No | No | String | Mini program: applet. Example: applet |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Dashboards | Array of UnifyDashboardMeta | Dashboard 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 |
|---|---|
| UnsupportedOperation | Unsupported operation. |
| InternalError | Internal error. |
| InvalidParameter.InvalidParameter | Invalid parameter. |
| LimitExceeded | The quota limit has been reached. |
| ResourceUnavailable | The resource is unavailable. |
| UnknownParameter | Unknown parameter error. |
| LimitExceeded.MetricQuotaExceeded | Quota limit on metrics is reached. Requests containing unregistered metrics are prohibited. |
| ResourceInUse | The resource is in use. |
| MissingParameter | Missing parameter. |
| UnauthorizedOperation | Unauthorized operation. |
| InvalidParameter | Invalid parameter. |
| FailedOperation | Operation failed. |
| ResourceInsufficient | Insufficient resource. |
| ResourceNotFound | The resource does not exist. |