获取一个项目的所有日志集合作业
注意
注意:群组和项目是同义词。您的 {PROJECT-ID}
与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
当您创建日志collection作业时,Ops Manager会启动背景作业,从指定的Ops Manager部署中下载日志。使用此端点检索指定 Ops Manager 项目的所有日志集合作业。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/logCollectionJobs
请求路径参数
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
群组 ID(group ID) | 字符串 | 必需 | 唯一的 24 位十六进制数字字符串,用于标识日志collection请求作业。 |
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数,用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数,最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 对于返回结果列表的端点, | false |
verbose | 布尔 | Optional | 指示是否在响应中包含所有子作业的标志。 每个日志collection作业都包含请求中包含的每种日志类型和 MongoDB 进程的子作业。 | false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
---|---|---|
results | 阵列 | 数组为 results 嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results
嵌入式文档
每个结果都是一个collection作业。
名称 | 类型 | 说明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
子作业 | 阵列 | 与此请求关联的子作业列表。 如果将详细查询参数设置为 true ,则包含在响应中。 | ||||||||||||
childJobs[n].errorMessage | 字符串 | 显示此子作业失败原因的错误消息(如适用)。 | ||||||||||||
childJobs[n].finishDate | 字符串 | ISO8601 格式的时间戳 此子作业完成时的日期和时间格式( UTC 格式)。 | ||||||||||||
childJobs[n].hostName | 字符串 | 子作业从中收集日志的主机的名称。 | ||||||||||||
childJobs[n].logCollectionType | 字符串 | 此子作业收集的日志类型。 返回以下值之一:
| ||||||||||||
childJobs[n].path | 字符串 | 此子作业为其收集日志的部署中进程的路径。 MongoDB Atlas 使用这些路径在压缩存档文件中构建目录层次结构。
| ||||||||||||
childJobs[n].startDate | 字符串 | ISO8601 格式的时间戳 此子作业启动时的日期和时间格式( UTC 格式)。 | ||||||||||||
childJobs[n].status | 字符串 | 此子作业的状态。 此资源返回以下值之一:
| ||||||||||||
childJobs[n].uncompressedDiskSpaceBytes | 数字 | 此子作业使用的未压缩磁盘空间总量(以字节为单位)。 | ||||||||||||
createdDate | 字符串 | 时间戳,以自 UNIX 纪元 以来经过的秒数表示 创建日志收集请求作业时。 | ||||||||||||
到期日期 | 字符串 | 时间戳,以自 UNIX 纪元 以来经过的秒数表示 当日志收集请求作业过期时。 | ||||||||||||
groupId | 字符串 | 唯一的 24-十六进制数字string ,用于标识与日志收集请求关联的项目。 | ||||||||||||
id | 字符串 | 唯一的 24 位十六进制数字字符串,用于标识日志collection请求作业。 | ||||||||||||
logTypes | 阵列 | 此请求中包含的日志类型列表。 此资源返回以下一个或多个值:
| ||||||||||||
redacted | 布尔 | 指示请求是否将响应中的电子邮件、主机名、IP 地址和命名空间替换为随机字符串值的标志。 | ||||||||||||
资源名称 | 字符串 | 您为其请求日志的资源的名称。 | ||||||||||||
资源类型 | 字符串 | 您为其请求日志的资源类型。 此资源返回以下值之一:
| ||||||||||||
rootResourceName | 字符串 | 如果您向部署的一部分发出日志请求,则为完整部署的名称。 部署的一部分可以是集群中的副本集或分片集群的一个分片。 | ||||||||||||
rootResourceType | 字符串 | 如果您向部署的一部分发出日志请求,请键入完整部署的一部分。 部署的一部分可以是集群中的副本集或分片集群的一个分片。 此资源返回以下值之一:
| ||||||||||||
状态 | 字符串 | 日志收集请求作业的状态。 此资源返回以下值之一:
| ||||||||||||
sizeRequestedPerFileBytes | 数字 | 每个日志文件的大小(以字节为单位)。 | ||||||||||||
uncompressedSizeTotalBytes | 数字 | 此请求返回的日志数据的未压缩总大小(以字节为单位)。 | ||||||||||||
用户 ID | 字符串 | 唯一的 24 位十六进制数字字符串,用于标识执行请求的用户。 | ||||||||||||
downloadUrl | 字符串 | 您从中下载此请求的日志的互联网地址。 |
请求示例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pretty=true"
响应示例
响应标头
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
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 "links": [ 3 { 4 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pageNum=1&itemsPerPage=100", 5 "rel": "self" 6 } 7 ], 8 "results": [ 9 { 10 "childJobs": [ 11 { 12 "automationAgentId": "5c810cc4ff7a256345ff97bf", 13 "errorMessage": null, 14 "finishDate": "2019-03-07T12:21:30Z", 15 "hostName": "server1.example.com", 16 "logCollectionType": "AUTOMATION_AGENT", 17 "path": "server1.example.com/automation_agent", 18 "startDate": "2019-03-07T12:21:24Z", 19 "status": "SUCCESS", 20 "uncompressedDiskSpaceBytes": 14686 21 } 22 ], 23 "creationDate": "2019-03-07T12:21:24Z", 24 "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c810cc4ff7a256345ff97b7/download", 25 "expirationDate": "2019-04-06T12:21:24Z", 26 "groupId": "5c8100bcf2a30b12ff88258f", 27 "id": "5c810cc4ff7a256345ff97b7", 28 "logTypes": [ 29 "AUTOMATION_AGENT", 30 "MONGODB" 31 ], 32 "redacted": true, 33 "resourceName": "myReplicaSet", 34 "resourceType": "replicaset", 35 "rootResourceName": "myReplicaSet", 36 "rootResourceType": "replicaset", 37 "sizeRequestedPerFileBytes": 1000, 38 "status": "SUCCESS", 39 "uncompressedSizeTotalBytes": 63326, 40 "userId": "5c80f75fcf09a246878f67a4" 41 }, 42 { 43 "childJobs": [ 44 { 45 "automationAgentId": "5c81086e014b76a3d85e1117", 46 "errorMessage": null, 47 "finishDate": "2019-03-07T12:02:57Z", 48 "hostName": "server1.example.com:27027", 49 "logCollectionType": "MONGODB", 50 "path": "server1.example.com/27027/mongodb", 51 "startDate": "2019-03-07T12:02:54Z", 52 "status": "SUCCESS", 53 "uncompressedDiskSpaceBytes": 9292 54 } 55 ], 56 "creationDate": "2019-03-07T12:02:54Z", 57 "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download", 58 "expirationDate": "2019-05-06T12:02:54Z", 59 "groupId": "5c8100bcf2a30b12ff88258f", 60 "id": "5c81086e014b76a3d85e1113", 61 "logTypes": [ 62 "MONGODB", 63 "FTDC", 64 "AUTOMATION_AGENT" 65 ], 66 "redacted": false, 67 "resourceName": "myReplicaSet", 68 "resourceType": "replicaset", 69 "rootResourceName": "myReplicaSet", 70 "rootResourceType": "replicaset", 71 "sizeRequestedPerFileBytes": 1000, 72 "status": "IN_PROGRESS", 73 "uncompressedSizeTotalBytes": 44518, 74 "userId": "5c80f75fcf09a246878f67a4" 75 } 76 ], 77 "totalCount": 2 78 }