VPC環境で利用できます。
Cloud DB for MongoDBは、MongoDBデータベースを簡単に構築して自動的に管理できます。NAVERの最適化設定で安定的に運用し、障害が発生すると自動復旧する完全管理型クラウドデータベースサービスです。Cloud DB for MongoDBでは、データベース管理機能関連の APIを RESTful形式で提供します。
Cloud DB for MongoDBの共通設定
Cloud DB for MongoDB APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです。
https://ncloud.apigw.ntruss.com
リクエストヘッダ
リクエストヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
|
x-ncp-iam-access-key |
Required | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名 |
レスポンス
共通レスポンス形式を説明します。
レスポンスステータスコード
Cloud DB for MongoDB APIは NAVERクラウドプラットフォームの共通レスポンスステータスコードを使用します。NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
Cloud DB for MongoDB API
Cloud DB for MongoDB APIサービスで提供する APIの説明は次の通りです。
| API | 説明 |
|---|---|
| addCloudMongoDbUserList | Cloud DB for MongoDB Userを追加 |
| changeCloudMongoDbConfigCount | Cloud DB for MongoDBの Configサーバ台数を変更 |
| changeCloudMongoDbMongosCount | Cloud DB for MongoDBの Mongosサーバ台数を変更 |
| changeCloudMongoDbSecondaryCount | Cloud DB for MongoDBの Secondaryサーバ台数を変更 |
| changeCloudMongoDbShardCount | Cloud DB for MongoDBの Shard台数を変更 |
| changeCloudMongoDbUserList | Cloud DB for MongoDB User情報を変更 |
| createCloudMongoDbInstance | Cloud DB for MongoDBインスタンスを作成 |
| deleteCloudMongoDbInstance | Cloud DB for MongoDBインスタンスを削除 |
| deleteCloudMongoDbUserList | Cloud DB for MongoDB Userを削除 |
| exportBackupToObjectStorage | Cloud DB for MongoDBのバックアップファイルを Object Storageに転送 |
| exportDbServerLogToObjectStorage | Cloud DB for MongoDBデータベースサーバログファイルを Object Storageに転送 |
| getCloudMongoDbBackupDetailList | Cloud DB for MongoDBバックアップ詳細情報を照会 |
| getCloudMongoDbBackupList | Cloud DB for MongoDBバックアップリストを照会 |
| getCloudMongoDbBucketList | Cloud DB for MongoDBで使用可能な Object Storageバケットリストを照会 |
| getCloudMongoDbImageProductList | Cloud DB for MongoDB商品コードリストを照会 |
| getCloudMongoDbInstanceDetail | Cloud DB for MongoDBインスタンスの詳細情報を照会 |
| getCloudMongoDbInstanceList | Cloud DB for MongoDBインスタンスリストを照会 |
| getCloudMongoDbProductList | 使用可能な Cloud DB for MongoDBサーバスペックコードリストを照会 |
| getCloudMongoDbTargetSubnetList | 使用可能な Subnetリストを照会 |
| getCloudMongoDbTargetVpcList | 使用可能な VPCリストを照会 |
| getCloudMongoDbUserList | Cloud DB for MongoDB Userリストを照会 |
| getDbServerLogList | Cloud DB for MongoDBデータベースサーバログリストを照会 |
| rebootCloudMongoDbServerInstance | Cloud DB for MongoDBサーバインスタンスを再起動 |
Cloud DB for MongoDB関連リソース
Cloud DB for MongoDB APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。
- Cloud DB for MongoDB APIの使用方法
- 署名(シグネチャー)の作成: リクエストヘッダに追加する署名の作成方法
- API Gatewayご利用ガイド: リクエストヘッダに追加する API Keyを発行
- Sub Accountご利用ガイド: リクエストヘッダに追加する Access Keyの発行方法
- Ncloudの共通レスポンスステータスコード: Cloud DB for MongoDBで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
- Cloud DB for MongoDBサービスの使用方法
- Cloud DB for MongoDBご利用ガイド: NAVERクラウドプラットフォームコンソールで Cloud DB for MongoDBを使用する方法
- 料金の紹介、特徴、詳細機能: Cloud DB for MongoDBの料金体系、特徴、詳細機能のサマリー
- サービスのお知らせ: Cloud DB for MongoDBに関するお知らせ
- よくある質問: Cloud DB for MongoDBに関するよくあるご質問
- お問い合わせ: APIガイドだけでは不明な点が解消されない場合、直接問い合わせ