文档首页/微服务引擎 CSE/API参考/CSE API/微服务治理/查询上报信息列表 - QueryReportedInformationList
更新时间：2025-12-31 GMT+08:00
查看PDF
分享

查询上报信息列表 - QueryReportedInformationList

功能介绍

查询上报信息列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v3/{project_id}/csemonitor/metric/list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户子项目的唯一标识。字符长度为1~64。

表2 Query参数

参数

是否必选

参数类型

描述

page

否

String

分页页码。

number

否

String

分页大小。

sortType

否

String

排序类型。

取值范围：

  • increase：升序。
  • decrease：降序。

sortKey

否

String

指定排序字段。

取值范围：

  • name
  • qps
  • latency
  • total

appIds

否

String

查询的应用列表，以逗号分隔。

nameFilter

否

String

过滤的名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

X-Enterprise-Project-ID

否

String

如果不带则默认企业项目为“default”，ID为“0”。

Content-Type

是

String

该字段内容填为 "application/json;charset=UTF-8"。

Accept

是

String

该字段内容填为 "application/json"。

响应参数

状态码： 200
表4 响应Body参数

参数

参数类型

描述

list

Array of KeyObject

key列表。

appIds

Array of String

应用ID列表。

page

Integer

分页页码。

number

Integer

当前页的数量。

total

Integer

查询总数。

表5 KeyObject

参数

参数类型

描述

key

String

key值。

serviceId

String

服务ID。

serviceName

String

服务名称。

appId

String

应用ID。

version

String

版本。

environment

String

环境名称。

custom

Map object

自定义信息。

状态码： 400
表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

detail

String

详细定位信息。

状态码： 500
表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

detail

String

详细定位信息。

请求示例

GET https://{endpoint}/v3/{project_id}/csemonitor/metric/list

响应示例

状态码： 200

success

{
  "list": [
    {
      "key": "string",
      "serviceId": "string",
      "appId": "string",
      "version": "string",
      "environment": "string",
      "custom": {
        "key": 1.0
      }
    }
  ],
  "appIds": ["string", "string"],
  "page": 0,
  "number": 0,
  "total": 0
}

状态码

状态码

描述

200

success

400

错误的请求。

500

服务器内部错误。

错误码

请参见CSE错误码。

父主题：微服务治理