Domain name for API request: csip.intl.tencentcloudapi.com.
Log analytics retrieval interface v3
A maximum of 20 requests can be initiated per second for this API.
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: DescribeCLSLogListV3. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| From | Yes | Integer | Start time. |
| To | Yes | Integer | End time. |
| Query | Yes | String | Query condition |
| SyntaxRule | Yes | Integer | Grammar. |
| Topics.N | No | Array of LogContextInfo | Topic |
| MemberId.N | No | Array of String | Group account member id. |
| Sort | No | String | Sort |
| Limit | No | Integer | limit |
| Offset | No | Integer | offset |
| SamplingRate | No | Float | Sampling |
| HighLight | No | Boolean | Highlight or not |
| UseNewAnalysis | No | Boolean | Whether to adopt new analytics |
| QueryOptimize | No | Integer | Query optimization |
| TopicId | No | String | Topic id |
| Context | No | String | context information |
| SubQueryTypes.N | No | Array of String | Query type. |
| Parameter Name | Type | Description |
|---|---|---|
| Context | String | context |
| ListOver | Boolean | listover |
| Analysis | Boolean | Whether to adopt analytics |
| Results | Array of LogSearchResult | Result. |
| ColNames | Array of String | Column name. |
| AnalysisResults | Array of LogItems | Analysis result |
| AnalysisRecords | Array of String | Analysis records |
| Columns | Array of LogColumn | Column name. |
| SamplingRate | Float | Sampling |
| Topics | LogSearchTopics | Topic information |
| 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. |
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCLSLogListV3
<Common request parameters>
{
"Topics": [
{
"TopicId": "csip-test-logaccess-251308491-tcss-container_assets"
}
],
"From": 1776300037000,
"To": 1776310037000,
"Query": "*",
"SyntaxRule": 1,
"MemberId": [
"mem-tencent-testa1b2"
],
"Sort": "",
"Limit": 10,
"Offset": 0,
"SamplingRate": 1,
"HighLight": false,
"UseNewAnalysis": false,
"QueryOptimize": 1
}{
"Response": {
"Analysis": false,
"AnalysisResults": [],
"ColNames": [],
"Context": "Y29udGV4dC1mMzI5ZTc0Ny05NzM1LTRmNDQtYjk4NS1hMDA2NjcwNDMwYWIxNzc2MzEwNjMyMzU2",
"ListOver": false,
"Results": [
{
"FileName": "",
"HighLights": [],
"HostName": "",
"IndexStatus": "",
"LogJson": "{\"quuid\":\"95a59821-0b97-4114-a8c6-a42f73ff752e\",\"insert_time\":\"1775739716\",\"host_inner_ip\":\"172.18.10.7\",\"table_id\":\"65490569\",\"table_name\":\"asset_host_info\",\"uuid\":\"95a59821-0b97-4114-a8c6-a42f73ff752e\",\"hostname\":\"QTA_VM\",\"update_time\":\"1776310035\",\"event_type\":\"TCSS_ASSET_HOST\",\"appid\":\"251196288\",\"cls_event_type\":\"asset_host_info\",\"event_mod\":\"MOD\",\"event_time\":\"1776310035\",\"status\":\"ONLINE\"}",
"PkgId": "",
"PkgLogId": "",
"RawLog": "",
"Source": "21.215.132.152",
"Time": 1776310036000,
"TopicId": "89cc4300-c3c5-4011-92c4-6214f59a6169",
"TopicName": "csip-test-logaccess-251308491-tcss-container_assets"
}
],
"SamplingRate": 0,
"Topics": {
"Errors": [],
"Infos": [
{
"Context": "Y29udGV4dC1mMzI5ZTc0Ny05NzM1LTRmNDQtYjk4NS1hMDA2NjcwNDMwYWIxNzc2MzEwNjMyMzU2",
"Period": 180,
"TopicId": "csip-test-logaccess-251308491-tcss-container_assets"
}
]
},
"RequestId": "f353404c-3828-442c-9385-5b3373b20c4b"
}
}POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCLSLogListV3
<Common request parameters>
{
"From": 1776300037000,
"To": 1776310037000,
"Query": "*",
"SyntaxRule": 1,
"Topics": [
{
"TopicId": "topic-cls-testq",
"Context": "context-aa"
}
],
"MemberId": [
"mem-tencent-te"
],
"Sort": "desc",
"Limit": 10,
"Offset": 0
}{
"Response": {
"Analysis": false,
"AnalysisRecords": [
"{\"level\":\"INFO\",\"count\":1}"
],
"AnalysisResults": [
{
"Data": [
{
"Key": "level",
"Value": "INFO"
}
]
}
],
"ColNames": [
"level"
],
"Columns": [
{
"Name": "level",
"Type": "text"
}
],
"Context": "mock-context",
"ListOver": true,
"Results": [
{
"FileName": "/var/log/mock.log",
"HighLights": [
{
"Key": "msg",
"Values": [
"mock"
]
}
],
"HostName": "mock-host",
"IndexStatus": "Success",
"LogJson": "{\"level\":\"INFO\",\"msg\":\"mock log\"}",
"PkgId": "mock-pkg-id",
"PkgLogId": "0",
"RawLog": "mock raw log",
"Source": "127.0.0.1",
"Time": 1715692800000,
"TopicId": "mock-topic-251308491",
"TopicName": "mock-topic-251308491"
}
],
"SamplingRate": 1,
"Topics": {
"Errors": [
{
"ErrorCodeStr": "MockError",
"ErrorMsg": "mock error message",
"TopicId": "mock-topic-251308491"
}
],
"Infos": [
{
"Context": "mock-context",
"Period": 7,
"TopicId": "mock-topic-251308491"
}
]
},
"RequestId": "b7423c66-9780-4a31-9190-f493c64a81b7"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | CAM signature/authentication error. |
| DryRunOperation | DryRun operation means the request will be successful, but the DryRun parameter is passed. |
| FailedOperation | Operation failed. |
| FailedOperation.DasbAmountNotEnough | FailedOperation.DasbAmountNotEnough |
| FailedOperation.DasbErrorCode | FailedOperation.DasbErrorCode |
| FailedOperation.DasbInvalidSecretId | FailedOperation.DasbInvalidSecretId |
| FailedOperation.DasbInvalidSecretKey | FailedOperation.DasbInvalidSecretKey |
| InternalError | Internal error. |
| InvalidFilter | Invalid Filter |
| InvalidParameter | Parameter error. |
| InvalidParameter.DecryptError | Decrypt error |
| InvalidParameter.ResourceId | InvalidParameter.ResourceId |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.SQLQueryFailed | SQL query failed |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Parameters are missing. |
| OperationDenied | Operation denied. |
| RegionError | Region error. |
| RequestLimitExceeded | Number of requests exceeds the frequency limit. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resources. |
| ResourceInsufficient.LogAnalysisQuantityInsufficient | Insufficient log analysis capacity |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | Resources are unavailable. |
| ResourcesSoldOut | Resources are sold out. |
| UnauthorizedOperation | Unauthorized operation. |
| UnauthorizedOperation.CloudAudit | Unauthorized operation on the "Operation Audit" product. |
| UnauthorizedOperation.Cos | Unauthorized operation on the "COS" product. |
| UnauthorizedOperation.NoPermission | UnauthorizedOperation.NoPermission |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | The operation is not supported. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários