对于 AI 代理：可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。

获取一个日志集合作业

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。终结点仍如文档中所述。

当您创建日志集合作业时， MongoDB Ops Manager会启动背景作业，从指定的MongoDB Ops Manager部署中下载日志。 使用此端点可通过其唯一标识符检索单个日志集合作业。

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}

请求路径参数

名称
类型
必要性
说明

群组 ID（group ID）

字符串

必需

唯一的 24 位十六进制数字字符串，用于标识日志collection请求作业。

作业 ID

字符串

必需

唯一的 24 位十六进制数字字符串，用于标识要重试的日志collection作业。使用“获取一个项目的所有日志collection作业”端点获取与项目关联的 ID。

请求查询参数

名称
类型
说明
默认

pageNum

整型

页码（从 1 开始）。

1

itemsPerPage

整型

每页要返回的项目数，最多 500 个。

100

pretty

布尔

指示显示正文是否应采用 prettyprint 格式。

false

envelope

布尔

指示是否要将响应封装在信封中。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 "envelope" : true。

对于返回一个结果的终结点，响应体包括：

  • status: HTTP 响应代码

  • content：预期响应正文

对于返回结果列表的端点， results对象是一个信封。 Ops Manager 将status字段添加到响应正文。

无

verbose

布尔

如果为 true，则返回响应中的所有子作业。 一个 collection 作业包含请求中包含的每种日志类型和 MongoDB 进程的作业。

false

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

名称
类型
说明

子作业

阵列

与此请求关联的子作业列表。 如果将详细查询参数设置为true ，则包含在响应中。

childJobs[n].errorMessage

字符串

显示此子作业失败原因的错误消息（如适用）。

childJobs[n].finishDate

字符串

Timestamp in ISO 8601 date and time format in UTC when this child job finished.

childJobs[n].hostName

字符串

子作业从中收集日志的主机的名称。

childJobs[n].logCollectionType

字符串

此子作业收集的日志类型。 返回以下值之一：

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

childJobs[n].path

字符串

此子作业为其收集日志的部署中进程的路径。 MongoDB Atlas 使用这些路径在压缩存档文件中构建目录层次结构。

  • AUTOMATION_AGENT: <hostname>/automation_agent

  • BACKUP_AGENT: <hostname>/automation_agent

  • MONITORING_AGENT: <hostname>/automation_agent

  • MONGODB: <hostname>/<port>/<mongodb>

  • FTDC: <hostname>/<port>/<ftdc>

childJobs[n].startDate

字符串

Timestamp in ISO 8601 date and time format in UTC when this child job started.

childJobs[n].status

字符串

此子作业的状态。 此资源返回以下值之一：

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

childJobs[n].uncompressedDiskSpaceBytes

数字

此子作业使用的未压缩磁盘空间总量（以字节为单位）。

createdDate

字符串

时间戳，以自创建日志集合请求作业的UNIX 纪元起经过的秒数。

到期日期

字符串

时间戳，以日志集合请求作业到期的 UNIX 纪元 起经过的秒数表示。

groupId

字符串

唯一的 24-十六进制数字string ，用于标识与日志收集请求关联的项目。

id

字符串

唯一的 24 位十六进制数字字符串，用于标识日志collection请求作业。

logTypes

阵列

此请求中包含的日志类型列表。 此资源返回以下一个或多个值：

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

redacted

布尔

指示请求是否将响应中的电子邮件、主机名、IP 地址和命名空间替换为随机字符串值的标志。

资源名称

字符串

您为其请求日志的资源的名称。

资源类型

字符串

您为其请求日志的资源类型。 此资源返回以下值之一：

  • CLUSTER

  • PROCESS

  • REPLICA_SET

rootResourceName

字符串

如果您向部署的一部分发出日志请求，则为完整部署的名称。 部署的一部分可以是集群中的副本集或分片集群的一个分片。

rootResourceType

字符串

如果您向部署的一部分发出日志请求，请键入完整部署的一部分。 部署的一部分可以是集群中的副本集或分片集群的一个分片。 此资源返回以下值之一：

  • CLUSTER

  • PROCESS

  • REPLICA_SET

状态

字符串

日志收集请求作业的状态。 此资源返回以下值之一：

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

sizeRequestedPerFileBytes

数字

每个日志文件的大小（以字节为单位）。

uncompressedSizeTotalBytes

数字

此请求返回的日志数据的未压缩总大小（以字节为单位）。

用户 ID

字符串

唯一的 24 位十六进制数字字符串，用于标识执行请求的用户。

downloadUrl

字符串

您从中下载此请求的日志的互联网地址。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --include \     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?verbose=true&pretty=true"

响应示例

响应标头

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

{  "childJobs": [    {      "automationAgentId": "5c81086e014b76a3d85e1123",      "errorMessage": null,      "finishDate": "2019-03-07T12:02:57Z",      "hostName": "server1.example.com",      "logCollectionType": "AUTOMATION_AGENT",      "path": "server1.example.com/automation_agent",      "startDate": "2019-03-07T12:02:54Z",      "status": "SUCCESS",      "uncompressedDiskSpaceBytes": 12827    },    {      "automationAgentId": "5c81086e014b76a3d85e1117",      "errorMessage": null,      "finishDate": "2019-03-07T12:02:57Z",      "hostName": "server1.example.com:27027",      "logCollectionType": "MONGODB",      "path": "server1.example.com/27027/mongodb",      "startDate": "2019-03-07T12:02:54Z",      "status": "SUCCESS",      "uncompressedDiskSpaceBytes": 9292    },    ...  ],  "creationDate": "2019-03-07T12:02:54Z",  "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download",  "expirationDate": "2019-05-06T12:02:54Z",  "groupId": "5c8100bcf2a30b12ff88258f",  "id": "5c81086e014b76a3d85e1113",  "logTypes": [    "AUTOMATION_AGENT",    "MONGODB",    "FTDC"  ],  "redacted": false,  "resourceName": "myReplicaSet",  "resourceType": "replicaset",  "rootResourceName": "myReplicaSet",  "rootResourceType": "replicaset",  "sizeRequestedPerFileBytes": 1000,  "status": "IN_PROGRESS",  "uncompressedSizeTotalBytes": 44518,  "userId": "5c80f75fcf09a246878f67a4"}
后退
获取所有作业
来年
下载日志
给本页内容打分

在此页面上