下表に、ApsaraDB for MongoDB で使用可能な API 操作を示します。

インスタンスの作成または複製

API 説明
CreateDBInstance ApsaraDB for MongoDB レプリカセットインスタンスを作成または複製します。
CreateShardingDBInstance ApsaraDB for MongoDB シャードクラスターインスタンスを作成または複製します。

インスタンス設定の変更

API 説明
ModifyDBInstanceSpec ApsaraDB for MongoDB スタンドアロンまたはレプリカセットインスタンスの仕様またはストレージ容量を変更します。
ModifyNodeSpec ApsaraDB for MongoDB シャードクラスターインスタンスの仕様またはストレージ容量を変更します。
t2102012.html#doc_api_Dds_ModifyNodeSpecBatch ApsaraDB for MongoDB シャードクラスターインスタンスの 1 つ以上のmongo またはシャードノードの設定を変更します。
CreateNode ApsaraDB for MongoDB シャードクラスターインスタンスのシャードノードまたは mongos ノードを作成します。
DeleteNode ApsaraDB for MongoDB シャードクラスターインスタンスのシャードノードまたは mongos ノードを削除します。

インスタンス

API 説明
UpgradeDBInstanceEngineVersion ApsaraDB for MongoDB インスタンスのデータベースバージョンを更新します。
UpgradeDBInstanceKernelVersion マイナーバージョンの ApsaraDB for MongoDB インスタンスをアップグレードします。
ModifyDBInstanceMaintainTime ApsaraDB for MongoDB インスタンスのメンテナンス期間を変更します。
ModifyDBInstanceDescription ApsaraDB for MongoDB インスタンスの記述を変更します。
ModifyDBInstanceNetExpireTime ApsaraDB for MongoDB インスタンスのクラシックネットワークの保持期間を延長します。
SwitchDBInstanceHA ApsaraDB for MongoDB インスタンスのプライマリノードとセカンダリノードを切り替えます。
RestartDBInstance ApsaraDB for MongoDB インスタンスを再起動します。
DeleteDBInstance ApsaraDB for MongoDB インスタンスをリリースします。
DestroyInstance ApsaraDB for MongoDB インスタンスを削除します。

インスタンス情報の照会

API 説明
DescribeReplicaSetRole ApsaraDB for MongoDB インスタンスのロールと接続情報を照会します。
DescribeKernelReleaseNotes マイナーバージョンの ApsaraDB for MongoDB インスタンスのリリースノートを照会します。
DescribeAvailableEngineVersion ApsaraDB for MongoDB インスタンスをアップグレードできるエンジンバージョンを照会します。
DescribeDBInstances ApsaraDB for MongoDB インスタンスのリストを照会します。
t1997401.html#doc_api_Dds_DescribeDedicatedClusterInstanceList 専用クラスター内のインスタンスを照会します。
DescribeDBInstanceAttribute ApsaraDB for MongoDB インスタンスの詳細を照会します。
DescribeRoleZoneInfo ApsaraDB for MongoDB インスタンスのノードのロールとゾーンを表示します。
t1846660.html#doc_api_Dds_DescribeInstanceAutoRenewalAttribute ApsaraDB for MongoDB インスタンスで自動更新が有効になっているかどうかを照会します。
t1920148.html#doc_api_Dds_DescribeActiveOperationTaskCount ApsaraDB for MongoDB インスタンスの O&M タスクの数を照会します。
t1920147.html#doc_api_Dds_DescribeActiveOperationTaskType ApsaraDB for MongoDB インスタンスの O&M タスクのタイプおよび各タイプのタスクの数を照会します。

リソース管理

API 説明
t1936251.html#doc_api_Dds_EvaluateResource ApsaraDB for MongoDB インスタンスを作成またはアップグレードするリージョンでリソースが十分にあるかどうかを確認します。
DescribeAvailableResource 特定ゾーンで作成できる ApsaraDB for MongoDB インスタンスのタイプを照会します。
t2101623.html#doc_api_Dds_ModifyResourceGroup AsparaDB for MongoDB インスタンスを指定リソースグループへと移行します。

リージョン管理

API 説明
MigrateToOtherZone ApsaraDB for MongoDB インスタンスを別のゾーンへと移行します。
DescribeRegions ApsaraDB for MongoDB インスタンスを作成可能なリージョンとゾーンを表示します。
MigrateAvailableZone ApsaraDB for MongoDB インスタンスを指定された移行先ゾーンまで移行します。

接続管理

API 説明
AllocatePublicNetworkAddress パブリックエンドポイントをApsaraDB for MongoDB インスタンスに割り当てます。
ReleasePublicNetworkAddress ApsaraDB for MongoDB インスタンスのパブリック IP アドレスをリリースします。
ModifyInstanceVpcAuthMode ApsaraDB for MongoDB インスタンスの認証を有効化または無効化して、インスタンスと同じ VPC からのアクセスを許可します。
DescribeShardingNetworkAddress ApsaraDB for MongoDB のシャードクラスターインスタンスの接続情報を照会します。
ModifyDBInstanceNetworkType ApsaraDB for MongoDB インスタンスのネットワークタイプを変更します。
ModifyDBInstanceConnectionString ApsaraDB for MongoDB インスタンスの接続文字列を変更します。
ReleaseNodePrivateNetworkAddress シャードの内部エンドポイントまたはシャードクラスターインスタンスの Configserver ノードをリリースします。
AllocateNodePrivateNetworkAddress シャードの内部エンドポイントまたは ApsaraDB for MongoDB シャードクラスターインスタンスの Configserver ノードに適用します。

タグ管理

API 説明
TagResources 1 つ以上の ApsaraDB for MongoDB インスタンスにタグを追加します。
ListTagResources ApsaraDB for MongoDB インスタンスとタグとの間の関係を照会します。
DescribeTags 指定されたリージョン内のタグをすべて照会します。
UntagResources インスタンスからタグを削除します。 タグが別のインスタンスにバインドされていない場合、そのタグは削除されます。

アカウント

API 説明
DescribeAccounts ApsaraDB for MongoDB インスタンスのデータベースアカウントを照会します。
ResetAccountPassword ApsaraDB for MongoDB インスタンスの root アカウントのパスワードをリセットします。
ModifyAccountDescription ApsaraDB for MongoDB インスタンスの root アカウントの記述を変更します。

IP ホワイトリストとセキュリティグループ

API 説明
DescribeSecurityGroupConfiguration ApsaraDB for MongoDB インスタンスに関連付けられている ECS セキュリティグループを照会します。
ModifySecurityGroupConfiguration ApsaraDB for MongoDB インスタンスにバインドされている ECS セキュリティグループを変更します。
DescribeSecurityIps ApsaraDB for MongoDB インスタンスの IP アドレスのホワイトリストを照会します。
ModifySecurityIps ApsaraDB for MongoDB インスタンスの IP アドレスのホワイトリストを変更します。

秘密鍵

API 説明
CheckCloudResourceAuthorized KMS キーが ApsaraDB for MongoDB インスタンスについて承認されているかどうかを検証します。
t1861698.html#doc_api_Dds_DescribeUserEncryptionKeyList ApsaraDB for MongoDB インスタンスのカスタムキーのリストを照会します。
t1861563.html#doc_api_Dds_DescribeDBInstanceEncryptionKey ApsaraDB for MongoDB インスタンス用のキーの詳細を照会します。
DescribeDBInstanceTDEInfo ApsaraDB for MongoDB インスタンス用の TDE が有効かどうかを照会します。
ModifyDBInstanceTDE ApsaraDB for MongoDBインスタンスの透過的データ暗号化 (TDE) 状態を変更します。

SSL 暗号化

API 説明
ModifyDBInstanceSSL ApsaraDB for MongoDB インスタンスの SSL 設定を変更します。
DescribeDBInstanceSSL ApsaraDB for MongoDB インスタンスの SSL 設定を照会します。

監査ログ

API 説明
DescribeAuditRecords ApsaraDB for MongoDB インスタンスの監査ログを照会します。
DescribeAuditPolicy ApsaraDB for MongoDB インスタンスで監査ログ機能が有効になっているかどうかを照会します。
ModifyAuditLogFilter ApsaraDB for MongoDB インスタンス用に収集する監査ログエントリのタイプを変更します。
DescribeAuditLogFilter ApsaraDB for MongoDB インスタンス用に収集された監査ログのエントリのタイプを照会します。
ModifyAuditPolicy 監査ログ機能を有効または無効にするか、あるいは ApsaraDB for MongoDB インスタンスのログ保持期間を設定します。

ログ

API 説明
DescribeSlowLogRecords ApsaraDB for MongoDB インスタンスの低速クエリログのエントリを照会します。
DescribeErrorLogRecords ApsaraDB for MongoDB インスタンスのエラーログを照会します。
DescribeRunningLogRecords ApsaraDB for MongoDB インスタンスの操作ログを照会します。
t1908732.html#doc_api_Dds_DescribeMongoDBLogConfig ApsaraDB for MongoDB インスタンスのログ機能構成を照会します。

パフォーマンスモニタリング

API 説明
DescribeDBInstancePerformance ApsaraDB for MongoDB インスタンスのパフォーマンスデータを照会します。
ModifyDBInstanceMonitor ApsaraDB for MongoDB インスタンスのモニタリングデータの収集頻度を設定します。
DescribeDBInstanceMonitor ApsaraDB for MongoDB インスタンスのモニタリングデータの収集頻度を照会します。

パラメーター

API 説明
DescribeParameterModificationHistory ApsaraDB for MongoDB インスタンスパラメーターの変更レコードを照会します。
DescribeParameters ApsaraDB for MongoDB インスタンスのパラメーター構成を照会します。
DescribeParameterTemplates ApsaraDB for MongoDB インスタンスのデフォルトのパラメーターテンプレートのリストを照会します。
ModifyParameters AsparaDB for MongoDB インスタンスのパラメーターを変更します。

インデックスの推奨

API 説明
CreateRecommendationTask AsparaDB for MongoDB インスタンスのインデックス分析タスクを作成します。
DescribeAvailableTimeRange ApsaraDB for MongoDB インスタンスのインデックス分析レポートの分析期間と作成状態を照会します。

バックアップとリカバリ

API 説明
DescribeBackupPolicy ApsaraDB for MongoDB インスタンスのバックアップポリシーを照会します。
ModifyBackupPolicy ApsaraDB for MongoDB インスタンスのバックアップポリシーを変更します。
CreateBackup MongoDB インスタンスを手動でバックアップします。
DescribeBackups ApsaraDB for MongoDB インスタンスのバックアップを照会します。
RestoreDBInstance 現在の ApsaraDB for MongoDB インスタンスにデータを復元します。
DescribeBackupDBs ApsaraDB for MongoDB インスタンスのデータベースを復元する前に、指定時間でのデータベースまたは指定されたバックアップセット内のデータベースを照会します。
CheckRecoveryCondition ApsaraDB for MongoDB インスタンスがデータ復元条件を満足しているかどうかを確認します。

更新

API 説明
t1883088.html#doc_api_Dds_DescribePrice ApsaraDB for MongoDB インスタンスを作成、アップグレードまたは更新することで発生する料金を照会します。
t1847418.html#doc_api_Dds_ModifyInstanceAutoRenewalAttribute Enables or disables auto-renewal for an ApsaraDB for MongoDB instance.
TransformToPrePaid ApsaraDB for MongoDB インスタンスの課金方法を、従量課金からサブスクリプションに変更できます。
RenewDBInstance サブスクリプションインスタンスを手動で更新します。
DescribeRenewalPrice ApsaraDB for MongoDB インスタンスの毎月の更新価格を照会します。

付録