查询MongoDB实例的错误日志。
接口说明
本接口适用于规格类型为通用型本地盘版和独享型本地盘版实例。
本接口限制每分钟调用 30 次,如超过这个限制会被限流,请勿高频调用。如需高频调用,请使用 Logstore,详情请参见管理 Logstore。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dds:DescribeErrorLogRecords |
get |
*dbinstance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DBInstanceId |
string |
是 |
实例 ID。 说明
当本参数传入的是分片集群实例 ID 时,还需要传入 NodeId 参数。 |
dds-bp12c5b040dc**** |
| NodeId |
string |
否 |
分片集群实例中 Mongos 节点 ID 或 Shard 节点 ID。 说明
当 DBInstanceId 参数传入的是分片集群实例 ID 时,本参数才可用。 |
d-bp128a003436**** |
| RoleType |
string |
否 |
实例中节点的角色。取值:
说明
当 NodeId 参数传入的是 Mongos 节点 ID 时,本参数取值只能为 primary。 |
primary |
| StartTime |
string |
是 |
查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。 |
2019-01-01T12:10Z |
| EndTime |
string |
是 |
查询结束时间,必须晚于查询开始时间,且与查询开始时间间隔时长不能大于一天。格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。 |
2019-01-02T12:10Z |
| DBName |
string |
否 |
数据库名。 |
mongodbtest |
| PageSize |
integer |
否 |
每页记录数,取值范围:30~100。 |
30 |
| PageNumber |
integer |
否 |
页码,取值为大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。 |
1 |
| ResourceGroupId |
string |
否 |
资源组 ID。资源组详情请参见查看资源组基本信息。 |
rg-acfmyiu4ekp**** |
| QueryKeywords |
string |
否 |
查询关键字,多个关键字以空格分隔,不超过 10 个关键字。 |
test test1 |
| LogicalOperator |
string |
否 |
关键字搜索的逻辑操作, 默认值为 and。 |
and |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| TotalRecordCount |
integer |
总记录数。 |
1 |
| PageRecordCount |
integer |
每页的记录数。 |
1 |
| RequestId |
string |
请求 ID。 |
68BCBEC2-1E66-471F-A1A8-E3C60C0A80B0 |
| PageNumber |
integer |
页码。 |
1 |
| Items |
object |
||
| LogRecords |
array<object> |
错误日志明细列表。 |
|
|
object |
|||
| ConnInfo |
string |
日志连接信息。 |
conn18xxxxxx |
| CreateTime |
string |
日志生成时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2019-02-26T12:09:34Z |
| Category |
string |
日志类别。返回值:
|
NETWORK |
| Content |
string |
日志信息。 |
xxxxxxxx |
| Id |
integer |
日志 ID。 |
1111111111 |
| Engine |
string |
当前数据库的引擎类型。 |
MongoDB |
示例
正常返回示例
JSON格式
{
"TotalRecordCount": 1,
"PageRecordCount": 1,
"RequestId": "68BCBEC2-1E66-471F-A1A8-E3C60C0A80B0",
"PageNumber": 1,
"Items": {
"LogRecords": [
{
"ConnInfo": "conn18xxxxxx",
"CreateTime": "2019-02-26T12:09:34Z",
"Category": "NETWORK",
"Content": "xxxxxxxx",
"Id": 1111111111
}
]
},
"Engine": "MongoDB"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameterCombination | The end time must be greater than the start time | 开始时间不能大于结束时间。 |
| 400 | InvalidStartTime.Malformed | The Specified parameter StartTime is not valid. | |
| 400 | InvalidEndTime.Malformed | The Specified parameter EndTime is not valid. | |
| 403 | LogApiFrequencyExceeded | Exceeding the allowed frequency of log api. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。