Release Notes
Announcements
Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to query running logs.
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: DescribeMongodbLogs. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-25. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID. Log in to the TencentDB for MongoDB console, and copy the instance ID from the instance list. |
| StartTime | Yes | String | Start time for querying logs. - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. - Query time range: Only log data within the last 7 days can be queried. |
| EndTime | Yes | String | End time for querying logs. - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. - Query time range: Only log data within the last 7 days can be queried. |
| NodeNames.N | No | Array of String | Node ID. Log in to the TencentDB for MongoDB console, and go to the Node Management page to obtain the ID of the node to be queried. |
| LogComponents.N | No | Array of String | Log category. - Log categories include but are not limited to COMMAND, ACCESS, CONTROL, FTDC, INDEX, NETWORK, QUERY, REPL, SHARDING, STORAGE, RECOVERY, JOURNAL, and WRITE. The specific supported categories may vary depending on the MongoDB version. For details, see Log Messages (https://www.mongodb.com/zh-cn/docs/v5.0/reference/log-messages/#log-message-examples). - Log in to the TencentDB for MongoDB console, and view the log category on the Error Log tab of the Log Management page. |
| LogLevels.N | No | Array of String | Log level. - The log levels are ranked by severity from high to low: FATAL, ERROR, and WARNING. -Log in to the TencentDB for MongoDB console, and view the log level on the Error Log tab of the Log Management page. |
| LogIds.N | No | Array of String | Log ID. Log in to the TencentDB for MongoDB console, and view the log ID on the Error Log tab of the Log Management page. |
| LogConnections.N | No | Array of String | Log connection information. Log in to the TencentDB for MongoDB console, and view the log connection information on the Error Log tab of the Log Management page. |
| LogDetailParams.N | No | Array of String | Specifies the field for filtering the logs. |
| Offset | No | Integer | Offset. The minimum value is 0, and the maximum value is 10000. The default value is 0. |
| Limit | No | Integer | Pagination size. The minimum value is 1, and the maximum value is 100. The default value is 20. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of logs. |
| LogList | Array of LogInfo | List of log details. Note: This field may return null, indicating that no valid values can be obtained. |
| 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. |
This example shows you how to query instance logs.
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMongodbLogs
<Common request parameters>
{
"InstanceId": "cmgo-k2p5su09",
"StartTime": "2024-03-07 9:22:15",
"EndTime": "2024-03-07 15:33:15",
"LogComponents": [
"NETWORK"
],
"LogConnections": [],
"LogIds": [],
"LogDetailParams": [
"client metadata"
]
}{
"Response": {
"LogList": [
{
"LogComponent": "NETWORK",
"LogConnection": "conn269939",
"LogDetail": "{\"t\":{\"$date\":\"2024-03-07T10:29:50.027+08:00\"},\"s\":\"I\", \"c\":\"NETWORK\", \"id\":51800, \"ctx\":\"conn269939\",\"msg\":\"client metadata\",\"attr\":{\"remote\":\"127.0.0.1:39024\",\"client\":\"conn269939\",\"doc\":{\"driver\":{\"name\":\"mongo-go-driver\",\"version\":\"v1.10.6\"},\"os\":{\"type\":\"linux\",\"architecture\":\"amd64\"},\"platform\":\"go1.20.4\",\"application\":{\"name\":\"CMongo\"}}}}",
"LogId": "51800",
"LogLevel": "WARNING",
"LogTime": "2024-03-07T10:29:50.027+08:00"
}
],
"RequestId": "ab2323tf-rqew1111",
"TotalCount": 1
}
}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 |
|---|---|
| InternalError | Internal error |
| InvalidParameterValue.NotFoundInstance | The instance was not found. |
| InvalidParameterValue.TimeFormatErr | Illegal time format. |
フィードバック