GetArmsTopNMetric - GetArmsTopNMetric

调用GetArmsTopNMetric接口获取应用监控的Top N应用列表。

调试

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

授权信息

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

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

请求语法

GET /pop/v1/sam/getArmsTopNMetric HTTP/1.1

请求参数

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

地域 ID。

cn-hangzhou
OrderBystring

排序字段,根据查询返回字段中的某个字段排序。

count
Limitlong

返回数据条数,取值范围[0,100]。

10
StartTimelong

查询起始时间。

1675823135951
EndTimelong

查询终止时间。

1675824035951
AppSourcestring

SAE 应用类型。

  • micro_service。
  • web。
  • job。
micro_service
CpuStrategystring

CPU 分配策略。

  • request:仅在有请求时分配 CPU。
  • always:始终分配固定 CPU。
always

返回参数

名称类型描述示例值
object
Messagestring

附加信息。取值说明如下:

  • 请求正常,返回 success
  • 请求异常,返回具体异常错误码。
success
RequestIdstring

请求 ID。

3B763F98-0BA2-5C23-B6B8-558568D2****
Dataarray<object>

应用信息列表。

ArmsMetricDtoobject

应用信息。

AppIdstring

应用 ID。

7171a6ca-d1cd-4928-8642-7d5cfe69****
Namestring

应用名称。

test
RegionIdstring

命名空间 ID。

cn-hangzhou
Countlong

总请求量,单位个。

100
Errorlong

错误数,单位个。

0
Rtlong

平均响应时间,单位 ms。

100
Codestring

接口状态或 POP 错误码。取值说明如下:

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

获取应用列表。取值说明如下:

  • true:获取成功。
  • false:获取失败。
true

示例

正常返回示例

JSON格式

{
  "Message": "success",
  "RequestId": "3B763F98-0BA2-5C23-B6B8-558568D2****",
  "Data": [
    {
      "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
      "Name": "test",
      "RegionId": "cn-hangzhou",
      "Count": 100,
      "Error": 0,
      "Rt": 100
    }
  ],
  "Code": "200",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.NotEmptyYou must specify the parameter %s.不合法的参数:%s不能为空。
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.不合法的参数{%s}。
400InvalidParameter.WithMessageThe parameter is invalid {%s}: %s不合法的参数{%s}:%s。

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

变更历史

变更时间变更内容概要操作
2024-03-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情