API 標準および多言語対応の SDK
本製品 (Dds/2015-12-01) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
インスタンスの作成またはクローン
|
API |
タイトル |
説明 |
| CreateShardingDBInstance | CreateShardingDBInstance | MongoDB シャードクラスターインスタンスを作成するか、クローンします。 |
インスタンス設定の変更
|
API |
タイトル |
説明 |
| CreateNodeBatch | CreateNodeBatch | シャードクラスターインスタンスに Mongos ノードまたはシャードノードを一括で追加します。 |
| ModifyNodeSpec | ModifyNodeSpec | MongoDB シャードクラスターインスタンス内のノードのインスタンスタイプとストレージスペースを変更します。 |
| ModifyNodeSpecBatch | ModifyNodeSpecBatch | ApsaraDB for MongoDB のシャードクラスターインスタンスにおける、1 つ以上の Mongos またはシャードノードの構成を変更します。 |
| ModifyDBInstanceDiskType | ModifyDBInstanceDiskType | ApsaraDB for MongoDB インスタンスのディスクタイプを変更します。 |
インスタンス管理
|
API |
タイトル |
説明 |
| ModifyDBInstanceNetExpireTime | ModifyDBInstanceNetExpireTime | ApsaraDB for MongoDB インスタンスのクラシックネットワークエンドポイントの保持期間を延長します。 |
| RestartNode | RestartNode | MongoDB インスタンスの単一ノードを再起動します。 |
更新管理
|
API |
タイトル |
説明 |
| RenewDBInstance | RenewDBInstance | ApsaraDB for MongoDB のサブスクリプションインスタンスを手動で更新します。 |
インスタンスの照会
|
API |
タイトル |
説明 |
| DescribeDBInstanceSpecInfo | DescribeDBInstanceSpecInfo | インスタンスタイプの詳細を取得します。 |
| DescribeReplicaSetRole | DescribeReplicaSetRole | MongoDB インスタンスのロール情報と接続詳細を取得します。 |
| DescribeKernelReleaseNotes | DescribeKernelReleaseNotes | ApsaraDB for MongoDB インスタンスのマイナーバージョンのリリースノートを照会します。 |
| DescribeAvailableEngineVersion | DescribeAvailableEngineVersion | ApsaraDB for MongoDB インスタンスがアップグレードできるエンジンバージョンを照会します。 |
| DescribeDBInstanceSwitchLog | DescribeDBInstanceSwitchLog | ApsaraDB for MongoDB インスタンスのプライマリ/セカンダリのスイッチオーバーログを照会します。 |
| DescribeActiveOperationTaskType | DescribeActiveOperationTaskType | ApsaraDB for MongoDB インスタンスの運用保守タスクのタイプと、各タイプのタスク数を照会します。 |
| DescribeDBInstancesOverview | DescribeDBInstancesOverview | 1 つ以上の ApsaraDB for MongoDB インスタンスの概要を照会します。 |
リソース管理
|
API |
タイトル |
説明 |
| EvaluateResource | EvaluateResource | 新しいインスタンスの購入、または既存インスタンスのスペックアップやスペックダウンの前に、十分なリソースが利用可能かどうかを評価します。 |
| DescribeAvailabilityZones | DescribeAvailabilityZones | ApsaraDB for MongoDB インスタンスがサポートするゾーンのリストを照会します。 |
リージョン管理
|
API |
タイトル |
説明 |
| MigrateAvailableZone | MigrateAvailableZone | ApsaraDB for MongoDB インスタンスを特定のゾーンに移行します。 |
接続管理
|
API |
タイトル |
説明 |
| DescribeShardingNetworkAddress | DescribeShardingNetworkAddress | MongoDB シャードクラスターインスタンスの接続情報を取得します。 |
| AllocatePublicNetworkAddress | AllocatePublicNetworkAddress | インスタンスにパブリックエンドポイントを割り当てます。 |
| ReleasePublicNetworkAddress | ReleasePublicNetworkAddress | ApsaraDB for MongoDB インスタンスのパブリックエンドポイントをリリースします。 |
| AllocateNodePrivateNetworkAddress | AllocateNodePrivateNetworkAddress | ApsaraDB for MongoDB のシャードクラスターインスタンスにおけるシャードノードまたは ConfigServer ノードの内部エンドポイントを申請します。 |
| ReleaseNodePrivateNetworkAddress | ReleaseNodePrivateNetworkAddress | シャードクラスターインスタンスのシャードまたは ConfigServer ノードの内部エンドポイントをリリースします。 |
キー
|
API |
タイトル |
説明 |
| DescribeDBInstanceTDEInfo | MongoDB インスタンスで TDE が有効かどうかを照会します | ApsaraDB for MongoDB インスタンスで TDE (透過的データ暗号化) が有効かどうかを照会します。 |
監査ログ
|
API |
タイトル |
説明 |
| ModifyAuditLogFilter | ModifyAuditLogFilter | ApsaraDB for MongoDB インスタンスで収集される監査ログの種類を変更します。 |
| ModifyAuditPolicy | ModifyAuditPolicy | MongoDB インスタンスの監査ログを有効化または無効化するか、ログの保持期間を変更します。 |
| DescribeAuditPolicy | DescribeAuditPolicy | MongoDB インスタンスの監査ログ機能が有効になっているかどうかを確認します。 |
| DescribeAuditLogFilter | DescribeAuditLogFilter | ApsaraDB for MongoDB インスタンスで収集された監査ログのエントリタイプを照会します。 |
| DescribeMongoDBLogConfig | DescribeMongoDBLogConfig | MongoDB Log Service の構成を確認できます。 |
バックアップとリカバリ
|
API |
タイトル |
説明 |
| DescribeBackupDBs | DescribeBackupDBs | ApsaraDB for MongoDB インスタンスのデータベースを復元する前に、指定した時点または指定したバックアップセット内のデータベースを照会します。 |
| DescribeRestoreDBInstanceList | DescribeRestoreDBInstanceList | 過去 7 日以内にバックアップから復元された ApsaraDB for MongoDB インスタンスを照会します。 |
| CheckRecoveryCondition | CheckRecoveryCondition | ApsaraDB for MongoDB インスタンスのデータを復元できるかどうかを照会します。 |
| TransferClusterBackup | TransferClusterBackup | ApsaraDB for MongoDB のシャードクラスターインスタンスのバックアップモードを、クラスターバックアップモードに切り替えます。インスタンスをクラスターバックアップモードに切り替えると、高頻度バックアップがサポートされるようになります。 |
| DescribeClusterBackups | DescribeClusterBackups | クラウドディスクを使用する ApsaraDB for MongoDB シャードクラスターインスタンスのクラスターバックアップセットをクエリします。 |
| DescribeClusterRecoverTime | シャードクラスターの復元可能な時間範囲を照会します | ApsaraDB for MongoDB のクラウドディスクを使用するシャードクラスターインスタンスの復元可能な時間範囲を照会します。 |
| DescribeBackupStorage | DescribeBackupStorage | クラウドディスクを使用する MongoDB レプリカセットまたはシャードクラスターインスタンスのバックアップ使用量を照会します。 |
| DescribeInstanceRecoverTime | レプリカセットインスタンスの復元可能な時間範囲を照会します | クラウドディスクを使用する ApsaraDB for MongoDB レプリカセットインスタンスの復元可能な時間範囲を照会します。 |
その他
|
API |
タイトル |
説明 |
| AllocateDBInstanceSrvNetworkAddress | AllocateDBInstanceSrvNetworkAddress | ApsaraDB for MongoDB インスタンスの SRV 接続文字列を申請します。 |
| DescribeActiveOperationTaskRegion | Query maintenance task types and task quantities. | MongoDB インスタンスの O&M タスクの種類と数を照会します。 |
| CreateNodeRoleTag | CreateNodeRoleTag | インスタンスノードのロールタグを作成します。 |
| ModifyDBInstanceAttribute | ModifyDBInstanceAttribute | インスタンスのリリース保護構成を変更します。 |
| ModifySrvNetworkAddress | ModifySrvNetworkAddress | MongoDB インスタンスの SRV 接続アドレスを変更します。 |
| DescribeRoleTagStatus | DescribeRoleTagStatus | ノードのタグのステータスを照会します。 |
| DescribeVpcsForMongoDB | DescribeVpcsForMongoDB | ページ分割された VPC のリストを照会します。 |
Others
|
API |
タイトル |
説明 |
| CancelActiveOperationTasks | CancelActiveOperationTasks | 運用保守 (O&M) イベントをバッチでキャンセルします。 |
| CheckCloudResourceAuthorized | CheckCloudResourceAuthorized | Key Management Service (KMS) のキーが ApsaraDB for MongoDB インスタンスに対して権限を付与されているかどうかを確認します。 |
| CheckServiceLinkedRole | CheckServiceLinkedRole | インスタンスに対してサービスリンクロール (SLR) が作成されているかどうかを確認します。 |
| CreateAccount | CreateAccount | クラウドディスクを使用する ApsaraDB for MongoDB のシャードクラスターインスタンス内のシャードノードに対して、読み取り専用権限が付与されたアカウントを作成します。 |
| CreateBackup | CreateBackup | MongoDB インスタンスのバックアップを作成します。 |
| CreateDBInstance | CreateDBInstance | ApsaraDB for MongoDB のレプリカセットインスタンスを作成またはクローンします。 |
| CreateGlobalSecurityIPGroup | CreateGlobalSecurityIPGroup | グローバル IP ホワイトリストテンプレートを作成します。 |
| CreateNode | CreateNode | ApsaraDB for MongoDB のシャードクラスターインスタンスにシャードノードまたは mongos ノードを追加します。 |
| DeleteBackup | DeleteBackup | MongoDB のバックアップセットを削除します。 |
| DeleteDBInstance | DeleteDBInstance | 従量課金の MongoDB インスタンスをリリースします。 |
| DeleteGlobalSecurityIPGroup | DeleteGlobalSecurityIPGroup | グローバル IP アドレスのホワイトリストテンプレートを削除します。 |
| DeleteNode | DeleteNode | ApsaraDB for MongoDB のシャードクラスターインスタンスからシャードまたは mongos ノードを削除します。 |
| DescribeAccounts | DescribeAccounts | ApsaraDB for MongoDB インスタンスのデータベースアカウントを照会します。 |
| DescribeActiveOperationMaintenanceConfig | DescribeActiveOperationMaintenanceConfig | MongoDB インスタンスの運用保守 (O&M) タスク構成を照会します。 |
| DescribeActiveOperationTask | DescribeActiveOperationTask | ApsaraDB for MongoDB インスタンスのタスクに関する詳細情報を照会します。 |
| DescribeActiveOperationTaskCount | DescribeActiveOperationTaskCount | ApsaraDB for MongoDB インスタンス上の運用メンテナンス タスクの数を照会します。 |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | MongoDB インスタンスのスケジュールされた操作とメンテナンス（O&M）タスクの詳細をクエリします。 |
| DescribeAuditRecords | DescribeAuditRecords | MongoDB インスタンスの監査ログをクエリします。 |
| DescribeAvailableResource | DescribeAvailableResource | 指定されたゾーンで利用可能なリソースをクエリします。 |
| DescribeBackupPolicy | DescribeBackupPolicy | MongoDB インスタンスのバックアップポリシーを照会します。 |
| DescribeBackupTasks | DescribeBackupTasks | クラウドディスクを使用する MongoDB ReplicaSet またはシャードクラスターインスタンスの進行中のバックアップジョブを照会します。 |
| DescribeBackups | DescribeBackups | MongoDB インスタンスのバックアップを照会します。 |
| DescribeBinlogFiles | DescribeBinlogFiles | ApsaraDB for MongoDB インスタンスのログバックアップファイルをクエリします。 |
| DescribeDBInstanceAttribute | DescribeDBInstanceAttribute | ApsaraDB for MongoDB インスタンスに関する情報を照会します。 |
| DescribeDBInstanceEncryptionKey | DescribeDBInstanceEncryptionKey | ApsaraDB for MongoDB インスタンスのキーの詳細を照会します。 |
| DescribeDBInstanceMonitor | DescribeDBInstanceMonitor | ApsaraDB for MongoDB インスタンスのモニタリングデータの収集頻度を照会します。 |
| DescribeDBInstancePerformance | DescribeDBInstancePerformance | MongoDB インスタンスのパフォーマンスデータをクエリします。 |
| DescribeDBInstanceSSL | DescribeDBInstanceSSL | MongoDB インスタンスの SSL 構成の詳細を照会します。 |
| DescribeDBInstances | DescribeDBInstances | MongoDB インスタンスのリストをクエリします。 |
| DescribeErrorLogRecords | DescribeErrorLogRecords | ApsaraDB for MongoDB インスタンスのエラーログのエントリをクエリします。 |
| DescribeGlobalSecurityIPGroup | DescribeGlobalSecurityIPGroup | ApsaraDB for MongoDB インスタンスのグローバル IP ホワイトリストテンプレートを照会します。 |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation | インスタンスとグローバル IP アドレスホワイトリストテンプレート間のマッピングをクエリします。 |
| DescribeHistoryTasks | DescribeHistoryTasks | タスクセンターのタスクリストをクエリします。 |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat | タスクセンターのタスクの概要を照会します。 |
| DescribeInstanceAutoRenewalAttribute | DescribeInstanceAutoRenewalAttribute | ApsaraDB for MongoDB インスタンスの自動更新ステータスを照会します。 |
| DescribeKmsKeys | DescribeKmsKeys | ディスク暗号化に使用できる Key Management Service (KMS) キーを照会します。 |
| DescribeParameterModificationHistory | DescribeParameterModificationHistory | ApsaraDB for MongoDB インスタンスのパラメーター変更履歴をクエリします。 |
| DescribeParameterTemplates | DescribeParameterTemplates | MongoDB インスタンスのデフォルトパラメータテンプレートを照会します。 |
| DescribeParameters | DescribeParameters | ApsaraDB for MongoDB インスタンスのパラメーター設定を照会します。 |
| DescribePrice | DescribePrice | 価格を照会します。 |
| DescribeRdsVSwitchs | DescribeRdsVSwitchs | vSwitch のリストをクエリします。 |
| DescribeRdsVpcs | DescribeRdsVpcs | VPC のリストを照会します。 |
| DescribeRegions | DescribeRegions | ApsaraDB for MongoDB インスタンスでサポートされているすべてのリージョンとゾーンを照会します。 |
| DescribeRenewalPrice | DescribeRenewalPrice | 特定の MongoDB インスタンスを 1 か月間更新する場合の価格を取得します。 |
| DescribeRoleZoneInfo | DescribeRoleZoneInfo | ApsaraDB for MongoDB インスタンス内の各ノードのロールとゾーンを照会します。 |
| DescribeRunningLogRecords | DescribeRunningLogRecords | MongoDB インスタンスの実行中ログを表示します。 |
| DescribeSecurityGroupConfiguration | DescribeSecurityGroupConfiguration | ApsaraDB for MongoDB インスタンスに関連付けられている Elastic Compute Service (ECS) セキュリティグループを照会します。 |
| DescribeSecurityIps | DescribeSecurityIps | ApsaraDB for MongoDB インスタンスの IP ホワイトリストを取得します。 |
| DescribeSlowLogRecords | DescribeSlowLogRecords | ApsaraDB for MongoDB インスタンスのスロークエリログ内のエントリの詳細を照会します。 |
| DescribeTags | DescribeTags | 指定されたリージョン内のすべてのタグをクエリします。 |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList | インスタンスのカスタムキーを照会します。 |
| DestroyInstance | DestroyInstance | ApsaraDB for MongoDB インスタンスを破棄します。 |
| ListTagResources | ListTagResources | ApsaraDB for MongoDB インスタンスとタグの関連付けを照会します。 |
| MigrateToOtherZone | MigrateToOtherZone | ApsaraDB for MongoDB インスタンスを別のゾーンに移行します。 |
| ModifyAccountDescription | ModifyAccountDescription | ApsaraDB for MongoDB インスタンスのルートアカウントの説明を変更します。 |
| ModifyActiveOperationMaintenanceConfig | ModifyActiveOperationMaintenanceConfig | MongoDB インスタンスの運用保守 (O&M) タスク構成を変更します。 |
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | ApsaraDB for MongoDB インスタンスのスケジュールされた運用保守タスクの切り替え時間を変更します。 |
| ModifyBackupExpireTime | ModifyBackupExpireTime | MongoDB バックアップセットの生存時間 (TTL) を変更します。 |
| ModifyBackupPolicy | ModifyBackupPolicy | MongoDB インスタンスのバックアップポリシーを変更します。 |
| ModifyDBInstanceConfig | ModifyDBInstanceConfig | インスタンス構成を変更します。 |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString | MongoDB インスタンスの接続アドレスとポートを変更します。 |
| ModifyDBInstanceDescription | ModifyDBInstanceDescription | ApsaraDB for MongoDB インスタンスの名前を変更します。 |
| ModifyDBInstanceMaintainTime | ModifyDBInstanceMaintainTime | ApsaraDB for MongoDB インスタンスのメンテナンスウィンドウを変更します。 |
| ModifyDBInstanceMonitor | ModifyDBInstanceMonitor | ApsaraDB for MongoDB インスタンスのモニタリングの粒度を設定します。 |
| ModifyDBInstanceNetworkType | インスタンスのネットワークタイプを切り替えます | MongoDB インスタンスのネットワークタイプを切り替えます。 |
| ModifyDBInstanceSSL | ModifyDBInstanceSSL | MongoDB インスタンスの SSL 構成を変更します。 |
| ModifyDBInstanceSpec | ModifyDBInstanceSpec | ApsaraDB for MongoDB のスタンドアロンインスタンス、レプリカセットインスタンス、またはサーバーレスインスタンスのインスタンスタイプまたはストレージ容量を変更します。 サーバーレスインスタンスは Alibaba Cloud 中国サイト限定です。 |
| ModifyDBInstanceTDE | ModifyDBInstanceTDE | MongoDB インスタンスの TDE (透過的データ暗号化) ステータスを変更します。 |
| ModifyGlobalSecurityIPGroup | ModifyGlobalSecurityIPGroup | ApsaraDB for MongoDB インスタンスに関連付けられているグローバル IP ホワイトリストテンプレートを変更します。 |
| ModifyGlobalSecurityIPGroupName | ModifyGlobalSecurityIPGroupName | ApsaraDB for MongoDB インスタンスに関連付けられているグローバル IP ホワイトリストテンプレートの名前を変更します。 |
| ModifyGlobalSecurityIPGroupRelation | ModifyGlobalSecurityIPGroupRelation | グローバルホワイトリストテンプレートと ApsaraDB for MongoDB インスタンス間のマッピングを変更します。 |
| ModifyInstanceAutoRenewalAttribute | ModifyInstanceAutoRenewalAttribute | ApsaraDB for MongoDB インスタンスの自動更新を有効または無効にします。 |
| ModifyInstanceVpcAuthMode | ModifyInstanceVpcAuthMode | ApsaraDB for MongoDB インスタンスの Virtual Private Cloud (VPC) 経由でのパスワードなしのアクセスを無効化します。 |
| ModifyParameters | ModifyParameters | ApsaraDB for MongoDB インスタンスのパラメーターを変更します。 |
| ModifyResourceGroup | ModifyResourceGroup | ApsaraDB for MongoDB インスタンスを指定のリソースグループに移動します。 |
| ModifySecurityGroupConfiguration | ModifySecurityGroupConfiguration | ApsaraDB for MongoDB インスタンスにバインドされている ECS セキュリティグループを変更します。 |
| ModifySecurityIps | ModifySecurityIps | ApsaraDB for MongoDB インスタンスの IP アドレスホワイトリストを変更します。 |
| ModifyTaskInfo | ModifyTaskInfo | ApsaraDB for MongoDB インスタンスのタスクセンターでタスクの情報を変更します。 |
| ResetAccountPassword | ResetAccountPassword | ApsaraDB for MongoDB インスタンスのルートアカウントのパスワードをリセットします。 |
| RestartDBInstance | RestartDBInstance | ApsaraDB for MongoDB インスタンスを再起動します。 |
| SwitchDBInstanceHA | SwitchDBInstanceHA | ApsaraDB for MongoDB インスタンスのプライマリノードとセカンダリノードを切り替えます。 |
| TagResources | TagResources | ApsaraDB for MongoDB インスタンスにタグを関連付けます。 |
| TransformInstanceChargeType | TransformInstanceChargeType | インスタンスの課金方法を従量課金からサブスクリプションに、またはサブスクリプションから従量課金に変更します。 |
| TransformToPrePaid | TransformToPrePaid | ApsaraDB for MongoDB インスタンスの課金方法を従量課金からサブスクリプションに変更します。 |
| UntagResources | UntagResources | タグが他のインスタンスに追加されていない場合、そのタグを削除します。 |
| UpgradeDBInstanceEngineVersion | UpgradeDBInstanceEngineVersion | ApsaraDB for MongoDB インスタンスのデータベースバージョンをアップグレードします。 |
| UpgradeDBInstanceKernelVersion | UpgradeDBInstanceKernelVersion | ApsaraDB for MongoDB インスタンスのマイナーバージョンをアップグレードします。 |