Docs 菜单
Docs 主页
/ /
配置资源
Docs 主页
/ /
自动化
/
配置资源
Docs 主页
/
管理
/
Cloud Manager
/
API
/
资源
/
自动化
/
配置资源

获取自动化配置（已编辑的敏感信息）

项目的自动化配置决定其MongoDB进程和代理的目标状态。 MongoDB Agent根据指定的目标构建部署。

重要

项目的自动化配置可能包含敏感信息，例如密码或键值。此资源获取包含已编辑敏感信息的自动化配置。要获取未编辑的自动化配置，请使用 /groups/{PROJECT- ID}/automationConfig 端点。

所需角色

此资源需要 Project Automation Admin角色。

Resource

基本 URL： https://cloud.mongodb.com/api/public/v1.0

GET /groups/{PROJECT-ID}/automationConfig/noSecrets

请求

路径参数

名称
类型
必要性
说明

PROJECT-ID

字符串

必需

拥有自动化配置的群组的唯一标识符。

查询参数

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

名称
类型
必要性
说明
默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

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

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

名称
说明

status

HTTP 响应代码

content

预期响应正文

false

正文参数

此端点不使用 HTTP 请求正文参数。

响应

要查看这些参数，请参阅自动化配置参数。

请求示例

curl --user "{publicApiKey}:{privateApiKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/noSecrets?pretty=true" \
     --output currentAutomationConfigRedacted.json

响应示例

响应标头

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}

响应体

以下示例响应正文显示了包含已编辑敏感信息的自动化配置示例。 /groups/{PROJECT-ID}/automationConfig/noSecrets 端点返回编辑文本，其中敏感字段值替换为字符串 <redacted>：

1{
2  "backupVersions": [
3    {
4      "hostname": "test-2.aabc.3172.mongodbdns.com"
5    }
6  ],
7  "mongoDbVersions": [
8    {
9      "name": "4.4.0"
10    }
11  ],
12  "monitoringVersions": [
13    {
14      "hostname": "test-2.aabc.3172.mongodbdns.com"
15    }
16  ],
17  "options": {
18    "downloadBase": "/var/lib/mongodb-mms-automation",
19    "downloadBaseWindows": "%SystemDrive%\\MMSAutomation\\versions"
20  },
21  "processes": [
22    {
23      "args2_6": {
24        "net": {
25          "port": 27017
26        },
27        "operationProfiling": {},
28        "replication": {
29          "replSetName": "replSet1"
30        },
31        "storage": {
32          "dbPath": "/data/replSet1_10"
33        },
34        "systemLog": {
35          "destination": "file",
36          "path": "/data/replSet1_10/mongodb.log"
37        }
38      },
39      "hostname": "test-2.aabc.3172.mongodbdns.com",
40      "logRotate": {
41        "sizeThresholdMB": 1000,
42        "timeThresholdHrs": 24
43      },
44      "auditLogRotate": {
45        "sizeThresholdMB": 1000,
46        "timeThresholdHrs": 24
47      },
48      "name": "replSet1_10",
49      "directAttachVerificationKey": "<redacted>",
50      "processType": "mongod",
51      "version": "4.4.0",
52      "authSchemaVersion": 5,
53      "featureCompatibilityVersion": "4.2"
54    },
55    {
56      "args2_6": {
57        "net": {
58          "port": 27017
59        },
60        "operationProfiling": {},
61        "replication": {
62          "replSetName": "replSet1"
63        },
64        "storage": {
65          "dbPath": "/data/replSet1_11"
66        },
67        "systemLog": {
68          "destination": "file",
69          "path": "/data/replSet1_11/mongodb.log"
70        }
71      },
72      "hostname": "test-1.aabc.3172.mongodbdns.com",
73      "logRotate": {
74        "sizeThresholdMB": 1000,
75        "timeThresholdHrs": 24
76      },
77      "auditLogRotate": {
78        "sizeThresholdMB": 1000,
79        "timeThresholdHrs": 24
80      },
81      "name": "replSet1_11",
82      "directAttachVerificationKey": "<redacted>",
83      "processType": "mongod",
84      "version": "4.4.0",
85      "authSchemaVersion": 5,
86      "featureCompatibilityVersion": "4.2"
87    },
88    {
89      "args2_6": {
90        "net": {
91          "port": 27017
92        },
93        "operationProfiling": {},
94        "replication": {
95          "replSetName": "replSet1"
96        },
97        "storage": {
98          "dbPath": "/data/replSet1_12"
99        },
100        "systemLog": {
101          "destination": "file",
102          "path": "/data/replSet1_12/mongodb.log"
103        }
104      },
105      "hostname": "test-0.aabc.3172.mongodbdns.com",
106      "logRotate": {
107        "sizeThresholdMB": 1000,
108        "timeThresholdHrs": 24
109      },
110      "auditLogRotate": {
111        "sizeThresholdMB": 1000,
112        "timeThresholdHrs": 24
113      },
114      "name": "replSet1_12",
115      "directAttachVerificationKey": "<redacted>",
116      "processType": "mongod",
117      "version": "4.4.0",
118      "authSchemaVersion": 5,
119      "featureCompatibilityVersion": "4.2"
120    },
121    {
122      "args2_6": {
123        "net": {
124          "port": 27018
125        },
126        "operationProfiling": {},
127        "replication": {
128          "replSetName": "replSet1"
129        },
130        "storage": {
131          "dbPath": "/data/replSet1_13"
132        },
133        "systemLog": {
134          "destination": "file",
135          "path": "/data/replSet1_13/mongodb.log"
136        }
137      },
138      "hostname": "test-2.aabc.3172.mongodbdns.com",
139      "logRotate": {
140        "sizeThresholdMB": 1000,
141        "timeThresholdHrs": 24
142      },
143      "auditLogRotate": {
144        "sizeThresholdMB": 1000,
145        "timeThresholdHrs": 24
146      },
147      "name": "replSet1_13",
148      "directAttachVerificationKey": "<redacted>",
149      "processType": "mongod",
150      "version": "4.4.0",
151      "authSchemaVersion": 5,
152      "featureCompatibilityVersion": "4.2"
153    }
154  ],
155  "replicaSets": [
156    {
157      "_id": "replSet1",
158      "protocolVersion": "1",
159      "members": [
160        {
161          "_id": 0,
162          "arbiterOnly": false,
163          "hidden": true,
164          "host": "replSet1_10",
165          "priority": 0.0,
166          "secondaryDelaySecs": 200,
167          "votes": 0
168        },
169        {
170          "_id": 1,
171          "arbiterOnly": false,
172          "hidden": false,
173          "host": "replSet1_11",
174          "priority": 1.0,
175          "secondaryDelaySecs": 0,
176          "votes": 1
177        },
178        {
179          "_id": 2,
180          "arbiterOnly": false,
181          "hidden": false,
182          "host": "replSet1_12",
183          "priority": 1.0,
184          "secondaryDelaySecs": 0,
185          "votes": 1
186        },
187        {
188          "_id": 3,
189          "arbiterOnly": true,
190          "hidden": false,
191          "host": "replSet1_13",
192          "priority": 0.0,
193          "secondaryDelaySecs": 0,
194          "votes": 1
195        }
196      ]
197    }
198  ],
199  "roles": [],
200  "sharding": [],
201  "indexConfigs": [
202    {
203      "key": [
204        [
205          "field",
206          "1"
207        ]
208      ],
209      "rsName": "replSet1",
210      "dbName": "db",
211      "collectionName": "collection"
212    }
213  ]
214}

后退

获取自动化配置

来年

更新自动化配置

在此页面上