GetAppApiByPage - 查询接口的黄金三指标数据_应用实时监控服务(ARMS)-阿里云帮助中心

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
arms:GetAppApiPageInfo	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
StartTime	long	是	开始时间的时间戳，精确到毫秒。	1600063200000
EndTime	long	是	结束时间的时间戳，精确到毫秒。	1600066800000
CurrentPage	integer	是	查询结果的页码。	1
PageSize	integer	否	此参数已不支持使用。查询结果的每页项目数量。默认为 10。	10
IntervalMills	integer	否	数据片的时间间隔，单位为毫秒，最小值为 60000，最大值为 2147483647。	60000
PId	string	是	应用 ID。在 ARMS 控制台的应用监控>应用列表页面单击目标应用名称。此时浏览器地址栏中的 URL 即包含应用的 pid，格式为 pid=xxx。由于浏览器进行了编码，因此需要对 pid 稍作修改。例如，如果 URL 中包含的 pid 为 xxx%4074xxx，则需要将%40 替换为@，即：xxx@74xxx。	a2n80plglh@745eddxxx

返回参数

名称	类型	描述	示例值
	object
Code	integer	接口状态。 2XX：成功。 3XX：重定向。 4XX：请求错误。 5XX：服务器错误。	200
Message	string	返回结果的提示信息。	message
RequestId	string	请求 ID。	B6A00968-82A8-4F14-9D1B-B53827DB****
Success	boolean	查询是否成功。 `true`：成功。 `false`：失败。	true
Data	object	返回结构体。
PageSize	integer	返回结果的每页项目数量。	10
Total	string	返回结果的总项目数量。说明此参数的返回值为估算值，仅用于分页结束判断，不代表实际的数据总量	2
Page	integer	返回结果的页码。	1
Completed	boolean	分页查询是否结束。 true：结束。 false：需要继续分页（CurrentPage+1 后继续查询）。	false
Items	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	错误码	错误信息	描述
400	ParameterIllegal	The specified parameter is invalid.	参数非法
400	ParameterRegionIllegal	The specified region is invalid.	地域参数非法
404	AppNotExist	The application does not exist.	应用不存在
500	InternalError	Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.	内部错误，建议重试。如果多次重试报错请联系钉钉服务账号。

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

变更历史

变更时间

变更内容概要

操作

2024-01-25

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	新增错误码：400
	新增错误码：404
	新增错误码：500

2023-06-09

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。