All Products
Search
Document Center

Tablestore:PercentilesAggregation

Last Updated:Apr 23, 2024

Specifies percentile statistics of the aggregation feature in search indexes. A percentile value indicates the relative position of a value in a dataset. For example, when you collect statistics for the response time of each request during the routine O&M of your system, you must analyze the response time distribution by using percentiles such as p25, p50, p90, and p99.

Request parameters

message PercentilesAggregation {
    optional string field_name = 1;
    repeated double percentiles = 2;
    optional bytes missing = 3;
}

Parameter

Type

Required

Description

field_name

string

Yes

The field that is used for aggregation.

percentiles

double

Yes

The percentiles such as p50, p90, and p99. You can specify one or more percentiles. Separate multiple percentiles with commas (,). Example: 25.0,50.0,99.0.

A percentile ranges from 1 to 100.

missing

bytes

No

The default value of a field if the value of the field is empty in the row. The value of the parameter is encoded in PlainBuffer. For more information, see PlainBuffer.

  • If you do not specify a value for the missing parameter, the row is ignored.

  • If you specify a value for the missing parameter, the value of the parameter is used as the value of the field in the row.

Response parameters

message PercentilesAggregationResult {
    repeated PercentilesAggregationItem percentiles_aggregation_items = 1;
}

Parameter

Type

Required

Description

percentiles_aggregation_items

repeated PercentilesAggregationItem

Yes

The percentile distribution in percentile statistics.