アクセス リストへのエントリの追加
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
POST /users/{USER-ID}/accessList
リクエスト パス パラメーター
Parameter | タイプ | 説明 |
|---|---|---|
ユーザー ID | string | （必須。） 現在のユーザーの一意の識別子。 現在のユーザーの ID を取得するには、 「 1 つのプロジェクトのすべてのユーザーを取得 」を参照してください。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを |
|
リクエスト ボディ パラメータ
リクエスト ボディは、アクセス リスト エンティティが 1 つしかない場合でも、アクセス リスト エンティティの配列である必要があります。 各リクエスト オブジェクトに指定する必要があるフィールドは、 IP-ADRESSのみです。
IP アドレスがすでにアクセス リストに含まれている場合は、無視されます。
/32サブネット マスクで単一の IP アドレスを指定すると、 /32はアドレスを変更しないため、Cloud Manager は/32を保存しません。
例
のアドレスは12.34.56.78 12.34.56.78/32と同じです。
Parameter | タイプ | 説明 |
|---|---|---|
ipAddress | string | （必須。） 指定されたユーザーのアクセス リストに追加する IP アドレスまたはCIDRブロック。 |
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つのアクセス リストです。
名前 | タイプ | 説明 |
|---|---|---|
| string | CIDR 表記の IP アドレス範囲。 |
| date | この IP アドレスがアクセス リストに追加された日付。 |
| string | アクセス リスト内の IP アドレス。 |
| date | この IP アドレスから送信された最新のリクエストの日付。 このフィールドは、アクセス リストで保護されているリソースがアクセスされたときにのみ更新されることに注意してください。 |
| string | API への最後の呼び出しが発行されたアドレス。 |
| 数値 | この IP アドレスから送信されたリクエストの合計数。 このフィールドは、アクセス リストで保護されているリソースがアクセスされたときにのみ更新されることに注意してください。 |
| 配列 | 関連するサブリソース へのリンク。 レスポンス内のすべてのリンク配列には、 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList" --data ' [ { "ipAddress" : "192.0.1.15", "comment" : "IP address for Application Server A" }, { "cidrBlock" : "192.0.2.0/24", "comment" : "CIDR block for Application Server B - D" } ]'
応答例
応答ヘッダー
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
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}
レスポンス本体
{ "totalCount" : 3, "results" : [ { "cidrBlock" : "12.34.56.78/32", "ipAddress" : "12.34.56.78", "created" : "2014-04-23T16:17:44Z", "lastUsed" : "2016-08-17T19:34:05Z", "lastUsedAddress" : "12.34.56.78", "count" : 0, "links" : [] }, { "cidrBlock" : "76.54.32.10/32", "ipAddress" : "76.54.32.10", "created" : "2016-08-17T19:34:05Z", "count" : 0, "links" : [] }, { "cidrBlock" : "2.3.4.5/32", "ipAddress" : "2.3.4.5", "created" : "2016-08-17T19:34:05Z", "count" : 0, "links" : [] } ], "links" : [] }