Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
日志集合作业

创建日志collection作业

在此页面上

  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

注意

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

创建日志收集作业时，Cloud Manager 会启动后台作业，从指定的 Cloud Manager 部署中下载日志。 使用此端点创建新的日志collection作业。

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

Resource

POST /groups/{GROUP-ID}/logCollectionJobs

请求路径参数

名称
类型
必要性
说明

群组 ID（group ID）

字符串

必需

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

请求查询参数

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

名称
类型
必要性
说明
默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

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

名称
说明

status

HTTP 响应代码

content

预期响应正文

false

请求正文参数

名称
类型
必要性
说明

资源类型

字符串

必需

要从中收集日志的资源类型。 必须是以下值之一：

  • CLUSTER，对于分片集群。

  • PROCESS，用于副本集中的节点。

  • REPLICASET，用于副本集。

资源名称

字符串

必需

要从中收集日志的资源的名称。 资源类型定义值：

  • 对于CLUSTER resourceType ，该值为部署或CLUSTER-ID的名称。 例如， my-deployment 。

  • 对于PROCESS resourceType ，该值是副本集的名称，后跟节点名称。 例如， Cluster0-shard-1-node-0 。

    要获取副本集的名称、节点列表和其他信息，请访问集群并运行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

日志集合的开始日期和时间（采用 ISO8601 格式 (UTC)。日期和时间必须是过去的日期和时间。

logCollectionToDate

字符串

如果使用logCollectionFromDate ，则为必填项。

日志集合的结束日期和时间（采用 ISO8601 格式 (UTC)。日期和时间必须是过去的日期和时间。 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://cloud.mongodb.com/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         "logCollectionFromDate": "2024-07-18T13:53:17Z",
18         "logCollectionToDate": "2024-07-18T15:53:17Z"
19       }'

响应示例

响应标头

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 201 Created
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{ "id": "5c81086e014b76a3d85e1113" }

后退

下载日志

来年

扩展