Real User Monitoring

Real User Monitoring
API Documentation
Product Documentation©2013-2022 Tencent Cloud. All rights reserved.

Page 1 of 289

Real User Monitoring

Copyright Notice©2013-2024 Tencent Cloud. All rights reserved.
Copyright in this document is exclusively owned by Tencent Cloud. You must not reproduce, modify, copy or distributein any way, in whole or in part, the contents of this document without Tencent Cloud's the prior written consent.
Trademark Notice

All trademarks associated with Tencent Cloud and its services are owned by Tencent Cloud Computing (Beijing)
Company Limited and its affiliated companies. Trademarks of third parties referred to in this document are owned bytheir respective proprietors.
Service Statement
This document is intended to provide users with general information about Tencent Cloud's products and services
only and does not form part of Tencent Cloud's terms and conditions. Tencent Cloud's products or services are
subject to change. Specific products and services and the standards applicable to them are exclusively provided for in
Tencent Cloud's applicable terms and conditions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 2 of 289

Real User Monitoring

Contents
API Documentation
History
Introduction
API Category
Making API Requests
Request Structure
Common Params
Signature v3
Signature
Responses
Console APIs
DescribeError
DescribeWhitelists
DescribeUvList
DescribeTawInstances
DescribeTawAreas
DescribeReleaseFiles
DescribeReleaseFileSign
DescribePvList
DescribeDataPvUrlInfo
DescribeDataLogUrlInfo
DescribeData
DeleteWhitelist
DeleteReleaseFile
CreateWhitelist
CreateReleaseFile
Log APIs
DescribeRumStatsLogList
DescribeRumLogList
DescribeRumGroupLog
DescribeRumLogExports
DescribeRumLogExport
Page View APIs
DescribeDataPvUrlStatistics
Page Performance APIs

©2013-2022 Tencent Cloud. All rights reserved.

Page 3 of 289

Real User Monitoring

DescribeDataPerformancePage
DescribeDataWebVitalsPage
DescribeDataSetUrlStatistics
Static Resource Monitoring APIs
DescribeDataStaticUrl
DescribeDataStaticResource
DescribeDataStaticProject
Custom Speed Test APIs
DescribeDataCustomUrl
Custom Event APIs
DescribeDataEventUrl
Exception Analysis APIs
DescribeDataLogUrlStatistics
Business System and Project Information APIs
ResumeProject
CreateProject
DescribeProjects
DescribeProjectLimits
DescribeScores
StopInstance
ResumeInstance
ModifyProjectLimit
ModifyProject
ModifyInstanceDescribeDataReportCount
DeleteStarProject
DeleteProject
DeleteInstance
CreateTawInstance
CreateStarProject
StopProject
API Monitoring APIs
DescribeDataFetchUrlInfo
DescribeDataFetchUrl
DescribeDataFetchProject
Data Types
Error Codes©2013-2022 Tencent Cloud. All rights reserved.

Page 4 of 289

Real User Monitoring

API Documentation
History：

Last updated 2023-07-06 17:39:22

Release 12
Release time: 2023-07-06 17:03:04
Release updates:
Improvement to existing documentation.
Modified APIs:
CreateTawInstanceNew input parameters:InstanceType
Modified data structures:
RumProject
New members:AccessPoint

Release 11
Release time: 2023-04-27 15:43:04
Release updates:
Improvement to existing documentation.
Modified APIs:
DescribeReleaseFileSign
New input parameters:FileType

Release 10
Release time: 2023-02-27 16:43:20
Release updates:©2013-2022 Tencent Cloud. All rights reserved.

Page 5 of 289

Real User Monitoring

Improvement to existing documentation.
New APIs:
DescribeRumLogExport
DescribeRumLogExports
ResumeProject

Release 9
Release time: 2023-02-03 14:32:42
Release updates:
Improvement to existing documentation.
Modified data structures:
ScoreInfo
New members:CreateTime

Release 8
Release time: 2023-01-31 15:47:45
Release updates:
Improvement to existing documentation.
New APIs:
DescribeRumGroupLog
DescribeRumLogList
DescribeRumStatsLogList
StopProject

Release 7
Release time: 2023-01-06 16:38:31
Release updates:
Improvement to existing documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 6 of 289

Real User Monitoring

Modified APIs:
CreateTawInstanceNew output parameters:DealName

Release 6
Release time: 2022-12-29 14:41:36
Release updates:
Improvement to existing documentation.
Modified APIs:
CreateTawInstanceNew input parameters:ResourcePackageType, ResourcePackageNum
CreateWhitelist
New output parameters:ID

Release 5
Release time: 2022-11-01 10:46:11
Release updates:
Improvement to existing documentation.
Modified APIs:
DescribeDataFetchUrl
New input parameters:NetStatus
DescribeDataPerformancePage
New input parameters:NetStatus

Release 4
Release time: 2022-09-28 10:16:34
Release updates:
Improvement to existing documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 7 of 289

Real User Monitoring

Modified data structures:
RumAreaInfo
New members:AreaRegionID, AreaRegionCode, AreaAbbr

Release 3
Release time: 2022-08-03 19:44:51
Release updates:
Improvement to existing documentation.
New APIs:
DescribeProjects
DescribeScores
Modified APIs:
DescribeDataFetchProject
New input parameters:Status, Ret
DescribeDataFetchUrl
New input parameters:Status, Ret
DescribeDataSetUrlStatistics
New input parameters:PackageType
New data structures:
Filter
RumProject
ScoreInfo

Release 2
Release time: 2022-04-12 16:04:29
Release updates:
Improvement to existing documentation.
Deleted APIs:©2013-2022 Tencent Cloud. All rights reserved.

Page 8 of 289

Real User Monitoring

DescribeProjects
DescribeScores
DescribeTawInstances
Modified APIs:
CreateTawInstanceNew input parameters:BuyingChannel
Deleted data structures:
FilterRumInstanceInfo
RumProject
ScoreInfo

Release 1
Release time: 2022-02-22 16:10:47
Release updates:
Improvement to existing documentation.
New APIs:
CreateLogExport
CreateOfflineLogConfig
CreateProject
CreateReleaseFile
CreateStarProject
CreateTawInstance
CreateWhitelist
DeleteInstanceDeleteLogExport
DeleteOfflineLogConfig
DeleteOfflineLogRecord
DeleteProject
DeleteReleaseFile
DeleteStarProject
DeleteWhitelist©2013-2022 Tencent Cloud. All rights reserved.

Page 9 of 289

Real User Monitoring

DescribeData
DescribeDataCustomUrl
DescribeDataEventUrl
DescribeDataFetchProject
DescribeDataFetchUrl
DescribeDataFetchUrlInfo
DescribeDataLogUrlInfo
DescribeDataLogUrlStatistics
DescribeDataPerformancePage
DescribeDataPerformanceProject
DescribeDataPvUrlInfo
DescribeDataPvUrlStatistics
DescribeDataReportCount
DescribeDataSetUrlStatistics
DescribeDataStaticProject
DescribeDataStaticResource
DescribeDataStaticUrl
DescribeDataWebVitalsPage
DescribeError
DescribeLogExports
DescribeLogList
DescribeOfflineLogConfigs
DescribeOfflineLogRecords
DescribeOfflineLogs
DescribeProjectLimits
DescribeProjects
DescribePvList
DescribeReleaseFileSign
DescribeReleaseFiles
DescribeScores
DescribeTawAreas
DescribeTawInstances
DescribeUvList
DescribeWhitelists
ModifyInstance
ModifyProject
ModifyProjectLimit
ResumeInstance©2013-2022 Tencent Cloud. All rights reserved.

Page 10 of 289

Real User Monitoring

StopInstanceNew data structures:
FilterLogExport
ProjectLimit
ReleaseFile
RumAreaInfo
RumInstanceInfo
RumProject
RumPvInfo
RumUvInfo
ScoreInfo
Tag
Whitelist©2013-2022 Tencent Cloud. All rights reserved.

Page 11 of 289

Real User Monitoring

Introduction：

Last updated 2022-09-28 10:25:40
Tencent Cloud Real User Monitoring (RUM) is a one-stop solution for monitoring the performance of your web apps
and mini programs. RUM gives you insights into the speed and performance of your user pages, APIs, and CDNs, andmakes it easier to troubleshoot Javascript and Ajax related errors. It also integrates easily with Tencent CloudApplication Performance Management (APM) to provide complete end-to-end monitoring. Simply install the SDK to
your page, perform a quick setup, and start monitoring the metrics that are important to your users.
You can use the APIs described in this document to perform operations such as reading the monitoring data. For more
supported operations, see API Overview

Note:
All Cloud Monitor (CM) APIs described here have been upgraded to API 3.0. New CM features will be
updated here. We recommend that you use API 3.0.

©2013-2022 Tencent Cloud. All rights reserved.

Page 12 of 289

Real User Monitoring

API Category：

Last updated 2023-07-06 17:39:22

Console APIs
API Name

FeatureFrequency Limit (maximum requests
per second)

CreateOfflineLogConfig

Creates offline log listener

20

CreateReleaseFile

Creates release file record

20

CreateWhitelist

Creates allowlist

20

DeleteOfflineLogConfig

Deletes offline RUM log listener

20

DeleteOfflineLogRecord

Deletes offline log record

20

DeleteReleaseFile

Deletes release file

20

DeleteWhitelist

Deletes allowlist

20

DescribeData

Gets QueryData

20

DescribeDataLogUrlInfo

Gets dataloginfo information

20

DescribeDataPvUrlInfo

Gets PvUrlInfo information

20

DescribeError

Gets homepage error information

20

DescribeOfflineLogConfigs

Gets the configuration of set offline
log listener20

DescribeOfflineLogRecords

Get all (up to 100) offline records

20

DescribeOfflineLogs

Gets specified offline log

20

DescribePvList

Gets PV list

20

DescribeReleaseFiles

Gets the list of source maps of an
application

20

DescribeTawAreas

Queries region information

20

DescribeUvList

Gets UV list

20

©2013-2022 Tencent Cloud. All rights reserved.

Page 13 of 289

Real User Monitoring

DescribeWhitelists

Gets allowlist list

20

DescribeReleaseFileSign

Gets temporary storage key

20

Log APIs
Frequency Limit (maximum

API Name

FeatureCreateLogExport

Creates log download task

20

DeleteLogExport

Deletes log download task

20

DescribeLogExports

Gets the list of log download tasks

20

DescribeLogList

Gets the log list (It has been deprecated. Use
DescribeRumLogList instead.)20

DescribeRumGroupLog

Gets RUM log aggregation information

20

DescribeRumLogExport

Exports the RUM log list

20

DescribeRumLogExports

Gets the list of exported RUM logs

20

DescribeRumLogList

Gets the RUM log list

20

DescribeRumStatsLogList

Gets the RUM log list every minute20

requests per second)

Business System and Project Information APIs
API Name

FeatureFrequency Limit (maximum
requests per second)

CreateProject

Creates a RUM application

20

CreateStarProject

Creates a starred application

20

DeleteInstanceDeletes a RUM business system

20

DeleteProject

Deletes a RUM application

20

DeleteStarProject

Deletes a starred application

20

DescribeDataReportCount

Gets the number of reported data entries

20©2013-2022 Tencent Cloud. All rights reserved.

Page 14 of 289

Real User Monitoring

DescribeProjectLimits

Gets the sampling information of an
application’s reporting APIs

20

DescribeProjects

Gets the RUM application list

20

DescribeScores

Gets the list of homepage scores

20

ModifyInstance

Modifies a RUM business system

20

ModifyProject

Modifies the RUM application information

20

ModifyProjectLimit

Adds or modifies data reporting limit

20

ResumeInstance

Recovers the RUM application information

20

ResumeProject

Recovers an application

20

StopInstance

Stops a RUM business system

20

StopProject

Stops an application from reporting data

20

CreateTawInstance

Creates a RUM business system

20

Page Performance APIs

API Name

FeatureFrequency Limit(maximumrequests per
second)DescribeDataPerformancePage

Gets PerformancePage information

20

Gets the PerformanceProject information.
DescribeDataPerformanceProjectThis API has been deprecated. Use

20

DescribeDataPerformancePage instead.
DescribeDataSetUrlStatistics

Gets DescribeDataSetUrlStatistics information

20

DescribeDataWebVitalsPage

Gets DescribeDataWebVitalsPage information

20

Custom Speed Test APIs

©2013-2022 Tencent Cloud. All rights reserved.

Page 15 of 289

Real User Monitoring

API Name

DescribeDataCustomUrl

FeatureGets DescribeDataCustomUrl
information

Frequency Limit (maximum requests per
second)20

Custom Event APIs
API Name

DescribeDataEventUrl

FeatureGets DescribeDataEventUrl
information

Frequency Limit (maximum requests per
second)20

API Monitoring APIs
API Name

Frequency Limit(maximum requests

Featureper second)
Gets the DescribeDataFetchProject information.
DescribeDataFetchProjectThis API has been deprecated. Use
DescribeDataFetchUrl instead.

20

DescribeDataFetchUrl

Gets DescribeDataFetchUrl information

20

DescribeDataFetchUrlInfo

Gets DescribeDataFetchUrlInfo information

20

Exception Analysis APIs
API Name

FeatureFrequency Limit (maximum requests per
second)DescribeDataLogUrlStatistics

Gets LogUrlStatistics
information

20

Page View APIs

©2013-2022 Tencent Cloud. All rights reserved.

Page 16 of 289

Real User Monitoring

API Name

DescribeDataPvUrlStatistics

FeatureGets DescribeDataPvUrlStatistics
information

Frequency Limit (maximum requests
per second)20

Static Resource Monitoring APIs
API Name

DescribeDataStaticProject

DescribeDataStaticResource

DescribeDataStaticUrl

FeatureGets DescribeDataStaticProject
information
Gets DescribeDataStaticResource
information
Gets DescribeDataStaticUrl
information©2013-2022 Tencent Cloud. All rights reserved.

Frequency Limit (maximum requests
per second)
20

20

20

Page 17 of 289

Real User Monitoring

Making API Requests
Request Structure：

Last updated 2023-02-27 16:45:57

1. Service Address
The API supports access from either a nearby region (at rum.tencentcloudapi.com) or a specified region (at rum.apguangzhou.tencentcloudapi.com for Guangzhou, for example).
We recommend using the domain name to access the nearest server. When you call an API, the request is
automatically resolved to a server in the region nearest to the location where the API is initiated. For example, when
you initiate an API request in Guangzhou, this domain name is automatically resolved to a Guangzhou server, theresult is the same as that of specifying the region in the domain like "rum.ap-guangzhou.tencentcloudapi.com".
Note: For latency-sensitive businesses, we recommend that you specify the region in the domain name.
Tencent Cloud currently supports the following regions:
Hosted region

Domain nameLocal access region (recommended, only for non-financial availability
zones)

rum.tencentcloudapi.com

South China (Guangzhou)

rum.apguangzhou.tencentcloudapi.com

East China (Shanghai)

rum.apshanghai.tencentcloudapi.com

North China (Beijing)

rum.ap-beijing.tencentcloudapi.com

Southwest China (Chengdu)

rum.ap-chengdu.tencentcloudapi.com

Southwest China (Chongqing)

rum.apchongqing.tencentcloudapi.com

Hong Kong, Macao, Taiwan (Hong Kong, China)

Southeast Asia (Singapore)
Southeast Asia (Bangkok)©2013-2022 Tencent Cloud. All rights reserved.

rum.aphongkong.tencentcloudapi.com
rum.apsingapore.tencentcloudapi.com
rum.ap-bangkok.tencentcloudapi.com

Page 18 of 289

Real User Monitoring

South Asia (Mumbai)

rum.ap-mumbai.tencentcloudapi.com

Northeast Asia (Seoul)

rum.ap-seoul.tencentcloudapi.com

Northeast Asia (Tokyo)

rum.ap-tokyo.tencentcloudapi.com

U.S. East Coast (Virginia)

rum.na-ashburn.tencentcloudapi.com

U.S. West Coast (Silicon Valley)

rum.nasiliconvalley.tencentcloudapi.com

North America (Toronto)

rum.na-toronto.tencentcloudapi.com

Europe (Frankfurt)

rum.eu-frankfurt.tencentcloudapi.com

2. Communications Protocol
All the Tencent Cloud APIs communicate via HTTPS, providing highly secure communication tunnels.

3. Request Methods
Supported HTTP request methods:
POST (recommended)GETThe Content-Type types supported by POST requests:
application/json (recommended). The TC3-HMAC-SHA256 signature algorithm must be used.
application/x-www-form-urlencoded. The HmacSHA1 or HmacSHA256 signature algorithm must be used.
multipart/form-data (only supported by certain APIs). You must use TC3-HMAC-SHA256 to calculate the signature.
The size of a GET request packet is up to 32 KB. The size of a POST request is up to 1 MB when the HmacSHA1 or
HmacSHA256 signature algorithm is used, and up to 10 MB when TC3-HMAC-SHA256 is used.

4. Character Encoding
Only UTF-8 encoding is used.

©2013-2022 Tencent Cloud. All rights reserved.

Page 19 of 289

Real User Monitoring

Common Params：

Last updated 2022-02-23 16:00:33
Common parameters are used for all APIs authenticating requestors. Common parameters must be included in all API
requests, and they will not be described in individual API documents.
The exact contents of the common parameters will vary depending on the version of the signature method you use.

Common parameters for Signature Algorithm v3
When the TC3-HMAC-SHA256 algorithm is used, the common parameters should be uniformly placed in the HTTP
request header, as shown below:
Parameter
Name

Type

Required

Description
The name of the API for the desired operation. For the specific value, see

X-TC-Action

X-TCRegion

X-TCTimestamp

StringStringYes

Yes

description of common parameter Action in the input parameters in r
documentation. For example, the API for querying the CVM instance list is
DescribeInstances .
Region parameter, which is used to identify the region to which the data ywork with belongs. For values supported for an API, see the description oparameter Region in the input parameters in related API documentati
parameter is not required for some APIs (which will be indicated in related
documentation), and will not take effect even it is passed.

Integer

X-TCVersion

StringAuthorization

StringYes

Yes

The current UNIX timestamp that records the time when the API request w
for example, 1529223702. Note: If the difference between the UNIX times
server time is greater than 5 minutes, a signature expiration error may occ
API version of the action. For the valid values, see the description of the cparameter Version in the API documentation. For example, the versi
2017-03-12.

Yes

The HTTP authentication request header, for example:
TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/Date/service/tc3_requ
SignedHeaders=content-type;host,Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc96317
Here:- TC3-HMAC-SHA256: Signature method, currently fixed as this value;- Credential: Signature credential; AKIDEXAMPLE is the SecretId; Date is
UTC time, and this value must match the value of X-TC-Timestamp (a co©2013-2022 Tencent Cloud. All rights reserved.

Page 20 of 289

Real User Monitoring

parameter) in UTC time format; service is the name of the product/service
generally a domain name prefix. For example, a domain name cvm.tencen
refers to the CVM product and the value would be cvm;
- SignedHeaders: The headers that contains the authentication informatio
type and host are the required headers;- Signature: Signature digest.

X-TC-Token

String

No

The token used for a temporary certificate. It must be used with a tempora
can obtain the temporary key and token by calling a CAM API. No token ia long-term key.

Assuming you want to query the list of Cloud Virtual Machine instances in the Guangzhou region, the request structurein the form of request URL, request header and request body may be as follows:
Example of an HTTP GET request structure:https://cvm.tencentcloudapi.com/?Limit=10&Offset=0
Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE/20
18-10-09/cvm/tc3_request, SignedHeaders=content-type;host, Signature=5da7a33f6993
f0614b047e5df4582db9e9bf4672ba50567dba16c6ccf174c474
Content-Type: application/x-www-form-urlencoded
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1539084154
X-TC-Region: ap-guangzhou
The following example shows you how to structure an HTTP POST (application/json) request:
https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/2018-05-30/cvm/tc3_request,
SignedHeaders=content-type;host, Signature=582c400e06b5924a6f2b5d7d672d79c15b1316
2d9279b0855cfba6789a8edb4c
Content-Type: application/json
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1527672334
X-TC-Region: ap-guangzhou{"Offset":0,"Limit":10}
Example of an HTTP POST (multipart/form-data) request structure (only supported by specific APIs):©2013-2022 Tencent Cloud. All rights reserved.

