Docs 菜单

获取一个日志集合作业

注意

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

创建日志收集作业时,Cloud Manager 会启动后台作业,从指定的 Cloud Manager 部署中下载日志。 使用此端点可通过其唯一标识符检索单个日志集合作业。

基本 URL: https://cloud.mongodb.com/api/public/v 1.0

GET /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}
名称
类型
必要性
说明

群组 ID(group ID)

字符串

必需

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

作业 ID

字符串

必需

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

名称
类型
说明
默认

pageNum

整型

页码(从 1 开始)。

1

itemsPerPage

整型

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

100

pretty

布尔

指示响应正文是否应采用 美观打印 格式。

false

envelope

布尔

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

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

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

名称
说明

status

HTTP 响应代码

content

预期响应正文

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

verbose

布尔

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

false

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

名称
类型
说明

子作业

阵列

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

childJobs[n].errorMessage

字符串

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

childJobs[n].finishDate

字符串

ISO8601 格式的时间戳 此子作业完成时的日期和时间格式( UTC 格式)。

childJobs[n].hostName

字符串

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

childJobs[n].logCollectionType

字符串

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

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

childJobs[n].path

字符串

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

logCollectionType
路径

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

字符串

ISO8601 格式的时间戳 此子作业启动时的日期和时间格式( UTC 格式)。

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 位十六进制数字字符串,用于标识执行请求的用户。

url

字符串

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

logCollectionFromDate

字符串

日志集合的开始日期和时间(采用 ISO8601 格式 (UTC)。

logCollectionToDate

字符串

日志集合的结束日期和时间(采用 ISO8601 格式 (UTC)。

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --include \
4 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?verbose=true&pretty=true"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
1{
2 "childJobs": [
3 {
4 "automationAgentId": "5c81086e014b76a3d85e1123",
5 "errorMessage": null,
6 "finishDate": "2019-03-07T12:02:57Z",
7 "hostName": "server1.example.com",
8 "logCollectionType": "AUTOMATION_AGENT",
9 "path": "server1.example.com/automation_agent",
10 "startDate": "2019-03-07T12:02:54Z",
11 "status": "SUCCESS",
12 "uncompressedDiskSpaceBytes": 12827
13 },
14 {
15 "automationAgentId": "5c81086e014b76a3d85e1117",
16 "errorMessage": null,
17 "finishDate": "2019-03-07T12:02:57Z",
18 "hostName": "server1.example.com:27027",
19 "logCollectionType": "MONGODB",
20 "path": "server1.example.com/27027/mongodb",
21 "startDate": "2019-03-07T12:02:54Z",
22 "status": "SUCCESS",
23 "uncompressedDiskSpaceBytes": 9292
24 },
25 ...
26 ],
27 "creationDate": "2019-03-07T12:02:54Z",
28 "downloadUrl": "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download",
29 "expirationDate": "2019-05-06T12:02:54Z",
30 "groupId": "5c8100bcf2a30b12ff88258f",
31 "id": "5c81086e014b76a3d85e1113",
32 "logTypes": [
33 "AUTOMATION_AGENT",
34 "MONGODB",
35 "FTDC"
36 ],
37 "redacted": false,
38 "resourceName": "myReplicaSet",
39 "resourceType": "replicaset",
40 "rootResourceName": "myReplicaSet",
41 "rootResourceType": "replicaset",
42 "sizeRequestedPerFileBytes": 1000,
43 "status": "IN_PROGRESS",
44 "uncompressedSizeTotalBytes": 44518,
45 "userId": "5c80f75fcf09a246878f67a4"
46}