更新时间:2025-08-26 GMT+08:00

查询用户数据详情

功能介绍

获取周期内用户的资源使用情况

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/data-analysis

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页显示的条目数量。

取值范围:

1-1000

默认取值:

10

offset

Integer

偏移量,表示从此偏移量开始查询。

取值范围:

0-2147483647

默认取值:

0

start_time

String

查询时间段开始时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"

end_time

String

查询时间段结束时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"

user_id

String

用户id(仅开启了子账号隔离功能的主账号携带才生效)

resource_type

String

资源类型

business_type

String

业务类型

  • LIVE_2D:分身数字人视频直播

  • VIDEO_2D:分身数字人视频制作

unit

String

使用量的单位。

  • MIN:分钟

  • HOUR:小时

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

格式为(YYYYMMDD'T'HHMMSS'Z')。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息。

X-App-UserId

String

第三方用户ID。不允许输入中文。

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表5 响应Body参数

参数

参数类型

描述

count

Integer

资源总数。

取值范围:

0-2147483647

time_list

Array of TimeResourceUsageInfo objects

资源用量列表

表6 TimeResourceUsageInfo

参数

参数类型

描述

time

String

查询时间段开始时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"

resources_usage

Array of ResourceUsageInfo objects

资源用量列表

表7 ResourceUsageInfo

参数

参数类型

描述

resource_type

String

资源类型

business_type

String

业务类型

  • LIVE_2D:分身数字人视频直播

  • VIDEO_2D:分身数字人视频制作

number

Integer

使用个数(视频制作的视频个数,直播的场次)

取值范围:

0-1000000

usage

Float

使用量

取值范围:

0-1000000

unit

String

使用量的单位。

  • MIN:分钟

  • HOUR:小时

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

响应示例

状态码:400

请求传参异常,包含错误码及对应描述。

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

状态码:401

未鉴权或鉴权失败。

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

状态码:403

未授权。

{
  "error_code" : "MSS.00000005",
  "error_msg" : "Forbidden"
}

状态码:500

内部服务错误。

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

状态码

状态码

描述

200

创建数据分析接口响应

400

请求传参异常,包含错误码及对应描述。

401

未鉴权或鉴权失败。

403

未授权。

500

内部服务错误。

错误码

请参见错误码