Page 21 of 289

Real User Monitoring

https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/2018-05-30/cvm/tc3_request,
SignedHeaders=content-type;host, Signature=582c400e06b5924a6f2b5d7d672d79c15b1316
2d9279b0855cfba6789a8edb4c
Content-Type: multipart/form-data; boundary=58731222010402
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1527672334
X-TC-Region: ap-guangzhou--58731222010402
Content-Disposition: form-data; name="Offset"
0--58731222010402
Content-Disposition: form-data; name="Limit"
10--58731222010402--

Common parameters for Signature Algorithm v1
To adopt the HmacSHA1 and HmacSHA256 signature methods, common parameters must be put into the request
string, as shown below:
Parameter NameType

Required

Description
The name of the API for the desired operation. For the specificvalue, see the description of common parameter Action in the

ActionStringYes

input parameters in related API documentation. For example, theAPI for querying the CVM instance list is
DescribeInstances .
Region parameter, which is used to identify the region to which
the data you want to work with belongs. For values supported for
an API, see the description of common parameter Region in

RegionStringYes

the input parameters in related API documentation. Note: Thisparameter is not required for some APIs (which will be indicated inrelated API documentation), and will not take effect even if it ispassed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 22 of 289

Real User Monitoring

Timestamp

IntegerYes

The current UNIX timestamp that records the time when the API
request was initiated, for example, 1529223702. If the difference
between the value and the current system time is too large, asignature expiration error may occur.
A random positive integer used along with Timestamp to

Nonce

Integer

Yes

SecretId

StringYes

The identifying SecretId obtained on the Cloud API Key page. A
SecretId corresponds to a unique SecretKey which is used togenerate the request signature (Signature).

Yes

Request signature used to verify the validity of this request. This iscalculated based on the actual input parameters. For more
information about how this is calculated, see the API
authentication documentation.

Signature

VersionStringStringYes

prevent replay attacks.

API version of the action. For the valid values, see the descriptionof the common input parameter Version in the API
documentation. For example, the version of CVM is 2017-03-12.

SignatureMethod

StringNo

Signature method. Currently, only HmacSHA256 and HmacSHA1
are supported. The HmacSHA256 algorithm is used to verify thesignature only when this parameter is specified as HmacSHA256.
In other cases, the signature is verified with HmacSHA1.

Token

String

No

The token used for a temporary certificate. It must be used with atemporary key. You can obtain the temporary key and token bycalling a CAM API. No token is required for a long-term key.

Assuming you want to query the list of Cloud Virtual Machine instances in the Guangzhou region, the request structurein the form of request URL, request header and request body may be as follows:
Example of an HTTP GET request structure:https://cvm.tencentcloudapi.com/?Action=DescribeInstances&Version=2017-03-12&Sign
atureMethod=HmacSHA256&Timestamp=1527672334&Signature=37ac2f4fde00b0ac9bd9eadeb45
9b1bbee224158d66e7ae5fcadb70b2d181d02&Region=ap-guangzhou&Nonce=23823223&SecretId=AKIDEXAMPLE
Host: cvm.tencentcloudapi.com
Content-Type: application/x-www-form-urlencoded
Example of an HTTP POST request structure:©2013-2022 Tencent Cloud. All rights reserved.

Page 23 of 289

Real User Monitoring

https://cvm.tencentcloudapi.com/
Host: cvm.tencentcloudapi.com
Content-Type: application/x-www-form-urlencoded
Action=DescribeInstances&Version=2017-03-12&SignatureMethod=HmacSHA256&Timestamp=
1527672334&Signature=37ac2f4fde00b0ac9bd9eadeb459b1bbee224158d66e7ae5fcadb70b2d18
1d02&Region=ap-guangzhou&Nonce=23823223&SecretId=AKIDEXAMPLE©2013-2022 Tencent Cloud. All rights reserved.

Page 24 of 289

Real User Monitoring

Signature v3：

Last updated 2022-02-23 16:01:23
TencentCloud API authenticates every single request, i.e., the request must be signed using the security credentials inthe designated steps. Each request has to contain the signature information (Signature) in the common request
parameters and be sent in the specified way and format.

Applying for Security Credentials
The security credential used in this document is a key, which includes a SecretId and a SecretKey. Each user canhave up to two pairs of keys.
SecretId: Used to identify the API caller, which is just like a username.
SecretKey: Used to authenticate the API caller, which is just like a password.
You must keep your security credentials private and avoid disclosure; otherwise, your assets may becompromised. If they are disclosed, please disable them as soon as possible.
You can apply for the security credentials through the following steps:
1. Log in to the Tencent Cloud Console.
2. Go to the TencentCloud API Key console page.
3. On the TencentCloud API Key page, click Create to create a SecretId/SecretKey pair.

Using the Resources for Developers
TencentCloud API comes with SDKs for seven commonly used programming languages, including Python, Java,
PHP, Go, NodeJS and .NET. In addition, it provides API Explorer which enables online call, signature verification, andSDK code generation. If you have any troubles calculating a signature, consult these resources.

TC3-HMAC-SHA256 Signature Algorithm
Compatible with the previous HmacSHA1 and HmacSHA256 signature algorithms, the TC3-HMAC-SHA256
signature algorithm is more secure and supports larger requests and JSON format with better performance. We
recommend using TC3-HMAC-SHA256 to calculate the signature.
TencentCloud API supports both GET and POST requests. For the GET method, only the Content-Type:application/x-www-form-urlencoded protocol format is supported. For the POST method, two protocol formats,©2013-2022 Tencent Cloud. All rights reserved.

Page 25 of 289

Real User Monitoring

Content-Type: application/json and Content-Type: multipart/form-data, are supported. The JSON format is supported
by default for all business APIs, and the multipart format is supported only for specific business APIs. In this case, theAPI cannot be called in JSON format. See the specific business API documentation for more information. The POST
method is recommended, as there is no difference in the results of both the methods, but the GET method only
supports request packets up to 32 KB.
The following uses querying the list of CVM instances in the Guangzhou region as an example to describe the steps ofsignature splicing. We chose this API because:
1. CVM is activated by default, and this API is often used;
2. It is read-only and does not change the status of existing resources;
3. It covers many types of parameters, which allows it to be used to demonstrate how to use arrays containing data
structures.
In the example, we try to choose common parameters and API parameters that are prone to mistakes. When you
actually call an API, please use parameters based on the actual conditions. The parameters vary by API. Do not copy
the parameters and values in this example.
Assuming that your SecretId and SecretKey are AKIDz8krbsJ5yKBZQpn74WFkmLPx3******* andGu5t9xGARNpq86cd98joQYCN3******* , respectively, if you want to view the status of the instance in the
Guangzhou region whose CVM instance name is "unnamed" and have only one data entry returned, then the request
may be:curl -X POST https://cvm.tencentcloudapi.com \-H "Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/2019-02-25/cvm/tc3_request, SignedHeaders=content-type;host, Signature=c492e8e4
1437e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff" \-H "Content-Type: application/json; charset=utf-8" \-H "Host: cvm.tencentcloudapi.com" \-H "X-TC-Action: DescribeInstances" \-H "X-TC-Timestamp: 1551113065" \-H "X-TC-Version: 2017-03-12" \-H "X-TC-Region: ap-guangzhou" \-d '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}'The signature calculation process is explained in detail below.

1. Concatenating the CanonicalRequest String
Concatenate the canonical request string (CanonicalRequest) in the following pseudocode format:
CanonicalRequest =HTTPRequestMethod + '\n' +CanonicalURI + '\n' +©2013-2022 Tencent Cloud. All rights reserved.

Page 26 of 289

Real User Monitoring

CanonicalQueryString + '\n' +CanonicalHeaders + '\n' +SignedHeaders + '\n' +HashedRequestPayload
Field Name

Explanation

HTTPRequestMethod

HTTP request method (GET or POST). This example uses POST .

CanonicalURI

URI parameter. Slash ("/") is used for API 3.0.
The query string in the URL of the originating HTTP request. This is always an empty st“” for POST requests, and is the string after the question mark (?) for GET requests. Fo

CanonicalQueryString。

example: Limit=10&Offset=0
Note: CanonicalQueryString must be URL-encoded, referencing RFC3986, theUTF8 character set. We recommend using the programming language library. All specia
characters must be encoded and capitalized.
Header information for signature calculation, including at least two headers of host
content-type . Custom headers can be added to participate in the signature proce
improve the uniqueness and security of the request.
Concatenation rules:
1. Both the key and value of the header should be converted to lowercase with the lead

CanonicalHeaders

and trailing spaces removed, so they are concatenated in the format of key:value\nformat;2. If there are multiple headers, they should be sorted in ASCII ascending order by theheader keys (lowercase).
The calculation result in this example is content-type:application/json;
charset=utf-8\nhost:cvm.tencentcloudapi.com\n .
Note: content-type must match the actually sent content. In some programming
languages, a charset value would be added even if it is not specified. In this case, therequest sent is different from the one signed, and the sever will return an error indicating
signature verification failed.
Header information for signature calculation, indicating which headers of the request
participate in the signature process (they must each individually correspond to the headin CanonicalHeaders). Content-type and host are required headers.

SignedHeaders

Concatenation rules:
1. Both the key and value of the header should be converted to lowercase;
2. If there are multiple headers, they should be sorted in ASCII ascending order by theheader keys (lowercase) and separated by semicolons (;).
The value in this example is content-type;hostHashedRequestPayload

