创建日志collection作业

注意

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

使用此终结点创建新的日志集合作业。当您创建日志集合作业时，Ops Manager 会启动一个背景作业，从指定的 Ops Manager 部署下载日志。

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

Resource

POST /groups/{GROUP-ID}/logCollectionJobs

请求路径参数

名称	类型	必要性	说明
群组 ID（group ID）	字符串	必需	唯一的 24 位十六进制数字字符串，用于标识日志collection请求作业。

请求查询参数

以下查询参数为可选参数：

名称	类型	必要性	说明	默认
pretty	布尔	Optional	指示响应正文是否采用 pretty-print 格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。对于返回一个结果的端点，响应体包括： `status`: HTTP 响应代码 `content`：预期响应正文	`false`

请求正文参数

名称	类型	必要性	说明
资源类型	字符串	必需	要从中收集日志的资源类型。必须是以下值之一： `CLUSTER`，对于分片集群。 `PROCESS`，用于副本集中的节点。 `REPLICASET`, 用于副本集。
资源名称	字符串	必需	要从中收集日志的资源的名称。资源类型定义值：对于`CLUSTER` `resourceType` ，该值为部署或`CLUSTER-ID`的名称。例如， `my-deployment` 。要获取此值，请使用/groups/{GROUP-ID}/clusters/{CLUSTER-ID}端点。对于`PROCESS` `resourceType` ，该值是副本集的名称，后跟节点名称。例如， `Cluster0-shard-1-node-0` 。要获取此值，请使用/groups/{项目ID}/automationConfig端点。该值位于`processes.name`参数中。要获取副本集的名称、节点列表和其他信息，请访问集群并运行`rs.conf()._id`和`rs.status()` 。对于`REPLICASET` `resourceType` ，该值是集群中副本集的名称，后跟分片名称。例如， `test-123abc-shard-0` 。
sizeRequestedPerFileBytes	数字	必需	每个日志文件的大小（以字节为单位）。
logTypes	阵列	必需	指定要收集的日志类型的字符串数组。每个数组元素必须是以下值之一： `AUTOMATION_AGENT` `BACKUP_AGENT` `MONITORING_AGENT` `MONGODB` `FTDC`
redacted	布尔	必需	如果设置为`true` ，则涉及此作业的 API 响应中的电子邮件、主机名、IP 地址和命名空间将替换为随机字符串值。
logCollectionFromDate	整型	Optional	自 Unix 纪元以来的毫秒数，表示此日志的开始日期和时间。如果指定 `logCollectionFromDate`，则还必须指定 `logCollectionToDate`。
logCollectionToDate	整型	Optional	以 Unix 纪元以来的毫秒数表示结束此日志的日期和时间。如果指定 `logCollectionToDate`，则还必须指定 `logCollectionFromDate`。

响应

名称	类型	说明
id	字符串	创建的日志collection作业的唯一标识。

请求示例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2     --header "Accept: application/json" \3     --header "Content-Type: application/json" \4     --include \5     --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?pretty=true" \6     --data '7       {8         "resourceType": "PROCESS",9         "resourceName": "my_deployment_1",10         "redacted": true,11         "sizeRequestedPerFileBytes": 10000000,12         "logTypes": [13             "FTDC",14             "MONGODB",15             "AUTOMATION_AGENT"16         ]17       }'

响应示例

响应标头

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 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

1{ "id": "5c81086e014b76a3d85e1113" }