- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Connection Guide
- API Documentation
- FAQs
- Service Protocol
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Connection Guide
- API Documentation
- FAQs
- Service Protocol
1. API Description
Domain name for API request: rum.intl.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 it
API 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 the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeRumLogList. |
| Version | Yes | String | Common Params. The value used for this API: 2021-06-22. |
| Region | No | String | Common Params. This parameter is not required. |
| OrderBy | Yes | String | Sorting order (required). Valid values: desc, asc. |
| StartTime | Yes | String | Start time in milliseconds. It is in timestamp format and is required. |
| Limit | Yes | Integer | The number of raw logs returned for a single query. This parameter is required. Maximum value: 100. |
| Page | Yes | Integer | Page number |
| Query | Yes | String | Query statement, which is required and can contain up to 4,096 characters. |
| EndTime | Yes | 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 |
|---|---|---|
| Result | String | Response string |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 123
Input Example
POST / HTTP/1.1
Host: rum.intl.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": ""
}
}
Example2 Getting the log list
This example shows you how to get the log list.
Input Example
POST / HTTP/1.1
Host: rum.intl.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": {
"RequestId": "72ef03a0-01a8-443e-908a-8573fbeaafcd",
"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 Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| 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. |
| ResourceInsufficient | Insufficient resource. |
| ResourceNotFound | The 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. |
Yes
No
Was this page helpful?