扩展日志collection作业
注意
注意:群组和项目是同义词。您的 {PROJECT-ID}
与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
创建日志收集作业时,Cloud Manager 会启动后台作业,从指定的 Cloud Manager 部署中下载日志。 创建的每个作业都有指定的到期日期。 Use this endpoint to extend the expiration date of an existing log collection job.
您无法延长已过期的日志collection作业的持续时间。
基本 URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
PATCH /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}
请求路径参数
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
群组 ID(group ID) | 字符串 | 必需 | 唯一的 24 位十六进制数字字符串,用于标识日志collection请求作业。 |
作业 ID | 字符串 | 必需 | 唯一的 24 位十六进制数字字符串,用于标识要重试的日志collection作业。使用“获取一个项目的所有日志collection作业”端点获取与项目关联的 ID。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 |
| ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
|
|
请求正文参数
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
到期日期 | 字符串 | 必需 | 时间戳,以自 UNIX 纪元 以来经过的秒数表示 当此作业到期时。这最长可能需要6个月(从创建作业时算起)。 您指定的日期不能早于提出请求的时间。 |
响应
此端点不返回响应正文。
请求示例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?pretty=true" 6 --data ' 7 { 8 "expirationDate": "2019-04-06T12:02:54Z" 9 }'
响应示例
响应标头
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}
响应体
此端点不返回响应正文。