sim_id | path | string | Yes | Simulation ID in sim_xxx format (base32-encoded UUID with prefix) |
metric | query | string (enum) | Yes | Metric type to summarize. rank-analysis is published but returns 501 Not Implemented until its compute path ships. uet-transport-stats and roce-transport-stats serve summary, which carries the whole-run transport projection, and timeSeries. Both return 501 for sampled until that compute path ships. scala-switch-agg-buff-stats serves summary, which carries the whole-run bufferPools projection unless the run settled with no buffer rows, and timeSeries, one group per buffer pool. It returns 501 for sampled until that compute path ships. |
mode | query | string (enum) | No | Output mode (default: summary). timeSeries is served for nd-stats, pfc, uet-transport-stats, roce-transport-stats and scala-switch-agg-buff-stats and returns 501 Not Implemented for the other metrics; sampled is published but returns 501 Not Implemented until its compute path ships. utilizationBins (a binned distribution of link utilization over time) is offered for nd-stats only: every other metric returns 400 with error code UNSUPPORTED_COMBINATION, a permanent answer that must not be retried, and for nd-stats the response’s file presigns a UtilizationBinsDocument. uplinkFairness (uplink port fairness per switch over time) is offered for nd-stats only in the same way: every other metric returns 400 with error code UNSUPPORTED_COMBINATION, and for nd-stats the response’s file presigns an UplinkFairnessDocument. completionTimeBins (a binned distribution of completion times over time) is offered on the Performance projection: perf returns the envelope whose presigned URL serves a CompletionTimeBinsDocument; chakra-perf returns 404 Not Found, as a run with no result shards does, because this shape does not bin its completions; and every other metric returns 400 with error code UNSUPPORTED_COMBINATION, a permanent answer that must not be retried. topPorts (the top ports of each tier, ranked by severity class and by each type of measure) is offered for nd-stats only: every other metric, pfc and the two transport metrics included, returns 400 with error code UNSUPPORTED_COMBINATION, a permanent answer that must not be retried, and for nd-stats the response’s file presigns a TopPortsDocument. |
tier | query | string (enum) | No | Tier filter for network device results (default: all) |
nodeId | query | array | No | Filter to these node ids. Comma-separated on the wire. An empty list is not accepted — omit the parameter instead. |
ifid | query | array | No | Filter to these interface ids. Comma-separated on the wire. An empty list is not accepted — omit the parameter instead. |
nicType | query | string | No | Filter to a NIC class. |
metricName | query | array | No | Filter to these metric names. Comma-separated on the wire; values may not contain commas. An empty list is not accepted — omit the parameter instead. |
application | query | array | No | Filter to these application names. Comma-separated on the wire; values may not contain commas. An empty list is not accepted — omit the parameter instead. |
priority | query | array | No | Filter to these PFC priorities. Comma-separated on the wire. An empty list is not accepted — omit the parameter instead. |
uldl | query | string (enum) | No | Filter to uplink or downlink direction. |
preset | query | string (enum) | No | Rank-analysis grouping preset (only consumed when metric=rank-analysis). Omit to get the server default, balanced. Carries no schema default: a schema default makes generated clients send the value on every request, which lists it in X-Ignored-Params on every mode and metric that does not consume it. |
tolerance | query | number | No | Dimensionless multiplier on the per-dimension tolerance bands (only consumed when metric=rank-analysis). Omit to get the server default, 0.0. Carries no schema default: a schema default makes generated clients send the value on every request, which lists it in X-Ignored-Params on every mode and metric that does not consume it. |
outlierThreshold | query | number | No | Outlier deviation-score fraction (only consumed when metric=rank-analysis). Omit to get the server default, 0.10. Carries no schema default: a schema default makes generated clients send the value on every request, which lists it in X-Ignored-Params on every mode and metric that does not consume it. |
portsPerRanking | query | integer | No | How many ports each ranking serves (only consumed when mode=topPorts and metric=nd-stats): an integer from 3 to 10. Omit to get the server default, 5. On every other mode and metric it is not parsed, whatever its value, and is named in X-Ignored-Params. Carries no schema default: a schema default makes generated clients send the value on every request, which lists it in X-Ignored-Params on every mode and metric that does not consume it. |