Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Querying Metrics/ Querying Top N Metrics of All Integration Applications

Updated on 2025-10-22 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Top N Metrics of All Integration Applications

Function

This API is used to query the top N metrics values of all integration applications within the statistical period. The master account permission is required.

If you have any questions related to the restriction, contact technical support.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v2/{project_id}/apic/instances/{instance_id}/statistics/roma-app-usages

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
cycle	No	String	Statistical period. minute hour day If cycle is set to minute, data of the last 30 days can be queried. If cycle is set to hour, data of the last 180 days can be queried. If cycle is set to day, data of the last 360 days can be queried.
start_time	No	String	Start time, for example, 2020-06-18 10:00:01.
end_time	No	String	End time, for example, 2020-06-18 23:00:00.
duration	No	String	The measurement duration is in the format of "integer+unit (m or h)". m indicates minute, and h indicates hour. The combination of hour and minute is supported. For example, 1h or 2h45m. If both start_time and end_time are specified, the query time range is [start_time, end_time]. If start_time does not exist, but end_time and duration exist and are valid, the query time range is [end_time – duration, end_time]. If start_time and end_time do not exist, duration exists and is valid, and end_time is now, the query time range is [end_time – duration, end_time]. If end_time does not exist, start_time and duration exist and are valid, and end_time is now, the query time range is [end_time – duration, end_time]. If start_time, end_time, and duration do not exist, the error message "missing time range parameters" is displayed.
top_roma_app_num	No	Integer	The top integration applications.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Response code.
start_time	Long	Timestamp (UTC) of the statistics start time.
end_time	Long	End time (UTC).
app_req_count	Array of AppRequestStatisticInfo objects	Top N number of API calling requests from applications.
app_req_count_error	Array of AppRequestErrorStatisticInfo objects	Top N statistics about application request errors.
app_input_throughput	Array of AppInputStatisticInfo objects	Top N uplink throughput of API calling requests sent by applications.
app_output_throughput	Array of AppOutputStatisticInfo objects	Top N statistics about the downlink throughput of application requests.
app_avg_latency	Array of AppAvgLatencyInfo objects	Top N average delay of API calling requests sent by applications.
app_avg_backend_latency	Array of AppAvgBackendLatencyInfo objects	TOP_n statistics about the average backend latency of application requests.

**Table 5** AppRequestStatisticInfo
Parameter	Type	Description
app_id	String	Application ID.
app_name	String	Application name.
req_count	Integer	Total number of requests.

**Table 6** AppRequestErrorStatisticInfo
Parameter	Type	Description
app_id	String	Application ID.
app_name	String	Application name.
req_count_error	Integer	Number of request errors.

**Table 7** AppInputStatisticInfo
Parameter	Type	Description
app_id	String	Application ID.
app_name	String	Application name.
input_throughput	Long	Total uplink throughput.

**Table 8** AppOutputStatisticInfo
Parameter	Type	Description
app_id	String	Application ID.
app_name	String	Application name.
output_throughput	Long	Total downlink throughput.

**Table 9** AppAvgLatencyInfo
Parameter	Type	Description
app_id	String	Application ID.
app_name	String	Application name.
avg_latency	Float	Average latency.

**Table 10** AppAvgBackendLatencyInfo
Parameter	Type	Description
app_id	String	Application ID.
app_name	String	Application name.
avg_backend_latency	Float	Average backend latency.

Status code: 400

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

None

Example Responses

Status code: 200

{
  "code" : "APIG.0000",
  "start_time" : 1599508511,
  "end_time" : 1599616511,
  "app_req_count" : [ {
    "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0",
    "app_name" : "ycs-product",
    "req_count" : 5
  } ],
  "app_req_count_error" : [ {
    "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0",
    "app_name" : "ycs-product",
    "req_count" : 5
  } ],
  "app_input_throughput" : [ {
    "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0",
    "app_name" : "ycs-product",
    "input_throughput" : 2990
  } ],
  "app_output_throughput" : [ {
    "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0",
    "app_name" : "ycs-product",
    "output_throughput" : 1695
  } ],
  "app_avg_latency" : [ {
    "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0",
    "app_name" : "ycs-product",
    "avg_latency" : 0
  } ],
  "app_avg_backend_latency" : [ {
    "app_id" : "1a7b421c-6103-4fcb-a0d7-3e322e863cb0",
    "app_name" : "ycs-product",
    "avg_backend_latency" : 0
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:api_id. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3002",
  "error_msg" : "API 39bce6d25a3f470e8cf7b2c97174f7d9 does not exist"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Querying Metrics

Previous topic: Querying Statistics on Application Request Metrics

Next topic: Instance Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot