文档

GetAppApiByPage - 查询接口的黄金三指标数据

更新时间:

通过分页的形式查询应用下每个接口的请求量、错误数、平均响应时间三种性能数据。可通过返回信息中的Completed字段判断分页是否结束。如未结束,CurrentPage参数加一后继续发起查询即可。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:GetAppApiPageInfonone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
StartTimelong

开始时间的时间戳,精确到毫秒。

1600063200000
EndTimelong

结束时间的时间戳,精确到毫秒。

1600066800000
CurrentPageinteger

查询结果的页码。

1
PageSizeinteger

此参数已不支持使用。查询结果的每页项目数量。默认为 10。

10
IntervalMillsinteger

数据片的时间间隔,单位为毫秒,最小值为 60000,最大值为 2147483647。

60000
PIdstring

应用 ID。

在 ARMS 控制台的应用监控>应用列表页面单击目标应用名称。此时浏览器地址栏中的 URL 即包含应用的 pid,格式为 pid=xxx。由于浏览器进行了编码,因此需要对 pid 稍作修改。例如,如果 URL 中包含的 pid 为 xxx%4074xxx,则需要将%40 替换为@,即:xxx@74xxx。

a2n80plglh@745eddxxx

返回参数

名称类型描述示例值
object
Codeinteger

接口状态。

  • 2XX:成功。
  • 3XX:重定向。
  • 4XX:请求错误。
  • 5XX:服务器错误。
200
Messagestring

返回结果的提示信息。

message
RequestIdstring

请求 ID。

B6A00968-82A8-4F14-9D1B-B53827DB****
Successboolean

查询是否成功。

  • true:成功。
  • false:失败。
true
Dataobject

返回结构体。

PageSizeinteger

返回结果的每页项目数量。

10
Totalstring

返回结果的总项目数量。

说明 此参数的返回值为估算值,仅用于分页结束判断,不代表实际的数据总量
2
Pageinteger

返回结果的页码。

1
Completedboolean

分页查询是否结束。

  • true:结束。
  • false:需要继续分页(CurrentPage+1 后继续查询)。
false
Itemsarray<object>

返回应用接口的黄金三指标数据

object

接口的黄金三指标数据

{
     "date": 1691051460000, //发生时间
     "rt": 89.61016949152541,  //平均响应时间
     "rpc": "/api/v1/info",  //接口
     "count": 59,  //请求数
     "error": 1  //错误数
}
[]

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "message",
  "RequestId": "B6A00968-82A8-4F14-9D1B-B53827DB****",
  "Success": true,
  "Data": {
    "PageSize": 10,
    "Total": "2",
    "Page": 1,
    "Completed": false,
    "Items": [
      []
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ParameterIllegalThe specified parameter is invalid.参数非法
400ParameterRegionIllegalThe specified region is invalid.地域参数非法
403RetcodeDailyCustomLimitUsage today has exceeded the custom limit. The current operation is prohibited.今日使用额度已经超过自定义额度,当前操作被禁止。
403RetcodeDailyFreeLimitUsage today has exceeded the Essential Edition limit. The current operation is prohibited.今日使用额度已经超过基础版限定量,当前操作被禁止。
404AppNotExistThe application does not exist.应用不存在
404RunningTaskNotExistApplication data collection task does not exist or has been stopped.应用数据采集任务不存在或已停止
429OperationIsThrottledThe backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again.后端服务无法完整的处理当前请求,返回结果可能是不完整的,请调整操作条件后重试。
452OperationTimeOutThe system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again.系统在处理当前请求时出现了超时,可能是请求涉及的资源过多导致系统无法在限定时间内处理完毕,请调整相关条件后重试。
500InternalErrorInternal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.内部错误,建议重试。如果多次重试报错请联系钉钉服务账号。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-19OpenAPI 错误码发生变更查看变更详情
2024-05-28OpenAPI 错误码发生变更查看变更详情
2024-01-25OpenAPI 错误码发生变更查看变更详情
2023-06-09OpenAPI 返回结构发生变更查看变更详情