文档首页/ 密码安全中心 DEW/ API参考/ API/ 云平台密码系统服务/ 资源监控/ 获取应用状态监控 - ShowStatusApp
更新时间：2026-06-11 GMT+08:00
查看PDF
分享

获取应用状态监控 - ShowStatusApp

功能介绍

CPCS服务创建的应用状态监控

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    cpcs::getStatusApp

    Read

    -

    -

    cpcs:system:getStatusApp

    -

URI

GET /v1/{project_id}/dew/cpcs/app/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

cluster_id

否

String

参数解释：

集群ID，默认空字符串，默认查询所有集群。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

app_id

否

String

参数解释：

应用ID，默认空字符串，默认查询所有应用。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

instance_id

否

String

参数解释：

集群ID，默认空字符串，默认查询所有集群。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

from

否

Long

参数解释：

查询范围起始时间，毫秒时间戳，默认为0，默认查询三天前。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

to

否

Long

参数解释：

查询范围终止时间，毫秒时间戳，默认为0，默认查询到当前时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

period

否

Integer

参数解释：

数据统计周期，默认0，默认为5分钟。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

filter

否

String

参数解释：

统计类型，默认min，默认用统计周期中数据的最小值。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

server_type

否

String

参数解释：

服务类型，默认空字符串，默认查询所有服务类型。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。使用AK、SK等认证方式，此处非必选

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

metric_name

String

参数解释：

资源名称

取值范围：

不涉及

app_list

Array of ShowStatusAppItem objects

参数解释：

应用列表

取值范围：

不涉及

total_access_count

Long

参数解释：

总访问次数

取值范围：

不涉及

success_access_count

Long

参数解释：

成功访问次数

取值范围：

不涉及
表5 ShowStatusAppItem

参数

参数类型

描述

success_rate

Double

参数解释：

成功率

取值范围：

不涉及

fail_rate

Double

参数解释：

失败率

取值范围：

不涉及

success_count

Long

参数解释：

成功次数

取值范围：

不涉及

total_count

Long

参数解释：

总次数

取值范围：

不涉及

average_value

Double

参数解释：

平均值

取值范围：

不涉及

total_value

Double

参数解释：

总数

取值范围：

不涉及

app_id

String

参数解释：

应用ID

取值范围：

不涉及

app_name

String

参数解释：

应用名称

取值范围：

不涉及

status

String

参数解释：

应用状态

取值范围：

不涉及

请求示例

  • 应用健康状态：不传appId 返回全量的 app信息

    /v1/{project_id}/dew/cpcs/app/status?appId=

  • 应用健康状态：传appId 返回指定的app信息

    /v1/{project_id}/dew/cpcs/app/status?appId=7bc173a0-1ab8-45ec-8dc7-3b84ec59e9d3

响应示例

状态码：200

正常返回

{
  "metric_name" : "应用健康状态",
  "app_list" : [ {
    "success_rate" : 0,
    "fail_rate" : 0,
    "success_count" : 0,
    "total_count" : 0,
    "average_value" : 0,
    "total_value" : 0,
    "app_id" : "609e2dca2a184dfda1e733f3749963f5",
    "app_name" : "12",
    "status" : null
  } ],
  "total_access_count" : 0,
  "success_access_count" : 0
}

状态码

状态码

描述

200

正常返回

错误码

请参见错误码。

父主题： 资源监控

相关文档