/ /

/ /

创建导入部署请求

注意

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

创建新的导入部署请求，将现有MongoDB流程添加到Ops Manager自动化。此端点启动将多个MongoDB进程导入监控和自动化管理的进程。

重要

从Ops Manager 8.0.13 开始提供此功能。

导入的部署将添加到项目的自动化配置中。 MongoDB 助手将开始监控进程并根据自动化配置对其管理。

所需角色

此端点需要Project Automation Admin 角色。

端点

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

POST /automation/importDeployment/{PROJECT-ID}

请求

路径参数

名称	类型	必要性	说明
PROJECT-ID	字符串	必需	将拥有导入的部署的项目的唯一标识符。

查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

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

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

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

正文参数

名称	类型	必要性	说明
种子主机端口	字符串	必需	要连接以进行发现的MongoDB种子进程的主机名和端口（例如，`mongodb1.example.com:27017`）。
requiredProcesses	阵列	必需	表示在继续导入之前必须发现的MongoDB进程的主机名:端口字符串的数组。
超时	对象	Optional	各个导入阶段的超时设置。
timeups.seedHostConnectionSec	数字	Optional	连接种子托管的超时时间（以秒为单位）。范围：60-86400 秒。默认使用系统设置。
timeups.processesDiscoverySec	数字	Optional	发现所有必需进程的超时时间（以秒为单位）。范围：60-86400 秒。默认使用系统设置。
timeups.automationImported	数字	Optional	完成自动化导入的超时时间（以秒为单位）。范围：60-86400 秒。默认使用系统设置。
timeups.goalStateSec	数字	Optional	达到自动化目标状态的超时时间（以秒为单位）。范围：60-86400 秒。默认使用系统设置。
authMechanism	字符串	Optional	用于连接到MongoDB进程的身份验证机制。可能的值为： `MONGODB_CR` （涵盖 SCRAM-SHA-1、SCRAM-SHA-256 和 MONGODB-CR。） `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
用户名	字符串	可选的	用于向MongoDB进程进行身份验证的用户名。如果指定了 `authMechanism`，则为必填项。
密码	字符串	可选的	用于对MongoDB进程进行身份验证的密码。如果 `authMechanism` 为 `MONGODB_CR`，则为必填项。 Ops Manager不会在响应文档中包含此参数。
adminDb	字符串	Optional	要进行身份验证的数据库。默认值：`admin`。
pemKeyFilePath	字符串	Optional	用于 TLS客户端身份验证的 PEM 密钥文件的路径。
pemKeyFilePassword	字符串	Optional	PEM 密钥文件的密码。 Ops Manager不会在响应文档中包含此参数。
adminKerberosKeytab	字符串	Optional	用于 GSSAPI身份验证的Kerberos keytab文件的路径。
adminLdapGroupDn	字符串	Optional	用于 PLAIN身份验证的LDAP群组标识名。
saslServiceName	字符串	Optional	用于 GSSAPI身份验证的 SASL 服务名称。
caFilePath	字符串	Optional	用于 TLS 连接的证书颁发机构文件的路径。
clusterCaFilePath	字符串	Optional	用于 TLS 连接的集群证书颁发机构文件的路径。
clientCertificateMode	字符串	Optional	TLS 连接的客户端证书模式。

响应

如果成功提交导入请求，则返回具有HTTP状态 200 的空成功响应。

注意

此端点不返回创建的导入请求的ID 。要追踪导入请求的状态，请使用获取导入部署请求端点列出项目的所有请求，并按创建时间或其他属性标识您的请求。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/automation/importDeployment/{PROJECT-ID}?pretty=true" \
     --data '{
       "seedHostport": "mongodb1.example.com:27017",
       "requiredProcesses": [
         "mongodb1.example.com:27017",
         "mongodb2.example.com:27017",
         "mongodb3.example.com:27018"
       ],
       "timeouts": {
         "seedHostConnectionSec": 300,
         "processesDiscoverySec": 600,
         "automationImported": 600,
         "goalStateSec": 1200
       },
       "authMechanism": "MONGODB_CR",
       "username": "admin",
       "password": "password123",
       "adminDb": "admin"
     }'

响应示例

响应标头

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 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}

响应体

{}

后退

导入部署

来年

获取导入部署请求