文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据服务API/ 总览接口/ 查询统计用户相关的总览调用指标
更新时间:2024-11-06 GMT+08:00

查询统计用户相关的总览调用指标

功能介绍

查询统计用户相关的总览调用指标。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/service/statistic/apps-overview

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

表2 Query参数

参数

是否必选

参数类型

描述

start_time

Long

开始时间(13位时间戳)。

end_time

Long

结束时间(13位时间戳)。

time_unit

String

时间单位。

枚举值:

  • HOUR:小时为单位

  • DAY:天为单位

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

workspace

String

工作空间ID,获取方法请参见实例ID和工作空间ID

Dlm-Type

String

数据服务的版本类型,指定SHARED共享版或EXCLUSIVE专享版。

Content-Type

String

消息体的类型(格式),有Body体的情况下必选,没有Body体无需填写。如果请求消息体中含有中文字符,则需要通过charset=utf8指定中文字符集,例如取值为:application/json;charset=utf8。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

apply_num

Integer

申请量。

call_num

Integer

调用总量。

success_num

Integer

成功调用量(取数成功)。

fail_num

Integer

失败调用量(取数失败)。

legal_num

Integer

合法调用量(通过校验)。

illegal_num

Integer

非法调用量(无法通过校验)。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询统计用户相关的总览调用指标。

/v1/0833a5737480d53b2f250010d01a7b88/service/statistic/apps-overview

响应示例

状态码: 200

查询统计用户相关的总览调用指标成功。

{
  "apply_num" : 4,
  "call_num" : 10,
  "success_num" : 9,
  "fail_num" : 1,
  "legal_num" : 10,
  "illegal_num" : 0
}

状态码

状态码

描述

200

查询统计用户相关的总览调用指标成功。

400

BadRequest。