查询用户数据概览
功能介绍
获取周期内用户的资源使用情况概览
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/data-analysis-summary
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
user_id |
否 |
String |
用户id(仅开启了子账号隔离功能的主账号携带才生效) |
|
resource_type |
否 |
String |
资源类型
|
|
business_type |
否 |
String |
业务类型
|
|
unit |
否 |
String |
使用量的单位。
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
请求ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_type |
String |
资源类型 |
|
business_type |
String |
业务类型
|
|
number |
Integer |
使用个数(视频制作的视频个数,直播的场次) 取值范围: 0-1000000 |
|
usage |
Float |
使用量 取值范围: 0-1000000 |
|
unit |
String |
使用量的单位。
|
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
GET https://{endpoint}/v1//{project_id}/data-analysis-summary
响应示例
状态码: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 |
内部服务错误。 |
错误码
请参见错误码。