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

:API概要

最終更新日:May 31, 2024

は次のAPI操作を提供します。

リージョン

API説明
DescribeRegionsPolarDBがサポートするリージョンとゾーンを照会します。

Clusters

カテゴリAPI説明
クラスター管理CreateDBClusterPolarDBクラスターを作成します。
DeleteDBCluster指定された従量課金PolarDBクラスターをリリースします。
DescribeDBClustersRAMユーザーがアクセスを許可されているPolarDBクラスターリストまたはPolarDBクラスターを照会します。
DescribeDBClusterAttribute 指定されたPolarDBクラスターの詳細属性を照会します。
ModifyDBClusterMaintainTime指定されたPolarDBクラスターのルーチンメンテナンス期間を変更します。 通常、定期メンテナンスウィンドウはオフピーク時間に設定されます。 Alibaba Cloudは、ビジネスへの影響を最小限に抑えるために、指定されたメンテナンス期間内にクラスターを維持します。
ModifyDBClusterDescription指定されたPolarDBクラスターの名前を変更して、クラスターのメンテナンスを容易にします。
DescribeTasksAPI操作に基づいて生成されたタスク (クラスターの作成など) の進行状況の詳細を照会します。
アーキテクチャの展開ModifyDBClusterPrimaryZone指定されたPolarDBクラスターのプライマリゾーンを変更します。
FailoverDBCluster指定されたPolarDBクラスターのプライマリノードと読み取り専用ノード間で手動切り替えを実行します。 新しいプライマリノードとして読み取り専用ノードを指定できます。
DescribeGlobalDatabaseNetworksアカウントのすべてのグローバルデータベースネットワーク (GDN) の詳細を表示します。
更新の管理DescribeAutoRenewAttributeサブスクリプションPolarDBクラスターの自動更新ステータスを照会します。
ModifyAutoRenewAttribute指定したサブスクリプションPolarDBクラスターの自動更新属性を指定します。
DescribeDBClusterAvailableResourcesPolarDBクラスターの使用可能なリソースを照会します。

カーネル

API説明
DescribeDBClusterVersion指定されたPolarDB for MySQLクラスターの現在のカーネルバージョンに関する詳細を照会します。

データセキュリティ

カテゴリAPI説明
ホワイトリストModifyDBClusterAccessWhitelist指定されたPolarDBクラスターのホワイトリスト (IPホワイトリストとセキュリティグループ) を作成または変更します。
DescribeDBClusterAccessWhitelistアクセス可能な指定されたPolarDBクラスターのIPホワイトリストとセキュリティグループを照会します。
SSL 暗号化ModifyDBClusterSSLSecure Sockets Layer (SSL) 暗号化を有効または無効にするか、指定したPolarDBクラスターの認証局 (CA) 証明書を更新します。
DescribeDBClusterSSL指定されたPolarDBクラスターのSSL設定を照会します。
TDEDescribeDBClusterTDE指定されたPolarDBクラスターの透過データ暗号化 (TDE) 設定に関する詳細を照会します。
ModifyDBClusterTDE指定されたPolarDB for MySQLクラスターのTDE機能を有効にするか、暗号化方法を変更します。

ノード

API説明
CreateDBNodes指定されたPolarDBクラスターに読み取り専用ノードを追加します。
ModifyDBNodeClass指定されたPolarDBクラスターのノード仕様を変更します。
RestartDBNode指定されたPolarDBクラスター内のノードを再起動します。
DeleteDBNodes指定されたPolarDBクラスターから読み取り専用ノードを削除します。

クラスタパラメータ

API説明
DescribeDBClusterParameters指定されたPolarDBクラスターのパラメーターを照会します。
ModifyDBClusterParameters指定されたPolarDBクラスターのパラメーターを変更します。

エンドポイント

API説明
CreateDBEndpointAddress指定されたPolarDBクラスターのパブリックエンドポイントを作成します。 パブリックエンドポイントは、プライマリエンドポイント、デフォルトのクラスターエンドポイント、またはカスタムクラスターエンドポイントにすることができます。
CreateDBClusterEndpoint指定されたPolarDBクラスターのカスタムクラスターエンドポイントを作成します。
DescribeDBClusterEndpoints指定されたPolarDBクラスターに関するエンドポイント情報を照会します。
ModifyDBClusterEndpoint読み取り /書き込みモードや整合性レベルなど、指定されたPolarDBクラスターエンドポイントの属性を変更します。 新しく追加されたノードを指定されたクラスターエンドポイントに自動的に関連付けるかどうかも指定できます。
ModifyDBEndpointAddress指定されたPolarDBクラスターのパブリックエンドポイントを変更します。 パブリックエンドポイントは、プライマリエンドポイント、デフォルトのクラスターエンドポイント、またはカスタムクラスターエンドポイントにすることができます。
DeleteDBEndpointAddress指定されたPolarDBクラスターのパブリックエンドポイントをリリースします。 パブリックエンドポイントは、プライマリエンドポイント、デフォルトのクラスターエンドポイント、またはカスタムクラスターエンドポイントにすることができます。
DeleteDBClusterEndpoint指定されたPolarDBクラスターのカスタムクラスターエンドポイントをリリースします。

