Tenant Cloud
Security
Cloud Workload Protection Platform
Security Operations APIs
DescribeESAggregations
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
API for querying the aggregation result of ES fields
Default interface request rate limit: 20 times per second.
Interface update time: 2022-05-20 15:12:33.
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: DescribeESAggregations |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-02-28 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| Query | Yes | No | String | ES aggregate condition in the JSON format. Example: {"cwp":"dev"} |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Data | String | ES aggregation result in the JSON format. Example: {"took":12,"total":3,"aggs":{"dst_port":{},"src_port":{}},"code":0,"message":"success"} |
| 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. |
| MissingParameter | Missing parameter. |
| FailedOperation.APIServerFail | Failed to call the API service. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | The parameter value is invalid. |