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

查询微服务上报信息

功能介绍

查询微服务上报信息。

URI

GET /v3/{project_id}/csemonitor/metric

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户子项目的唯一标识。字符长度为1~64。
表2 Query参数

参数

是否必选

参数类型

描述

service

是

String

服务名称列表，以“,”分隔。

instance

否

String

实例名称。

function

否

String

方法名称。

flag

否

String

批量查询标记。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

X-Enterprise-Project-ID

否

String

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

缺省值：0

Content-Type

是

String

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

Accept

是

String

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

响应参数

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

参数

参数类型

描述

success

Array of MetricInfo objects

查询结果。
表5 MetricInfo

参数

参数类型

描述

time

Long

时间戳。

appId

String

服务appId。

version

String

服务版本号。

qps

Double

每秒请求量，单位：个。

latency

Double

时延，单位：毫秒。

rate

Double

成功率，百分比（0-100）。

failureRate

Double

失败率，百分比（0-100）。

total

Long

请求总量。

breakerRateAgg

Float

平均熔断率。

circuitBreakerOpen

Boolean

当前熔断状态。

failure

Long

失败总个数。

shortCircuited

Long

总短路个数。

semaphoreRejected

Long

总信号量拒绝个数。

threadPoolRejected

Long

总线程池拒绝个数。

countTimeout

Long

总超时个数。

l995

double

所有请求时延从小到大排序，前99.5%的时延。

l99

double

所有请求时延从小到大排序，前99%的时延。

l90

double

所有请求时延从小到大排序，前90%的时延。

l75

double

所有请求时延从小到大排序，前75%的时延。

l50

double

所有请求时延从小到大排序，前50%的时延。

l25

double

所有请求时延从小到大排序，前25%的时延。

l5

double

所有请求时延从小到大排序，前5%的时延。

name

String

名称。

serviceId

String

服务Id。

instanceCount

Long

服务实例数量。

environment

String

环境名称。

diagnosis

Array of Diagnosisobject

服务诊断结果。

instanceId

String

实例Id。

thread

Integer

线程数量。

cpu

Double

cpu使用率，百分比。

memory

Map object

内存使用率，百分比。

functionCount

Long

函数方法数量。

customs

Map object

用户自定义变量。

providersCache

Array of ProviderCache object

服务端实例集合。

functionType

String

方法类型。
表6 ProviderCache

参数

参数类型

描述

appId

String

应用Id。

microserviceName

String

服务名称。

detail

String

细节信息。

pulledInstances

Array of ProviderInstance object

服务提供者实例信息。

status

String

状态信息。
表7 ProviderInstance

参数

参数类型

描述

instanceId

String

实例Id。

endpoints

Array of String

实例接入点信息列表。

hostName

String

实例域名。

timestamp

String

时间戳。
表8 Diagnosis

参数

参数类型

描述

instanceCache

Array of InstanceCache object

服务实例缓存结果。
表9 InstanceCache

参数

参数类型

描述

status

String

检查状态。

枚举值：

  • NORMAL
  • ABNORMAL
  • UNKNOWN

timestamp

Long

时间戳。

producers

Array of Producer object

服务提供者列表。

checkTime

Long

检测时间，如果有异常时，显示最新的异常时间，否则为最新的检测时间。

latestStatus

String

检查状态。

枚举值：

  • NORMAL
  • ABNORMAL
  • UNKNOWN
表10 Producer

参数

参数类型

描述

status

String

检查状态。

枚举值：

  • NORMAL
  • ABNORMAL
  • UNKNOWN

appId

String

应用ID。

microserviceName

String

微服务名称。

detail

String

详细信息。
状态码： 400
表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

detail

String

详细定位信息。
状态码： 500
表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

detail

String

详细定位信息。

请求示例

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

响应示例

状态码： 200

success

[
  [
    {
      "time": 1733973104652,
      "appId": "weathermap",
      "version": "0.0.2",
      "qps": 0.0,
      "latency": 0.0,
      "failureRate": 0.0,
      "total": 0,
      "breakerRateAgg": 0.0,
      "circuitBreakerOpen": false,
      "failure": 0,
      "shortCircuited": 0,
      "semaphoreRejected": 0,
      "threadPoolRejected": 0,
      "countTimeout": 0,
      "l995": 0,
      "l99": 0,
      "l90": 0,
      "l75": 0,
      "l50": 0,
      "l25": 0,
      "l5": 0,
      "serviceId": "da21c8749d7ca08047b7d8da63f79e296127c21b",
      "instanceCount": 10,
      "environment": "",
      "diagnosis": {
        "instanceCache": null
      },
      "name": "weather"
    }
  ]
]

状态码

状态码

描述

200

success

400

错误的请求。

500

服务器内部错误。

错误码

请参见CSE错误码。

父主题： 微服务治理

相关文档