Domain name for API request: cls.tencentcloudapi.com.
This API is used to get the result of an offline search task.
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 parameter. The value used for this API: DescribeAsyncSearchResult. |
Version | Yes | String | Common parameter. The value used for this API: 2020-10-16. |
Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
AsyncSearchTaskId | Yes | String | Offline search task ID |
TopicId | Yes | String | Logset ID |
Context | No | String | This field is used to load more logs. Pass through the last Context value returned to get more log content. |
Limit | No | Integer | Number of logs returned in a single call. Default value: 20. Maximum value: 500 |
Parameter Name | Type | Description |
---|---|---|
Context | String | Context for loading subsequent content |
ListOver | Boolean | Whether all log query results are returned |
Results | Array of LogInfo | Log content |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAsyncSearchResult
<Common request parameters>
{
"TopicId": "682d0718-07bb-4ec0-9fda-f1e9a2767e0b",
"AsyncSearchTaskId": "as-65eff1fb-d552-4603-8966-03703e59188f",
"Limit": 100
}
{
"Response": {
"Results": [
{
"PkgId": "4C581DDA5FC70663-FDA78",
"TopicId": "682d0718-07bb-4ec0-9fda-f1e9a2767e0b",
"LogJson": "{\"content\":\"test\"}",
"FileName": "/root/test/nginx.log",
"Source": "10.0.0.1",
"Time": 1608794854001,
"TopicName": "nginx-log",
"PkgLogId": "655363"
}
],
"ListOver": true,
"Context": "",
"RequestId": "b276cb6e-4687-11eb-b378-0242ac130002"
}
}
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 |
---|---|
FailedOperation.AsyncSearchNotCompleted | The offline search task has not been completed. Please wait. |
FailedOperation.AsyncTaskNotCompleted | The offline task is not completed. |
OperationDenied | Operation denied. |
OperationDenied.AccountDestroy | The account has been terminated. |
OperationDenied.AccountIsolate | The account has overdue payments. |
OperationDenied.AccountNotExists | The account does not exist. |
ResourceNotFound.AsyncSearchTaskNotExist | The offline search task does not exist. |
ResourceNotFound.AsyncTaskNotExist | The offline task does not exist. |
Was this page helpful?