All Products
Search
Document Center

Application Real-Time Monitoring Service:QueryMetricByPage

Last Updated:May 09, 2024

Queries an Application Monitoring metric or a Browser Monitoring metric.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
arms:QueryMetricByPageRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IntervalInSecintegerYes

The time interval at which data entries are aggregated. Unit: milliseconds. Minimum value: 60000.

100000
StartTimelongYes

The start of the time range to query. Unit: milliseconds.

1667287695000
EndTimelongYes

The end of the time range to query. Unit: milliseconds.

1667546895000
OrderBystringNo

The dimension from which metrics are sorted. You can set this parameter to a supported dimension.

pid
MetricstringYes

The metric that you want to query. You cannot specify a custom metric. For more information, see the "Application monitoring metrics that can be queried" section.

appstat.host
OrderstringNo

The order in which measures are sorted. Valid values:

  • ASC: ascending order
  • DESC: descending order
Note If you do not specify the parameter, data is not sorted.
ASC
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. This parameter is no longer supported. The number of entries to return on each page.

10
Filtersobject []No

The filter conditions.

KeystringNo

The key of the filter condition. You must set the key to pid or regionId.

pid
ValuestringNo

The value of the filter condition. You must set the value of the pid or regionId condition. For information about how to obtain the pid, see the "Obtain the PID of an application" section.

xxx@74xxx
DimensionsarrayNo

The dimensions of the metric that you want to query.

stringNo

The dimensions of the metric that you want to query. For more information, see the "Application monitoring metrics that can be queried" section. You can specify a maximum of five dimensions.

pid
MeasuresarrayNo

The measures of the metric that you want to query.

stringNo

The measures of the metric that you want to query. For more information, see the "Application monitoring metrics that can be queried" section. You can specify a maximum of five measures.

instanceCount
CustomFiltersarrayNo

Custom filter conditions.

stringNo

Custom filter conditions. Separate multiple filter conditions with commas (,).

["not rpcType:40","not rpcType:41"]

Obtain the PID of an application

In the left-side navigation pane of the ARMS console, choose Application Monitoring > Applications or Browser Monitoring > Browser Monitoring. Then, click the name of target application that you want to query to open the overview page of this application.

The URL in the browser address bar contains the PID of this application in the format of pid=xxx. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d****, you must replace %40 with @ to obtain eb4zdose6v@9781be0f44d****.

Application monitoring metrics that can be queried

NoteYou must set the pid and regionId filter conditions by specifying the Filters parameter. You must set all known filter conditions by specifying the Filters parameter to define the range of query results. If no filter conditions are known, you can specify one or more dimensions provided in the following table to narrow down the query range.

MetricDescriptionDimensionMeasure
appstat.vmA collection of common metrics that are shown in the JVM monitoring chart on the application details page. These metrics are related to GCs, heap memory, non-heap memory, and threads.- pid- rootIpGCs:- youngGcCount: the number of GCs in the young generation- oldGcCount: the number of full heap GCs (Full GCs)- youngGcTime: the amount of time consumed to monitor GCs in the young generation- oldGcTime: the amount of time consumed to monitor Full GCs- youngGcCountInstant: the instantaneous value of the number of GCs in the young generation- oldGcCountInstant: the instantaneous value of the number of Full GCs- youngGcTimeInstant: the instantaneous value of the amount of time consumed to monitor GCs in the young generation- oldGcTimeInstant: the instantaneous value of the amount of time consumed to monitor Full GCs
appstat.vmA collection of common metrics that are shown in the JVM monitoring chart on the application details page. These metrics are related to GCs, heap memory, non-heap memory, and threads.- pid- rootIpHeap memory and non-heap memory:- edenSpace: the eden space in the young generation- oldGen: the old generation- survivorSpace: the survivor space in the young generation- metaSpace: metaspace- nonHeapCommitted: the non-heap memory- nonHeapInit: the initial value of the non-heap memory- nonHeapMax: the maximum value of the non-heap memory- nonHeapUsed: the usage of the non-heap memory- directUsed: the amount of used direct buffer in the off-heap memory- directCapacity: the total amount of direct buffer in the off-heap memory
appstat.vmA collection of common metrics that are shown in the JVM monitoring chart on the application details page. These metrics are related to GCs, heap memory, non-heap memory, and threads.- pid- rootIpThreads:- threadCount: the total number of threads- threadNewCount: the number of new threads- threadDeadlockCount: threadDeadlockCount: the number of deadlocked threads in the JVM- threadRunnableCount: the number of runnable threads in the JVM- threadTerminatedCount: the number of terminated threads- threadTimedWaitCount: the number of threads in the timed_waiting state- threadWaitCount: the number of threads in the waiting state- threadBlockedCount: the number of blocked threads
appstat.hostA collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.- pid- rootIpinstanceCount: the number of instances
appstat.hostA collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.- pid- rootIpCPU:- systemCpuIdle: the percentage of idle CPU in the last 5 seconds, which is not displayed in the ARMS console- systemCpuSystem: the CPU utilization of the system in the last 5 seconds- systemCpuUser: the percentage of CPU occupied by users in the last 5 seconds- systemCpuIoWait: the percentage of CPU consumed for I/O waiting in the last 5 seconds
appstat.hostA collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.- pid- rootIpPhysical memory:- systemMemFree: the amount of free memory (Unit: KB)- systemMemUsed: the amount of used memory (Unit: KB)- systemMemTotal: the total amount of memory, which is not displayed in the ARMS console (Unit: KB)- systemMemBuffers: the amount of memory in the buffer cache- systemMemCached: the amount of memory in the page cache
appstat.hostA collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.- pid- rootIpDisk:- systemDiskFree: the size of free disk space in bytes- systemDiskUsedRatio: the usage of the disk space- SystemDiskTotal: the total size of disk space in bytes, which is not displayed in the ARMS console
appstat.hostA collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.- pid- rootIpsystemLoad: the load
appstat.hostA collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.- pid- rootIpNetwork:- systemNetInPackets: the average number of packets received over the network per second in the last 30 seconds- systemNetOutPackets: the average number of packets sent over the network per second in the last 30 seconds- systemNetInErrs: the average number of frame errors received over the network per second in the last 30 seconds- systemNetOutErrs: the average number of errors sent over the network per second in the last 30 seconds- systemNetInBytes: the average number of bytes received over the network per second in the last 30 seconds- systemNetOutBytes: the average number of bytes sent over the network per second in the last 30 seconds
appstat.databaseA collection of metrics for database calls.- pid- rpcType: the type of the call- endpoint: The database endpoint, which is localhost: 3306- destId: the database name, which is arms- rt: the response time.- count: the number of requests.- error: the number of errors.- resultsize: This metric is available only for MySQL 5.x.- slowcount: the number of slow calls.
appstat.incallA collection of metrics related to application details.- pid- rpcType- rootIp- rpc- ppid- rt: the response time- count: the number of requests- error: the number of errors- exception: the number of exceptions- errorrate: the error rate- qps: the number of queries per second
appstat.exceptionA collection of metrics related to exceptions.- pid- rpc- endpoint- excepType- excepInfo- rt: the response time- count: the number of requests- error: the number of errors
appstat.sqlA collection of metrics related to slow SQL queries.- pid- rpc- endpoint- sqlId- rt: the response time.- count: the number of requests.- error: the number of errors.- slowcount: the number of slow calls.- resultsize: This metric is available only for MySQL 5.x.Note: If the value of the slow metric is true, the filter conditions do not take effect.
appstat.mq.sendA collection of metrics related to message sending by using Message QueueNone- rt: the response time- count: the number of requests- error: error: the number of errors- delay: the scheduling delay
appstat.mq.receiveA collection of metrics related to message receiving by using Message QueueNone- rt: the response time- count: the number of requests- error: error: the number of errors- delay: the scheduling delay
appstat.schedulerxA collection of metrics related to SchedulerX calls.- pid- rpcType- rootIp- rpccount: the number of requests
appstat.elasticsearchA collection of metrics related to Elasticsearch calls.- rpc- endpoint- opType: the type of the operation, such as index and search operations. This dimension is supported only when elasticsearch-rest-high-level-client is used.count: the number of requests
appstat.redisA collection of metrics related to ApsaraDB for Redis calls.- pid- rpcType- endpoint- opType- rpc/count: the number of requests

Browser Monitoring metrics that can be queried

You can call the QueryMetric operation to query the following metrics of Browser Monitoring.

NoteYou must set the pid and regionId filter conditions by specifying the Filters parameter.You must set all known filter conditions by specifying the Filters parameter to define the range of query results. If no filter conditions are known, you can specify one or more dimensions provided in the following table to narrow down the query range.

MetricDescriptionDimensionMeasure
webstat.apiSuccess rate of API calls- api: the URL of the API call without parameters- detector_app_version: the client version- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- release: the version number- sr: the screen resolution- count: the number of requests- rate: the success rate of API calls- avg_time: the average response time
webstat.api.detailAPI details- api: the URL of the API call without parameters- ct: the network connection type- detector_browser: the browser- detector_browser_version: the version of the browser- detector_device: the device- detector_os: the operating system- detector_os_version: the version of the operating system- domain: the domain name- ip_country_id: the ID of the country or area- ip_isp: the carrier- ip_region_id: the ID of the region- msg: the returned message- page: the URL of the page- sr: the screen resolution- count: the number of requests- fail_count: the number of failed API calls- fail_time: the response time for failed API calls- fail_uv: the number of users affected by failures- success_count: the number of successful API calls- success_rate: the success rate- success_time: the response time for successful API calls
webstat.apicostResponse time for successful API calls- api: the URL of the API call without parameters- code: the returned status code- detector_app_version: the client version- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- release: the version number- sr: the screen resolution- count: the number of successful API calls- avg_time: the average response time for successful API calls
webstat.apifailtimeResponse time for failed API calls- api: the URL of the API call without parameters- code: the returned status code- detector_app_version: the client version- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- release: the version number- sr: the screen resolution- count: the number of failed API calls- avg_time: the average response time for failed API calls
webstat.apimsgClassification and aggregation of API response messages- code: the returned status code- detector_app_version: the client version- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- msg: the error message- release: the version number- sr: the screen resolution- success: The value 1 indicates that the request is successful and the value 0 indicates that the request has failed.count: the number of requests
webstat.avgCustom statistics: average- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- key: the custom key- sr: the screen resolution- count: the total number of occurrences- pv: the number of page views- uv: the number of unique visitors- avg_val: the average value
webstat.errcateError message ranking- msg: the error message- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- detector_browser: the browser- detector_device: the device- detector_os: the operating system- sr: the screen resolution- release: the version number- environment: the environment- detector_app_version: the client version- detector_app: the client appcount: the number of resource errors
webstat.indexPage view overview- ct: the network connection type- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_isp: the carrier- ip_region_id: the ID of the region- page: the URL of the page- sr: the screen resolution- pv: the number of page views- uv: the number of unique visitors
webstat.msg.topFrequent errors- msg: the error message- page: the URL of the page- count: the number of errors- error_uv: the number of affected users- Ratio of affected users: the ratio obtained by dividing affected users by total UVs
webstat.perf.bucketPerformance Sample Distribution section on the Page Speed page in the ARMS console- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- page: the URL of the page- sr: the screen resolution- cfpt: the time that you estimate and preset for the first pixel to be painted on the screen- ctti: the time that you estimate and preset for a webpage to become fully interactive- dns: the time used for the DNS query- dom: the time used for the DOM resolution- fmp: the time taken for the primary content of the page to become visible- fpt: the time taken for the first pixel to be painted on the screen- load: the time taken for the page to be completely loaded- ready: the time taken for the DOM to become ready- res: the time used to load resources- ssl: the time used to establish an SSL connection- t1\~t10: the custom performance metrics- tcp: the time used to establish a TCP connection- trans: the time used to transfer data- ttfb: the response time to a request- tti: the time taken for a webpage to become fully interactive
webstat.perf.distributionPerformance Stacked Area Chart on the Page Speed page in the ARMS console- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- page: the URL of the page- sr: the screen resolution- cfpt: the time that you estimate and preset for the first pixel to be painted on the screen- ctti: the time that you estimate and preset for a webpage to become fully interactive- dns: the time used for the DNS query- dom: the time used for the DOM resolution- fmp: the time taken for the primary content of the page to become visible- fpt: the time taken for the first pixel to be painted on the screen- load: the time taken for the page to be completely loaded- ready: the time taken for the DOM to become ready- res: the time used to load resources- ssl: the time used to establish an SSL connection- t1\~t10: the custom performance metrics- tcp: the time used to establish a TCP connection- trans: the time used to transfer data- ttfb: the response time to a request- tti: the time taken for a webpage to become fully interactive
webstat.resourceResource error ranking- ct: the network connection type- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_isp: the carrier- ip_region_id: the ID of the region- node_name: the error type- page: the URL of the page- sr: the screen resolution- src: the resource informationcount: the number of resource errors
webstat.resourceResource Error section on the Overview page in the ARMS console- ct: the network connection type- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_isp: the carrier- ip_region_id: the ID of the region- node_name: the error type- page: the URL of the page- sr: the screen resolution- src: the resource informationcount: the number of resource errors
webstat.satisfySatisfaction- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- page: the URL of the page- sr: the screen resolution- bad: frustrated, indicating that the value of fpt is greater than 8,000- good: satisfied, indicating that the value of fpt is smaller than 2,000- neutral: tolerable, indicating that the value of fpt is between 2,000 and 8,000- satisfy: Application Performance Index (Apdex)
webstat.sessionSlow loading troubleshootingNone- browser_version: the browser version- browser: the browser- date: the start time of the data query- dom: the time used for the DOM resolution- ip_country_id: the ID of the country or area- ip_country: the name of the country or area- ip_region_id: the ID of the region- ip_region: the name of the region- load: the time taken for the page to be completely loaded- page: the URL of the page- sid: the session ID
webstat.speedAccess speed- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- release: the version number- sr: the screen resolution- page: the URL of the page- environment: the environment- avg_cfpt: the average of the time that you estimate and preset for the first pixel to be painted on the screen- count: the number of samples- avg_ctti: the average of the time that you estimate and preset for a webpage to become fully interactive- avg_dns: the average time used for the DNS query- avg_dom: the average time used for the DOM resolution- avg_fmp: the average time taken for the primary content of the page to become visible- avg_fpt: the average time taken for the first pixel is to be painted on the screen- avg_load: the average time taken for the page to be completely loaded- avg_ready: the average time taken for the DOM to become ready- avg_res: the average time used to load resources- avg_ssl: the average time used to establish an SSL connection- avg_t1\~t10: the custom performance metrics- avg_tcp: the average time used to establish a TCP connection- avg_trans: the average time used to transfer data- avg_ttfb: the average response time to a request- avg_tti: the average time taken for a webpage to become fully interactive
webstat.stableError rate ranking- page: the URL of the page- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- detector_browser: the browser- detector_device: the device- detector_os: the operating system- sr: the screen resolution- msg: the error message- release: the version number- environment: the environment- detector_app_version: the client version- detector_app: the client app- count: the number of samples- error_pv: the number of JS errors- rate: JS error rate
webstat.sumCustom statistics: sum- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- key: the custom key- sr: the screen resolution- count: the total number of occurrences of specified events- pv: the number of page views- sum_val: the total value- uv: the number of unique visitors
webstat.urlAccess URL- detector_browser: the browser- detector_device: the device- detector_os: the operating system- ip_country_id: the ID of the country or area- ip_region_id: the ID of the region- sr: the screen resolution- uid- username: the username- pv: the number of page views- uv: the number of unique visitors

Response parameters

ParameterTypeDescriptionExample
object

The information about the array object.

Codestring

The HTTP status code returned for the request. Valid values:

  • 2XX: The request was successful.
  • 3XX: A redirection message was returned.
  • 4XX: The request was invalid.
  • 5XX: A server error occurred.
200
Messagestring

The error message returned if the call fails.

StartTime is mandatory for this action.
RequestIdstring

The request ID.

687F9CB7-4798-57BF-A6EE-E6CC76******
Successboolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
true
Dataobject

The information about the array object.

PageSizeinteger

The number of entries returned per page.

1
Totalinteger

The total number of entries returned.

2
Pageinteger

The page number of the returned page.

1
Completedboolean

Whether the paging query ends.

true: end. false: Need to continue pagination (continue to query after CurrentPage+1).

false
Itemsobject []

The data entries returned.

object

The data entries returned.

[]

Sample response

{
  "RequestId": "687F9CB7-4798-57BF-A6EE-E6CC76******",
  "Data": {
    "PageSize": 1,
    "Total": 87,
    "Page": 1,
    "Items": [
      {
        "date": 1667287680000,
        "instanceCount": 17,
        "rule": "query1",
        "pid": "null"
      },
      {
        "date": 1667290680000,
        "instanceCount": 17,
        "rule": "query1",
        "pid": "null"
      }
    ]
  },
  "Code": 200,
  "Success": true
}

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "StartTime is mandatory for this action.",
  "RequestId": "687F9CB7-4798-57BF-A6EE-E6CC76******",
  "Success": true,
  "Data": {
    "PageSize": 1,
    "Total": 2,
    "Page": 1,
    "Completed": false,
    "Items": [
      []
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400ParameterMetricIllegalThe specified metric is invalid.The specified metric is invalid.
400ParameterMeasuresIllegalThe specified Measures is invalid.The specified Measures is invalid.
400ParameterTimeStampIllegalThe specified timeStamp is invalid.The specified timeStamp is invalid.
400ParameterOrderIllegalThe specified order is invalid.The specified order is invalid.
400ParameterZeroStrategyIllegalThe specified zeroStrategy is invalid.The specified zeroStrategy is invalid.
400ParameterPageSizeIllegalThe specified PageSize is invalid.The specified PageSize is invalid.
400ParameterIntervalIllegalThe specified interval is invalid.The specified interval is invalid.
400ParameterMeasuresMissingYou must specify measures.You must specify measures.
400ParameterDimensionsIllegalThe specified dimensions is invalid.The specified dimensions is invalid.
400ParameterPidMissingYou must specify pid.You must specify pid.
400ParameterRegionIdIllegalThe specified RegionId is invalid.The specified RegionId is invalid.
400InternalErrorInternal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.
403APINotAuthorizeThe current user is not authorized to access the interface.The current user is not authorized to access the interface.
404AppNotExistThe application does not exist.The application does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-25The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
    delete Error Codes: 404
2023-08-14The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
    Added Error Codes: 403
    Added Error Codes: 404
2023-06-09The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2021-10-09The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: CustomFilters
2021-10-09The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: CustomFilters

Browser Monitoring FAQ

  • Why does an error about the RAM permissions occur when I call the API? This is because the RAM user does not have required permissions. You can grant the permissions to the RAM user. For more information, see Use a RAM role to access resources across Alibaba Cloud accounts.

  • How do I obtain a list of data entries without specifying a time interval? Set the intervalInSec parameter to 2147483647.

  • Why is 0 returned for all the queries?

    • Check whether the time interval that you set is too short. Make sure that the value of the intervalInSec parameter is greater than or equal to 60,000.

    • Check whether the value of the regionId parameter is valid. The value depends on the region where the server that receives logs resides, rather than the region where you reside. You can identify the region ID based on the URL of the log source.

      • URL of the log source in the China (Hangzhou) region: https://arms-retcode.aliyuncs.com/r.png?
      • URL of the log source in the Singapore region: https://arms-retcode-sg.aliyuncs.com/r.png?
      • URL of the log source in the US (Silicon Valley) region: https://retcode-us-west-1.arms.aliyuncs.com/r.png?
  • Why does an error occur when I call the simulator or an API?

    • Check whether the regionId parameter is specified and whether the pid parameter is specified by using the Filters parameter.
    • Check whether you have specified a valid value of the Measures or Dimensions parameter for the metric. For more information, see the Browser Monitoring metrics that can be queried section in this topic.
  • Error messages and solutions

    • Query error. Contact the administrator.

      • Check whether the value of the Metric parameter is valid.
      • Check whether the value of the Measures or Dimensions parameter is valid.
      • Check whether the pid parameter is specified by using the Filters parameter.
    • InvalidIntervalInSec Check whether the value of the intervalInSec parameter exceeds the maximum value 2,147,483,647.

    • MissingMeasures Check whether the Measures parameter is specified.

    • NonsequenceParameter.Dimensions

      • Check whether the value of the Dimensions parameter is valid.
      • Check whether the value of the Dimensions parameter contains extra spaces.
    • ServiceUnavailable Check whether the value of the regionId parameter is valid.

    • Invalid Region Check whether the value of the regionId parameter is valid. The value depends on the region where the server that receives logs resides, rather than the region where you reside. You can identify the region ID based on the URL of the log source.

      • URL of the log source in the China (Hangzhou) region: https://arms-retcode.aliyuncs.com/r.png?
      • URL of the log source in the Singapore region: https://arms-retcode-sg.aliyuncs.com/r.png?
      • URL of the log source in the US (Silicon Valley) region: https://retcode-us-west-1.arms.aliyuncs.com/r.png?
  • Why are some Measures or Dimensions parameters missing from my dataset? This happens because you can specify a maximum of five Measures or Dimensions parameters. If more than five parameters are specified, no data can be returned.

  • Why does the sum of some metrics significantly decrease after they are aggregated compared with when they were not aggregated? For example, when the values of the pv parameter for the webstat.index metric are aggregated, the sum of aggregated values is significantly less than the sum of all the individual values. The API gateway admits a maximum of 10,000 data entries at a time. Additional data entries are discarded. When you attempt to aggregate more than 10,000 data entries, only the first 10,000 data entries are aggregated and the rest are discarded. This causes the aggregated result to be far less than the result of individually adding all the values. You must make sure that no more than 10,000 data entries are returned for each request. This ensures that you can obtain an accurate aggregated value.