Hash value of the request payload (i.e., the body, such as {"Limit": 1, "Filter©2013-2022 Tencent Cloud. All rights reserved.

Page 27 of 289

Real User Monitoring[{"Values": ["unnamed"], "Name": "instance-name"}]} in this example
The pseudocode for calculation is
Lowercase(HexEncode(Hash.SHA256(RequestPayload))) by SHA256 hashing the payof the HTTP request, performing hexadecimal encoding, and finally converting the enco
string to lowercase letters. For GET requests, RequestPayload is always an empt
string. The calculation result in this example is
99d58dfbc6745f6747f36bfca17dee5e6881dc0428a0a36f96199342bc5b49

According to the rules above, the CanonicalRequest string obtained in the example is as follows:

POST/
content-type:application/json; charset=utf-8
host:cvm.tencentcloudapi.com
content-type;host
99d58dfbc6745f6747f36bfca17dee5e6881dc0428a0a36f96199342bc5b4907

2. Concatenating the String to Be Signed
The string to sign is concatenated as follows:
StringToSign =Algorithm + \n +RequestTimestamp + \n +CredentialScope + \n +HashedCanonicalRequest
Field Name

Explanation

Algorithm

Signature algorithm, which is currently always TC3-HMAC-SHA256 .
Request timestamp, i.e., the value of the common parameter X-TC-Timestamp in

RequestTimestamp

request header, which is the UNIX timestamp of the current time in seconds, such as1551113065 in this example.
Scope of the credential in the format of Date/service/tc3_request , including
date, requested service and termination string (tc3_request). Date is a date in UT

CredentialScopetime, whose value should match the UTC date converted by the common
parameter X-TC-Timestamp ; service is the product name, which should mthe domain name of the product called. The calculation result in this example is 201
25/cvm/tc3_request .

©2013-2022 Tencent Cloud. All rights reserved.

Page 28 of 289

Real User Monitoring

HashedCanonicalRequest

Hash value of the CanonicalRequest string concatenated in the steps above. The
pseudocode for calculation is Lowercase(HexEncode(Hash.SHA256(CanonicalRequ
The calculation result in this example is2815843035062fffda5fd6f2a44ea8a34818b0dc46f024b8b3786976a3ad

Note:

1. Date has to be calculated from the timestamp "X-TC-Timestamp" and the time zone is UTC+0. If you add
the system's local time zone information (such as UTC+8), calls can succeed both day and night but willdefinitely fail at 00:00. For example, if the timestamp is 1551113065 and the time in UTC+8 is 2019-02-26
00:44:25, the UTC+0 date in the calculated Date value should be 2019-02-25 instead of 2019-02-26.
2. Timestamp must be the same as your current system time, and your system time and standard time must be
synced; if the difference between Timestamp and your current system time is larger than five minutes, therequest will fail. If your system time is out of sync with the standard time for a while, the request will fail andreturn a signature expiration error.

According to the preceding rules, the string to be signed obtained in the example is as follows:
TC3-HMAC-SHA256
1551113065
2019-02-25/cvm/tc3_request
2815843035062fffda5fd6f2a44ea8a34818b0dc46f024b8b3786976a3adda7a

3. Calculating the Signature
1. Calculate the derived signature key with the following pseudocode:

SecretKey = "Gu5t9xGARNpq86cd98joQYCN3*******"
SecretDate = HMAC_SHA256("TC3" + SecretKey, Date)
SecretService = HMAC_SHA256(SecretDate, Service)
SecretSigning = HMAC_SHA256(SecretService, "tc3_request")
Field Name

Explanation

SecretKey

The original SecretKey, i.e., Gu5t9xGARNpq86cd98joQYCN3******* .

Date

The Date field information in Credential , such as 2019-02-25 in this example.

©2013-2022 Tencent Cloud. All rights reserved.

Page 29 of 289

Real User Monitoring

Service

Value in the Service field in Credential , such as cvm in this example.

2. Calculate the signature with the following pseudocode:

Signature = HexEncode(HMAC_SHA256(SecretSigning, StringToSign))

4. Concatenating the Authorization
The Authorization is concatenated as follows:

Authorization =Algorithm + ' ' +'Credential=' + SecretId + '/' + CredentialScope + ', ' +'SignedHeaders=' + SignedHeaders + ', ' +'Signature=' + Signature
Field Name

Explanation

Algorithm

Signature algorithm, which is always TC3-HMAC-SHA256 .

SecretId

The SecretId in the key pair, i.e., AKIDz8krbsJ5yKBZQpn74WFkmLPx3******* .

CredentialScope

SignedHeadersSignature

Credential scope (see above). The calculation result in this example is 2019-0225/cvm/tc3_request .
Header information for signature calculation (see above), such as content-type;hostin this example.
Signature value. The calculation result in this example isc492e8e41437e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff .

According to the rules above, the value obtained in the example is:TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/2019-02-25/cvm/tc
3_request, SignedHeaders=content-type;host, Signature=c492e8e41437e97a620b728c301
bb8d17e7dc0c17eeabce80c20cd70fc3a78ff
The following example shows a finished authorization header:
POST https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/20
19-02-25/cvm/tc3_request, SignedHeaders=content-type;host, Signature=c492e8e41437
e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff©2013-2022 Tencent Cloud. All rights reserved.

Page 30 of 289

Real User Monitoring

Content-Type: application/json; charset=utf-8
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1551113065
X-TC-Region: ap-guangzhou{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}5. Signature Demo
When calling API 3.0, you are recommended to use the corresponding Tencent Cloud SDK 3.0 which encapsulates
the signature process, enabling you to focus on only the specific APIs provided by the product when developing. See
SDK Center for more information. Currently, the following programming languages are supported:
PythonJava
PHP
Go
NodeJS.NET
To further explain the signing process, we will use a programming language to implement the process describedabove. The request domain name, API and parameter values in the sample are used here. This goal of this example isonly to provide additional clarification for the signature process, please see the SDK for actual usage.
The final output URL might be: https://cvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=apguangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Signature=EliP9YW3pW28FpsEdkXt%2F%2B
WcGeI%3D&Timestamp=1465185768&Version=2017-03-12.
Note: The key in the example is fictitious, and the timestamp is not the current time of the system, so if this URL is
opened in the browser or called using commands such as curl, an authentication error will be returned: Signature
expired. In order to get a URL that can work properly, you need to replace the SecretId and SecretKey in the example
with your real credentials and use the current time of the system as the Timestamp.
Note: In the example below, even if you use the same programming language, the order of the parameters in the URL
may be different for each execution. However, the order does not matter, as long as all the parameters are included in
the URL and the signature is calculated correctly.
Note: The following code is only applicable to API 3.0. It cannot be directly used in other signature processes. Even
with an older API, signature calculation errors may occur due to the differences in details. Please refer to thecorresponding documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 31 of 289

Real User MonitoringJava
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
import java.util.TreeMap;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import javax.xml.bind.DatatypeConverter;
public class TencentCloudAPITC3Demo {private final static Charset UTF8 = StandardCharsets.UTF_8;
private final static String SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
private final static String SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
private final static String CT_JSON = "application/json; charset=utf-8";
public static byte[] hmac256(byte[] key, String msg) throws Exception {Mac mac = Mac.getInstance("HmacSHA256");
SecretKeySpec secretKeySpec = new SecretKeySpec(key, mac.getAlgorithm());
mac.init(secretKeySpec);
return mac.doFinal(msg.getBytes(UTF8));}
public static String sha256Hex(String s) throws Exception {MessageDigest md = MessageDigest.getInstance("SHA-256");
byte[] d = md.digest(s.getBytes(UTF8));
return DatatypeConverter.printHexBinary(d).toLowerCase();}public static void main(String[] args) throws Exception {String service = "cvm";
String host = "cvm.tencentcloudapi.com";
String region = "ap-guangzhou";String action = "DescribeInstances";
String version = "2017-03-12";
String algorithm = "TC3-HMAC-SHA256";
String timestamp = "1551113065";//String timestamp = String.valueOf(System.currentTimeMillis() / 1000);
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");// Pay attention to the time zone; otherwise, errors may occur
sdf.setTimeZone(TimeZone.getTimeZone("UTC"));
String date = sdf.format(new Date(Long.valueOf(timestamp + "000")));// ************* Step 1: Concatenate the CanonicalRequest string *************©2013-2022 Tencent Cloud. All rights reserved.

Page 32 of 289

Real User Monitoring

String httpRequestMethod = "POST";
String canonicalUri = "/";
String canonicalQueryString = "";String canonicalHeaders = "content-type:application/json; charset=utf-8\n" + "host:" + host + "\n";String signedHeaders = "content-type;host";
String payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}";
String hashedRequestPayload = sha256Hex(payload);
String canonicalRequest = httpRequestMethod + "\n" + canonicalUri + "\n" + canoni
calQueryString + "\n"+ canonicalHeaders + "\n" + signedHeaders + "\n" + hashedRequestPayload;
System.out.println(canonicalRequest);// ************* Step 2: Concatenate the string to sign *************
String credentialScope = date + "/" + service + "/" + "tc3_request";
String hashedCanonicalRequest = sha256Hex(canonicalRequest);
String stringToSign = algorithm + "\n" + timestamp + "\n" + credentialScope +"\n" + hashedCanonicalRequest;
System.out.println(stringToSign);// ************* Step 3: Calculate the signature *************
byte[] secretDate = hmac256(("TC3" + SECRET_KEY).getBytes(UTF8), date);byte[] secretService = hmac256(secretDate, service);byte[] secretSigning = hmac256(secretService, "tc3_request");String signature = DatatypeConverter.printHexBinary(hmac256(secretSigning, string
ToSign)).toLowerCase();
System.out.println(signature);// ************* Step 4: Concatenate the Authorization *************
String authorization = algorithm + " " + "Credential=" + SECRET_ID + "/" + creden
tialScope + ", "+ "SignedHeaders=" + signedHeaders + ", " + "Signature=" + signature;
System.out.println(authorization);
TreeMap<String, String> headers = new TreeMap<String, String>();headers.put("Authorization", authorization);headers.put("Content-Type", CT_JSON);headers.put("Host", host);
headers.put("X-TC-Action", action);headers.put("X-TC-Timestamp", timestamp);
headers.put("X-TC-Version", version);headers.put("X-TC-Region", region);
StringBuilder sb = new StringBuilder();sb.append("curl -X POST https://").append(host)©2013-2022 Tencent Cloud. All rights reserved.

Page 33 of 289

Real User Monitoring.append(" -H \"Authorization: ").append(authorization).append("\"").append(" -H \"Content-Type: application/json; charset=utf-8\"").append(" -H \"Host: ").append(host).append("\"").append(" -H \"X-TC-Action: ").append(action).append("\"").append(" -H \"X-TC-Timestamp: ").append(timestamp).append("\"").append(" -H \"X-TC-Version: ").append(version).append("\"").append(" -H \"X-TC-Region: ").append(region).append("\"").append(" -d '").append(payload).append("'");
System.out.println(sb.toString());}}

Python# -*- coding: utf-8 -*import hashlib, hmac, json, os, sys, timefrom datetime import datetime# Key Parameters
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"
service = "cvm"host = "cvm.tencentcloudapi.com"
endpoint = "https://" + hostregion = "ap-guangzhou"
action = "DescribeInstances"version = "2017-03-12"
algorithm = "TC3-HMAC-SHA256"#timestamp = int(time.time())
timestamp = 1551113065
date = datetime.utcfromtimestamp(timestamp).strftime("%Y-%m-%d")params = {"Limit": 1, "Filters": [{"Name": "instance-name", "Values": ["unnamed"]}]}# ************* Step 1: Concatenate the CanonicalRequest string *************
http_request_method = "POST"
canonical_uri = "/"canonical_querystring = ""ct = "application/json; charset=utf-8"
payload = json.dumps(params)
canonical_headers = "content-type:%s\nhost:%s\n" % (ct, host)signed_headers = "content-type;host"hashed_request_payload = hashlib.sha256(payload.encode("utf-8")).hexdigest()
canonical_request = (http_request_method + "\n" +canonical_uri + "\n" +©2013-2022 Tencent Cloud. All rights reserved.

Page 34 of 289

Real User Monitoring

canonical_querystring + "\n" +canonical_headers + "\n" +signed_headers + "\n" +hashed_request_payload)
print(canonical_request)# ************* Step 2: Concatenate the string to sign *************
credential_scope = date + "/" + service + "/" + "tc3_request"
hashed_canonical_request = hashlib.sha256(canonical_request.encode("utf-8")).hexd
igest()
string_to_sign = (algorithm + "\n" +str(timestamp) + "\n" +credential_scope + "\n" +hashed_canonical_request)
print(string_to_sign)# ************* Step 3: Calculate the Signature *************# Function for computing signature digest
def sign(key, msg):
return hmac.new(key, msg.encode("utf-8"), hashlib.sha256).digest()
secret_date = sign(("TC3" + secret_key).encode("utf-8"), date)secret_service = sign(secret_date, service)secret_signing = sign(secret_service, "tc3_request")
signature = hmac.new(secret_signing, string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
print(signature)# ************* Step 4: Concatenate the Authorization *************
authorization = (algorithm + " " +"Credential=" + secret_id + "/" + credential_scope + ", " +"SignedHeaders=" + signed_headers + ", " +"Signature=" + signature)
print(authorization)
print('curl -X POST ' + endpoint+ ' -H "Authorization: ' + authorization + '"'+ ' -H "Content-Type: application/json; charset=utf-8"'+ ' -H "Host: ' + host + '"'+ ' -H "X-TC-Action: ' + action + '"'+ ' -H "X-TC-Timestamp: ' + str(timestamp) + '"'+ ' -H "X-TC-Version: ' + version + '"'+ ' -H "X-TC-Region: ' + region + '"'+ " -d '" + payload + "'")

Golang©2013-2022 Tencent Cloud. All rights reserved.

Page 35 of 289

Real User Monitoring

package main
import ("crypto/hmac""crypto/sha256""encoding/hex""fmt""time")
func sha256hex(s string) string {b := sha256.Sum256([]byte(s))
return hex.EncodeToString(b[:])}func hmacsha256(s, key string) string {hashed := hmac.New(sha256.New, []byte(key))hashed.Write([]byte(s))
return string(hashed.Sum(nil))}func main() {secretId := "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secretKey := "Gu5t9xGARNpq86cd98joQYCN3*******"
host := "cvm.tencentcloudapi.com"
algorithm := "TC3-HMAC-SHA256"
service := "cvm"version := "2017-03-12"
action := "DescribeInstances"
region := "ap-guangzhou"//var timestamp int64 = time.Now().Unix()
var timestamp int64 = 1551113065// step 1: build canonical request string
httpRequestMethod := "POST"
canonicalURI := "/"canonicalQueryString := ""canonicalHeaders := "content-type:application/json; charset=utf-8\n" + "host:" +host + "\n"signedHeaders := "content-type;host"
payload := `{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}`
hashedRequestPayload := sha256hex(payload)
canonicalRequest := fmt.Sprintf("%s\n%s\n%s\n%s\n%s\n%s",
httpRequestMethod,
canonicalURI,©2013-2022 Tencent Cloud. All rights reserved.

Page 36 of 289

Real User Monitoring

canonicalQueryString,canonicalHeaders,signedHeaders,hashedRequestPayload)
fmt.Println(canonicalRequest)// step 2: build string to sign
date := time.Unix(timestamp, 0).UTC().Format("2006-01-02")
credentialScope := fmt.Sprintf("%s/%s/tc3_request", date, service)hashedCanonicalRequest := sha256hex(canonicalRequest)
string2sign := fmt.Sprintf("%s\n%d\n%s\n%s",
algorithm,
timestamp,
credentialScope,
hashedCanonicalRequest)
fmt.Println(string2sign)// step 3: sign string
secretDate := hmacsha256(date, "TC3"+secretKey)
secretService := hmacsha256(service, secretDate)secretSigning := hmacsha256("tc3_request", secretService)signature := hex.EncodeToString([]byte(hmacsha256(string2sign, secretSigning)))
fmt.Println(signature)// step 4: build authorization
authorization := fmt.Sprintf("%s Credential=%s/%s, SignedHeaders=%s, Signature=%s",algorithm,
secretId,
credentialScope,
signedHeaders,signature)
fmt.Println(authorization)
curl := fmt.Sprintf(`curl -X POST https://%s\-H "Authorization: %s"\
-H "Content-Type: application/json; charset=utf-8"\-H "Host: %s" -H "X-TC-Action: %s"\
-H "X-TC-Timestamp: %d"\
-H "X-TC-Version: %s"\
-H "X-TC-Region: %s"\-d '%s'`, host, authorization, host, action, timestamp, version, region, payload)
fmt.Println(curl)}

PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 37 of 289

Real User Monitoring<?php$secretId = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";$secretKey = "Gu5t9xGARNpq86cd98joQYCN3*******";$host = "cvm.tencentcloudapi.com";$service = "cvm";$version = "2017-03-12";$action = "DescribeInstances";$region = "ap-guangzhou";// $timestamp = time();$timestamp = 1551113065;$algorithm = "TC3-HMAC-SHA256";// step 1: build canonical request string$httpRequestMethod = "POST";$canonicalUri = "/";
$canonicalQueryString = "";$canonicalHeaders = "content-type:application/json; charset=utf-8\n"."host:".$host."\n";$signedHeaders = "content-type;host";$payload = '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}';$hashedRequestPayload = hash("SHA256", $payload);$canonicalRequest = $httpRequestMethod."\n".$canonicalUri."\n".$canonicalQueryString."\n".$canonicalHeaders."\n".$signedHeaders."\n".$hashedRequestPayload;
echo $canonicalRequest.PHP_EOL;// step 2: build string to sign
$date = gmdate("Y-m-d", $timestamp);$credentialScope = $date."/".$service."/tc3_request";$hashedCanonicalRequest = hash("SHA256", $canonicalRequest);$stringToSign = $algorithm."\n".$timestamp."\n".$credentialScope."\n".$hashedCanonicalRequest;
echo $stringToSign.PHP_EOL;// step 3: sign string$secretDate = hash_hmac("SHA256", $date, "TC3".$secretKey, true);$secretService = hash_hmac("SHA256", $service, $secretDate, true);$secretSigning = hash_hmac("SHA256", "tc3_request", $secretService, true);$signature = hash_hmac("SHA256", $stringToSign, $secretSigning);
echo $signature.PHP_EOL;©2013-2022 Tencent Cloud. All rights reserved.

Page 38 of 289

Real User Monitoring// step 4: build authorization$authorization = $algorithm." Credential=".$secretId."/".$credentialScope.", SignedHeaders=content-type;host, Signature=".$signature;echo $authorization.PHP_EOL;$curl = "curl -X POST https://".$host.' -H "Authorization: '.$authorization.'"'.' -H "Content-Type: application/json; charset=utf-8"'.' -H "Host: '.$host.'"'.' -H "X-TC-Action: '.$action.'"'.' -H "X-TC-Timestamp: '.$timestamp.'"'.' -H "X-TC-Version: '.$version.'"'.' -H "X-TC-Region: '.$region.'"'." -d '".$payload."'";
echo $curl.PHP_EOL;

Ruby# -*- coding: UTF-8 -*# require ruby>=2.3.0
require 'digest'
require 'json'
require 'time'require 'openssl'# Key Parameters
secret_id = 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******'
secret_key = 'Gu5t9xGARNpq86cd98joQYCN3*******'
service = 'cvm'
host = 'cvm.tencentcloudapi.com'
endpoint = 'https://' + hostregion = 'ap-guangzhou'
action = 'DescribeInstances'version = '2017-03-12'
algorithm = 'TC3-HMAC-SHA256'# timestamp = Time.now.to_i
timestamp = 1551113065
date = Time.at(timestamp).utc.strftime('%Y-%m-%d')# ************* Step 1: Concatenate the CanonicalRequest string *************
http_request_method = 'POST'
canonical_uri = '/'canonical_querystring = ''©2013-2022 Tencent Cloud. All rights reserved.

Page 39 of 289

Real User Monitoring

canonical_headers = "content-type:application/json; charset=utf-8\nhost:#{host}\n"signed_headers = 'content-type;host'# params = { 'Limit' => 1, 'Filters' => [{ 'Name' => 'instance-name', 'Values' =>['unnamed'] }] }# payload = JSON.generate(params, { 'ascii_only' => true, 'space' => ' ' })# json will generate in random order, to get specified result in example, we hard-code it here.
payload = '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}'
hashed_request_payload = Digest::SHA256.hexdigest(payload)
canonical_request = [http_request_method,
canonical_uri,canonical_querystring,canonical_headers,signed_headers,hashed_request_payload,].join("\n")puts canonical_request# ************* Step 2: Concatenate the string to sign *************
credential_scope = date + '/' + service + '/' + 'tc3_request'
hashed_request_payload = Digest::SHA256.hexdigest(canonical_request)
string_to_sign = [algorithm,
timestamp.to_s,
credential_scope,
hashed_request_payload,].join("\n")puts string_to_sign# ************* Step 3: Calculate the Signature *************
digest = OpenSSL::Digest.new('sha256')secret_date = OpenSSL::HMAC.digest(digest, 'TC3' + secret_key, date)secret_service = OpenSSL::HMAC.digest(digest, secret_date, service)secret_signing = OpenSSL::HMAC.digest(digest, secret_service, 'tc3_request')
signature = OpenSSL::HMAC.hexdigest(digest, secret_signing, string_to_sign)
puts signature# ************* Step 4: Concatenate the Authorization *************
authorization = "#{algorithm} Credential=#{secret_id}/#{credential_scope}, Signed
Headers=#{signed_headers}, Signature=#{signature}"puts authorization
puts 'curl -X POST ' + endpoint \©2013-2022 Tencent Cloud. All rights reserved.

Page 40 of 289

Real User Monitoring+ ' -H "Authorization: ' + authorization + '"' \+ ' -H "Content-Type: application/json; charset=utf-8"' \+ ' -H "Host: ' + host + '"' \+ ' -H "X-TC-Action: ' + action + '"' \+ ' -H "X-TC-Timestamp: ' + timestamp.to_s + '"' \+ ' -H "X-TC-Version: ' + version + '"' \+ ' -H "X-TC-Region: ' + region + '"' \+ " -d '" + payload + "'"DotNetusing System;
using System.Collections.Generic;using System.Security.Cryptography;
using System.Text;
public class Application{
public static string SHA256Hex(string s){
using (SHA256 algo = SHA256.Create()){
byte[] hashbytes = algo.ComputeHash(Encoding.UTF8.GetBytes(s));
StringBuilder builder = new StringBuilder();for (int i = 0; i < hashbytes.Length; ++i){
builder.Append(hashbytes[i].ToString("x2"));}
return builder.ToString();}}
public static byte[] HmacSHA256(byte[] key, byte[] msg){
using (HMACSHA256 mac = new HMACSHA256(key)){
return mac.ComputeHash(msg);}}
public static Dictionary<String, String> BuildHeaders(string secretid,
string secretkey, string service, string endpoint, string region,
string action, string version, DateTime date, string requestPayload){
string datestr = date.ToString("yyyy-MM-dd");
DateTime startTime = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc);
long requestTimestamp = (long)Math.Round((date - startTime).TotalMilliseconds, Mi©2013-2022 Tencent Cloud. All rights reserved.

Page 41 of 289

Real User Monitoring

dpointRounding.AwayFromZero) / 1000;// ************* Step 1: Concatenate the CanonicalRequest string *************
string algorithm = "TC3-HMAC-SHA256";
string httpRequestMethod = "POST";
string canonicalUri = "/";
string canonicalQueryString = "";string contentType = "application/json";string canonicalHeaders = "content-type:" + contentType + "; charset=utf-8\n" +"host:" + endpoint + "\n";string signedHeaders = "content-type;host";
string hashedRequestPayload = SHA256Hex(requestPayload);string canonicalRequest = httpRequestMethod + "\n"+ canonicalUri + "\n"+ canonicalQueryString + "\n"+ canonicalHeaders + "\n"+ signedHeaders + "\n"+ hashedRequestPayload;
Console.WriteLine(canonicalRequest);
Console.WriteLine("----------------------------------");// ************ Step 2: Concatenate the string to sign *************
string credentialScope = datestr + "/" + service + "/" + "tc3_request";
string hashedCanonicalRequest = SHA256Hex(canonicalRequest);
string stringToSign = algorithm + "\n" + requestTimestamp.ToString() + "\n" + cre
dentialScope + "\n" + hashedCanonicalRequest;
Console.WriteLine(stringToSign);
Console.WriteLine("----------------------------------");// ************* Step 3: Calculate the signature *************
byte[] tc3SecretKey = Encoding.UTF8.GetBytes("TC3" + secretkey);byte[] secretDate = HmacSHA256(tc3SecretKey, Encoding.UTF8.GetBytes(datestr));byte[] secretService = HmacSHA256(secretDate, Encoding.UTF8.GetBytes(service));byte[] secretSigning = HmacSHA256(secretService, Encoding.UTF8.GetBytes("tc3_request"));
byte[] signatureBytes = HmacSHA256(secretSigning, Encoding.UTF8.GetBytes(stringTo
Sign));
string signature = BitConverter.ToString(signatureBytes).Replace("-", "").ToLower();
Console.WriteLine(signature);
Console.WriteLine("----------------------------------");// ************* Step 4: Concatenate the Authorization *************
string authorization = algorithm + " "+ "Credential=" + secretid + "/" + credentialScope + ", "+ "SignedHeaders=" + signedHeaders + ", "+ "Signature=" + signature;
Console.WriteLine(authorization);©2013-2022 Tencent Cloud. All rights reserved.

Page 42 of 289

Real User Monitoring

Console.WriteLine("----------------------------------");
Dictionary<string, string> headers = new Dictionary<string, string>();headers.Add("Authorization", authorization);headers.Add("Host", endpoint);
headers.Add("Content-Type", contentType + "; charset=utf-8");
headers.Add("X-TC-Timestamp", requestTimestamp.ToString());
headers.Add("X-TC-Version", version);headers.Add("X-TC-Action", action);headers.Add("X-TC-Region", region);
return headers;}public static void Main(string[] args){// SecretID and SecretKey
string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string service = "cvm";
string endpoint = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";// The timestamp `2019-02-26 00:44:25` used here is only for reference. In a proj
ect, use the following parameter:// DateTime date = DateTime.UtcNow;// Enter the correct time zone. We recommend using UTC timestamp to avoid errors.
DateTime date = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc).AddSeconds(1551113065);
string requestPayload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"\\u672a\\u5
47d\\u540d\"], \"Name\": \"instance-name\"}]}";
Dictionary<string, string> headers = BuildHeaders(SECRET_ID, SECRET_KEY, service, endpoint, region, action, version, date, requestPayload);
Console.WriteLine("POST https://cvm.tencentcloudapi.com");foreach (KeyValuePair<string, string> kv in headers){Console.WriteLine(kv.Key + ": " + kv.Value);}
Console.WriteLine();Console.WriteLine(requestPayload);}}©2013-2022 Tencent Cloud. All rights reserved.

Page 43 of 289

Real User Monitoring

NodeJS
const crypto = require('crypto');function sha256(message, secret = '', encoding) {const hmac = crypto.createHmac('sha256', secret)return hmac.update(message).digest(encoding)}
function getHash(message, encoding = 'hex') {const hash = crypto.createHash('sha256')
return hash.update(message).digest(encoding)}
function getDate(timestamp) {const date = new Date(timestamp * 1000)
const year = date.getUTCFullYear()const month = ('0' + (date.getUTCMonth() + 1)).slice(-2)
const day = ('0' + date.getUTCDate()).slice(-2)
return `${year}-${month}-${day}`}function main(){const SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
const SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******"
const endpoint = "cvm.tencentcloudapi.com"
const service = "cvm"
const region = "ap-guangzhou"
const action = "DescribeInstances"
const version = "2017-03-12"//const timestamp = getTime()
const timestamp = 1551113065
const date = getDate(timestamp)// ************* Step 1: Concatenate the CanonicalRequest string *************
const signedHeaders = "content-type;host"const payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}"
const hashedRequestPayload = getHash(payload);
const httpRequestMethod = "POST"
const canonicalUri = "/"const canonicalQueryString = ""const canonicalHeaders = "content-type:application/json; charset=utf-8\n" + "host:" + endpoint + "\n"const canonicalRequest = httpRequestMethod + "\n"©2013-2022 Tencent Cloud. All rights reserved.

Page 44 of 289

Real User Monitoring+ canonicalUri + "\n"+ canonicalQueryString + "\n"+ canonicalHeaders + "\n"+ signedHeaders + "\n"+ hashedRequestPayload
console.log(canonicalRequest)
console.log("----------------------------")// ************* Step 2: Concatenate the string to sign *************
const algorithm = "TC3-HMAC-SHA256"
const hashedCanonicalRequest = getHash(canonicalRequest);
const credentialScope = date + "/" + service + "/" + "tc3_request"
const stringToSign = algorithm + "\n" +timestamp + "\n" +credentialScope + "\n" +hashedCanonicalRequest
console.log(stringToSign)
console.log("----------------------------")// ************* Step 3: Calculate the signature *************
const kDate = sha256(date, 'TC3' + SECRET_KEY)
const kService = sha256(service, kDate)
const kSigning = sha256('tc3_request', kService)
const signature = sha256(stringToSign, kSigning, 'hex')
console.log(signature)
console.log("----------------------------")// ************* Step 4: Concatenate the Authorization *************
const authorization = algorithm + " " +"Credential=" + SECRET_ID + "/" + credentialScope + ", " +"SignedHeaders=" + signedHeaders + ", " +"Signature=" + signature
console.log(authorization)
console.log("----------------------------")
const Call_Information = 'curl -X POST ' + "https://" + endpoint+ ' -H "Authorization: ' + authorization + '"'+ ' -H "Content-Type: application/json; charset=utf-8"'+ ' -H "Host: ' + endpoint + '"'+ ' -H "X-TC-Action: ' + action + '"'+ ' -H "X-TC-Timestamp: ' + timestamp.toString() + '"'+ ' -H "X-TC-Version: ' + version + '"'+ ' -H "X-TC-Region: ' + region + '"'+ " -d '" + payload + "'"console.log(Call_Information)}main()©2013-2022 Tencent Cloud. All rights reserved.

Page 45 of 289

Real User MonitoringC++#include <iostream>#include <iomanip>#include <sstream>#include <string>#include <stdio.h>#include <time.h>#include <openssl/sha.h>#include <openssl/hmac.h>using namespace std;
string get_data(int64_t &timestamp){
string utcDate;char buff[20] = {0};// time_t timenow;
struct tm sttime;
sttime = *gmtime(&timestamp);
strftime(buff, sizeof(buff), "%Y-%m-%d", &sttime);
utcDate = string(buff);
return utcDate;}string int2str(int64_t n){
std::stringstream ss;
ss << n;return ss.str();}string sha256Hex(const string &str){
char buf[3];unsigned char hash[SHA256_DIGEST_LENGTH];
SHA256_CTX sha256;
SHA256_Init(&sha256);
SHA256_Update(&sha256, str.c_str(), str.size());
SHA256_Final(hash, &sha256);
std::string NewString = "";for(int i = 0; i < SHA256_DIGEST_LENGTH; i++){snprintf(buf, sizeof(buf), "%02x", hash[i]);NewString = NewString + buf;}
return NewString;©2013-2022 Tencent Cloud. All rights reserved.

Page 46 of 289

Real User Monitoring}
string HmacSha256(const string &key, const string &input){
unsigned char hash[32];
HMAC_CTX *h;#if OPENSSL_VERSION_NUMBER < 0x10100000L
HMAC_CTX hmac;
HMAC_CTX_init(&hmac);h = &hmac;#else
h = HMAC_CTX_new();#endif
HMAC_Init_ex(h, &key[0], key.length(), EVP_sha256(), NULL);
HMAC_Update(h, ( unsigned char* )&input[0], input.length());
unsigned int len = 32;
HMAC_Final(h, hash, &len);#if OPENSSL_VERSION_NUMBER < 0x10100000L
HMAC_CTX_cleanup(h);#else
HMAC_CTX_free(h);#endif
std::stringstream ss;
ss << std::setfill('0');for (int i = 0; i < len; i++){ss << hash[i];}return (ss.str());}
string HexEncode(const string &input){
static const char* const lut = "0123456789abcdef";
size_t len = input.length();string output;
output.reserve(2 * len);for (size_t i = 0; i < len; ++i){
const unsigned char c = input[i];output.push_back(lut[c >> 4]);
output.push_back(lut[c & 15]);}©2013-2022 Tencent Cloud. All rights reserved.

Page 47 of 289

Real User Monitoring

return output;}
int main(){string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string service = "cvm";
string host = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";
int64_t timestamp = 1551113065;
string date = get_data(timestamp);// ************* Step 1: Concatenate the CanonicalRequest string *************
string httpRequestMethod = "POST";
string canonicalUri = "/";
string canonicalQueryString = "";string canonicalHeaders = "content-type:application/json; charset=utf-8\nhost:" +host + "\n";string signedHeaders = "content-type;host";
string payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}";
string hashedRequestPayload = sha256Hex(payload);string canonicalRequest = httpRequestMethod + "\n" + canonicalUri + "\n" + canoni
calQueryString + "\n"+ canonicalHeaders + "\n" + signedHeaders + "\n" + hashedRequestPayload;cout << canonicalRequest << endl;
cout << "-----------------------" << endl;// ************* Step 2: Concatenate the string to sign *************
string algorithm = "TC3-HMAC-SHA256";
string RequestTimestamp = int2str(timestamp);
string credentialScope = date + "/" + service + "/" + "tc3_request";
string hashedCanonicalRequest = sha256Hex(canonicalRequest);
string stringToSign = algorithm + "\n" + RequestTimestamp + "\n" + credentialScop
e + "\n" + hashedCanonicalRequest;
cout << stringToSign << endl;
cout << "-----------------------" << endl;// ************* Step 3: Calculate the signature ***************
string kKey = "TC3" + SECRET_KEY;
string kDate = HmacSha256(kKey, date);
string kService = HmacSha256(kDate, service);
string kSigning = HmacSha256(kService, "tc3_request");©2013-2022 Tencent Cloud. All rights reserved.

Page 48 of 289

Real User Monitoring

string signature = HexEncode(HmacSha256(kSigning, stringToSign));cout << signature << endl;
cout << "-----------------------" << endl;// ************* Step 4: Concatenate the Authorization *************
string authorization = algorithm + " " + "Credential=" + SECRET_ID + "/" + creden
tialScope + ", "+ "SignedHeaders=" + signedHeaders + ", " + "Signature=" + signature;cout << authorization << endl;
cout << "------------------------" << endl;
string headers = "curl -X POST https://" + host + "\n"+ " -H \"Authorization: " + authorization + "\n"+ " -H \"Content-Type: application/json; charset=utf-8\"" + "\n"+ " -H \"Host: " + host + "\n"+ " -H \"X-TC-Action: " + action + "\n"+ " -H \"X-TC-Timestamp: " + RequestTimestamp + "\n"+ " -H \"X-TC-Version: " + version + "\n"+ " -H \"X-TC-Region: " + region + "\n"+ " -d '" + payload;cout << headers << endl;
return 0;};

