从日志collection作业下载日志
注意
注意:群组和项目是同义词。您的 {PROJECT-ID}
与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
当您创建日志collection作业时,Ops Manager会启动背景作业,从指定的Ops Manager部署中下载日志。使用此端点可为与指定作业关联的所有日志下载.tar.gz
文件流。
您可以下载成功和失败的collection作业的日志。如果作业失败,则会下载所有成功的组件。 日志将下载到执行请求的同一目录中,且采用的格式与通过 Ops Manager 用户界面下载日志时所使用的格式相同。
例子
hostname/ automation_agent/ Automation-agent-verbose.log.2019-01-... mongos/ ... myShard_1/ 27017/ ... 27018/ ...
您无法从处于EXPIRED
或IN_PROGRESS
状态的作业下载日志。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}/download
请求路径参数
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
群组 ID(group ID) | 字符串 | 必需 | 唯一的 24 位十六进制数字字符串,用于标识日志collection请求作业。 |
作业 ID | 字符串 | 必需 | 要为其下载日志的作业的唯一标识符。 您可以使用“ 获取一个项目的所有日志集合作业”端点获取与项目关联的 JOB-IDs 。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
此端点没有响应元素。
请求示例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest 2 --header "Accept: application/json" 3 --header "Accept: application/gzip" 4 --output logs.tar.gz 5 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}/download"
注意
如果使用 cURL 发出请求,则必须包含--output
选项并指定用于存储日志的文件名。
响应示例
响应标头
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}
响应体
此端点不返回响应正文。