ApsaraDB for MongoDB で使用可能な API 操作を下表に示します。
インスタンスの作成またはクローニング
| API 操作 | 説明 |
| CreateDBInstance | ApsaraDB for MongoDB レプリカセットインスタンスを作成または複製します。 |
| CreateShardingDBInstance | ApsaraDB for MongoDB シャードクラスターインスタンスを作成または複製します。 |
インスタンス設定の変更
| API 操作 | 説明 |
| ModifyDBInstanceSpec | ApsaraDB for MongoDBスタンドアロンまたはレプリカセットインスタンスの仕様またはストレージ容量を変更します。 |
| ModifyNodeSpec | ApsaraDB for MongoDB シャードクラスターインスタンスの仕様またはストレージ容量を変更します。 |
| ModifyNodeSpecBatch | ApsaraDB for MongoDB シャードクラスターインスタンスの 1 つ以上のmongo またはシャードノードの設定を変更します。 |
| CreateNode | ApsaraDB for MongoDB シャードクラスターインスタンスのシャードノードまたは mongos ノードを作成します。 |
| CreateNodeBatch | 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 インスタンスのリストを照会します。 |
| DescribeDBInstanceAttribute | ApsaraDB for MongoDBインスタンスの詳細情報を照会します。 |
| DescribeRoleZoneInfo | ApsaraDB for MongoDB インスタンスのノードのロールとゾーンを表示します。 |
| DescribeInstanceAutoRenewalAttribute | ApsaraDB for MongoDB インスタンスで自動更新が有効になっているかどうかを照会します。 |
| DescribeActiveOperationTaskCount | ApsaraDB for MongoDB インスタンスの O＆M タスクの数を照会します。 |
| DescribeActiveOperationTaskType | ApsaraDB for MongoDB インスタンスの O＆M タスクのタイプおよび各タイプのタスクの数を照会します。 |
リソース管理
| API 操作 | 説明 |
| EvaluateResource | ApsaraDB for MongoDB インスタンスを作成またはアップグレードするリージョンでリソースが十分にあるかどうかを確認します。 |
| DescribeAvailableResource | 特定ゾーンで作成できる ApsaraDB for MongoDB インスタンスのタイプを照会します。 |
| 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 | ApsaraDB for MongoDBシャードクラスターインスタンスのシャードまたは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 インスタンスについて承認されているかどうかを検証します。 |
| DescribeUserEncryptionKeyList | ApsaraDB for MongoDB インスタンスのカスタムキーのリストを照会します。 |
| 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インスタンスのログ保持期間を設定します。 |
| DescribeMongoDBLogConfig | ApsaraDB for MongoDB インスタンスのログ機能構成を照会します。 |
ログ管理
| API 操作 | 説明 |
| DescribeSlowLogRecords | ApsaraDB for MongoDB インスタンスの低速クエリログのエントリを照会します。 |
| DescribeErrorLogRecords | ApsaraDB for MongoDB インスタンスのエラーログを照会します。 |
| DescribeRunningLogRecords | 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 操作 | 説明 |
| DescribeBackupPolicy | ApsaraDB for MongoDB インスタンスのバックアップポリシーを照会します。 |
| ModifyBackupPolicy | MongoDBインスタンスのバックアップポリシーを変更します。 |
| CreateBackup | MongoDB インスタンスを手動でバックアップします。 |
| DescribeBackups | ApsaraDB for MongoDBインスタンスのバックアップセットを照会します。 |
| RestoreDBInstance | 現在の ApsaraDB for MongoDB インスタンスにデータを復元します。 |
| DescribeBackupDBs | ApsaraDB for MongoDB インスタンスのデータベースを復元する前に、指定時間でのデータベースまたは指定されたバックアップセット内のデータベースを照会します。 |
| CheckRecoveryCondition | ApsaraDB for MongoDB インスタンスがデータ復元条件を満足しているかどうかを確認します。 |
更新の管理
| API 操作 | 説明 |
| DescribePrice | ApsaraDB for MongoDB インスタンスを作成、アップグレードまたは更新することで発生する料金を照会します。 |
| ModifyInstanceAutoRenewalAttribute | Enables or disables auto-renewal for an ApsaraDB for MongoDB instance. |
| TransformToPrePaid | ApsaraDB for MongoDBインスタンスの課金方法を従量課金からサブスクリプションに変更します。 |
| RenewDBInstance | サブスクリプションインスタンスを手動で更新します。 |
| DescribeRenewalPrice | ApsaraDB for MongoDB インスタンスの毎月の更新価格を照会します。 |