Signature Failure
The following situational error codes for signature failure may occur. Please resolve the errors accordingly.
Error CodeDescription

AuthFailure.SignatureExpire

Signature expired. Timestamp and server time cannot differ by more than fiveminutes.

AuthFailure.SecretIdNotFoundThe key does not exist. Please go to the console to check whether it isdisabled or you copied fewer or more characters.

AuthFailure.SignatureFailure

Signature error. It is possible that the signature was calculated incorrectly, thesignature does not match the content actually sent, or the SecretKey isincorrect.

AuthFailure.TokenFailure

Temporary certificate token error.

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

©2013-2022 Tencent Cloud. All rights reserved.

Page 49 of 289

Real User Monitoring

Signature：

Last updated 2022-07-27 10:20:44
Tencent Cloud API authenticates each access request, i.e. each request needs to include authentication information(Signature) in the common parameters to verify the identity of the requester.
The Signature is generated by the security credentials which include SecretId and SecretKey. If you don't have thesecurity credentials yet, go to the TencentCloud API Key page to apply for them; otherwise, you cannot invoke theTencentCloud API.

1. Applying for Security Credentials
Before using the TencentCloud API for the first time, go to the TencentCloud API Key page to apply for security
credentials.
Security credentials consist of SecretId and SecretKey:
SecretId is used to identify the API requester.
SecretKey is used to encrypt the signature string and verify it on the server.
You must keep your security credentials private and avoid disclosure.
You can apply for the security credentials through the following steps:
1. Log in to the Tencent Cloud Console.
2. Go to the TencentCloud API Key page.
3. On the API Key Management page, click Create Key to create a SecretId/SecretKey pair.
Note: Each account can have up to two pairs of SecretId/SecretKey.

2. Generating a SignatureWith the SecretId and SecretKey, a signature can be generated. The following describes how to generate a signature:
Assume that the SecretId and SecretKey are:SecretId: AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******
SecretKey: Gu5t9xGARNpq86cd98joQYCN3*******
Note: This is just an example. For actual operations, please use your own SecretId and SecretKey.

©2013-2022 Tencent Cloud. All rights reserved.

Page 50 of 289

Real User Monitoring

Take the Cloud Virtual Machine's request to view the instance list (DescribeInstances) as an example. When you
invoke this API, the request parameters may be as follows:
Parameter
nameDescription

Parameter value

Action

Method name

DescribeInstances

SecretId

Key ID

AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******

Timestamp

Current timestamp

1465185768

Nonce

Random positive integer

11886

RegionRegion where the instance islocatedap-guangzhou

InstanceIds.0

ID of the instance to query

ins-09dx96dg

OffsetOffset0

Limit

Allowed maximum output

20

VersionAPI version number

2017-03-12

2.1. Sorting Parameters
First, sort all the request parameters in an ascending lexicographical order (ASCII code) by their names. Notes: (1)Parameters are sorted by their names instead of their values; (2) The parameters are sorted based on ASCII code, notin an alphabetical order or by values. For example, InstanceIds.2 should be arranged after InstanceIds.12. You cancomplete the sorting process using a sorting function in a programming language, such as the ksort function in PHP.
The parameters in the example are sorted as follows:{'Action' : 'DescribeInstances','InstanceIds.0' : 'ins-09dx96dg','Limit' : 20,'Nonce' : 11886,'Offset' : 0,
'Region' : 'ap-guangzhou','SecretId' : 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******','Timestamp' : 1465185768,'Version': '2017-03-12',}©2013-2022 Tencent Cloud. All rights reserved.

Page 51 of 289

Real User Monitoring

When developing in another programming language, you can sort these sample parameters and it will work as long as
you obtain the same results.

2.2. Concatenating a Request String
This step generates a request string.
Format the request parameters sorted in the previous step into the form of "parameter name"="parameter value". For
example, for the Action parameter, its parameter name is "Action" and its parameter value is "DescribeInstances", so it
will become Action=DescribeInstances after formatted.
Note: The "parameter value" is the original value but not the value after URL encoding.
Then, concatenate the formatted parameters with "&". The resulting request string is as follows:
Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Timestamp=1465
185768&Version=2017-03-12

2.3. Concatenating the Signature Original String
This step generates a signature original string.
The signature original string consists of the following parameters:
1. HTTP method: POST and GET modes are supported, and GET is used here for the request. Please note that themethod name should be in all capital letters.
2. Request server: the domain name of the request to view the list of instances (DescribeInstances) is
cvm.tencentcloudapi.com. The actual request domain name varies by the module to which the API belongs. For
more information, see the instructions of the specific API.
3. Request path: The request path in the current version of TencentCloud API is fixed to /.
4. Request string: the request string generated in the previous step.
The concatenation rule of the signature original string is: Request method + request host + request path + ? + request
string
The concatenation result of the example is:

GETcvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&L
imit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WF
kmLPx3*******&Timestamp=1465185768&Version=2017-03-12

2.4. Generating a Signature String
This step generates a signature string.
First, use the HMAC-SHA1 algorithm to sign the signature original string obtained in the previous step, and then©2013-2022 Tencent Cloud. All rights reserved.

Page 52 of 289

Real User Monitoring

encode the generated signature using Base64 to obtain the final signature.
The specific code is as follows with the PHP language being used as an example:$secretKey = 'Gu5t9xGARNpq86cd98joQYCN3*******';$srcStr = 'GETcvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5
yKBZQpn74WFkmLPx3*******&Timestamp=1465185768&Version=2017-03-12';$signStr = base64_encode(hash_hmac('sha1', $srcStr, $secretKey, true));echo $signStr;
The final signature is:zmmjn35mikh6pM3V7sUEuX4wyYM=
When developing in another programming language, you can sign and verify the original in the example above and it
works as long as you get the same results.

3. Encoding a Signature String
The generated signature string cannot be directly used as a request parameter and must be URL encoded.
For example, if the signature string generated in the previous step is zmmjn35mikh6pM3V7sUEuX4wyYM=, the final
signature string request parameter (Signature) is zmmjn35mikh6pM3V7sUEuX4wyYM%3D, which will be used togenerate the final request URL.
Note: If your request method is GET, or the request method is POST and the Content-Type isapplication/x-www-form-urlencoded, then all the request parameter values need to be URL encoded(except the parameter key and the symbol of =) when sending the request. Non-ASCII characters need to
be encoded with UTF-8 before URL encoding.
Note: The network libraries of some programming languages automatically URL encode all parameters, inwhich case there is no need to URL encode the signature string; otherwise, two rounds of URL encoding
will cause the signature to fail.
Note: Other parameter values also need to be encoded using RFC 3986. Use %XY in percent-encoding forspecial characters such as Chinese characters, where "X" and "Y" are hexadecimal characters (0-9 anduppercase A-F), and using lowercase will cause an error.

4. Signature Failure©2013-2022 Tencent Cloud. All rights reserved.

Page 53 of 289

Real User Monitoring

The following situational error codes for signature failure may occur. Please resolve the errors accordingly.
Error code

Error description

AuthFailure.SignatureExpire

The signature is expired

AuthFailure.SecretIdNotFoundThe key does not exist

AuthFailure.SignatureFailure

Signature error

AuthFailure.TokenFailure

Token error

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type)

5. Signature Demo
When calling API 3.0, you are recommended to use the corresponding Tencent Cloud SDK 3.0 which encapsulates
the signature process, enabling you to focus on only the specific APIs provided by the product when developing. See
SDK Center for more information. Currently, the following programming languages are supported:
PythonJava
PHP
Go
NodeJS.NET
To further explain the signing process, we will use a programming language to implement the process describedabove. The request domain name, API and parameter values in the sample are used here. This goal of this example isonly to provide additional clarification for the signature process, please see the SDK for actual usage.
The final output URL might be: https://cvm.tencentcloudapi.com/?
Action=DescribeInstances&InstanceIds.0=ins09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=apguangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Signature=zmmjn35mikh6pM3V7s
UEuX4wyYM%3D&Timestamp=1465185768&Version=2017-03-12 .
Note: The key in the example is fictitious, and the timestamp is not the current time of the system, so if this URL is
opened in the browser or called using commands such as curl, an authentication error will be returned: Signature
expired. In order to get a URL that can work properly, you need to replace the SecretId and SecretKey in the example
with your real credentials and use the current time of the system as the Timestamp.

©2013-2022 Tencent Cloud. All rights reserved.

Page 54 of 289

Real User Monitoring

Note: In the example below, even if you use the same programming language, the order of the parameters in the URL
may be different for each execution. However, the order does not matter, as long as all the parameters are included in
the URL and the signature is calculated correctly.
Note: The following code is only applicable to API 3.0. It cannot be directly used in other signature processes. Even
with an older API, signature calculation errors may occur due to the differences in details. Please refer to thecorresponding documentation.

Java
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;import java.util.Random;
import java.util.TreeMap;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import javax.xml.bind.DatatypeConverter;
public class TencentCloudAPIDemo {private final static String CHARSET = "UTF-8";
public static String sign(String s, String key, String method) throws Exception {Mac mac = Mac.getInstance(method);
SecretKeySpec secretKeySpec = new SecretKeySpec(key.getBytes(CHARSET), mac.getAlg
orithm());
mac.init(secretKeySpec);
byte[] hash = mac.doFinal(s.getBytes(CHARSET));
return DatatypeConverter.printBase64Binary(hash);}public static String getStringToSign(TreeMap<String, Object> params) {StringBuilder s2s = new StringBuilder("GETcvm.tencentcloudapi.com/?");// When signing, the parameters need to be sorted in lexicographical order. TreeM
ap is used here to guarantee the correct order.
for (String k : params.keySet()) {s2s.append(k).append("=").append(params.get(k).toString()).append("&");}
return s2s.toString().substring(0, s2s.length() - 1);}
public static String getUrl(TreeMap<String, Object> params) throws UnsupportedEnc
odingException {StringBuilder url = new StringBuilder("https://cvm.tencentcloudapi.com/?");// There is no requirement for the order of the parameters in the actual request
URL.
for (String k : params.keySet()) {// The request string needs to be URL encoded. As the Key is all in English letters, only the value is URL encoded here.
url.append(k).append("=").append(URLEncoder.encode(params.get(k).toString(), CHAR
SET)).append("&");©2013-2022 Tencent Cloud. All rights reserved.

Page 55 of 289

Real User Monitoring}
return url.toString().substring(0, url.length() - 1);}
public static void main(String[] args) throws Exception {TreeMap<String, Object> params = new TreeMap<String, Object>(); // TreeMap enable
s automatic sorting// A random number should be used when actually calling, for example: params.put("Nonce", new Random().nextInt(java.lang.Integer.MAX_VALUE));params.put("Nonce", 11886); // Common parameter// The current time of the system should be used when actually calling, for examp
le: params.put("Timestamp", System.currentTimeMillis() / 1000);params.put("Timestamp", 1465185768); // Common parameterparams.put("SecretId", "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"); // Common parameterparams.put("Action", "DescribeInstances"); // Common parameterparams.put("Version", "2017-03-12"); // Common parameterparams.put("Region", "ap-guangzhou"); // Common parameterparams.put("Limit", 20); // Business parameterparams.put("Offset", 0); // Business parameterparams.put("InstanceIds.0", "ins-09dx96dg"); // Business parameterparams.put("Signature", sign(getStringToSign(params), "Gu5t9xGARNpq86cd98joQYCN3*******", "HmacSHA1")); // Common parameter
System.out.println(getUrl(params));}}

PythonNote: If running in a Python 2 environment, the following requests dependency package must be installed first: pip
install requests .

# -*- coding: utf8 -*import base64
import hashlib
import hmac
import time
import requests
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"
def get_string_to_sign(method, endpoint, params):
s = method + endpoint + "/?"
query_str = "&".join("%s=%s" % (k, params[k]) for k in sorted(params))
return s + query_str
def sign_str(key, s, method):
hmac_str = hmac.new(key.encode("utf8"), s.encode("utf8"), method).digest()
return base64.b64encode(hmac_str)©2013-2022 Tencent Cloud. All rights reserved.

Page 56 of 289

Real User Monitoring

