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

PolarDB:API概要

最終更新日:Jun 03, 2024

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

課金

API

説明

TransformDBClusterPayType

指定されたPolarDBクラスターの課金方法を変更します。

リージョン

API

説明

DescribeRegions

PolarDBでサポートされているリージョンとゾーンを照会します。

Clusters

カテゴリ

API

説明

クラスター管理

CreateDBCluster

PolarDBクラスターを作成します。

DeleteDBCluster

指定された従量課金PolarDBクラスターをリリースします。

DescribeDBClusters

PolarDBクラスター、またはRAMユーザーがアクセスを許可されているクラスターを照会します。

DescribeDBClusterAttribute

指定されたPolarDBクラスターの詳細属性を照会します。

ModifyDBClusterMaintainTime

指定されたPolarDBクラスターのメンテナンス期間を変更します。 ほとんどの場合、メンテナンス期間はオフピーク時間に設定されます。 Alibaba Cloudは、ビジネスへの影響を最小限に抑えるために、指定されたメンテナンス期間内にクラスターを維持します。

ModifyDBClusterDescription

指定されたPolarDBクラスターの名前を変更して、クラスターのメンテナンスを容易にします。

DescribeTasks

API操作を使用して生成されたタスク (クラスターの作成など) の進行状況の詳細を照会します。

アーキテクチャの展開

ModifyDBClusterPrimaryZone

指定されたPolarDBクラスターのプライマリゾーンを変更します。

FailoverDBCluster

指定されたPolarDBクラスターのプライマリノードと読み取り専用ノードを手動で切り替えます。 新しいプライマリノードとして読み取り専用ノードを指定できます。

DescribeGlobalDatabaseNetworks

アカウントに属するすべてのグローバルデータベースネットワーク (GDN) に関する詳細を照会します。

更新管理

DescribeAutoRenewAttribute

サブスクリプション課金方法を使用する指定されたPolarDBクラスターの自動更新ステータスを照会します。

ModifyAutoRenewAttribute

サブスクリプション課金方法を使用する指定されたPolarDBクラスターの自動更新を設定します。

DescribeDBClusterAvailableResources

指定されたPolarDBクラスターで使用可能なリソースを照会します。

カーネル

API

説明

DescribeDBClusterVersion

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

UpgradeDBClusterVersion

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

データセキュリティ

カテゴリ

API

説明

ホワイトリスト

ModifyDBClusterAccessWhitelist

指定されたPolarDBクラスターのホワイトリスト (IPホワイトリストとセキュリティグループ) を作成または変更します。

DescribeDBClusterAccessWhitelist

アクセス可能な指定されたPolarDBクラスターのIPホワイトリストとセキュリティグループを照会します。

SSL暗号化

ModifyDBClusterSSL

Secure Sockets Layer (SSL) 暗号化を有効または無効にするか、指定したPolarDBクラスターの認証局 (CA) 証明書を更新します。

DescribeDBClusterSSL

指定されたPolarDBクラスターのSSL設定を照会します。

TDE

DescribeDBClusterTDE

指定されたPolarDBクラスターの透過データ暗号化 (TDE) 設定に関する詳細を照会します。

ModifyDBClusterTDE

指定されたPolarDB for MySQLクラスターのTDE機能を有効にするか、暗号化方法を変更します。

ノード

API

説明

CreateDBNodes

指定されたPolarDBクラスターに読み取り専用ノードを追加します。

ModifyDBNodeClass

指定されたPolarDBクラスターのノード仕様を変更します。

RestartDBNode

指定されたPolarDBクラスター内のノードを再起動します。

DeleteDBNodes

指定されたPolarDBクラスターの読み取り専用ノードを削除します。

クラスターパラメーター

API

説明

DescribeDBClusterParameters

指定されたPolarDBクラスターのパラメーターを照会します。

ModifyDBClusterParameters

指定されたPolarDBクラスターのパラメーターを変更するか、パラメーターテンプレートをクラスターに適用します。

CreateParameterGroup

指定されたPolarDBクラスターのパラメーターテンプレートを作成します。

DescribeParameterGroups

指定されたPolarDBクラスターのパラメータテンプレートリストを照会します。

DescribeParameterGroup

指定されたPolarDBクラスターのパラメーターテンプレートに関する詳細を照会します。

DescribeParameterTemplates

指定されたPolarDBクラスターのデフォルトパラメータリストを照会します。

DeleteParameterGroup

指定された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クラスターのデータベースアカウントに関する情報を照会します。

CheckAccountName

指定されたアカウント名が有効かどうか、または指定されたアカウントと同じ名前のアカウントが現在のクラスターにすでに存在するかどうかを確認します。

ModifyAccountDescription