ログ

API説明
DescribeSlowLogRecords指定されたPolarDBクラスターのスロークエリログに関する詳細を照会します。
DescribeDBClusterAuditLogCollector指定されたPolarDBクラスターに対してSQLデータコレクターが有効になっているかどうかを照会します。 SQLデータコレクターの機能には、監査ログとSQL Explorerが含まれます。
ModifyDBClusterAuditLogCollector指定したPolarDBクラスターのSQLデータコレクターを有効または無効にします。 SQLデータコレクターの機能には、監査ログとSQL Explorerが含まれます。

アカウント

API説明
CreateAccount指定されたPolarDBデータベースのアカウントを作成します。
DescribeAccounts指定されたPolarDBクラスターのデータベースアカウントに関する情報を照会します。
ModifyAccountDescriptionPolarDBデータベースアカウントのコメントを変更します。
ModifyAccountPasswordPolarDBデータベースアカウントのパスワードを変更します。
GrantAccountPrivilege指定されたPolarDBクラスター内の1つ以上のデータベースにアクセスする権限を標準アカウントに付与します。
RevokeAccountPrivilege指定されたPolarDB標準アカウントからデータベースへのアクセス許可を取り消します。
ResetAccountPolarDBの特権アカウントをリセットします。
DeleteAccount指定されたPolarDBデータベースアカウントを削除します。

データベース

API説明
CreateDatabase指定されたPolarDBクラスターのデータベースを作成します。
DescribeDatabases指定されたPolarDBクラスターに関するデータベースリスト情報を照会します。
ModifyDBDescription指定されたPolarDBデータベースの説明または注釈を変更します。
DeleteDatabase指定されたPolarDBクラスターからデータベースを削除します。

Backups

カテゴリAPI説明
バックアップ管理CreateBackup指定されたPolarDBクラスターの完全スナップショットバックアップを手動で作成します。
DescribeBackups指定されたPolarDBクラスターのバックアップ情報を照会します。
DescribeBackupTasks指定されたPolarDBクラスターのバックアップタスクリストを照会します。
DescribeBackupLogsバックアップログの一覧と、バックアップログをダウンロードするためのURLを照会します。
DescribeDetachedBackupsリリースされたPolarDBクラスターに関するバックアップセット情報を照会します。
DescribeDBClustersWithBackupsバックアップセットを含み、指定されたリージョンに存在するPolarDBクラスターに関する詳細を照会します。
DeleteBackup指定されたPolarDBクラスターのバックアップを削除します。
バックアップポリシーDescribeBackupPolicy自動バックアップポリシーを照会します。
DescribeLogBackupPolicy指定されたPolarDBクラスターのログバックアップの保持ポリシーを照会します。
ModifyBackupPolicy自動バックアップポリシーを変更します。
ModifyLogBackupPolicy指定されたPolarDBクラスターのログバックアップの保持ポリシーを変更します。

ApsaraDB RDS for MySQLからのデータ移行

API説明
DescribeDBClusterMigration指定されたPolarDBクラスターのデータ移行ステータスを照会します。
ModifyDBClusterMigrationワンクリックでApsaraDB RDS for MySQLインスタンスからPolarDBにデータを移行するか、データ移行をロールバックします。
CloseDBClusterMigration移行をキャンセルまたは完了します。

Tags

API説明
TagResourcesPolarDBクラスターにタグをアタッチします。
UntagResourcesPolarDBクラスターからタグをデタッチします。
ListTagResources1つ以上のPolarDBクラスターにアタッチされているタグを照会するか、1つ以上のタグがアタッチされているPolarDBクラスターリストを照会します。

保留中のイベント

API説明
DescribePendingMaintenanceAction保留中のイベントの詳細を照会します。
DescribePendingMaintenanceActionsさまざまなタスクタイプの保留中のイベントの数を照会します。
ModifyPendingMaintenanceAction保留中のイベントのタスク切り替え時間を変更します。

モニタリング

API説明
DescribeDBNodePerformance指定されたPolarDBクラスターノードのパフォーマンスデータを照会します。
DescribeDBClusterPerformance指定されたPolarDBクラスターのパフォーマンスデータを照会します。
DescribeDBClusterMonitor指定されたPolarDBクラスターのモニタリングデータが収集される頻度を照会します。
ModifyDBClusterMonitor指定されたPolarDBクラスターのモニタリングデータを収集する頻度を変更します。