1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
API for pulling all namespaces.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-10-27 19:42:25.
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: DescribeAllNamespaces |
| 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 |
| SceneType | Yes | No | String | Filter by monitoring types, "ST_DASHBOARD"=Cloud product monitoring, and "ST_ALARM"=Cloud monitoring alarm. Example: ST_ALARM |
| MonitorTypes | No | No | Array of String | Filters by namespace ID. If this parameter is left empty, all will be queried. Example: ["MT_QCE"] |
| Ids | No | No | Array of String | Filters by use case. Valid values: "ST_DASHBOARD" (dashboard type), "ST_ALARM"(alarm type). Example: cvm_device |
| Module | Yes | No | String | The value is fixed to "monitor". Example: monitor |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| QceNamespaces | Array of CommonNamespace | Cloud product namespace. Example:View |
| CustomNamespaces | Array of CommonNamespace | Custom monitoring namespace. Example:View |
| CommonNamespaces | Array of String | CommonNamespaces Example: {"Id":"performance_metric","MonitorType":"MT_TAW","Name":"Performance metric","Dimensions":[]} |
| CustomNamespacesNew | Array of String | CustomNamespacesNew Example: {"Id":"=wenlong_sidecar","Name":"=wenlong_sidecar","ProductName":"=wenlong_sidecar","Value":"=wenlong_sidecar","Config":"","AvailableRegions":[],"DashboardId":"=wenlong_sidecar","SortId":0} |
| QceNamespacesNew | Array of DashboardNamespace | QceNamespacesNew 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
There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.