指定されたPolarDBデータベースアカウントの注釈を変更します。

ModifyAccountPassword

指定されたPolarDBデータベースアカウントのパスワードを変更します。

GrantAccountPrivilege

指定されたPolarDBクラスター内の1つ以上のデータベースにアクセスする権限を標準アカウントに付与します。

RevokeAccountPrivilege

指定されたPolarDB標準アカウントに付与されているデータベースアクセス権限を無効にします。

ResetAccount

指定されたPolarDB特権データベースアカウントをリセットします。

DeleteAccount

指定されたPolarDBデータベースアカウントを削除します。

データベース

API

説明

CreateDatabase

指定されたPolarDBクラスターにデータベースを作成します。

DescribeDatabases

指定されたPolarDBクラスター内のデータベースを照会します。

ModifyDBDescription

指定されたPolarDBデータベースの説明または注釈を変更します。

DeleteDatabase

指定されたPolarDBクラスターのデータベースを削除します。

DescribeCharacterSetName

指定されたPolarDB for MySQLデータベースでサポートされている文字セットを照会します。

CheckDBName

指定されたデータベース名が有効かどうか、または指定されたデータベースと同じ名前のデータベースが現在のクラスターにすでに存在するかどうかを確認します。

Backups

カテゴリ

API

説明

バックアップ管理

CreateBackup

指定されたPolarDBクラスターの完全なスナップショットを手動で作成します。

DescribeBackups

指定されたPolarDBクラスターのバックアップ情報を照会します。

DescribeBackupTasks

指定されたPolarDBクラスターのバックアップタスクを照会します。

DescribeBackupLogs

バックアップログとURLを照会してバックアップログをダウンロードします。

DescribeDetachedBackups

既にリリースされている指定されたPolarDBクラスターのバックアップセットに関する情報を照会します。

DescribeDBClustersWithBackups

バックアップセットが含まれ、指定されたリージョンにデプロイされているPolarDBクラスターに関する詳細を照会します。

DeleteBackup

指定されたPolarDBクラスターのバックアップを削除します。

バックアップポリシー

DescribeBackupPolicy

自動バックアップポリシーを照会します。

DescribeLogBackupPolicy

指定されたPolarDBクラスターのログバックアップの保持ポリシーを照会します。

ModifyBackupPolicy

自動バックアップポリシーを変更します。

ModifyLogBackupPolicy

指定されたPolarDBクラスターのログバックアップの保持ポリシーを変更します。

復元

API

説明

DescribeMetaList

復元可能なデータベースとテーブルのメタデータを照会します。

RestoreTable

指定されたPolarDBデータベースまたはテーブルを復元します。

ApsaraDB RDSからのデータ移行

API

説明

DescribeDBClusterMigration

指定されたPolarDBクラスターの移行ステータスを照会します。

ModifyDBClusterMigration

ApsaraDB RDS for MySQLインスタンスからPolarDBにデータを移行するか、データ移行をロールバックします。

CloseDBClusterMigration

データ移行を中止または完了します。

Tags

API

説明

TagResources

指定されたPolarDBクラスターにタグを追加します。

UntagResources

指定されたPolarDBクラスターからタグを削除します。

ListTagResources

1つ以上のPolarDBクラスターに追加されたタグを照会するか、1つ以上のタグが追加されたPolarDBクラスターを照会します。

保留中のイベント

API

説明

DescribePendingMaintenanceAction

保留中のイベントの詳細を照会します。

DescribePendingMaintenanceActions

さまざまな種類のタスクの保留中のイベントの数を照会します。

ModifyPendingMaintenanceAction

保留中のイベントのタスク切り替え時間を変更します。

スケジュール済みタスク

API

説明

DescribeScheduleTasks

現在のアカウントに属するすべてまたは指定されたスケジュール済みタスクに関する詳細を照会します。

CancelScheduleTasks

指定されたスケジュール済みタスクをキャンセルします。

マスキングルール

API

説明

DescribeMaskingRules

指定されたPolarDBクラスターに適用されるデータマスキングルール、または指定されたマスキングルールに関する詳細を照会します。

ModifyMaskingRules

データマスキングルールを変更または追加します。

DeleteMaskingRules

指定されたデータマスキングルールを削除します。

モニタリング

API

説明

DescribeDBNodePerformance

指定されたPolarDBクラスターノードのパフォーマンスデータを照会します。

DescribeDBClusterPerformance

指定されたPolarDBクラスターのパフォーマンスデータを照会します。

DescribeDBClusterMonitor

指定されたPolarDBクラスターのモニタリングデータが収集される頻度を照会します。

ModifyDBClusterMonitor

指定されたPolarDBクラスターのモニタリングデータを収集する頻度を変更します。