Querying Usage

Function

This API is used to query usage data of various services in a past period.

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}/rtc/history/usage

**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
app	Yes	String	Application identifier.
metric	Yes	String	Type of data to be queried. CommunicationDuration: audio and video call duration
start_date	Yes	String	Time when the query starts. UTC time in the format of YYYY-MM-DD, for example, 2020-04-23. If this parameter is not specified, data of the last day is read by default.
end_date	Yes	String	Queries end time. UTC time in the format of YYYY-MM-DD, for example, 2020-04-23.

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. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Authorization	No	String	Authentication information. This parameter is mandatory when AK/SK-based authentication is used.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.
X-Project-Id	No	String	Project ID, which is the same as that used in the URI. This parameter is mandatory when AK/SK-based authentication is used.

Response Parameters

Status code: 200

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

**Table 5** Response body parameters
Parameter	Type	Description
usage	Array of RtcHistoryUsage objects	Timestamp and metric value list at the corresponding time

**Table 6** RtcHistoryUsage
Parameter	Type	Description
date	String	Sampling time. The format must comply with the ISO 8601 standard (UTC time). The format is YYYY-MM-DD.
video_sd	Long	SD video duration, in seconds.
video_hd	Long	HD video duration, in seconds.
video_hdp	Long	UHD video duration, in seconds.
audio	Long	Audio duration, in seconds.
total_duration	Long	Total audio and video duration, in seconds.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

GET /v1/{project_id}/rtc/history/usage?app=5fa682b34a974f7ad24d223b&metric=CommunicationDuration&start_date=2020-04-23&end_date=2020-04-26

Example Responses

Status code: 200

This status code is returned if the request succeeds.

{
  "usage" : [ {
    "date" : "2020-06-04",
    "video_sd" : 1,
    "video_hd" : 1,
    "video_hdp" : 1,
    "audio" : 1,
    "total_duration" : 4
  } ]
}

Status code: 400

This status code is returned if the request fails.

{
  "error_code" : "DATA.100011001",
  "error_msg" : "Required String parameter 'app' is not present"
}

Status Codes

Status Code	Description
200	This status code is returned if the request succeeds.
400	This status code is returned if the request fails.

Error Codes

See Error Codes.

Parent topic: Statistical Analysis

Previous topic: Querying Real-Time Network Data

Next topic: Querying Historical Scale Data

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot