导出用户使用统计数据 - ExportUserUsageMetricV3
功能介绍
导出用户使用统计信息;
最多导出30天内的数据;
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:statistics:exportUserMetrics
List
-
-
-
-
URI
GET /v3/{project_id}/statistics/metrics/users/export
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
start_time |
是 |
String |
查询起始时间(0时区)。 |
|
end_time |
是 |
String |
查询截至时间(0时区)。 |
|
username |
否 |
String |
用户名(模糊匹配)。 |
|
usage_min_hours |
否 |
Integer |
使用时长最小值。 |
|
usage_max_hours |
否 |
Integer |
使用时长最大值 usage_min_hours和usage_max_hours同时存在时,usage_max_hours必须大于等于usage_min_hours |
|
enterprise_project_id |
否 |
String |
企业项目ID。 |
|
sort_field |
否 |
String |
按照指标进行排序
|
|
sort_type |
否 |
String |
按照指标进行排序的方向;需配合sort_field起义使用
|
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
导出任务id。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
导出任务id。 |
|
400 |
客户端请求有误。 |
|
401 |
鉴权失败。 |
|
500 |
内部错误。 |
错误码
请参见错误码。