if __name__ == '__main__':endpoint = "cvm.tencentcloudapi.com"
data = {'Action' : 'DescribeInstances','InstanceIds.0' : 'ins-09dx96dg','Limit' : 20,'Nonce' : 11886,'Offset' : 0,
'Region' : 'ap-guangzhou','SecretId' : secret_id,'Timestamp' : 1465185768, # int(time.time())'Version': '2017-03-12'}
s = get_string_to_sign("GET", endpoint, data)
data["Signature"] = sign_str(secret_key, s, hashlib.sha1)
print(data["Signature"])# An actual invocation would occur here, which may incur fees after success# resp = requests.get("https://" + endpoint, params=data)# print(resp.url)

Golangpackage main
import ("bytes""crypto/hmac""crypto/sha1""encoding/base64""fmt""sort")
func main() {secretId := "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secretKey := "Gu5t9xGARNpq86cd98joQYCN3*******"
params := map[string]string{"Nonce": "11886","Timestamp": "1465185768","Region": "ap-guangzhou","SecretId": secretId,"Version": "2017-03-12","Action": "DescribeInstances","InstanceIds.0": "ins-09dx96dg","Limit": "20","Offset": "0",}var buf bytes.Buffer©2013-2022 Tencent Cloud. All rights reserved.

Page 57 of 289

Real User Monitoring

buf.WriteString("GET")
buf.WriteString("cvm.tencentcloudapi.com")buf.WriteString("/")
buf.WriteString("?")// sort keys by ascii asc orderkeys := make([]string, 0, len(params))
for k, _ := range params {keys = append(keys, k)}sort.Strings(keys)
for i := range keys {k := keys[i]buf.WriteString(k)buf.WriteString("=")
buf.WriteString(params[k])buf.WriteString("&")}
buf.Truncate(buf.Len() - 1)hashed := hmac.New(sha1.New, []byte(secretKey))hashed.Write(buf.Bytes())
fmt.Println(base64.StdEncoding.EncodeToString(hashed.Sum(nil)))
}

PHP
<?php
$secretId = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";$secretKey = "Gu5t9xGARNpq86cd98joQYCN3*******";$param["Nonce"] = 11886;//rand();$param["Timestamp"] = 1465185768;//time();$param["Region"] = "ap-guangzhou";$param["SecretId"] = $secretId;$param["Version"] = "2017-03-12";$param["Action"] = "DescribeInstances";$param["InstanceIds.0"] = "ins-09dx96dg";$param["Limit"] = 20;$param["Offset"] = 0;
ksort($param);$signStr = "GETcvm.tencentcloudapi.com/?";foreach ( $param as $key => $value ) {$signStr = $signStr . $key . "=" . $value . "&";}
$signStr = substr($signStr, 0, -1);
$signature = base64_encode(hash_hmac("sha1", $signStr, $secretKey, true));echo $signature.PHP_EOL;// need to install and enable curl extension in php.ini©2013-2022 Tencent Cloud. All rights reserved.

Page 58 of 289

Real User Monitoring// $param["Signature"] = $signature;// $url = "https://cvm.tencentcloudapi.com/?".http_build_query($param);// echo $url.PHP_EOL;// $ch = curl_init();// curl_setopt($ch, CURLOPT_URL, $url);// $output = curl_exec($ch);// curl_close($ch);// echo json_decode($output);Ruby# -*- coding: UTF-8 -*# require ruby>=2.3.0
require 'time'require 'openssl'
require 'base64'
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"
method = 'GET'
endpoint = 'cvm.tencentcloudapi.com'
data = {'Action' => 'DescribeInstances','InstanceIds.0' => 'ins-09dx96dg','Limit' => 20,'Nonce' => 11886,'Offset' => 0,'Region' => 'ap-guangzhou','SecretId' => secret_id,'Timestamp' => 1465185768, # Time.now.to_i'Version' => '2017-03-12',}
sign = method + endpoint + '/?'
params = []data.sort.each do |item|
params << "#{item[0]}=#{item[1]}"endsign += params.join('&')
digest = OpenSSL::Digest.new('sha1')
data['Signature'] = Base64.encode64(OpenSSL::HMAC.digest(digest, secret_key, sign))puts data['Signature']# require 'net/http'# uri = URI('https://' + endpoint)# uri.query = URI.encode_www_form(data)# p uri©2013-2022 Tencent Cloud. All rights reserved.

Page 59 of 289

Real User Monitoring# res = Net::HTTP.get_response(uri)# puts res.body

DotNetusing System;
using System.Collections.Generic;using System.Net;
using System.Security.Cryptography;
using System.Text;
public class Application {public static string Sign(string signKey, string secret){string signRet = string.Empty;
using (HMACSHA1 mac = new HMACSHA1(Encoding.UTF8.GetBytes(signKey))){byte[] hash = mac.ComputeHash(Encoding.UTF8.GetBytes(secret));signRet = Convert.ToBase64String(hash);}return signRet;}
public static string MakeSignPlainText(SortedDictionary<string, string> requestParams, string requestMethod, string requestHost, string requestPath){string retStr = "";retStr += requestMethod;
retStr += requestHost;
retStr += requestPath;
retStr += "?";
string v = "";foreach (string key in requestParams.Keys){v += string.Format("{0}={1}&", key, requestParams[key]);}
retStr += v.TrimEnd('&');
return retStr;}
public static void Main(string[] args){
string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string endpoint = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";
double RequestTimestamp = 1465185768;©2013-2022 Tencent Cloud. All rights reserved.

Page 60 of 289

Real User Monitoring// long timestamp = ToTimestamp() / 1000;// string requestTimestamp = timestamp.ToString();
Dictionary<string, string> param = new Dictionary<string, string>();param.Add("Limit", "20");param.Add("Offset", "0");param.Add("InstanceIds.0", "ins-09dx96dg");
param.Add("Action", action);param.Add("Nonce", "11886");// param.Add("Nonce", Math.Abs(new Random().Next()).ToString());
param.Add("Timestamp", RequestTimestamp.ToString());
param.Add("Version", version);param.Add("SecretId", SECRET_ID);
param.Add("Region", region);
SortedDictionary<string, string> headers = new SortedDictionary<string, string>(param, StringComparer.Ordinal);
string sigInParam = MakeSignPlainText(headers, "GET", endpoint, "/");
Console.WriteLine(sigInParam);
string sigOutParam = Sign(SECRET_KEY, sigInParam);
Console.WriteLine("GET https://cvm.tencentcloudapi.com");foreach (KeyValuePair<string, string> kv in headers){Console.WriteLine(kv.Key + ": " + kv.Value);}
Console.WriteLine("Signature" + ": " + WebUtility.UrlEncode(sigOutParam));
Console.WriteLine();string result = "https://cvm.tencentcloudapi.com/?";foreach (KeyValuePair<string, string> kv in headers){
result += WebUtility.UrlEncode(kv.Key) + "=" + WebUtility.UrlEncode(kv.Value) +"&";}result += WebUtility.UrlEncode("Signature") + "=" + WebUtility.UrlEncode(sigOutPa
ram);
Console.WriteLine("GET " + result);}}

NodeJS
const crypto = require('crypto');function get_req_url(params, endpoint){
params['Signature'] = escape(params['Signature']);const url_strParam = sort_params(params)
return "https://" + endpoint + "/?" + url_strParam.slice(1);}function formatSignString(reqMethod, endpoint, path, strParam){©2013-2022 Tencent Cloud. All rights reserved.

Page 61 of 289

Real User Monitoring

let strSign = reqMethod + endpoint + path + "?" + strParam.slice(1);return strSign;}function sha1(secretKey, strsign){
let signMethodMap = {'HmacSHA1': "sha1"};
let hmac = crypto.createHmac(signMethodMap['HmacSHA1'], secretKey || "");
return hmac.update(Buffer.from(strsign, 'utf8')).digest('base64')}function sort_params(params){
let strParam = "";let keys = Object.keys(params);
keys.sort();for (let k in keys) {//k = k.replace(/_/g, '.');
strParam += ("&" + keys[k] + "=" + params[keys[k]]);}return strParam}function main(){const SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
const SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******"
const endpoint = "cvm.tencentcloudapi.com"
const Region = "ap-guangzhou"
const Version = "2017-03-12"
const Action = "DescribeInstances"
const Timestamp = 1465185768// const Timestamp = Math.round(Date.now() / 1000)
const Nonce = 11886//const nonce = Math.round(Math.random() * 65535)
let params = {};params['Action'] = Action;
params['InstanceIds.0'] = 'ins-09dx96dg';
params['Limit'] = 20;
params['Offset'] = 0;params['Nonce'] = Nonce;params['Region'] = Region;
params['SecretId'] = SECRET_ID;
params['Timestamp'] = Timestamp;
params['Version'] = Version;
strParam = sort_params(params)
const reqMethod = "GET";
const path = "/";
strSign = formatSignString(reqMethod, endpoint, path, strParam)
console.log(strSign)
console.log("-----------------------")
params['Signature'] = sha1(SECRET_KEY, strSign)
console.log(params['Signature'])©2013-2022 Tencent Cloud. All rights reserved.

Page 62 of 289

Real User Monitoring

console.log("-----------------------")
const req_url = get_req_url(params, endpoint)
console.log(params['Signature'])console.log("-----------------------")
console.log(req_url)}
main()©2013-2022 Tencent Cloud. All rights reserved.

Page 63 of 289

Real User Monitoring

Responses：

Last updated 2022-02-23 16:03:03

Response for Successful Requests
For example, when calling CAM API (version: 2017-03-12) to view the status of instances (DescribeInstancesStatus),
if the request has succeeded, you may see the response as shown below:{"Response": {"TotalCount": 0,"InstanceStatusSet": [],"RequestId": "b5b41468-520d-4192-b42f-595cc34b6c1c"}}
The API will return Response , which contains RequestId , as long as it processes the request. It does notmatter if the request is successful or not.
RequestId is the unique ID of an API request. Contact us with this ID when an exception occurs.
Except for the fixed fields, all fields are action-specified. For the definitions of action-specified fields, see thecorresponding API documentation. In this example, TotalCount and InstanceStatusSet are the fields
specified by the API DescribeInstancesStatus . 0 TotalCount means that the requester owns 0 CVM
instance so the InstanceStatusSet is empty.

Response for Failed Requests
If the request has failed, you may see the response as shown below:{"Response": {"Error": {"Code": "AuthFailure.SignatureFailure","Message": "The provided credentials could not be validated. Please ensure your signature is correct."},"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 64 of 289

Real User Monitoring

The presence of the Error field indicates that the request has failed. A response for a failed request will include
Error , Code and Message fields.
Code is the code of the error that helps you identify the cause and solution. There are two types of error codes
so you may find the code in either common error codes or API-specified error codes.
Message explains the cause of the error. Note that the returned messages are subject to service updates. The
information the messages provide may not be up-to-date and should not be the only source of reference.
RequestId is the unique ID of an API request. Contact us with this ID when an exception occurs.

Common Error Codes
If there is an Error field in the response, it means that the API call failed. The Code field in Error indicates the error
code. The following table lists the common error codes that all actions can return.
Error CodeDescription

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

AuthFailure.MFAFailure

MFA failed.

AuthFailure.SecretIdNotFoundThe key does not exist.

AuthFailure.SignatureExpire

Signature expired.

AuthFailure.SignatureFailure

Signature error.

AuthFailure.TokenFailure

Token error.

AuthFailure.UnauthorizedOperation

The request does not have CAM authorization.

DryRunOperation

DryRun Operation. It means that the request would have succeeded, but
the DryRun parameter was used.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidAction

The API does not exist.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Invalid parameter value.

LimitExceeded

Quota limit exceeded.

MissingParameter

A parameter is missing.

©2013-2022 Tencent Cloud. All rights reserved.

Page 65 of 289

Real User Monitoring

NoSuchVersion

The API version does not exist.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

Resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

Resource is unavailable.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

UnsupportedProtocol
UnsupportedRegion

HTTPS request method error. Only GET and POST requests aresupported.
API does not support the requested region.

©2013-2022 Tencent Cloud. All rights reserved.

Page 66 of 289

Real User Monitoring

Console APIs
DescribeError：

Last updated 2023-07-06 17:39:28

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the homepage error information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeError.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

Date

Yes

String

Date

ID

Yes

Integer

Project ID

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 67 of 289

Real User Monitoring

Content

StringContent

ID

Integer

Project ID

CreateTime

StringTime

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting homepage error information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeError&ID=1&Date=20210520&<Common request parameters>

Output Example{"Response": {"ID": 1,"CreateTime": "20210520","Content": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 68 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 69 of 289

Real User Monitoring

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 70 of 289

Real User Monitoring

DescribeWhitelists：

Last updated 2023-07-06 17:39:27

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the list of allowlists.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeWhitelists.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceID

Yes

String

Instance ID

3. Output Parameters
Parameter
Name
WhitelistSet

Type
Array ofWhitelist

Description

Allowlist list

©2013-2022 Tencent Cloud. All rights reserved.

Page 71 of 289

Real User Monitoring

RequestId

String

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Getting allowlist list
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeWhitelists&InstanceID=taw-123&<Common request parameters>

Output Example{"Response": {"WhitelistSet": [],"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 72 of 289

Real User Monitoring

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code
DryRunOperation

Description
DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 73 of 289

Real User Monitoring

DescribeUvList：

Last updated 2023-07-06 17:39:27

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the list of UVs under a project.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeUvList.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ProjectId

Yes

IntegerID

EndTimeYes

String

End time

StartTime

Yes

StringStart time

Dimension

No

StringGet day:d min:m

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 74 of 289

Real User Monitoring

Name
ProjectUvSet

Array of
RumUvInfo

UV listRequestId

String

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Getting UV list
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeUvList&ProjectId=1&StartTime="1"&EndTime="20"&Dimension="d"&<Common request parameters>

Output Example{"Response": {"ProjectUvSet": [],"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go©2013-2022 Tencent Cloud. All rights reserved.

Page 75 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 76 of 289

Real User Monitoring

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 77 of 289

Real User Monitoring

DescribeTawInstances：

Last updated 2022-02-23 15:56:54

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to query instance information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides
higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See
details.
Parameter Name

RequiredType

Description

ActionYes

StringCommon parameter. The value used for this API:
DescribeTawInstances.

VersionYes

StringCommon parameter. The value used for this API: 2021-06-22.

RegionNo

StringCommon parameter. This parameter is not required for this API.

No

Array
of
Integer

Billing status

No

Array
of
Integer

Billing type

ChargeStatuses.N

ChargeTypes.N©2013-2022 Tencent Cloud. All rights reserved.

Page 78 of 289

Real User Monitoring

Limit

No

Integer

Pagination limit

OffsetNo

Integer

Pagination offset

No

Array
of
Integer

Region ID

No

Array
of
Integer

Instance status (1: creating; 2: running; 3: exceptional; 4:
restarting; 5: stopping; 6: stopped; 7: terminating; 8: terminated)

No

Array
of
String

Instance ID

AreaIds.N

InstanceStatuses.N

InstanceIds.N

Filters.N

No

Array
of

Filter parameter

Filter

3. Output Parameters
Parameter
Name

Type

Description

InstanceSet

Array ofRumInstanceInfo

Instance list

TotalCount

Integer

Total number of instances

RequestId

String

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Querying instance
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTawInstances©2013-2022 Tencent Cloud. All rights reserved.

Page 79 of 289

Real User Monitoring<Common request parameters>{}

Output Example{"Response": {"InstanceSet": [{"AreaId": "1","ChargeStatus": 1,"ChargeType": 1,"ClusterId": "1","CreatedAt": "2021-04-29 20:51:05","DataRetentionDays": "30","InstanceDesc": "","InstanceId": "taw-VJ2mHDEb","InstanceName": "test","InstanceStatus": 2,"Tags": [],"UpdatedAt": "2021-04-29 20:51:05"},{"AreaId": "1","ChargeStatus": 1,"ChargeType": 1,"ClusterId": "1","CreatedAt": "2021-04-29 20:59:15","DataRetentionDays": "30","InstanceDesc": "","InstanceId": "taw-mE08H4Ez","InstanceName": "test","InstanceStatus": 2,"Tags": [],"UpdatedAt": "2021-04-29 20:59:15"}],"RequestId": "d356e035-ac3d-4237-add9-50a44c01dd39","TotalCount": "2"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 80 of 289

Real User Monitoring

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 81 of 289

Real User Monitoring

DescribeTawAreas：

Last updated 2023-07-06 17:39:27

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to query region information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeTawAreas.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for thisAPI.

AreaIds.N

No

Array ofInteger

Region ID

AreaKeys.N

No

Array of
StringRegion key

Limit

No

Integer

Pagination limit

AreaStatuses.N

No

Array ofInteger

Region status (1: valid; 2: invalid)©2013-2022 Tencent Cloud. All rights reserved.

Page 82 of 289

Real User Monitoring

OffsetNo

Integer

Pagination offset

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total number of regions

AreaSetArray of
RumAreaInfo

Region list

RequestId

String

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Querying region
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTawAreas<Common request parameters>{"AreaIds": [1],"AreaStatuses": [1],"Limit": 0,"Offset": 100}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 83 of 289

Real User Monitoring{"Response": {"TotalCount": 1,"AreaSet": [{"AreaId": 1,"AreaStatus": 1,"AreaName": "Chinese mainland","AreaKey": "area_cn_dl"}],"RequestId": "10f605a3-6480-4254-bbb7-7ca1ab6a133e"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription©2013-2022 Tencent Cloud. All rights reserved.

Page 84 of 289

Real User Monitoring

AuthFailure

Error with CAM signature/authentication.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 85 of 289

Real User Monitoring

DescribeReleaseFiles：

Last updated 2023-04-27 15:44:49

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the list of source maps of an application.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeReleaseFiles.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ProjectID

Yes

Integer

Project ID

FileVersion

No

StringFile version

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 86 of 289

Real User Monitoring

Files

Array of
ReleaseFile

RequestId

StringFile information list

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Getting the list of source maps of an application
This example shows you how to get the list of source maps of an application
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeReleaseFiles&ProjectID=1&<Common request parameters>

Output Example{"Response": {"Files": [],"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET

©2013-2022 Tencent Cloud. All rights reserved.

Page 87 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

©2013-2022 Tencent Cloud. All rights reserved.

Page 88 of 289

Real User Monitoring

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 89 of 289

Real User Monitoring

DescribeReleaseFileSign：

Last updated 2023-04-27 15:44:49

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the temporary key for uploaded file storage.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeReleaseFileSign.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

Timeout

No

Integer

Timeout period. If it is not set, it will be 5 minutes by default

FileType

No

Integer

Bucket type. Valid values: 1 : (Web, which is the default value),
2 (Application).

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 90 of 289

Real User Monitoring

Name
SecretKey

String

Temporary key

SecretID

String

Temporary key ID

SessionToken

String

Temporary key token

StartTime

IntegerStart timestamp

ExpiredTime

Integer

Expiration timestamp

RequestId

String

The unique request ID, which is returned for each request. RequestId is required
for locating a problem.

4. Example
Example1 Obtaining the temporary key
This example shows you how to obtain the temporary key.
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeReleaseFileSign&<Common request parameters>

Output Example{"Response": {"SecretKey": "dahfldaflndfdfdsf","SecretID": "asdkadalsdlsafk","SessionToken": "fdslkfjdkjfldsjfdfdf","StartTime": 1232132132,"ExpiredTime": 123212143434,"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 91 of 289

Real User Monitoring

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

©2013-2022 Tencent Cloud. All rights reserved.

Page 92 of 289

Real User Monitoring

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 93 of 289

Real User Monitoring

DescribePvList：

Last updated 2023-07-06 17:39:27

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the list of PVs under a project.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribePvList.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ProjectId

Yes

IntegerID

EndTimeYes

String

End time

StartTime

Yes

StringStart time

Dimension

No

StringGet day:d (leave this parameter empty if to get min)3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 94 of 289

Real User Monitoring

Name

ProjectPvSet

RequestId

Array ofPV listRumPvInfo

Note: this field may return null, indicating that no valid values can beobtained.

String

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Getting PV list
Input Example
https://rum.tencentcloudapi.com/?Action=DescribePvList&ProjectId=1&StartTime="1"&EndTime="20"&Dimension="d"&<Common request parameters>

Output Example{"Response": {"ProjectPvSet": [],"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 95 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 96 of 289

Real User Monitoring

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 97 of 289

Real User Monitoring

DescribeDataPvUrlInfo：

Last updated 2023-07-06 17:39:28

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the PvUrlInfo information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeDataPvUrlInfo.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time

Type

Yes

StringType

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID

ExtSecond

No

StringCustom 2

EngineNo

StringBrowser engineName©2013-2022 Tencent Cloud. All rights reserved.

Page 98 of 289

Real User Monitoring

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

Env

No

StringEnvironment

3. Output Parameters
Parameter

Type

Description

ResultStringReturned value

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting PvUrlInfo information©2013-2022 Tencent Cloud. All rights reserved.

Page 99 of 289

Real User Monitoring

Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataPvUrlInfo&ID=1&StartTime=1625444040&EndTime=1625454840&Type=pagepv&Level=1&Isp=China Mobile&Area=China&NetType=2&Platform=2&Device=Samsung&VersionNum=Version&ExtFirst=Custom 1&ExtSecond=Custom 2&ExtThird=Custom 3&IsAbroad=1&Browser=ie&Os=apple&Engine=ie2&Brand=apple&From=index.html&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 100 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

©2013-2022 Tencent Cloud. All rights reserved.

Page 101 of 289

Real User Monitoring

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 102 of 289

Real User Monitoring

DescribeDataLogUrlInfo：

Last updated 2023-07-06 17:39:28

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the loginfo information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ID

Yes

Integer

Project ID

StartTime

Yes

Integer

Timestamp

EndTimeYes

Integer

Timestamp

Name

Description
Common Params. The value used for this API:
DescribeDataLogUrlInfo.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 103 of 289

Real User Monitoring

Parameter
Name

Type

Description

ResultStringResponse string

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting dataloginfo information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataLogUrlInfo&ID=1&StartTime=1625444040&EndTime=1625454840&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS©2013-2022 Tencent Cloud. All rights reserved.

Page 104 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 105 of 289

Real User Monitoring

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 106 of 289

Real User Monitoring

DescribeData：

Last updated 2023-07-06 17:39:28

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to query the forwarding monitor.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeData.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

Query

Yes

StringQuery string

ID

Yes

Integer

Project ID

3. Output Parameters
Parameter
Name
ResultType

Description

StringResponse string©2013-2022 Tencent Cloud. All rights reserved.

Page 107 of 289

Real User Monitoring

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting QueryData
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeData&ID=1&Query="select delta(count) as allCount from pv_url_statistics where time >= 1621
240040s and time <= 1621243620s and id='1613' group by \"ext3\" slimit 1000"&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 108 of 289

Real User Monitoring

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

©2013-2022 Tencent Cloud. All rights reserved.

Page 109 of 289

Real User Monitoring

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 110 of 289

Real User Monitoring

DeleteWhitelist：

Last updated 2023-07-06 17:39:29

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to delete an allowlist.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DeleteWhitelist.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceID

Yes

String

Instance ID

ID

Yes

StringList ID

3. Output Parameters
Parameter
Name

Type

Description

Msg

StringSuccess message©2013-2022 Tencent Cloud. All rights reserved.

Page 111 of 289

Real User Monitoring

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Deleting allowlist
Input Example
https://rum.tencentcloudapi.com/?Action=DeleteWhitelist&ID=1&InstanceID=taw-123&<Common request parameters>

Output Example{"Response": {"Msg": "","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 112 of 289

Real User Monitoring

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 113 of 289

Real User Monitoring

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 114 of 289

Real User Monitoring

DeleteReleaseFile：

Last updated 2023-07-06 17:39:29

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to delete the specified sourcemap file.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DeleteReleaseFile.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ID

Yes

Integer

File ID

3. Output Parameters
Parameter

Type

Description

Msg

StringResponse string of the API request

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forName©2013-2022 Tencent Cloud. All rights reserved.

Page 115 of 289

Real User Monitoring

locating a problem.

4. Example
Example1 Deleting file record
Input Example
https://rum.tencentcloudapi.com/?Action=DeleteReleaseFile&ID=1&<Common request parameters>

Output Example{"Response": {"Msg": "success","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 116 of 289

Real User Monitoring

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 117 of 289

Real User Monitoring

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 118 of 289

Real User Monitoring

CreateWhitelist：

Last updated 2023-07-06 17:39:30

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to create an allowlist.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CreateWhitelist.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceID

Yes

String

Instance ID, such as taw-123

RemarkYes

StringRemarks

WhitelistUin

YesStringuin: business identifier

Aid

No

StringBusiness identifier

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 119 of 289

Real User Monitoring

Name
Msg

StringMessage

ID

Integer

Allowlist ID

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Creating an allowlist
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWhitelist<Common request parameters>{"InstanceID": "taw-123","Aid": "222","Remark": "Remarks","WhitelistUin": "1123"}

Output Example{"Response": {"Msg": "xx","ID": 1,"RequestId": "xx"}}

Example2 12
Input Example©2013-2022 Tencent Cloud. All rights reserved.

Page 120 of 289

Real User Monitoring

POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWhitelist<Common request parameters>{"InstanceID": "taw-123","Aid": "333","Remark": "222","WhitelistUin": "22323"}

Output Example{"Response": {"ID": 77,
"Msg": "success","RequestId": "fcaec326-8c68-4302-8624-c5b08b9f1893"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 121 of 289

Real User Monitoring

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 122 of 289

Real User Monitoring

CreateReleaseFile：

Last updated 2023-07-06 17:39:30

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to create a file record for the specified project.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2021-0622.

RegionNo

StringCommon Params. This parameter is not required for thisAPI.

ProjectID

Yes

Integer

Project ID

Files.N

Yes

Name

Array of
ReleaseFile

Description
Common Params. The value used for this API:
CreateReleaseFile.

File information list

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 123 of 289

Real User Monitoring

Parameter
Name

Type

Description

Msg

StringCall result

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Creating file record
Input Example
https://rum.tencentcloudapi.com/?Action=CreateReleaseFile&ProjectID=1&Files.0.Version='0.0.1'&Files.0.FileName='a.js.map'&Files.0.FileKey='1-0.0.1-a.js.map'&Files.0.FileHash='sadfjfhdkhfksdjhg;'&<Common request parameters>

Output Example{"Response": {"Msg": "success","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 124 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 125 of 289

Real User Monitoring

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 126 of 289

Real User Monitoring

Log APIs
DescribeRumStatsLogList：

Last updated 2023-07-06 17:39:24

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the list of logs in a project every minute.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

StringStart time (required)

Limit

Yes

Integer

The number of raw logs returned for a single query. This parameter isrequired. Maximum value: 100 .

Query

Yes

String

EndTimeYes

StringName

Description
Common Params. The value used for this API:
DescribeRumStatsLogList.

Query statement, which is required and can contain up to 4,096
characters.
End time (required)©2013-2022 Tencent Cloud. All rights reserved.

Page 127 of 289

Real User Monitoring

ID

Yes

Integer

Project ID (required)

3. Output Parameters
Parameter

Type

Description

ResultStringResponse string

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting the log list
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRumStatsLogList<Common request parameters>{"StartTime": "\"1\"","Limit": "10","Query": "\"xxx\"","EndTime": "\"20\"","ID": "10"}Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 128 of 289

Real User Monitoring

Example2 1212
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRumStatsLogList<Common request parameters>{"Query": "1",
"EndTime": "1",
"Limit": "1",
"ID": "1","StartTime": "1"}

Output Example{"Response": {"RequestId": "7987e9a1-cece-4468-b104-cd239f2f6cd6","Result": ""}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 129 of 289

Real User Monitoring

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 130 of 289

Real User Monitoring

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 131 of 289

Real User Monitoring

DescribeRumLogList：

Last updated 2023-07-06 17:39:24

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the list of logs in a project (created by an instance).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeRumLogList.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

OrderBy

Yes

String

Sorting order (required). Valid values: desc , asc .

StartTime

Yes

StringStart time in milliseconds. It is in timestamp format and is required.

Limit

Yes

IntegerPage

Yes

Integer

Page number

Query

Yes

StringQuery statement, which is required and can contain up to 4,096
characters.

Name

The number of raw logs returned for a single query. This parameter isrequired. Maximum value: 100 .

©2013-2022 Tencent Cloud. All rights reserved.

Page 132 of 289

Real User Monitoring

EndTimeYes

String

End time in milliseconds. It is in timestamp format and is required.

ID

Yes

Integer

Project ID (required)

3. Output Parameters
Parameter
Name

Type

Description

ResultStringResponse string

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting the log list
This example shows you how to get the log list.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRumLogList<Common request parameters>{"OrderBy": "desc","ID": "120000","Limit": "100","StartTime": "1665994920000","Query": "id:120000","EndTime": "1673417492913","Page": "1"}

Output Example{"Response": {©2013-2022 Tencent Cloud. All rights reserved.

Page 133 of 289

Real User Monitoring"RequestId": "72ef03a0-01a8-443e-908a-8573fbeaafcd","Result": ""}}Example2 123
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRumLogList<Common request parameters>{"OrderBy": "asc","ID": "4",
"Limit": "1","StartTime": "1676390400000","Query": "id:4","EndTime": "1676476799000","Page": "1"}

Output Example{"Response": {"RequestId": "a6bafa2f-3f6a-4f1a-b9a3-d1d848d34168","Result": ""}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 134 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

©2013-2022 Tencent Cloud. All rights reserved.

Page 135 of 289

Real User Monitoring

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 136 of 289

Real User Monitoring

DescribeRumGroupLog：

Last updated 2023-07-06 17:39:25

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the log aggregation information under a project.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeRumGroupLog.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

OrderBy

Yes

String

Sorting order (required). Valid values: desc , asc .

StartTime

Yes

StringStart time (required)

Limit

Yes

Integer

The number of raw logs returned for a single query. This parameter isrequired. Maximum value: 100 .

Page

Yes

Integer

Page number

Query

Yes

StringQuery statement, which is required and can contain up to 4,096
characters.

Name©2013-2022 Tencent Cloud. All rights reserved.

Page 137 of 289

Real User Monitoring

EndTimeYes

String

End time (required)

ID

Yes

Integer

Project ID (required)GroupField

Yes

StringAggregate field

3. Output Parameters
Parameter

Type

Description

ResultStringResponse string

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting the log list
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRumGroupLog<Common request parameters>{"OrderBy": "\"desc\"","StartTime": "\"1\"","Limit": "10","Query": "\"xxx\"","EndTime": "\"20\"","ID": "10","Page": "1","GroupField": "xx"}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 138 of 289

Real User Monitoring{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

Example2 2312
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRumGroupLog<Common request parameters>{"OrderBy": "asc","ID": "1",
"Limit": "1","GroupField": "","StartTime": "1",
"Query": "1",
"EndTime": "1","Page": "1"}

Output Example{"Response": {"RequestId": "81a43a52-d00f-462a-82da-89841117f4ca","Result": ""}}5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 139 of 289

Real User Monitoring

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

©2013-2022 Tencent Cloud. All rights reserved.

Page 140 of 289

Real User Monitoring

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 141 of 289

Real User Monitoring

DescribeRumLogExports：

Last updated 2023-07-06 17:39:25

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the list of exported logs in a project.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

PageSize

Yes

Integer

Page size

PageNum

Yes

Integer

Page number

ID

Yes

Integer

Project ID (required)

Description
Common Params. The value used for this API:
DescribeRumLogExports.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 142 of 289

Real User Monitoring

Parameter

Type

Description

ResultStringResponse string

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting the log list
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRumLogExports<Common request parameters>{"PageSize": "10","ID": "10","PageNum": "1"}

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

Example2 xc
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRumLogExports©2013-2022 Tencent Cloud. All rights reserved.

Page 143 of 289

Real User Monitoring<Common request parameters>{"PageNum": "1",
"ID": "1","PageSize": "1"}

Output Example{"Response": {"RequestId": "641faf00-efc4-46b5-b3ce-03383133dc08","Result": ""}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 144 of 289

Real User Monitoring

Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 145 of 289

Real User Monitoring

DescribeRumLogExport：

Last updated 2023-07-06 17:39:25

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the list of logs in a project (created by an instance).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

Name

Yes

StringExport identifier nameStartTime

Yes

StringStart time (required)

Query

Yes

StringQuery statement, which is required and can contain up to 4,096
characters.

EndTimeYes

String

End time (required)

ID

Yes

Integer

Project ID (required)Name©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
DescribeRumLogExport.

Page 146 of 289

Real User Monitoring

Fields.N

No

Array of
StringFilter field

3. Output Parameters
Parameter

Type

Description

ResultStringResponse string

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting the log list
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRumLogExport<Common request parameters>{"Name": "xx","Fields": ["xx"],"StartTime": "xx","Query": "xx","EndTime": "xx","ID": 0}

Output Example{"Response": {"Result": "xxxx",©2013-2022 Tencent Cloud. All rights reserved.

Page 147 of 289

Real User Monitoring"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

Example2 1212
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRumLogExport<Common request parameters>{"Query": "id:1","EndTime": "1","Name": "","StartTime": "1665994920000","ID": "1"}Output Example{"Response": {"RequestId": "763188d1-9f99-45e8-8bbf-bcdffa8f58f0","Result": ""}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go©2013-2022 Tencent Cloud. All rights reserved.

Page 148 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 149 of 289

Real User Monitoring

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 150 of 289

Real User Monitoring

Page View APIs
DescribeDataPvUrlStatistics：

Last updated 2023-07-06 17:39:23

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataPvUrlStatistics information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataPvUrlStatistic

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time
allcount ; performance view; day : 14-day data, vp : performanc

Type

Yes

Stringnettype / version / platform / isp / region / device /network/platform view; version view; device view; ISP view; region view; b

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID©2013-2022 Tencent Cloud. All rights reserved.

Page 151 of 289

Real User Monitoring

ExtSecond

No

StringCustom 2

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

Env

No

StringEnvironment

3. Output Parameters
Parameter
Name

Type

Description

ResultStringReturned value

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 152 of 289

Real User Monitoring

4. Example
Example1 Getting DescribeDataPvUrlStatistics information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataPvUrlStatistics&ID=1&StartTime=1625444040&EndTime=1625454840&Type=pagepv&Level=1&Isp=China Mobile&Area=China&NetType=2&Platform=2&Device=Samsung&VersionNum=Version&ExtFirst=Custom 1&ExtSecond=Custom 2&ExtThird=Custom 3&IsAbroad=1&Browser=ie&Os=apple&Engine=ie2&Brand=apple&From=index.html&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 153 of 289

Real User Monitoring

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 154 of 289

Real User Monitoring

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 155 of 289

Real User Monitoring

Page Performance APIs
DescribeDataPerformancePage：

Last updated 2023-07-06 17:39:24

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the PerformancePage information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataPerformance

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ID

Yes

Integer

Project ID

StartTime

Yes

IntegerStart time

EndTimeYes

Integer

End time

Type

Yes

Stringpagepv : PV view; allcount : performance view; falls : page lo
nettype : network/platform view; performance : top underperformversion / platform / isp / region / device / browser /version view; device view; ISP view; region view; browser view, and so on©2013-2022 Tencent Cloud. All rights reserved.

Page 156 of 289

Real User Monitoring

Level

No

StringLog level

Isp

No

String

ISP

Area

No

StringRegionNetTypeNo

StringNetwork type

Platform

No

StringPlatform

DeviceNo

StringModel

VersionNum

No

String

Version

ExtFirst

No

StringCustom 1

ExtSecond

No

StringCustom 2

ExtThird

No

StringCustom 3

IsAbroadNo

StringWhether it is outside the Chinese mainland

BrowserNo

StringBrowserOs

No

StringOS

EngineNo

StringBrowser engine

Brand

No

String

Brand

From

No

StringSource page

CostType

No

StringDuration calculation method

Env

No

StringEnvironment variable

NetStatus

No

StringNetwork status

3. Output Parameters
Parameter
Name

Type

Description

ResultStringReturned value

RequestId

String

The unique request ID, which is returned for each request. RequestId is required for©2013-2022 Tencent Cloud. All rights reserved.

Page 157 of 289

Real User Monitoring

locating a problem.

4. Example
Example1 Getting PerformancePage information
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataPerformancePage<Common request parameters>{"ExtSecond": "Custom 2","Engine": "ie2","IsAbroad": "1",
"Area": "China","NetType": "2",
"Level": "1","Os": "apple","Brand": "apple","Isp": "China Mobile","VersionNum": "Version","Platform": "2",
"ExtThird": "Custom 3","ExtFirst": "Custom 1","StartTime": "1625444040","Device": "Samsung","From": "index.html","EndTime": "1625454840","Type": "pagepv","ID": "1",
"Browser": "ie"}Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"©2013-2022 Tencent Cloud. All rights reserved.

Page 158 of 289

Real User Monitoring}}

Example2 22
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataPerformancePage<Common request parameters>{"EndTime": "1658390700","Type": "allcount","ID": "1","StartTime": "1658304300"}

Output Example{"Response": {"RequestId": "ddec0dc8-3268-4571-9ac0-566ae7537495","Result": "{\"request_id\":\"ddec0dc8-3268-4571-9ac0-566ae7537495\",\"results\":[{\"statement_id\":0,\"total\":0},{\"statement_id\":1,\"total\":0},{\"statement_id\":2,\"total\":0},{\"statement_id\":3,\"total\":0}]}"}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go©2013-2022 Tencent Cloud. All rights reserved.

Page 159 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

©2013-2022 Tencent Cloud. All rights reserved.

Page 160 of 289

Real User Monitoring

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 161 of 289

Real User Monitoring

DescribeDataWebVitalsPage：

Last updated 2023-07-06 17:39:23

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataWebVitalsPage information, which is about core user activities.
It includes the Web Vitals metric for the page loading performance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeDataWebVitalsPage.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID

ExtSecond

No

StringCustom 2

EngineNo

StringBrowser engine©2013-2022 Tencent Cloud. All rights reserved.

Page 162 of 289

Real User Monitoring

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Type

No

StringNo type yet

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

CostType

No

StringDuration calculation

Env

No

StringEnvironment

3. Output Parameters
Parameter

Type

Description

ResultStringReturned value

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 163 of 289

Real User Monitoring

4. Example
Example1 Getting WebVitalsPage information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataWebVitalsPage&ID=1&StartTime=1625444040&EndTime=1625454840&Type=pagepv&Level=1&Isp=China Mobile&Area=China&NetType=2&Platform=2&Device=Samsung&VersionNum=Version&ExtFirst=Custom 1&ExtSecond=Custom 2&ExtThird=Custom 3&IsAbroad=1&Browser=ie&Os=apple&Engine=ie2&Brand=apple&From=index.html&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 164 of 289

Real User Monitoring

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 165 of 289

Real User Monitoring

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 166 of 289

Real User Monitoring

DescribeDataSetUrlStatistics：

Last updated 2023-07-06 17:39:24

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataSetUrlStatistics information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataSetUrlStatis

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time
allcount : performance view; data : mini program; component

Type

Yes

Stringnettype : network/platform view; performance : top underperfor
version / platform / isp / region / device / browser /version view; device view; ISP view; region view; browser view, and so o

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID

ExtSecond

No

StringCustom 2©2013-2022 Tencent Cloud. All rights reserved.

Page 167 of 289

Real User Monitoring

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

CostType

No

StringDuration calculation

Env

No

StringEnvironment

PackageType

No

StringThe obtained package.

3. Output Parameters
Parameter
Name

Type

Description

ResultStringReturned value

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 168 of 289

Real User Monitoring

4. Example
Example1 Getting DescribeDataSetUrlStatistics information
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataSetUrlStatistics<Common request parameters>{"ExtSecond": "Custom 2","Engine": "ie2","IsAbroad": "1",
"Area": "China","NetType": "2",
"CostType": "avg","Level": "1","Os": "apple","Brand": "apple","Isp": "China Mobile","VersionNum": "Version","Platform": "2",
"ExtThird": "Custom 3","ExtFirst": "Custom 1","StartTime": "1625444040","Device": "Samsung","From": "index.html","EndTime": "1625454840","Type": "pagepv","ID": "1",
"Browser": "ie"}Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 169 of 289

Real User Monitoring

Example2 222
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataSetUrlStatistics<Common request parameters>{"EndTime": "1625454840","Type": "condition","ID": "1","StartTime": "1625444040"}

Output Example{"Response": {"RequestId": "888d57f1-f544-4291-9a88-8638c050f208","Result": "{\"request_id\":\"888d57f1-f544-4291-9a88-8638c050f208\",\"results\":[{\"statement_id\":0,\"total\":0},{\"statement_id\":1,\"total\":0},{\"statement_id\":2,\"total\":0}]}"}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 170 of 289

Real User Monitoring

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

©2013-2022 Tencent Cloud. All rights reserved.

Page 171 of 289

Real User Monitoring

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 172 of 289

Real User Monitoring

Static Resource Monitoring APIs
DescribeDataStaticUrl：

Last updated 2023-07-06 17:39:22

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataStaticUrl information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataStaticUrl.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time
pagepv : page view;

Type

Yes

Stringnettype / version / platform / isp / region / device /network/platform view; version view; device view; ISP view; region view; b

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID©2013-2022 Tencent Cloud. All rights reserved.

Page 173 of 289

Real User Monitoring

ExtSecond

No

StringCustom 2

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

CostType

No

StringDuration calculation method

Url

No

StringSourceEnv

No

StringEnvironment

3. Output Parameters
Parameter
Name

Type

Description

ResultStringReturned value

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 174 of 289

Real User Monitoring

4. Example
Example1 Getting DescribeDataStaticUrl information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataStaticUrl&ID=1&StartTime=1625444040&EndTime=1625454840&Type=pagepv&Level=1&Isp=China Mobile&Area=China&NetType=2&Platform=2&Device=Samsung&VersionNum=Version&ExtFirst=Custom 1&ExtSecond=Custom 2&ExtThird=Custom 3&IsAbroad=1&Browser=ie&Os=apple&Engine=ie2&Brand=apple&From=index.html&CostType=avg&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 175 of 289

Real User Monitoring

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

©2013-2022 Tencent Cloud. All rights reserved.

Page 176 of 289

Real User Monitoring

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 177 of 289

Real User Monitoring

DescribeDataStaticResource：

Last updated 2023-07-06 17:39:23

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataStaticResource information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataStaticResour

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time
top : top resources view; count40x : HTTP status codes 40X view;

Type

Yes

Stringnettype / version / platform / isp / region / device /network/platform view; version view; device view; ISP view; region view; b

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID

ExtSecond

No

StringCustom 2©2013-2022 Tencent Cloud. All rights reserved.

Page 178 of 289

Real User Monitoring

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

CostType

No

StringDuration calculation method

Url

No

StringSourceEnv

No

StringEnvironment

3. Output Parameters
Parameter
Name

Type

Description

ResultStringReturned value

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 179 of 289

Real User Monitoring

4. Example
Example1 Getting DescribeDataStaticResource information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataStaticResource&ID=1&StartTime=1625444040&EndTime=1625454840&Type=pagepv&Level=1&Isp=China Mobile&Area=China&NetType=2&Platform=2&Device=Samsung&VersionNum=Version&ExtFirst=Custom 1&ExtSecond=Custom 2&ExtThird=Custom 3&IsAbroad=1&Browser=ie&Os=apple&Engine=ie2&Brand=apple&From=index.html&CostType=avg&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 180 of 289

Real User Monitoring

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 181 of 289

Real User Monitoring

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 182 of 289

Real User Monitoring

DescribeDataStaticProject：

Last updated 2023-07-06 17:39:23

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataStaticProject information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataStaticProject

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time
allcount : performance view; day : 14-day data; condition : co

Type

Yes

Stringnettype / version / platform / isp / region / device /network/platform view; version view; device view; ISP view; region view; b

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID

ExtSecond

No

StringCustom 2©2013-2022 Tencent Cloud. All rights reserved.

Page 183 of 289

Real User Monitoring

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

CostType

No

StringDuration calculation

No

Array
of

SourceUrl.N

StringEnv

No

StringEnvironment

3. Output Parameters
Parameter
Name

Type

Description

ResultStringReturned value

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 184 of 289

Real User Monitoring

4. Example
Example1 Getting DescribeDataStaticProject information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataStaticProject&ID=1&StartTime=1625444040&EndTime=1625454840&Type=pagepv&Level=1&Isp=China Mobile&Area=China&NetType=2&Platform=2&Device=Samsung&VersionNum=Version&ExtFirst=Custom 1&ExtSecond=Custom 2&ExtThird=Custom 3&IsAbroad=1&Browser=ie&Os=apple&Engine=ie2&Brand=apple&From=index.html&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 185 of 289

Real User Monitoring

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

©2013-2022 Tencent Cloud. All rights reserved.

Page 186 of 289

Real User Monitoring

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 187 of 289

Real User Monitoring

Custom Speed Test APIs
DescribeDataCustomUrl：

Last updated 2023-07-06 17:39:26

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataCustomUrl information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataCustomUrl.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time
top : top resources view; allcount : performance view; day : 14-

Type

Yes

Stringspeed distribution;
nettype / version / platform / isp / region / device /network/platform view; version view; device view; ISP view; region view; b

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID©2013-2022 Tencent Cloud. All rights reserved.

Page 188 of 289

Real User Monitoring

ExtSecond

No

StringCustom 2

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

CostType

No

StringDuration calculation method

Url

No

String

Key value of the custom speed test

Env

No

StringEnvironment

3. Output Parameters
Parameter
Name

Type

Description

ResultStringReturned value

RequestId

String

The unique request ID, which is returned for each request. RequestId is required for©2013-2022 Tencent Cloud. All rights reserved.

Page 189 of 289

Real User Monitoring

locating a problem.

4. Example
Example1 Getting DescribeDataCustomUrl information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataCustomUrl&ID=1&StartTime=1625444040&EndTime=1625454840&Type=pagepv&Level=1&Isp=China Mobile&Area=China&NetType=2&Platform=2&Device=Samsung&VersionNum=Version&ExtFirst=Custom 1&ExtSecond=Custom 2&ExtThird=Custom 3&IsAbroad=1&Browser=ie&Os=apple&Engine=ie2&Brand=apple&From=index.html&CostType=avg&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 190 of 289

Real User Monitoring

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

©2013-2022 Tencent Cloud. All rights reserved.

Page 191 of 289

Real User Monitoring

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 192 of 289

Real User Monitoring

Custom Event APIs
DescribeDataEventUrl：

Last updated 2023-07-06 17:39:26

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataEventUrl information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataEventUrl.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time
allcount : performance view; day : 14-day data; condition : co

Type

Yes

Stringnettype / version / platform / isp / region / device /network/platform view; version view; device view; ISP view; region view; b

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID©2013-2022 Tencent Cloud. All rights reserved.

Page 193 of 289

Real User Monitoring

ExtSecond

No

StringCustom 2

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowserName

No

StringFilterEnv

No

StringEnvironment

3. Output Parameters
Parameter
Name

Type

Description

ResultStringReturned value

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 194 of 289

Real User Monitoring

4. Example
Example1 Getting DescribeDataEventUrl information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataEventUrl&ID=1&StartTime=1625444040&EndTime=1625454840&Type=pagepv&Level=1&Isp=China Mobile&Area=China&NetType=2&Platform=2&Device=Samsung&VersionNum=Version&ExtFirst=Custom 1&ExtSecond=Custom 2&ExtThird=Custom 3&IsAbroad=1&Browser=ie&Os=apple&Engine=ie2&Brand=apple&From=index.html&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 195 of 289

Real User Monitoring

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 196 of 289

Real User Monitoring

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 197 of 289

Real User Monitoring

Exception Analysis APIs
DescribeDataLogUrlStatistics：

Last updated 2023-07-06 17:39:26

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the LogUrlStatistics information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataLogUrlStatist

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time
analysis : exception analysis; compare : exception list comparison

Type

Yes

Stringnettype / version / platform / isp / region / device /network/platform view; version view; device view; ISP view; region view; b

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID©2013-2022 Tencent Cloud. All rights reserved.

Page 198 of 289

Real User Monitoring

ExtSecond

No

StringCustom 2

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

Env

No

StringEnvironment

3. Output Parameters
Parameter
Name

Type

Description

ResultStringReturned value

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 199 of 289

Real User Monitoring

4. Example
Example1 Getting LogUrlStatistics information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataLogUrlStatistics&ID=1&StartTime=1625444040&EndTime=1625454840&Type=pagepv&Level=1&Isp=China Mobile&Area=China&NetType=2&Platform=2&Device=Samsung&VersionNum=Version&ExtFirst=Custom 1&ExtSecond=Custom 2&ExtThird=Custom 3&IsAbroad=1&Browser=ie&Os=apple&Engine=ie2&Brand=apple&From=index.html&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 200 of 289

Real User Monitoring

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 201 of 289

Real User Monitoring

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 202 of 289

Real User Monitoring

Business System and Project Information
APIs
ResumeProject：

Last updated 2023-04-27 15:44:53

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to recover an application and resume data reporting.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ResumeProject.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ProjectId

Yes

Integer

Project ID

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 203 of 289

Real User Monitoring

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Recovering an application
This example shows you how to recover an application.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResumeProject<Common request parameters>{"ProjectId": 1}

Output Example{"Response": {"RequestId": "2c56dbc9-2b99-437a-9a5e-51ed6dcba7e5"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go©2013-2022 Tencent Cloud. All rights reserved.

Page 204 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 205 of 289

Real User Monitoring

CreateProject：

Last updated 2023-04-27 15:44:56

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to create a RUM application which belongs to a specific team.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CreateProject.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

Name

Yes

StringName of the created project (required and up to 200 characters)

InstanceID

Yes

StringBusiness system ID

Rate

Yes

StringProject sampling rate (greater than or equal to 0)

EnableURLGroupYes

Integer

Whether to enable aggregation

Type

Yes

StringRepo

NoString©2013-2022 Tencent Cloud. All rights reserved.

Project type (valid values: "web", "mp", "android", "ios", "node","hippy", "weex", "viola", "rn")Repository address of the project (optional and up to 256
characters)

Page 206 of 289

Real User Monitoring

URL

No

String

Webpage address of the project (optional and up to 256
characters)

Desc

No

StringDescription of the created project (optional and up to 1,000
characters)

3. Output Parameters
Parameter

Type

Description

ID

Integer

Project ID

Key

StringUnique project key

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

Name

4. Example
Example1 Creating a RUM application
This example shows you how to create a RUM application.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProject<Common request parameters>{"Name": "'Test project'","InstanceID": "\"taw-123\"","Repo": "'http://github.com/xxx'","URL": "'http://www.qq.com'","Rate": "\"10\"","EnableURLGroup": "1","Type": "web","Desc": "'Project description'"}©2013-2022 Tencent Cloud. All rights reserved.

Page 207 of 289

Real User Monitoring

Output Example{"Response": {"ID": 1,
"Key": "RlOmCVbPrKd4","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

FailedOperation

Operation failed.

InternalError

Internal error.

©2013-2022 Tencent Cloud. All rights reserved.

Page 208 of 289

Real User Monitoring

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

MissingParameter

Missing parameter.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

UnauthorizedOperation

Unauthorized operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 209 of 289

Real User Monitoring

DescribeProjects：

Last updated 2023-04-27 15:44:54

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the list of projects (under teams created by an instance).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeProjects.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

Limit

Yes

IntegerNumber of items per page (integer)

OffsetYes

Integer

Page number (integer)

Filters.N

No

Array ofFilter parameter. Pass in {"Name": "IsDemo", "Values":["1"]} for theFilterdemo mode.

IsDemoNo

NameIntegerThis parameter has been disused. You need to indicate whether thedemo mode is used in Filters .

©2013-2022 Tencent Cloud. All rights reserved.

Page 210 of 289

Real User Monitoring

3. Output Parameters
Parameter

Type

Description

TotalCount

Integer

Total number of items in the list

ProjectSet

Array of
RumProject

Project list

RequestId

StringName

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Getting the RUM application list by filter
This example shows you how to get the RUM application list by filter.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjects<Common request parameters>{"Limit": "20","Filters": [{"Values": ["'Test project name 2'","'Test project name'"],"Name": "'Name'"}],"Offset": "1"}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 211 of 289

Real User Monitoring{"Response": {"TotalCount": 0,"ProjectSet": [],"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

Example2 Getting the RUM application list
This examples shows you how to get the RUM application list.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjects<Common request parameters>{"Limit": "20","Offset": "1"}

Output Example{"Response": {"TotalCount": 0,"ProjectSet": [],"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python©2013-2022 Tencent Cloud. All rights reserved.

Page 212 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation

Unauthorized operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 213 of 289

Real User Monitoring

DescribeProjectLimits：

Last updated 2023-04-27 15:44:54

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the sampling information of an application’s reporting APIs.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ProjectID

Yes

Integer

Project ID

Name

Description
Common Params. The value used for this API:
DescribeProjectLimits.

3. Output Parameters
Parameter
Name
ProjectLimitSetType

Description

Array ofArray of reporting rates©2013-2022 Tencent Cloud. All rights reserved.

Page 214 of 289

Real User Monitoring

ProjectLimit
RequestId

String

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Getting the sampling information of an application’s reporting APIs
This example shows you how to get the sampling information of an application’s reporting APIs.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjectLimits<Common request parameters>{"ProjectID": "8"}

Output Example{"Response": {"ProjectLimitSet": [{"ID": 17,
"ProjectID": 8,"ProjectInterface": "web","ReportRate": 10,"ReportType": 1}],"RequestId": "6f867613-843d-410a-8000-c74477ca48a8"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 215 of 289

Real User Monitoring

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

©2013-2022 Tencent Cloud. All rights reserved.

Page 216 of 289

Real User Monitoring

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 217 of 289

Real User Monitoring

DescribeScores：

Last updated 2023-04-27 15:44:54

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the list of homepage scores.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeScores.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

EndTimeYes

String

End time

StartTime

Yes

StringStart timeID

No

Integer

Project ID

IsDemoNo

IntegerThis parameter has been disused.

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 218 of 289

Real User Monitoring

Name
ScoreSet

RequestId

Array of
ScoreInfo
StringArray
The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Getting the homepage score
This example shows you how to get the homepage score.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScores<Common request parameters>{"EndTime": "2022051914","ID": "1","StartTime": "2020011920"}

Output Example{"Response": {"ScoreSet": [],"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 219 of 289

Real User Monitoring

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

©2013-2022 Tencent Cloud. All rights reserved.

Page 220 of 289

Real User Monitoring

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 221 of 289

Real User Monitoring

StopInstance：

Last updated 2023-04-27 15:44:53

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to stop an instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: StopInstance.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of the instance to be stopped

3. Output Parameters
Parameter
Name
RequestId

Type

Description

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 222 of 289

Real User Monitoring

4. Example
Example1 Stopping an instanceThis example shows you how to stop an instance. Once the instance is stopped, all applications in the businesssystem will be unable to report data.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StopInstance<Common request parameters>{"InstanceId": "rum-abcd1234"}

Output Example{"Response": {"RequestId": "2c56dbc9-2b99-437a-9a5e-51ed6dcba7e5"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 223 of 289

Real User Monitoring

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 224 of 289

Real User Monitoring

ResumeInstance：

Last updated 2023-07-06 17:39:30

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to recover a RUM business system so that you can use the application to report data normally.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ResumeInstance.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of the instance to be resumed

3. Output Parameters
Parameter
Name
RequestId

Type

Description

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 225 of 289

Real User Monitoring

4. Example
Example1 Resuming instance
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResumeInstance<Common request parameters>{"InstanceId": "rum-abcd1234"}

Output Example{"Response": {"RequestId": "2c56dbc9-2b99-437a-9a5e-51ed6dcba7e5"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 226 of 289

Real User Monitoring

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

OperationDenied

The operation was denied.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 227 of 289

Real User Monitoring

ModifyProjectLimit：

Last updated 2023-07-06 17:39:30

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to add or modify data reporting limit.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ModifyProjectLimit.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ProjectID

Yes

Integer

Project ID

ProjectInterface

No

StringProject API

ReportRate

No

Integer

Reporting rate. 10 means 10%

ReportType

No

Integer

Reporting type. 1: rate; 2: number of reported data entries

ID

No

IntegerPrimary key ID

Name©2013-2022 Tencent Cloud. All rights reserved.

Page 228 of 289

Real User Monitoring

3. Output Parameters
Parameter
Name

Type

Msg

StringRequestId

StringDescription
Returned message
Note: this field may return null, indicating that no valid values can be obtained.
The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Adding or modifying data reporting limit
This example shows you how to add or modify data reporting limit.
Input Example
https://rum.tencentcloudapi.com/?Action=ModifyProjectLimit&ProjectID=1&ProjectInterface=web&ReportRate=10&ReportType=1&ID=1&<Common request parameters>

Output Example{"Response": {"Msg": "xx","RequestId": "xx"}}

Example2 Adding sample
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com©2013-2022 Tencent Cloud. All rights reserved.

Page 229 of 289

Real User Monitoring

Content-Type: application/json
X-TC-Action: ModifyProjectLimit<Common request parameters>{"ProjectInterface": "web","ProjectID": "8","ReportRate": "10","ReportType": "1"}

Output Example{"Response": {"Msg": "success","RequestId": "a62c0f90-5ed0-4f3e-b285-8e4885a5ca45"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 230 of 289

Real User Monitoring

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 231 of 289

Real User Monitoring

ModifyProject：

Last updated 2023-04-27 15:44:54

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to modify the RUM application information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ModifyProject.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ID

Yes

Integer

Project ID

Name

No

StringProject name (optional, not empty, and up to 200 characters)

URL

No

StringProject webpage URL (optional and up to 256 characters)

Repo

No

StringProject repository address (optional and up to 256 characters)

InstanceID

No

StringID of the instance to which to move the project (optional)

Rate

No

StringProject sample rate (optional)

EnableURLGroupNo

Integer

Whether to enable aggregation (optional)©2013-2022 Tencent Cloud. All rights reserved.

Page 232 of 289

Real User Monitoring

Type

No

StringProject type (valid values: "web", "mp", "android", "ios", "node","hippy", "weex", "viola", "rn")

Desc

No

StringProject description (optional and up to 1,000 characters)

3. Output Parameters
Parameter

Type

Description

Msg

StringOperation information

ID

Integer

Project ID

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Modifying the RUM application information
This example shows you how to modify the RUM application information.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyProject<Common request parameters>{"ID": "6","Name": "'Test project'"}

Output Example{"Response": {"ID": 1,
"Msg": "success",©2013-2022 Tencent Cloud. All rights reserved.

Page 233 of 289

Real User Monitoring"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 234 of 289

Real User Monitoring

ModifyInstance：

Last updated 2023-07-06 17:39:31

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to modify a RUM business system.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ModifyInstance.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of the instance to be modified

InstanceName

No

String

New instance name (up to 255 characters)

InstanceDesc

No

String

New instance description (up to 1,024 characters)

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 235 of 289

Real User Monitoring

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Modifying instance
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstance<Common request parameters>{"InstanceId": "taw-12345678","InstanceName": "New instance name","InstanceDesc": "New instance description"}

Output Example{"Response": {"RequestId": "411c8d9d-9cea-4d1d-906d-6f1e076ded28"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS©2013-2022 Tencent Cloud. All rights reserved.

Page 236 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 237 of 289

Real User Monitoring

DescribeDataReportCount：

Last updated 2023-07-06 17:39:31

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the number of reported data entries for a project.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time

EndTimeYes

Integer

End time

ID

No

Integer

Project ID

ReportType

No

StringReporting typeInstanceID

No

String

Instance ID©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
DescribeDataReportCount.

Page 238 of 289

Real User Monitoring

3. Output Parameters
Parameter

Type

Description

ResultStringReturned value

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

Name

4. Example
Example1 Getting the number of reported data entries
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataReportCount<Common request parameters>{"EndTime": "1625454840","ReportType": "custom","ID": "1","StartTime": "1625444040"}

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 239 of 289

Real User Monitoring

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

©2013-2022 Tencent Cloud. All rights reserved.

Page 240 of 289

Real User Monitoring

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 241 of 289

Real User Monitoring

DeleteStarProject：

Last updated 2023-04-27 15:44:55

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to delete a starred project for the specified user.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DeleteStarProject.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceID

Yes

String

Instance ID, such as taw-123

ID

Yes

Integer

Project ID

3. Output Parameters
Parameter
Name
Msg

Type

Description

StringResponse message©2013-2022 Tencent Cloud. All rights reserved.

Page 242 of 289

Real User Monitoring

Note: this field may return null, indicating that no valid values can be obtained.
RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Deleting a starred application
This example shows you how to delete a starred application.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteStarProject<Common request parameters>{"InstanceID": "taw-123","ID": "1"}Output Example{"Response": {"Msg": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 243 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

©2013-2022 Tencent Cloud. All rights reserved.

Page 244 of 289

Real User Monitoring

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 245 of 289

Real User Monitoring

DeleteProject：

Last updated 2023-04-27 15:44:55

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to delete the specified RUM project.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DeleteProject.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ID

Yes

Integer

ID of the project to be deleted

3. Output Parameters
Parameter

Type

Description

Msg

StringOperation information

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forName©2013-2022 Tencent Cloud. All rights reserved.

Page 246 of 289

Real User Monitoring

locating a problem.

4. Example
Example1 Deleting a RUM application
This example shows you how to delete a RUM application.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteProject<Common request parameters>{"ID": "6"}Output Example{"Response": {"Msg": "success","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS©2013-2022 Tencent Cloud. All rights reserved.

Page 247 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 248 of 289

Real User Monitoring

DeleteInstance：

Last updated 2023-04-27 15:44:55

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to delete an instance. The deleted instance cannot be recovered.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DeleteInstance.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceId

Yes

StringID of the instance to be deleted

3. Output Parameters
Parameter
Name
RequestId

Type

StringDescription
The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 249 of 289

Real User Monitoring

4. Example
Example1 Deleting a RUM business system
This example shows you how to delete a RUM business system.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteInstance<Common request parameters>{"InstanceId": "rum-abcd1234"}

Output Example{"Response": {"RequestId": "2c56dbc9-2b99-437a-9a5e-51ed6dcba7e5"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 250 of 289

Real User Monitoring

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

FailedOperation

Operation failed.

InternalError

Internal error.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 251 of 289

Real User Monitoring

CreateTawInstance：

Last updated 2023-07-06 17:39:31

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to create a RUM business system.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringRegionNo

StringAreaIdYes

Integer

Region ID (at least greater than 0)ChargeType

Yes

Integer

Billing type (1: Pay-as-you-go).

DataRetentionDays

Yes

Integer

Data retention period (at least greater than 0)

InstanceName

Yes

String

Instance name (up to 255 bytes)

Tags.NNo

Array ofTag

©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
CreateTawInstance.
Common Params. The value used for this API: 2021-0622.
Common Params. This parameter is not required for thisAPI.

Tag list

Page 252 of 289

Real User Monitoring

InstanceDesc

No

String

Instance description (up to 1,024 bytes)

CountNum

No

StringNumber of data entries reported per day

PeriodRetain

No

StringBilling for data storage

BuyingChannel

No

String

Instance purchase channel. Valid value: cdn .

ResourcePackageType

No

Integer

ResourcePackageNum

No

Integer

The number of prepaid resource packs (only required for
prepaid mode)

InstanceType

No

Integer

Instance type. 1 : Web; 2 : Application

Type of prepaid resource pack (only required for prepaidmode)

3. Output Parameters
Parameter

Type

Description

InstanceId

String

Instance ID

DealName

StringID of prepaid order
Note: This field may return null, indicating that no valid values can be obtained.

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Querying an instanceThis example shows you how to create an instance.
Input Example
POST / HTTP/1.1Host: rum.tencentcloudapi.comContent-Type: application/jsonX-TC-Ac
tion: CreateTawInstance<Common request parameters>{ "AreaId": 1, "InstanceName":"test", "ChargeType": 1, "DataRetentionDays": 30, "InstanceDesc": "test"}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 253 of 289

Real User Monitoring{"Response": {"InstanceId": "taw-4vVPH0Jn","DealName": "","RequestId": "57f4d8a2-13b6-4ac0-9f0b-0acc7bbc1d61"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

FailedOperation

Operation failed.

FailedOperation.ChargeNoBalanceBilling - The account balance is insufficient.

FailedOperation.ChargeNoPayRight

Billing - The account doesn’t have the payment permission.

©2013-2022 Tencent Cloud. All rights reserved.

Page 254 of 289

Real User Monitoring

FailedOperation.ChargeParamInvalid

Billing - Invalid billing parameters.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 255 of 289

Real User Monitoring

CreateStarProject：

Last updated 2023-04-27 15:44:56

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to add a starred project.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CreateStarProject.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

InstanceID

Yes

String

Instance ID, such as taw-123

ID

Yes

Integer

Project ID

3. Output Parameters
Parameter
Name

Type

Description

Msg

String

API response information©2013-2022 Tencent Cloud. All rights reserved.

Page 256 of 289

Real User Monitoring

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Creating a starred application
This example shows you how to create a starred application.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateStarProject<Common request parameters>{"InstanceID": "taw-123","ID": "1"}Output Example{"Response": {"Msg": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 257 of 289

Real User Monitoring

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 258 of 289

Real User Monitoring

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 259 of 289

Real User Monitoring

StopProject：

Last updated 2023-04-27 15:44:53

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to stop a project from reporting data.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: StopProject.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

ProjectId

Yes

Integer

Project ID

3. Output Parameters
Parameter
Name

Type

RequestId

StringDescription
The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 260 of 289

Real User Monitoring

4. Example
Example1 Stopping an application from reporting data
This example shows you how to stop an application from reporting data.
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StopProject<Common request parameters>{"ProjectId": 1}

Output Example{"Response": {"RequestId": "2c56dbc9-2b99-437a-9a5e-51ed6dcba7e5"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 261 of 289

Real User Monitoring

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

ResourceNotFoundThe resource does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 262 of 289

Real User Monitoring

API Monitoring APIs
DescribeDataFetchUrlInfo：

Last updated 2023-07-06 17:39:31

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataFetchUrlInfo information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time

Type

Yes

StringType

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID

ExtSecond

No

StringCustom 2

Name©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
DescribeDataFetchUrlInfo.

Page 263 of 289

Real User Monitoring

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

CostType

No

StringDuration calculation method

Url

No

StringSourceEnv

No

StringEnvironment

3. Output Parameters
Parameter

Type

Description

ResultStringReturned value

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 264 of 289

Real User Monitoring

4. Example
Example1 Getting DescribeDataFetchUrlInfo information
Input Example
https://rum.tencentcloudapi.com/?Action=DescribeDataFetchUrlInfo&ID=1&StartTime=1625444040&EndTime=1625454840&Type=pagepv&Level=1&Isp=China Mobile&Area=China&NetType=2&Platform=2&Device=Samsung&VersionNum=Version&ExtFirst=Custom 1&ExtSecond=Custom 2&ExtThird=Custom 3&IsAbroad=1&Browser=ie&Os=apple&Engine=ie2&Brand=apple&From=index.html&CostType=avg&<Common request parameters>

Output Example{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 265 of 289

Real User Monitoring

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 266 of 289

Real User Monitoring

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 267 of 289

Real User Monitoring

DescribeDataFetchUrl：

Last updated 2023-07-06 17:39:31

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataFetchUrl information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataFetchUrl.

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time
allcount : performance view; day : 14-day data; count40x : HT

Type

Yes

count5xand4x : HTTP status codes 40X∑50X view; top : top reso

Stringnettype / version / platform / isp / region / device /network/platform view; version view; device view; ISP view; region view; b

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID

ExtSecond

No

StringCustom 2©2013-2022 Tencent Cloud. All rights reserved.

Page 268 of 289

Real User Monitoring

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

CostType

No

StringDuration calculation method

Url

No

StringSourceEnv

No

StringEnvironment

StatusNo

StringHTTP status code.

Ret

No

StringretcodeNetStatus

No

StringNetwork status

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 269 of 289

Real User Monitoring

ResultStringRequestId

StringReturned value
The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting DescribeDataFetchUrl information
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataFetchUrl<Common request parameters>{"ExtSecond": "Custom 2","Engine": "ie2","IsAbroad": "1",
"Area": "China","NetType": "2",
"CostType": "avg","Level": "1","Os": "apple","Brand": "apple","Isp": "China Mobile","VersionNum": "Version","Platform": "2",
"ExtThird": "Custom 3","ExtFirst": "Custom 1","StartTime": "1625444040","Device": "Samsung","From": "index.html","EndTime": "1625454840","Type": "pagepv","ID": "1",
"Browser": "ie"}Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 270 of 289

Real User Monitoring{"Response": {"Result": "xxxx","RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

Example2 333
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataFetchUrl<Common request parameters>{"EndTime": "1625454840","Type": "condition","ID": "1","StartTime": "1625444040"}

Output Example{"Response": {"RequestId": "d8b037d7-08ae-401d-84cf-071e7a133c00","Result": "{\"request_id\":\"d8b037d7-08ae-401d-84cf-071e7a133c00\",\"results\":[{\"statement_id\":0,\"total\":0},{\"statement_id\":1,\"total\":0}]}"}}

Example3 1
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataFetchUrl<Common request parameters>©2013-2022 Tencent Cloud. All rights reserved.

Page 271 of 289

Real User Monitoring{"EndTime": "1658390700","Type": "allcount","ID": "1","StartTime": "1658304300"}

Output Example{"Response": {"RequestId": "d446c290-7034-47d3-8d72-46e7a692f5ac","Result": "{\"request_id\":\"d446c290-7034-47d3-8d72-46e7a692f5ac\",\"results\":[{\"statement_id\":0,\"total\":0},{\"statement_id\":1,\"total\":0}]}"}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 272 of 289

Real User Monitoring

Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 273 of 289

Real User Monitoring

DescribeDataFetchProject：

Last updated 2023-07-06 17:39:31

1. API Description
Domain name for API request: rum.tencentcloudapi.com.
This API is used to get the DescribeDataFetchProject information and has been deprecated. Use
DescribeDataFetchUrl instead.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeDataFetchProject

VersionYes

StringCommon Params. The value used for this API: 2021-06-22.

RegionNo

StringCommon Params. This parameter is not required for this API.

StartTime

Yes

IntegerStart time
allcount : performance view; day : 14-day data; condition : co

Type

Yes

Stringnettype / version / platform / isp / region / device /network/platform view; version view; device view; ISP view; region view; b

EndTimeYes

Integer

End time

ID

Yes

Integer

Project ID

ExtSecond

No

StringCustom 2©2013-2022 Tencent Cloud. All rights reserved.

Page 274 of 289

Real User Monitoring

EngineNo

StringBrowser engine

Isp

No

String

ISP

From

No

StringSource page

Level

No

StringLog level

Brand

No

String

Brand

Area

No

StringRegionVersionNum

No

String

VersionPlatform

No

StringPlatform

ExtThird

No

StringCustom 3

ExtFirst

No

StringCustom 1

NetTypeNo

StringNetwork type

DeviceNo

StringModel

IsAbroadNo

StringWhether it is outside the Chinese mainland

Os

No

StringOS

BrowserNo

StringBrowser

CostType

No

StringDuration calculation method

Url

No

StringSourceEnv

No

StringEnvironment

StatusNo

StringHTTP status code.

Ret

No

Stringretcode3. Output Parameters
Parameter
Name
ResultType

Description

StringReturned value©2013-2022 Tencent Cloud. All rights reserved.

Page 275 of 289

Real User Monitoring

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Getting DescribeDataFetchProject information
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataFetchProject<Common request parameters>{"ExtSecond": "Custom 2","Engine": "ie2","IsAbroad": "1",
"Area": "China","NetType": "2",
"CostType": "avg","Level": "1","Os": "apple","Brand": "apple","Isp": "China Mobile","VersionNum": "Version","Platform": "2",
"ExtThird": "Custom 3","ExtFirst": "Custom 1","StartTime": "1625444040","Device": "Samsung","From": "index.html","EndTime": "1625454840","Type": "pagepv","ID": "1",
"Browser": "ie"}Output Example{"Response": {"Result": "xxxx",©2013-2022 Tencent Cloud. All rights reserved.

Page 276 of 289

Real User Monitoring"RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"}}

Example2 111
Input Example
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataFetchProject<Common request parameters>{"EndTime": "1625454840","Type": "condition","ID": "1","StartTime": "1625444040"}

Output Example{"Response": {"RequestId": "9906759b-ea71-409e-b4e0-b877512713cf","Result": "{\"request_id\":\"9906759b-ea71-409e-b4e0-b877512713cf\",\"results\":[{\"statement_id\":0,\"series\":[{\"name\":\"fetch_project_statistics\",\"columns\":[\"key\",\"value\"]}],\"total\":0},{\"statement_id\":1,\"series\":[{\"name\":\"fetch_project_statistics\",\"columns\":[\"key\",\"value\"]}],\"total\":0},{\"statement_id\":2,\"series\":[{\"name\":\"fetch_project_statistics\",\"columns\":[\"
key\",\"value\"]}],\"total\":0},{\"statement_id\":3,\"series\":[{\"name\":\"fetch_project_statistics\",\"columns\":[\"key\",\"value\"]}],\"total\":0},{\"statement_id\":4,\"series\":[{\"name\":\"fetch_project_statistics\",\"columns\":[\"key\",\"value\"]}],\"total\":0},{\"statement_id\":5,\"series\":[{\"name\":\"fetch_proje
ct_statistics\",\"columns\":[\"key\",\"value\"]}],\"total\":0},{\"statement_id\":6,\"series\":[{\"name\":\"fetch_project_statistics\",\"columns\":[\"key\",\"value\"]}],\"total\":0},{\"statement_id\":7,\"series\":[{\"name\":\"fetch_project_stat
istics\",\"columns\":[\"key\",\"value\"]}],\"total\":0},{\"statement_id\":8,\"series\":[{\"name\":\"fetch_project_statistics\",\"columns\":[\"key\",\"value\"]}],\"total\":0},{\"statement_id\":9,\"series\":[{\"name\":\"fetch_project_statistics\",\"columns\":[\"key\",\"value\"]}],\"total\":0}]}"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 277 of 289

Real User Monitoring

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

DryRunOperation

DryRun Operation. It means that the request would have succeeded,
but the DryRun parameter was used.

FailedOperation

Operation failed.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

InternalError

Internal error.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Incorrect parameter value.

©2013-2022 Tencent Cloud. All rights reserved.

Page 278 of 289

Real User Monitoring

LimitExceeded

The quota limit is exceeded.

MissingParameter

Missing parameter.

OperationDenied

The operation was denied.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

The resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceNotFound.NoInstance

The instance does not exist.

ResourceUnavailable

The resource is unavailable.

ResourcesSoldOut

The resources have been sold out.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 279 of 289

Real User Monitoring

Data Types：

Last updated 2023-07-06 17:39:32

Filter
Key-Value pair filter for conditional filtering queries, such as filtering ID, name, status, etc.
· If more than one filter exists, the logical relationship between these filters is AND .
· If multiple values exist in one filter, the logical relationship between these values is OR .
Used by actions: DescribeProjects.
Name

Type

Required

Description

ValuesArray of StringNo

One or more filter values.

NameStringNo

Filter name.

LogExport
Log export record
Used by actions: DescribeLogExports.
Name

Type

Description

CosPathStringLog export pathCount

IntegerNumber of logs to be exported

CreateTime

StringLog export task creation time

ExportID

StringLog export task ID

FileName

StringLog export filename

FileSize

Integer

Log file size

FormatStringLog export format

Order

StringLog export time sorting

Query

StringLog export query statement©2013-2022 Tencent Cloud. All rights reserved.

Page 280 of 289

Real User Monitoring

StartTime

StringLog export start time

EndTimeStringLog export end time

StatusStringLog download status. Valid values: Queuing: queuing; Processing: exporting;Complete: completed; Failed: failed; Expired: expired (3-day validity period).

ProjectLimit
Project API restriction type
Used by actions: DescribeProjectLimits.
Name

Type

Required

Description

ID

IntegerYes

Primary key ID

ProjectID

Integer

Yes

Project ID

ProjectInterface

String

Yes

API

ReportRate

Integer

Yes

Reporting rate

ReportType

Integer

Yes

Reporting type. 1: reporting rate; 2: reporting count limit

ReleaseFile
Release file list (sourcemap)
Used by actions: CreateReleaseFile, DescribeReleaseFiles.
Name

Type

Description

VersionStringFile version

FileKey

StringUnique file key

FileName

StringFilename

FileHashStringFile hash

ID

Integer

File ID
Note: this field may return null, indicating that no valid values can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 281 of 289

Real User Monitoring

RumAreaInfo
RUM region information
Used by actions: DescribeTawAreas.
Name

Type

Description

AreaIdInteger

Region ID

AreaStatus

Integer

Region status (1: valid; 2: invalid)

AreaName

StringRegion nameAreaKey

StringRegion key

AreaRegionID

StringRegion ID.

AreaRegionCode

StringRegion code, such as “ap-xxx” (xxx is the region name).

AreaAbbr

StringRegion abbreviation.

RumProject
RUM project information
Used by actions: DescribeProjects.
Name

Type

Description

Name

StringProject nameCreator

StringCreator ID

InstanceID

String

Instance ID

TypeStringProject type

CreateTime

Timestamp

Creation time

StringProject repository address
Note: this field may return null, indicating that no valid values can beRepo

obtained.
URL

StringProject URL
Note: this field may return null, indicating that no valid values can be©2013-2022 Tencent Cloud. All rights reserved.

Page 282 of 289

Real User Monitoringobtained.
Rate

StringProject sample rate

Key

StringUnique project key (12 characters)

EnableURLGroup

Integer

Whether to enable URL aggregation

InstanceName

String

Instance nameID

Integer

Project ID

InstanceKey

String

Instance key

StringProject description
Note: this field may return null, indicating that no valid values can beDescobtained.
Starred status. 1: yes; 0: no
IsStarInteger

Note: this field may return null, indicating that no valid values can beobtained.
Project status ( 1 : Creating; 2 : Running; 3 : Abnormal; 4 :Restarting; 5 : Stopping; 6 : Stopped; 7 : Terminating; 8 :ProjectStatus

Integer

Terminated)
Note: This field may return null , indicating that no valid values can beobtained.

AccessPoint

Log access point, which can be ignored.
Note: This field may return null, indicating that no valid values can be

Stringobtained.

RumPvInfo
RUM log object
Used by actions: DescribePvList.
Name

Type

Description

ProjectId

Integer

Project ID

Pv

StringNumber of PVs
Note: this field may return null, indicating that no valid values can be obtained.

CreateTime

StringTime©2013-2022 Tencent Cloud. All rights reserved.

Page 283 of 289

Real User Monitoring

RumUvInfo
Number of RUM UVs
Used by actions: DescribeUvList.
Name

Type

Description

ProjectId

Integer

Project ID

Uv

StringNumber of UVs

CreateTime

StringCreation time

ScoreInfo
Project score entity
Used by actions: DescribeScores.
Name

Type

Description

StaticDuration

Stringduration

PagePv

String

pv

ApiFail

StringFailureApiNumStringRequestStaticFail

Stringfail

ProjectID

Integer

Project ID

PageUv

Stringuv

ApiDuration

StringNumber of requests

Score

StringScore

PageError

Stringerror

StaticNum

Stringnum

RecordNum

Integernum©2013-2022 Tencent Cloud. All rights reserved.

Page 284 of 289

Real User Monitoring

PageDuration

StringCreateTime

StringDurationTime
Note: This field may return null, indicating that no valid values can be obtained.

Tag
Tag
Used by actions: CreateTawInstance.
Name

Type

Required

Description

Key

StringYes

Tag key

Value

StringYes

Tag value

Whitelist
Allowlist
Used by actions: DescribeWhitelists.
Name

Type

Description

RemarkStringRemarks

InstanceID

String

Instance ID

Ttl

String

End time

ID

StringAuto-Increment allowlist ID

WhitelistUin

StringUnique business identifier

CreateUser

StringCreator ID

AidStringaid

CreateTime

StringCreation time©2013-2022 Tencent Cloud. All rights reserved.

Page 285 of 289

Real User Monitoring

Error Codes：

Last updated 2022-12-29 14:43:13

Feature Description
If there is an Error field in the response, it means that the API call failed. For example:{"Response": {"Error": {"Code": "AuthFailure.SignatureFailure","Message": "The provided credentials could not be validated. Please check your si
gnature is correct."},"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"}}
Code in Error indicates the error code, and Message indicates the specific information of the error.

Error Code List
Common Error Codes
Error CodeDescription

ActionOffline

This API has been deprecated.

AuthFailure.InvalidAuthorization

Authorization in the request header is invalid.

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

AuthFailure.MFAFailure

MFA failed.
Key does not exist. Check if the key has been

AuthFailure.SecretIdNotFound

deleted or disabled in the console, and if not, checkif the key is correctly entered. Note that whitespaces
should not exist before or after the key.

AuthFailure.SignatureExpire

Signature expired. Timestamp and server timecannot differ by more than five minutes. Please©2013-2022 Tencent Cloud. All rights reserved.

Page 286 of 289

Real User Monitoring

ensure your current local time matches the standard
time.
Invalid signature. Signature calculation error. Please
AuthFailure.SignatureFailure

ensure you’ve followed the signature calculation
process described in the Signature API
documentation.

AuthFailure.TokenFailure
AuthFailure.UnauthorizedOperation

DryRunOperation

Token error.
The request is not authorized. For more information,
see the CAM documentation.
DryRun Operation. It means that the request would
have succeeded, but the DryRun parameter wasused.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidAction

The API does not exist.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Invalid parameter value.

InvalidRequest

The multipart format of the request body is incorrect.

IpInBlacklist

Your IP is in uin IP blacklist.

IpNotInWhitelistYour IP is not in uin IP whitelist.

LimitExceeded

Quota limit exceeded.

MissingParameter

A parameter is missing.

NoSuchProduct

The product does not exist.

NoSuchVersion

The API version does not exist.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

RequestLimitExceeded.GlobalRegionUinLimitExceeded

Uin exceeds the frequency limit.

RequestLimitExceeded.IPLimitExceeded
RequestLimitExceeded.UinLimitExceeded©2013-2022 Tencent Cloud. All rights reserved.

The number of ip requests exceeds the frequency
limit.
The number of uin requests exceeds the frequency

Page 287 of 289

Real User Monitoring

limit.
RequestSizeLimitExceeded

The request size exceeds the upper limit.

ResourceInUse

Resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

Resource is unavailable.

ResponseSizeLimitExceeded

The response size exceeds the upper limit.

ServiceUnavailable

Service is unavailable now.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.
HTTP(S) request protocol error; only GET and

UnsupportedProtocol

POST requests are supported.

UnsupportedRegion

API does not support the requested region.

Service Error Codes
Error CodeDescription

AuthFailure

Error with CAM signature/authentication.

FailedOperation.ChargeNoBalanceBilling - The account balance is insufficient.

FailedOperation.ChargeNoPayRight

Billing - The account doesn’t have the payment permission.

FailedOperation.ChargeParamInvalid

Billing - Invalid billing parameters.

FailedOperation.ClsCallFail

CLS call failed.

FailedOperation.DataBaseException

Exceptional data operation.

FailedOperation.InfrastructureError

Exceptional third-party dependency.

OperationDenied

The operation was denied.

ResourceNotFound.NoInstance

The instance does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 288 of 289

Real User Monitoring

ResourcesSoldOut©2013-2022 Tencent Cloud. All rights reserved.

The resources have been sold out.

Page 289 of 289