Obtaining Summary Table Data
Function
This API is used to obtain summary table data.
URI
POST /v1/apm2/openapi/view/metric/sum-table
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
x-business-id |
Yes |
Long |
Application ID. |
X-Auth-Token |
Yes |
String |
User token obtained from IAM. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
request_id |
No |
String |
ID of the last request. |
view_config |
Yes |
SumTableView object |
View configuration information. |
strategy |
No |
String |
Policy. |
page |
Yes |
Integer |
Current page number. |
page_size |
Yes |
Integer |
Number of data records on each page. |
order_by |
No |
String |
Sorting rule. |
search_word |
No |
String |
Search keyword. |
instance_id |
No |
Long |
Instance ID. |
monitor_item_id |
Yes |
Long |
Monitoring item ID. |
env_id |
Yes |
Long |
Environment ID. |
start_time |
Yes |
String |
Start time. |
end_time |
Yes |
String |
End time. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
view_type |
Yes |
String |
View type. Enumeration values:
|
collector_name |
Yes |
String |
Collector name. |
metric_set |
Yes |
String |
Name of the metric set corresponding to the view. |
title |
Yes |
String |
Title to be displayed. |
table_direction |
Yes |
String |
Direction of the table heading. Options: H (default): horizontal. V: vertical. Enumeration values:
|
group_by |
No |
String |
Grouping rule. |
filter |
No |
String |
Filter list model. |
field_item_list |
Yes |
Array of FieldItem objects |
Field list models to be displayed. |
span |
No |
Boolean |
Span. |
span_field |
No |
String |
Span field. |
order_by |
No |
String |
Sorting rule. |
latest |
No |
Boolean |
Whether to display only the latest data. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result_id |
String |
Result ID, which is contained in the pagination query result. |
row_list |
Array of FrontRow objects |
Data row list. |
latest_data_Time |
Long |
Time when the latest data record was generated. |
table_direction |
String |
Direction of the table heading. Options: H (default): horizontal. V: vertical. Enumeration values:
|
real_start_time |
Long |
Actual start time. |
real_end_time |
Long |
Actual end time. |
notice_msg |
String |
Prompt message. |
total_count |
Integer |
Total number. |
Parameter |
Type |
Description |
---|---|---|
cell_list |
Array of FrontCell objects |
Data unit set. |
filter |
String |
"Group by" fields concatenated for subsequent query. |
header |
Boolean |
Whether the information is about the header. |
tx_id |
Long |
URL trace ID. |
Parameter |
Type |
Description |
---|---|---|
data_type |
String |
Data type. |
function |
String |
Function. |
trace |
Boolean |
Trace or not. |
span |
Boolean |
Whether the information is related to spans. If yes, you will be redirected to the trace search page. |
span_field |
String |
Span field. |
precision |
Integer |
Number of decimal places. |
text |
String |
Text information. |
unit |
String |
Unit. |
visible |
Boolean |
Visible or not. |
Example Requests
None
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
OK: The request is successful. |
401 |
Unauthorized: No permissions. |
403 |
Forbidden: Access forbidden. |
404 |
Not Found: The requested resource is not found. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot