すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB RDS:API の概要

最終更新日:Aug 17, 2026

API 標準および多言語対応の SDK

本製品 (Rds/2014-08-15) の 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 セキュリティを確保するには、以下を作成し、設定する必要があります。

課金

API

タイトル

説明

TransformDBInstancePayType TransformDBInstancePayType ApsaraDB RDS インスタンスの課金方法を変更します。
ModifyDBInstancePayType ModifyDBInstancePayType インスタンスの課金方法を従量課金からサブスクリプションに変更します。
ModifyInstanceAutoRenewalAttribute ModifyInstanceAutoRenewalAttribute インスタンスの自動更新設定を変更します。
DescribePrice DescribePrice インスタンスの価格を照会します。
DescribeRenewalPrice DescribeRenewalPrice サブスクリプションインスタンスの更新料金を照会します。
DescribeInstanceAutoRenewalAttribute DescribeInstanceAutoRenewalAttribute インスタンスの自動更新ステータスを照会します。
RenewInstance RenewInstance インスタンスを手動で更新します。
DescribeDBInstancePromoteActivity DescribeDBInstancePromoteActivity この操作は廃止されました。

インスタンス

API

タイトル

説明

CreateDBInstance ApsaraDB RDS インスタンスを作成します ApsaraDB RDS インスタンスを作成します。
CreateDBInstanceForRebuild CreateDBInstanceForRebuild ゴミ箱からインスタンスを再構築します。
DeleteDBInstance RDS インスタンスのリリース。 ApsaraDB RDS インスタンスをリリースします。
RestartDBInstance RestartDBInstance インスタンスを再起動します。
StopDBInstance StopDBInstance ApsaraDB RDS インスタンスを停止します。
StartDBInstance StartDBInstance インスタンスを再開します。
ModifyDBInstanceSpec RDS インスタンスの仕様を変更します。 ApsaraDB RDS インスタンスの仕様およびストレージ容量を変更します。
DestroyDBInstance インスタンスの削除。 ゴミ箱内の ApsaraDB RDS インスタンスを削除します。
ModifyDasInstanceConfig ModifyDasInstanceConfig インスタンスのストレージ自動拡張を設定します。
MigrateToOtherZone MigrateToOtherZone RDS インスタンスを別のアベイラビリティーゾーンに移行します。
ModifyDBInstanceDescription Modify the name of an instance ModifyDBInstanceDescription 操作を呼び出して、インスタンスの名前を変更できます。
ModifyDBInstanceMaintainTime ModifyDBInstanceMaintainTime インスタンスのメンテナンスウィンドウを変更します。
ModifyResourceGroup ModifyResourceGroup ApsaraDB RDS インスタンスを指定のリソースグループに移動します。
ModifyHADiagnoseConfig ModifyHADiagnoseConfig インスタンスの可用性チェック方法を変更します。
ModifyAccountSecurityPolicy ModifyAccountSecurityPolicy ApsaraDB RDS for SQL Server インスタンスのアカウントのパスワードポリシーを変更します。
DescribeSupportOnlineResizeDisk DescribeSupportOnlineResizeDisk ApsaraDB RDS for SQL Server インスタンスのディスクをオンラインでサイズ変更できるかどうかを確認します。
DescribeAvailableZones DescribeAvailableZones インスタンスで利用可能なゾーンをクエリします。
DescribeAvailableClasses DescribeAvailableClasses インスタンスでサポートされている仕様を照会します。仕様には、インスタンスタイプとストレージ容量が含まれます。
DescribeDBInstanceAttribute DescribeDBInstanceAttribute ApsaraDB RDS インスタンスの詳細を照会します。
GetDBInstanceTopology GetDBInstanceTopology インスタンスのトポロジーを照会します。
DescribeDBInstances Query Instance List この API は、RDS インスタンスのリストを取得します。
ListClasses ListClasses インスタンスの仕様詳細を照会します。
DescribeDBInstancesByExpireTime DescribeDBInstancesByExpireTime ApsaraDB RDS インスタンスのサブスクリプション期間の残りに基づいて、インスタンスの情報を照会します。
DescribeRegions DescribeRegions ApsaraDB RDS のすべてのリージョンとゾーンの詳細を照会します。サポートが終了したリージョンも照会されます。この操作を呼び出す際はご注意ください。
CheckInstanceExist Query whether an instance exists CheckInstanceExist 操作を呼び出して、ApsaraDB RDS インスタンスが存在するかどうかを照会します。
DescribeHADiagnoseConfig DescribeHADiagnoseConfig インスタンスの可用性チェックメソッドを照会します。
CheckCloudResourceAuthorized CheckCloudResourceAuthorized インスタンスに付与されている権限を確認します。
ReleaseInstanceConnection ReleaseInstanceConnection インスタンスのパブリックエンドポイントをリリースします。
DescribeDBInstanceDetail Query the details of an instance DescribeDBInstanceDetail 操作を呼び出して、インスタンスの詳細をクエリできます。
DescribeDBInstancesByPerformance Query instances base on performance DescribeDBInstancePerformance 操作を呼び出して、インスタンスのパフォーマンスをクエリできます。
DescribeDBInstancesForClone DescribeDBInstancesForClone インスタンスのリストを照会します。
DescribeDBInstancesAsCsv DescribeDBInstancesAsCsv この API はインスタンスのリストを取得します。現在、この API は非推奨です。

バージョンアップグレード

API

タイトル

説明

ModifyDBInstanceAutoUpgradeMinorVersion ModifyDBInstanceAutoUpgradeMinorVersion ApsaraDB RDS for MySQL インスタンスまたは ApsaraDB RDS for PostgreSQL インスタンスのマイナーエンジンバージョンの更新方法を変更します。
DescribeUpgradeMajorVersionPrecheckTask DescribeUpgradeMajorVersionPrecheckTask この API を使用して、RDS MySQL および RDS PostgreSQL のメジャーバージョンアップグレードに関するアップグレード事前チェックレポートを取得します。
DescribeUpgradeMajorVersionTasks DescribeUpgradeMajorVersionTasks この API は、RDS PostgreSQL インスタンスのメジャーバージョンアップタスクの履歴を照会するために使用されます。
UpgradeDBInstanceEngineVersion UpgradeDBInstanceEngineVersion ApsaraDB RDS for MySQL インスタンスのメジャーエンジンバージョンをアップグレードします。
UpgradeDBInstanceKernelVersion UpgradeDBInstanceKernelVersion ApsaraDB RDS インスタンスのマイナーエンジンバージョンを更新します。
UpgradeDBInstanceMajorVersionPrecheck Pre-check for RDS Major Version Upgrade この API は、RDS MySQL または RDS PostgreSQL のメジャーバージョンをアップグレードする前に事前チェックを実行するために使用されます。
UpgradeDBInstanceMajorVersion UpgradeDBInstanceMajorVersion RDS PostgreSQL インスタンスのメジャーバージョンアップを開始します。

ネットワークと接続アドレス

API

タイトル

説明

AllocateInstancePublicConnection パブリックエンドポイントの申請。 ApsaraDB RDS インスタンスのパブリックエンドポイントを申請します。
ReleaseInstancePublicConnection インスタンスのパブリックエンドポイントをリリースします インスタンスのパブリックエンドポイントをリリースします。
ModifyDBInstanceConnectionString Manage the connection address and port of an instance この API は、インスタンスのエンドポイントとポートを管理するために使用されます。
ModifyDBInstanceNetworkExpireTime ModifyDBInstanceNetworkExpireTime ハイブリッドアクセスモードのインスタンスにおけるクラシックネットワークエンドポイントの有効期限を変更します。
SwitchDBInstanceNetType SwitchDBInstanceNetType クラシックネットワーク内のインスタンスの内部エンドポイントとパブリックエンドポイントを切り替えます。
ModifyDBInstanceNetworkType ModifyDBInstanceNetworkType ApsaraDB RDS インスタンスのネットワークタイプをクラシックネットワークから VPC に変更します。
SwitchDBInstanceVpc SwitchDBInstanceVpc ApsaraDB RDS インスタンスの VPC と vSwitch を変更します。
ModifyDBInstanceConfig ModifyDBInstanceConfig インスタンスの設定項目を変更します。
DescribeDBInstanceNetInfo DescribeDBInstanceNetInfo インスタンスのすべてのエンドポイントをクエリします。
DescribeVSwitches DescribeVSwitches Virtual Private Cloud (VPC) で利用可能な vSwitch の詳細を照会します。

プライマリ/セカンダリ高可用性とデータレプリケーション

API

タイトル

説明

ModifyDBInstanceHAConfig ModifyDBInstanceHAConfig インスタンスの高可用性 (HA) とデータレプリケーションモードを変更します。
ModifyHASwitchConfig ModifyHASwitchConfig インスタンスの自動プライマリ/セカンダリ スイッチオーバー機能を有効または無効にします。
DescribeDBInstanceHAConfig DescribeDBInstanceHAConfig インスタンスの高可用性モードとデータレプリケーションモードを照会します。
DescribeHASwitchConfig DescribeHASwitchConfig インスタンスの自動プライマリ/セカンダリ スイッチオーバー機能の設定を照会します。
SwitchDBInstanceHA SwitchDBInstanceHA プライマリ ApsaraDB RDS インスタンスとセカンダリ ApsaraDB RDS インスタンス間でワークロードを切り替えます。

履歴イベント

API

タイトル

説明

ModifyActionEventPolicy ModifyActionEventPolicy インスタンスのイベント履歴機能を有効または無効にします。
DescribeEvents DescribeEvents インスタンスの履歴イベントを照会します。
DescribeActionEventPolicy DescribeActionEventPolicy 履歴イベント機能が有効になっているかどうかを照会します。

通知

API

タイトル

説明

QueryNotify QueryNotify ApsaraDB RDS インスタンスの通知をクエリします。
ConfirmNotify ConfirmNotify Alibaba Cloud アカウント内のインスタンスの通知を確認済みとしてマークします。
DescribeRdsResourceSettings DescribeRdsResourceSettings インスタンスリソースの通知設定を取得します。この操作は呼び出し可能ですが、メンテナンスは終了しています。

アカウント

API

タイトル

説明

CreateAccount データベースアカウントを作成します。 データベースアカウントを作成します。
DeleteAccount DeleteAccount インスタンスからアカウントを削除します。
ModifyAccountCheckPolicy ModifyAccountCheckPolicy アカウントにパスワードポリシーが適用されているかどうかを確認します。
ModifyAccountDescription ModifyAccountDescription データベースアカウントの説明を変更します。
ModifyPGHbaConfig ModifyPGHbaConfig ApsaraDB RDS for PostgreSQL インスタンスの pg_hba.conf ファイルを変更します。
DescribeAccounts データベースアカウント情報の照会。 ApsaraDB RDS インスタンスのアカウント情報を照会します。
DescribeInstanceKeywords DescribeInstanceKeywords インスタンスの予約キーワードを照会します。予約キーワードは、アカウントのユーザー名やデータベース名として使用することはできません。
DescribePGHbaConfig DescribePGHbaConfig ApsaraDB RDS for PostgreSQL インスタンスの pg_hba.conf ファイルの構成を照会します。
DescribeModifyPGHbaConfigLog DescribeModifyPGHbaConfigLog ApsaraDB RDS for PostgreSQL インスタンスの pg_hba.conf ファイルへの変更に関する詳細を照会します。
ResetAccountPassword ResetAccountPassword データベースアカウントのパスワードをリセットします。
LockAccount LockAccount ApsaraDB RDS for PostgreSQL インスタンスのアカウントをロックします。
UnlockAccount UnlockAccount ApsaraDB RDS for PostgreSQL インスタンスのデータベースアカウントをロック解除します。
GrantAccountPrivilege GrantAccountPrivilege この API は、指定されたデータベースアカウントに 1 つ以上のデータベースへのアクセス権限を付与するために使用されます。
GrantOperatorPermission GrantOperatorPermission サービスアカウントに権限を付与します。
RevokeOperatorPermission RevokeOperatorPermission ApsaraDB RDS インスタンスのサービスアカウントから権限を取り消します。
RevokeAccountPrivilege RevokeAccountPrivilege ApsaraDB RDS インスタンスのアカウントから、データベースに対する権限を削除します。
ResetAccount ResetAccount 特権アカウントの権限をリセットします。
CheckAccountNameAvailable CheckAccountNameAvailable インスタンスに作成するアカウントのユーザー名が利用可能かどうかを確認します。

データベース

API

タイトル

説明

CreateDatabase データベースを作成します。 ApsaraDB RDS インスタンスにデータベースを作成します。
DeleteDatabase DeleteDatabase RDS インスタンスからデータベースを削除します。
CopyDatabase CopyDatabase SQL Server 2008 R2 を実行するインスタンスのデータベースを別のインスタンスにレプリケートします。この操作は廃止されました。
ModifyDBDescription ModifyDBDescription インスタンスの説明を変更します。
ModifyDatabaseConfig ModifyDatabaseConfig ApsaraDB RDS for SQL Server インスタンスのプロパティ設定を変更します。
ModifyCollationTimeZone ModifyCollationTimeZone インスタンス上のシステムデータベースの文字セットの照合順序とタイムゾーンを変更します。
DescribeDatabases DescribeDatabases この API は、RDS インスタンス内のデータベースを一覧表示します。
DescribeCollationTimeZones DescribeCollationTimeZones ApsaraDB RDS for SQL Server で使用可能な文字セットの照合順序とタイムゾーンを照会します。
DescribeCharacterSetName DescribeCharacterSetName インスタンスでサポートされている文字セットをクエリします。
CopyDatabaseBetweenInstances CopyDatabaseBetweenInstances RDS SQL Server インスタンス間でデータベースを複製します。
CheckDBNameAvailable CheckDBNameAvailable インスタンス上のデータベース名が一意であり、命名規則に準拠しているかどうかを確認します。

読み取り専用インスタンス

API

タイトル

説明

CreateReadOnlyDBInstance Create a Read-Only Instance この API は、RDS インスタンスの読み取り専用インスタンスを作成するために使用されます。
ModifyReadonlyInstanceDelayReplicationTime ModifyReadonlyInstanceDelayReplicationTime 読み取り専用 ApsaraDB RDS for MySQL インスタンスがプライマリインスタンスからデータをレプリケーションする際の遅延を変更します。
DescribeReadDBInstanceDelay DescribeReadDBInstanceDelay プライマリインスタンスとその読み取り専用インスタンス間のデータレプリケーションの遅延を照会します。
PrecheckDuckDBDependency PrecheckDuckDBDependency 指定された RDS for PostgreSQL プライマリインスタンスに対して DuckDB ベースの分析インスタンスを作成できるかどうかを確認します。DuckDB ベースの分析インスタンスを作成できない場合、この操作は失敗原因を返し、ソリューションまたは推奨仕様値を提供します。

RDS Cluster Edition インスタンス

API

タイトル

説明

CreateDBNodes CreateDBNodes RDS Cluster Edition を実行する ApsaraDB RDS for MySQL インスタンスまたは ApsaraDB RDS for PostgreSQL インスタンスにノードを追加します。RDS Cluster Edition を実行する RDS インスタンスは、RDS クラスターと呼ばれます。
CreateDBInstanceEndpoint CreateDBInstanceEndpoint RDS Cluster Edition を実行するインスタンスのエンドポイントを作成します。
CreateDBInstanceEndpointAddress CreateDBInstanceEndpointAddress RDS Cluster Edition を実行するインスタンスのパブリックエンドポイントを作成します。
DeleteDBNodes DeleteDBNodes RDS Cluster Edition を実行するインスタンスからノードを削除します。
DeleteDBInstanceEndpoint DeleteDBInstanceEndpoint RDS Cluster Edition を実行するインスタンスのエンドポイントを削除します。
DeleteDBInstanceEndpointAddress DeleteDBInstanceEndpointAddress RDS Cluster Edition を実行するインスタンスのパブリックエンドポイントをリリースします。
ModifyDBInstanceEndpoint インスタンスのエンドポイント重み情報を変更します ApsaraDB RDS クラスターインスタンスのエンドポイント重みフォーマット情報を変更します。
ModifyDBInstanceEndpointAddress ModifyDBInstanceEndpointAddress RDS Cluster Edition を実行するインスタンスのエンドポイントに関する情報を変更します。
DescribeDBInstanceEndpoints DescribeDBInstanceEndpoints RDS Cluster Edition を実行するインスタンスのエンドポイントに関する情報を照会します。

データベースプロキシ

API

タイトル

説明

CreateDBProxyEndpointAddress CreateDBProxyEndpointAddress インスタンスの専用プロキシへの接続に使用されるエンドポイントを作成します。
DeleteDBProxyEndpointAddress DeleteDBProxyEndpointAddress インスタンスの専用プロキシへの接続に使用されるエンドポイントを削除します。
ModifyDBProxy ModifyDBProxy インスタンスのデータベースプロキシ機能を有効化または変更します。
UpgradeDBProxyInstanceKernelVersion UpgradeDBProxyInstanceKernelVersion データベースプロキシのマイナーカーネルバージョンをアップグレードします。
ModifyDBProxyInstance ModifyDBProxyInstance インスタンスのデータベースプロキシの構成を変更します。
ModifyDBProxyEndpoint ModifyDBProxyEndpoint データベースプロキシエンドポイントの接続設定を変更します。
ModifyDBProxyEndpointAddress ModifyDBProxyEndpointAddress インスタンスのプロキシ接続アドレスを変更します。
ModifyDbProxyInstanceSsl ModifyDbProxyInstanceSsl ApsaraDB RDS for MySQL インスタンスの専用プロキシエンドポイントの SSL 暗号化を設定します。
DescribeDBProxy DescribeDBProxy この API は、RDS インスタンスの PolarProxy 設定をクエリするために使用されます。
DescribeDBProxyEndpoint DescribeDBProxyEndpoint この API は、RDS インスタンスのプロキシ接続アドレスを取得するために使用されます。
DescribeDBProxyPerformance DescribeDBProxyPerformance この API は、ApsaraDB RDS インスタンスのデータベースプロキシのパフォーマンスデータを照会するために使用します。
GetDbProxyInstanceSsl GetDbProxyInstanceSsl ApsaraDB RDS for MySQL インスタンスの専用プロキシエンドポイントの SSL 暗号化設定を照会します。

共有データベースプロキシ (非推奨)

API

タイトル

説明

ModifyReadWriteSplittingConnection ModifyReadWriteSplittingConnection 読み書き分離リンクのレイテンシーしきい値、およびプライマリインスタンスとその読み取り専用インスタンスの読み取り重みを変更します。
DescribeDBInstanceProxyConfiguration DescribeDBInstanceProxyConfiguration インスタンスで有効になっている共有プロキシの設定を照会します。
AllocateReadWriteSplittingConnection AllocateReadWriteSplittingConnection インスタンスの読み取り専用ルートエンドポイントを申請します。
ReleaseReadWriteSplittingConnection ReleaseReadWriteSplittingConnection この操作は、読み書き分離エンドポイントをリリースするために使用します。
CalculateDBInstanceWeight CalculateDBInstanceWeight システムによって割り当てられた読み取り重みをクエリします。

セキュリティと暗号化

API

タイトル

説明

AttachWhitelistTemplateToInstance AttachWhitelistTemplateToInstance ホワイトリストテンプレートをインスタンスに関連付けます。
CreateServiceLinkedRole CreateServiceLinkedRole サービスリンクロールを作成します。
DetachWhitelistTemplateToInstance DetachWhitelistTemplateToInstance インスタンスからホワイトリストテンプレートの関連付けを解除します。
ModifyWhitelistTemplate ModifyWhitelistTemplate ホワイトリストを編集します。この操作を呼び出して、ホワイトリストを作成、変更、または削除できます。
DescribeSecurityGroupConfiguration DescribeSecurityGroupConfiguration インスタンスに追加されている ECS セキュリティグループを照会します。
ModifySecurityGroupConfiguration ModifySecurityGroupConfiguration インスタンスが追加される ECS セキュリティグループを変更します。
CreateDBInstanceSecurityGroupRule CreateDBInstanceSecurityGroupRule ApsaraDB RDS for SQL Server インスタンスにセキュリティグループルールを追加します。
DescribeDBInstanceSecurityGroupRule DescribeDBInstanceSecurityGroupRule ApsaraDB RDS for SQL Server インスタンスに設定されているセキュリティグループルールを照会します。
ModifyDBInstanceSecurityGroupRule ModifyDBInstanceSecurityGroupRule ApsaraDB RDS for SQL Server インスタンスに設定されているセキュリティグループルールを変更します。
DeleteDBInstanceSecurityGroupRule DeleteDBInstanceSecurityGroupRule ApsaraDB RDS for SQL Server インスタンスに設定されているセキュリティグループルールを削除します。
ModifySecurityIps ModifySecurityIps ApsaraDB RDS インスタンスの IP アドレスホワイトリストを変更します。
ModifyDBInstanceSSL RDS インスタンスの SSL 構成を変更します。 ApsaraDB RDS インスタンスの SSL リンク構成を変更します。
ModifyDBInstanceTDE RDS インスタンスの TDE ステータスを変更します。 ApsaraDB RDS インスタンスの TDE (透過的データ暗号化) 機能を有効化または変更します。
ModifyDTCSecurityIpHostsForSQLServer ModifyDTCSecurityIpHostsForSQLServer ApsaraDB RDS for SQL Server インスタンスの分散トランザクションホワイトリストを設定します。
ModifyDBInstanceDeletionProtection ModifyDBInstanceDeletionProtection インスタンスのリリース保護機能を有効または無効にします。
DescribeWhitelistTemplateLinkedInstance DescribeWhitelistTemplateLinkedInstance ホワイトリストテンプレートによって関連付けられたインスタンスをクエリします。
DescribeInstanceLinkedWhitelistTemplate DescribeInstanceLinkedWhitelistTemplate インスタンス名で関連付けられたホワイトリストを照会します。
DescribeWhitelistTemplate DescribeWhitelistTemplate 指定された IP ホワイトリストの情報を照会します。
DescribeAllWhitelistTemplate DescribeAllWhitelistTemplate あいまい検索を使用して、一度に複数のホワイトリストテンプレートを照会します。
DescribeDBInstanceIPArrayList DescribeDBInstanceIPArrayList ApsaraDB RDS インスタンスの IP アドレスホワイトリストをクエリします。
DescribeDBInstanceSSL DescribeDBInstanceSSL インスタンスの SSL 構成を照会します。
DescribeDBInstanceTDE RDS インスタンスの TDE ステータスを照会します。 ApsaraDB RDS インスタンスの TDE (透過的データ暗号化) ステータスを照会します。
DescribeDBInstanceEncryptionKey DescribeDBInstanceEncryptionKey DescribeDBInstanceEncryptionKey 操作を呼び出すことで、インスタンスのディスク暗号化が有効になっているかを確認できます。また、ディスク暗号化に使用されるキーの詳細をクエリすることもできます。この操作は、MySQL、SQL Server、または PostgreSQL を実行するインスタンスでサポートされています。
DescribeDBInstanceIpHostname DescribeDBInstanceIpHostname ApsaraDB RDS for SQL Server インスタンスが実行されている Elastic Compute Service (ECS) インスタンスの内部 IP アドレスとホスト名を照会します。
DescribeDTCSecurityIpHostsForSQLServer DescribeDTCSecurityIpHostsForSQLServer ApsaraDB RDS for SQL Server インスタンスの分散トランザクションホワイトリストをクエリします。
MigrateSecurityIPMode MigrateSecurityIPMode インスタンスのホワイトリストモードを標準ホワイトリストモードから高セキュリティホワイトリストモードに変更します。

ログ

API

タイトル

説明

DescribeSQLLogReportList DescribeSQLLogReportList SQL ログレポートを照会します。
PurgeDBInstanceLog PurgeDBInstanceLog ApsaraDB RDS インスタンスのオンプレミスログをクリアします。
DescribeSQLLogFiles DescribeSQLLogFiles インスタンスの SQL Explorer (SQL 監査) 機能によって生成されたログファイルを照会します。 DescribeSQLLogFiles 操作は、SQL Explorer 機能によって生成され、ApsaraDB RDS コンソールから手動でエクスポートされたログファイルを返しません。 DescribeSQLLogFiles 操作は、リクエストパラメーター Form を File に設定して DescribeSQLLogRecords 操作を呼び出すことによって生成された SQL Explorer ログファイルを返します。
DescribeSlowLogs DescribeSlowLogs スロークエリログの統計情報を照会します。
DescribeSlowLogRecords DescribeSlowLogRecords この API は、インスタンスのスロークエリログの詳細を表示するために使用されます。
DescribeErrorLogs エラーログの表示。 指定された時間範囲内のインスタンスのエラーログを照会します。
ModifySQLCollectorPolicy ModifySQLCollectorPolicy この操作は呼び出し可能ですが、メンテナンスは終了しています。この操作は、インスタンスの SQL Explorer (SQL 監査) 機能を有効または無効にします。
ModifySQLCollectorRetention ModifySQLCollectorRetention ApsaraDB RDS インスタンスの SQL Explorer が生成するログファイルの保持期間を変更します。
DescribeSQLCollectorPolicy DescribeSQLCollectorPolicy ApsaraDB RDS インスタンスの SQL Explorer (SQL 監査) 機能のステータスを照会します。
DescribeSQLLogRecords インスタンスの SQL 監査ログを照会します (非推奨) 非推奨: 正常に呼び出し可能ですが、メンテナンスは終了しています。ApsaraDB RDS インスタンスの SQL Explorer (SQL 監査) ログを照会します。
DescribeSQLCollectorRetention DescribeSQLCollectorRetention インスタンスの SQL Explorer 機能によって生成されたログファイルの保存期間を照会します。

バックアップ

API

タイトル

説明

ModifyBackupSetExpireTime ModifyBackupSetExpireTime 単一データベースの手動バックアップによって生成されたバックアップセット (物理バックアップセットと完全バックアップセットを含む) の有効期限を延長します。
CreateBackup CreateBackup RDS インスタンスのバックアップセットを作成します。
DeleteBackup DeleteBackup ApsaraDB RDS インスタンスのデータバックアップファイルを削除します。
DeleteBackupFile DeleteBackupFile ApsaraDB RDS for SQL Server インスタンスのバックアップファイルを削除します。この操作は、インスタンスのホワイトリストに追加されたユーザーのみが利用できます。
ModifyBackupPolicy インスタンスのバックアップポリシーを変更します。 ApsaraDB RDS インスタンスのバックアップポリシー設定を変更します。
DescribeBackups DescribeBackups この API は、RDS インスタンスのバックアップセットリストを表示するために使用されます。
DescribeDetachedBackups DescribeDetachedBackups リリース済みの ApsaraDB RDS インスタンスのデータバックアップファイルを照会します。
DescribeBackupPolicy インスタンスのバックアップ設定を表示します ApsaraDB RDS インスタンスのバックアップセットの設定を照会します。
DescribeBackupTasks DescribeBackupTasks インスタンスのバックアップタスクを照会します。
DescribeBinlogFiles DescribeBinlogFiles MySQL または MariaDB を実行するインスタンスのバイナリログファイル、または PostgreSQL を実行するインスタンスの先行書き込みログ (WAL) ファイルをクエリします。
DescribeLogBackupFiles DescribeLogBackupFiles ApsaraDB RDS for SQL Server インスタンスのログバックアップファイルをクエリします。
DescribeBackupDatabase DescribeBackupDatabase バックアップファイルに含まれるデータベースを照会します。

復元

API

タイトル

説明

CreateTempDBInstance 一時インスタンスを作成します。 プレミアムローカル SSD を備えた ApsaraDB RDS for SQL Server 2008 R2 インスタンスの一時インスタンスを作成します。
DescribeLocalAvailableRecoveryTime DescribeLocalAvailableRecoveryTime RDS インスタンスを復元できる時間範囲を照会します。
DescribeMetaList DescribeMetaList 指定されたバックアップセットから復元できるデータベースとテーブルに関する情報をクエリします。
RecoveryDBInstance RecoveryDBInstance ApsaraDB RDS for SQL Server インスタンスのバックアップデータを、既存のインスタンスまたは新しいインスタンスに復元します。
CloneDBInstance CloneDBInstance この操作は、既存データを新しいクローンインスタンスに復元します。
RestoreTable 特定のデータベースまたはテーブルを元の RDS インスタンスに復元します。 ApsaraDB RDS インスタンスの特定のデータベースまたはテーブルを元のインスタンスに復元します。

クロスリージョンバックアップと復元

API

タイトル

説明

CreateDdrInstance CreateDdrInstance リージョン間でデータを新しいインスタンスに復元します。
ModifyInstanceCrossBackupPolicy ModifyInstanceCrossBackupPolicy インスタンスのクロスリージョンバックアップ設定を変更します。
DescribeInstanceCrossBackupPolicy DescribeInstanceCrossBackupPolicy インスタンスのクロスリージョンバックアップ設定を照会します。
DescribeCrossBackupMetaList DescribeCrossBackupMetaList インスタンスのクロスリージョンバックアップファイルに含まれるデータベースとテーブルのデータをクエリします。
DescribeCrossRegionBackups DescribeCrossRegionBackups インスタンスのクロスリージョンデータバックアップファイルを照会します。
DescribeCrossRegionLogBackupFiles DescribeCrossRegionLogBackupFiles インスタンスのクロスリージョンログバックアップファイルを照会します。
DescribeAvailableCrossRegion DescribeAvailableCrossRegion 特定のソースリージョンからクロスリージョンバックアップファイルをレプリケートできる、利用可能なターゲットリージョンを照会します。
DescribeAvailableRecoveryTime DescribeAvailableRecoveryTime クロスリージョンバックアップファイルからデータを復元できる期間を照会します。
DescribeCrossRegionBackupDBInstance DescribeCrossRegionBackupDBInstance あるリージョンでクロスリージョンバックアップ機能が有効になっているインスタンスと、それらのインスタンスのクロスリージョンバックアップ設定を照会します。
CheckCreateDdrDBInstance CheckCreateDdrDBInstance リージョン間バックアップセットを使用してインスタンスを復元できるかどうかを照会します。
RestoreDdrTable RestoreDdrTable 既存のインスタンスにデータをクロスリージョンで復元します。

モニタリング

API

タイトル

説明

ModifyDBInstanceMonitor ModifyDBInstanceMonitor モニタリング周波数を変更します。
ModifyDBInstanceMetrics ModifyDBInstanceMetrics ApsaraDB RDS for PostgreSQL インスタンスに表示される拡張モニタリングのメトリックを変更します。
DescribeResourceUsage DescribeResourceUsage インスタンスのストレージ使用量を照会します。
DescribeDBInstancePerformance DescribeDBInstancePerformance インスタンスのパフォーマンスメトリクスをクエリします。
DescribeDBInstanceMonitor DescribeDBInstanceMonitor インスタンスのモニタリング周波数を照会します。
DescribeAvailableMetrics DescribeAvailableMetrics ApsaraDB RDS for PostgreSQL インスタンスでサポートされているすべての拡張モニタリングメトリックを照会します。
DescribeDBInstanceMetrics DescribeDBInstanceMetrics ApsaraDB RDS for PostgreSQL インスタンスに表示される拡張モニタリングメトリックを照会します。

パラメーター

API

タイトル

説明

CreateParameterGroup CreateParameterGroup インスタンスのパラメータテンプレートを作成します。
DeleteParameterGroup DeleteParameterGroup インスタンスからパラメータテンプレートを削除します。
ModifyParameter ModifyParameter インスタンスのパラメーター値を変更します。
ModifyParameterGroup ModifyParameterGroup インスタンスのパラメータテンプレートを変更します。
DescribeParameters DescribeParameters インスタンスのパラメータ設定をクエリします。
DescribeModifyParameterLog DescribeModifyParameterLog インスタンスのパラメーター変更ログを照会します。
DescribeParameterTemplates DescribeParameterTemplates パラメータテンプレートを照会します。
DescribeParameterGroups DescribeParameterGroups 指定されたリージョンで利用可能なパラメータテンプレートをクエリします。
DescribeParameterGroup DescribeParameterGroup パラメータテンプレートの情報を照会します。
CloneParameterGroup CloneParameterGroup パラメータテンプレートを現在のリージョンまたは別のリージョンに複製します。

データ移行

API

タイトル

説明

DescibeImportsFromDatabase DescibeImportsFromDatabase インスタンスの移行タスクを照会します。

O&M タスク管理

API

タイトル

説明

ModifyActiveOperationTasks ModifyActiveOperationTasks インスタンスの定期 O&M タスクの切り替え時間を変更します。
DescribeActiveOperationTasks DescribeActiveOperationTasks インスタンスにスケジュールされた運用保守タスクの詳細を照会します。
CancelActiveOperationTasks CancelActiveOperationTasks 開始されていない運用保守タスクをキャンセルします。

MySQL バックアップファイルのクラウドへの移行

API

タイトル

説明

DeleteUserBackupFile DeleteUserBackupFile ApsaraDB RDS for MySQL インスタンスのバックアップファイルを削除します。
UpdateUserBackupFile UpdateUserBackupFile 完全バックアップファイルの説明と保持期間を変更します。
ListUserBackupFiles ListUserBackupFiles インスタンスにインポートされた完全バックアップファイルの詳細を照会します。
ImportUserBackupFile ImportUserBackupFile この API は、自己管理 MySQL 5.7 データベースのバックアップデータを RDS にインポートするために使用されます。

SQL Server バックアップファイルのクラウドへの移行

API

タイトル

説明

CreateMigrateTask CreateMigrateTask Object Storage Service (OSS) バケットから ApsaraDB RDS for SQL Server インスタンスにバックアップファイルを復元するための移行タスクを作成します。
CreateOnlineDatabaseTask CreateOnlineDatabaseTask ApsaraDB RDS for SQL Server インスタンスのバックアップデータ移行タスクに関連するデータベースを開きます。
DescribeMigrateTasks DescribeMigrateTasks ApsaraDB RDS for SQL Server インスタンスのバックアップデータを移行するために作成されたタスクを照会します。
DescribeOssDownloads DescribeOssDownloads ApsaraDB RDS for SQL Server インスタンスのバックアップデータ移行タスクに含まれるバックアップファイルを照会します。
DescribeMigrateTaskById DescribeMigrateTaskById ApsaraDB RDS for SQL Server インスタンスのバックアップデータを Object Storage Service (OSS) バケットにインポートするために使用されるタスクをクエリします。
TerminateMigrateTask TerminateMigrateTask ApsaraDB RDS for SQL Server インスタンスの進行中の移行タスクを終了します。

SQL Server AD ドメイン

API

タイトル

説明

DeleteADSetting DeleteADSetting ApsaraDB RDS for SQL Server インスタンスを Active Directory (AD) ドメインから削除します。
ModifyADInfo ModifyADInfo ApsaraDB RDS for SQL Server インスタンスの AD ドメイン情報を変更します。
DescribeADInfo DescribeADInfo インスタンスの AD ドメインに関する情報を照会します。この情報には、インスタンスが AD ドメインに追加されているかどうか、AD ドメインの名前、アカウントが含まれます。

PostgreSQL のワンクリッククラウド移行

API

タイトル

説明

CreateCloudMigrationPrecheckTask CreateCloudMigrationPrecheckTask ApsaraDB RDS for PostgreSQL インスタンスへのクラウド移行のための評価タスクを作成します。
CreateCloudMigrationTask CreateCloudMigrationTask ApsaraDB RDS for PostgreSQL インスタンスのクラウド移行タスクを作成します。
DescribeCloudMigrationPrecheckResult DescribeCloudMigrationPrecheckResult インスタンスへのクラウド移行の評価レポートの詳細をクエリします。
DescribeCloudMigrationResult DescribeCloudMigrationResult ApsaraDB RDS for PostgreSQL インスタンスのクラウド移行タスクの詳細を照会します。
ActivateMigrationTargetInstance ActivateMigrationTargetInstance ソース PostgreSQL インスタンスから宛先 ApsaraDB RDS for PostgreSQL インスタンスにワークロードを切り替えます。

タグ

API

タイトル

説明

TagResources TagResources 1 つ以上のインスタンスにタグを作成して追加します。
AddTagsToResource AddTagsToResource インスタンスにタグを追加します。
UntagResources UntagResources 1 つ以上のインスタンスからタグを削除します。
RemoveTagsFromResource RemoveTagsFromResource インスタンスからタグを削除します。
ListTagResources ListTagResources 1 つ以上のインスタンスに追加されたタグを照会します。
DescribeTags DescribeTags インスタンスのタグをクエリします。
DescribeDBInstanceByTags DescribeDBInstanceByTags インスタンスに追加されたタグに関する情報をクエリします。

RDS PostgreSQL 拡張機能の管理

API

タイトル

説明

CreatePostgresExtensions CreatePostgresExtensions データベースの拡張を作成します。
DeletePostgresExtensions DeletePostgresExtensions データベースから拡張を削除します。
UpdatePostgresExtensions UpdatePostgresExtensions データベース上の拡張機能のバージョンを更新します。
DescribePostgresExtensions DescribePostgresExtensions データベースにインストールされている拡張機能を照会します。

PostgreSQL インスタンスのレプリケーションスロット管理

API

タイトル

説明

DeleteSlot DeleteSlot インスタンスのレプリケーションスロットを削除します。
DescribeSlots DescribeSlots インスタンスのすべてのレプリケーションスロットをクエリします。

ディザスタリカバリインスタンス

API

タイトル

説明

CreateReplicationLink CreateReplicationLink ディザスタリカバリ (DR) ApsaraDB RDS インスタンスのデータ同期タスクを作成します。
DescribeReplicationLinkLogs DescribeReplicationLinkLogs 指定された ApsaraDB RDS インスタンスのデータ同期タスクの操作ログを照会します。
RebuildReplicationLink RebuildReplicationLink ディザスタリカバリ用の ApsaraDB RDS インスタンスのデータ同期リンクを再作成します。
DeleteReplicationLink DeleteReplicationLink ディザスタリカバリ (DR) ApsaraDB RDS インスタンスのデータ同期リンクを削除し、DR インスタンスをプライマリインスタンスに昇格させます。

コミット型サーバーレス

API

タイトル

説明

ModifyComputeBurstConfig コミット済みサーバーレス機能を変更または無効にします。 コミット済みサーバーレス機能を変更または無効にします。
DescribeComputeBurstConfig DescribeComputeBurstConfig 保証付きサーバーレスの設定を照会します。

その他

API

タイトル

説明

ユーザー認証情報 ユーザー認証情報
CreateSecret CreateSecret Data API 機能を使用するユーザーの認証情報を作成します。
DeleteSecret DeleteSecret Data API 機能を使用するユーザーの認証情報を削除します。
DescribeSecrets DescribeSecrets Data API 機能を使用するユーザーの認証情報をクエリします。
MigrateConnectionToOtherZone MigrateConnectionToOtherZone インスタンスを別のゾーンに移行します。
ModifyDBInstanceDelayedReplicationTime ModifyDBInstanceDelayedReplicationTime 読み取り専用 ApsaraDB RDS for MySQL インスタンスのレプリケーション遅延を設定します。
CheckServiceLinkedRole CheckServiceLinkedRole サービスリンクロール (SLR) が作成されているかどうかを確認します。
DescribeDBMiniEngineVersions DescribeDBMiniEngineVersions ApsaraDB RDS for MySQL インスタンスまたは ApsaraDB RDS for PostgreSQL インスタンスで利用可能なマイナーエンジンバージョンをクエリします。
DescribeRegionInfos DescribeRegionInfos リージョンを照会します。
DescribeDBInstanceNetInfoForChannel DescribeDBInstanceNetInfoForChannel インスタンスのすべてのエンドポイントを照会します。
DescribeHostWebShell DescribeHostWebShell ApsaraDB RDS for SQL Server インスタンスのホストへの接続に使用されるウェブシェル URL をクエリします。
DescribeClassDetails DescribeClassDetails インスタンスタイプのコードを使用して、インスタンスのインスタンスタイプの詳細を照会します。
DescribeKmsAssociateResources DescribeKmsAssociateResources 指定された Key Management Service (KMS) のリソースが ApsaraDB RDS インスタンスに関連付けられているかどうかを確認します。
ModifyDBInstanceReplicationSwitch ModifyDBInstanceReplicationSwitch ApsaraDB RDS for MySQL のネイティブレプリケーション機能を有効または無効にします。
DescribeDBInstanceReplication Query Instance Replication Status この API は、ネイティブレプリケーションインスタンスのステータスと構成を返します。
MigrateDBNodes MigrateDBNodes RDS Cluster Edition を実行する ApsaraDB RDS for MySQL インスタンスのノードのゾーンを変更します。
SwitchOverMajorVersionUpgrade SwitchOverMajorVersionUpgrade RDS PostgreSQL の無停止メジャーバージョンアップにおけるトラフィックスイッチオーバーを実行します。
AuthorizeBackupEncryption AuthorizeBackupEncryption AliyunServiceRoleForRdsBackupEncryption サービスリンクロールを作成します。
CheckBackupEncryptionAuthorized CheckBackupEncryptionAuthorized ユーザーアカウントに AliyunServiceRoleForRdsBackupEncryption サービスリンクロールが存在するかどうかを確認します。
CheckRegionSupportBackupEncryption CheckRegionSupportBackupEncryption 現在のリージョンがバックアップの暗号化をサポートしているかどうかを確認します。
DescribeSQLServerUpgradeVersions DescribeSQLServerUpgradeVersions SQL Server インスタンスまたは指定の SQL Server バージョンのアップグレード先となるバージョンについて説明します。
DescribeVpcs DescribeVpcs Alibaba Cloud アカウントの仮想プライベートクラウド (VPC) を一覧表示します。
EnableBackupEncryption EnableBackupEncryption この API を使用して、バックアップの暗号化を有効にします。
DescribeActiveOperationMaintainConf Query proactive O\&M configuration ユーザーの運用保守設定情報を取得します。この情報には現在、スケジュールされた管理イベントのタイムウィンドウ情報が含まれています。
CreateMaskingRules CreateMaskingRules 指定されたインスタンスに対して、新しい暗号化またはマスキングルールを作成します。
ModifyAccountMaskingPrivilege Modify Account Masking Permission 指定されたインスタンスのアカウントの暗号化またはマスキング権限を変更します。
ModifyMaskingRules ModifyMaskingRules 指定されたインスタンスの暗号化またはデータマスキングルールを変更します。
DescribeMaskingRules DescribeMaskingRules 指定されたインスタンスの暗号化ルールまたはデータマスキングルールを一覧表示します。
DeleteMaskingRules DeleteMaskingRules 指定されたインスタンスの暗号化ルールまたはデータマスキングルールを削除します。
DescribeAccountMaskingPrivilege DescribeAccountMaskingPrivilege 指定されたインスタンスのアカウントに対する暗号化またはデータマスキングの権限設定を取得します。
DeleteParameterTimedScheduleTask DeleteParameterTimedScheduleTask インスタンスパラメーターを変更するための定期タスクを削除します。
DescribeParameterTimedScheduleTask DescribeParameterTimedScheduleTask インスタンスパラメーターを変更する定期タスクの詳細を照会します。
ModifyParameterTimedScheduleTask ModifyParameterTimedScheduleTask スケジュールされたパラメーター変更タスクの有効開始時刻を変更します。
DescribeDBInstanceCLS DescribeDBInstanceCLS 指定されたインスタンスの列レベルの暗号化アルゴリズムの構成を返します。
ModifyDBInstanceCLS ModifyDBInstanceCLS 指定されたインスタンスの列レベルの暗号化アルゴリズムの構成を変更します。
CreateRCImage CreateRCImage RDS Custom インスタンスのカスタムイメージを作成します。
ModifyDBInstanceVectorSupportStatus ModifyDBInstanceVectorSupportStatus MySQL インスタンスのベクターストレージを有効または無効にします。
DescribeImportTaskValidation Queries the Details of a Precheck for an Import Job インポートタスクの事前チェックの詳細をクエリします。この操作は、各事前チェック項目とその結果を返します。
DescribeImportTask Query import job details ネイティブレプリケーションを使用する RDS インスタンスのデータインポートタスクの詳細を取得します。
CreateImportTask CreateImportTask データインポートタスクを作成します。
ValidateImportTask Precheck for Data Import Job ネイティブレプリケーションを使用する RDS for MySQL インスタンスのデータインポートタスクに対して事前チェックを実行します。
ListImportTasks List Data Import Jobs ネイティブレプリケーションのデータインポートタスクをクエリします。
ModifyImportTask Modify Data Import Job RDS MySQL ネイティブレプリケーションインスタンスのデータインポートタスクを変更します。
ModifyRCDiskAttribute ModifyRCDiskAttribute ブロックストレージデバイスの名前、説明、インスタンスと共にリリースされるかどうか、バースト機能が有効になっているかどうかなどの属性を変更します。
UpdateDBInstanceReplication UpdateDBInstanceReplication ネイティブレプリケーションインスタンスのレプリケーションチャンネルを更新します。
CreateDBInstanceReplication Create replication channel ネイティブレプリケーションインスタンスのレプリケーションリンクを作成します。
DeleteDBInstanceReplication DeleteDBInstanceReplication ネイティブレプリケーションインスタンスからレプリケーションチャンネルを削除します。
ModifyDBInstance インスタンスを変更します。 インスタンスを変更します。現在、PostgreSQL エンジンのみがサポートされています。

イベントとタスク

API

タイトル

説明

DescribeHistoryEventsStat DescribeHistoryEventsStat イベントセンターの履歴イベントの統計を照会します。
DescribeHistoryEvents DescribeHistoryEvents イベントセンターの履歴イベントを照会します。
ModifyEventInfo ModifyEventInfo イベントセンターのイベントに関する情報を変更します。
DescribeHistoryTasksStat DescribeHistoryTasksStat タスクセンターのタスクを収集します。
DescribeHistoryTasks DescribeHistoryTasks 30日以内に作成された履歴タスクを照会します。
ModifyTaskInfo ModifyTaskInfo タスクセンターの履歴タスクの情報を変更します。
DescribeTasks DescribeTasks ApsaraDB RDS for SQL Server インスタンスで待機中または実行中のタスクをクエリします。