Querying User Data Details

Function

Queries the user resource usage in a period.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/data-analysis

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records displayed on each page. Value range: 1~1000 Default value: 10
offset	No	Integer	Offset where the query starts. Value range: 0~2147483647 Default value: 0
start_time	Yes	String	Start time of the query period. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
end_time	Yes	String	End time of the query period. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
user_id	No	String	User ID (This parameter is valid only for accounts enabled with IAM user isolation.)
resource_type	No	String	Resource type. video_time_2d_model: virtual avatar video production video_time_flexus_2d_model: virtual avatar video production (Flexus edition)
business_type	No	String	Service type. LIVE_2D: virtual avatar livestreaming VIDEO_2D: virtual avatar video production
unit	No	String	Usage unit. MIN HOUR

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. You can obtain the token by calling the IAM API used to obtain a user token. Value of X-Subject-Token in the response header.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication. The format is YYYYMMDD'T'HHMMSS'Z'.
X-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.
X-App-UserId	No	String	Third-party user ID, which does not allow Chinese characters.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 5** Response body parameters
Parameter	Type	Description
count	Integer	Total number of resources. Value range: 0~2147483647
time_list	Array of TimeResourceUsageInfo objects	Resource usage list.

**Table 6** TimeResourceUsageInfo
Parameter	Type	Description
time	String	Start time of the query period. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
resources_usage	Array of ResourceUsageInfo objects	Resource usage list.

**Table 7** ResourceUsageInfo
Parameter	Type	Description
resource_type	String	Resource type.
business_type	String	Service type. LIVE_2D: virtual avatar livestreaming VIDEO_2D: virtual avatar video production
number	Integer	Number of used resources (number of produced videos and number of livestream sessions) Value range: 0~1000000
usage	Float	Usage. Value range: 0~1000000
unit	String	Usage unit. MIN HOUR

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

GET https://{endpoint}/v1//{project_id}/data-analysis

Example Responses

Status code: 400

Parameters error, including the error code and its description.

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

Status code: 401

Authentication is not performed or fails.

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

Status code: 403

Not authorized.

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

Status code: 500

Internal service error.

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

Status Codes

Status Code	Description
200	Response to the request for creating a data analysis task.
400	Parameters error, including the error code and its description.
401	Authentication is not performed or fails.
403	Not authorized.
500	Internal service error.