API 標準および多言語対応の SDK
本製品 (selectdb/2023-05-22) の 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 |
タイトル |
説明 |
| CreateServiceLinkedRoleForSelectDB | CreateServiceLinkedRoleForSelectDB | この操作を呼び出して、サービスリンクロールを作成できます。 |
| CheckCreateDBInstance | CheckCreateDBInstance | ApsaraDB for SelectDB インスタンスの作成に必要なリソースの事前チェックを実行します。 |
| DescribeSecurityIPList | DescribeSecurityIPList | ApsaraDB for SelectDB インスタンスのホワイトリスト内の IP アドレスを照会します。 |
| ModifySecurityIPList | ModifySecurityIPList | ApsaraDB for SelectDB インスタンスのホワイトリスト内の IP アドレスを変更します。 |
| CheckIpExistsInSecurityIpList | CheckIpExistsInSecurityIpList | 指定された IP アドレスがホワイトリストグループに存在するかどうかを確認します。 |
| ModifyDBInstanceAttribute | ModifyDBInstanceAttribute | ApsaraDB for SelectDB インスタンスのメンテナンスウィンドウまたは説明を変更します。 |
クラスター管理
|
API |
タイトル |
説明 |
| ModifyVirtualCluster | ModifyVirtualCluster | 仮想クラスターを変更します。 |
| CreateDBClusterBinding | CreateDBClusterBinding | クラスターのバインディング関係を作成します。ゾーン冗長ストレージ (ZRS) デプロイメントメソッドを使用する場合、2 つのクラスター間にバインディング関係を作成できます。 |
| DeleteDBClusterBinding | DeleteDBClusterBinding | 相互バックアップのために、2 つのクラスター間のバインディング関係を削除します。 |
| GetCreateBEClusterInquiry | GetCreateBEClusterInquiry | ApsaraDB for SelectDB インスタンスの新しいクラスターの価格を照会します。 |
| GetModifyBEClusterInquiry | GetModifyBEClusterInquiry | 指定された ApsaraDB for SelectDB インスタンス内に新しいクラスターを作成するための価格情報を取得します。 |
| ModifyBEClusterAttribute | ModifyBEClusterAttribute | ApsaraDB for SelectDB インスタンスの BE クラスターの名前を変更します。 |
| StopBECluster | StopBECluster | 指定された ApsaraDB for SelectDB クラスターを停止します。 |
| StartBECluster | StartBECluster | 指定された ApsaraDB SelectDB クラスターを起動します。 |
| RestartDBCluster | RestartDBCluster | 指定された ApsaraDB for SelectDB インスタンスのクラスターを再起動します。 |
| DescribeDBClusterConfig | DescribeDBClusterConfig | ApsaraDB for SelectDB インスタンス内のクラスターの構成情報を照会します。 |
| ModifyDBClusterConfig | ModifyDBClusterConfig | クラスタの構成を変更します。 |
| DescribeDBClusterConfigChangeLogs | DescribeDBClusterConfigChangeLogs | クラスター構成の変更ログを照会します。 |
その他
|
API |
タイトル |
説明 |
| DescribeAllDBInstanceClass | DescribeAllDBInstanceClass | すべてのインスタンスタイプに関する情報を取得します。 |
| ModifyElasticRule | ModifyElasticRule | スケジュールされたスケーリングルールを変更します。 |
| DescribeElasticRules | DescribeElasticRules | スケジュールされたスケーリングルールを照会します。 |
| DescribeDBClusterStorageLimitation | DescribeDBClusterStorageLimitation | 各クラスター仕様のキャッシュ制限を照会します。 |
| DeleteElasticRule | DeleteElasticRule | スケジュールされたスケーリングルールを削除します。 |
| EnDisableScalingRules | EnDisableScalingRules | スケジュールされたスケーリングポリシーを使用します。 |
| CreateElasticRule | CreateElasticRule | 時間ベースのスケーリングルールを作成します。 |
Others
|
API |
タイトル |
説明 |
| AllocateInstancePublicConnection | AllocateInstancePublicConnection | ApsaraDB for SelectDB インスタンスのパブリックエンドポイントを申請します。 |
| ChangeResourceGroup | ChangeResourceGroup | インスタンスのリソースグループを変更します。 |
| CheckServiceLinkedRole | CheckServiceLinkedRole | サービスリンクロールが存在するかどうかを確認します。 |
| CreateDBCluster | CreateDBCluster | 指定された ApsaraDB for SelectDB インスタンスのクラスタを作成します。 |
| CreateDBInstance | インスタンスを作成します | ApsaraDB for SelectDB インスタンスを作成します。 |
| CreateVirtualCluster | CreateVirtualCluster | 仮想クラスターを作成します。 |
| DeleteDBCluster | DeleteDBCluster | インスタンス内のクラスターを削除します。 |
| DeleteDBInstance | DeleteDBInstance | 指定された ApsaraDB for SelectDB インスタンスを削除します。 |
| DeleteVirtualCluster | DeleteVirtualCluster | 仮想クラスターを削除します。 |
| DescribeDBInstanceAttribute | DescribeDBInstanceAttribute | 指定されたインスタンスの詳細を取得します。 |
| DescribeDBInstanceNetInfo | DescribeDBInstanceNetInfo | 指定された SelectDB インスタンスのネットワーク情報を照会します。 |
| DescribeDBInstances | DescribeDBInstances | 1 つ以上のインスタンスに関する情報を照会します。 |
| DescribeProfile | DescribeProfile | クエリのプロファイル分析を取得します。 |
| DescribeRegions | DescribeRegions | 利用可能なリージョンとゾーンを照会します。 |
| DescribeSlowQueryStats | DescribeSlowQueryStats | 指定した時間範囲におけるスロークエリ統計を取得します。 |
| DescribeVSwitches | DescribeVSwitches | 指定されたゾーン内の vSwitch を照会します。 |
| DescribeZones | DescribeZones | 利用可能なゾーンを記述します。 |
| ModifyDBCluster | ModifyDBCluster | 指定された ApsaraDB for SelectDB クラスターをスケールアウトまたはスケールインします。 |
| ReleaseInstancePublicConnection | ReleaseInstancePublicConnection | ApsaraDB for SelectDB インスタンスのパブリックエンドポイントを解放します。 |
| ResetAccountPassword | ResetAccountPassword | ApsaraDB for SelectDB インスタンスのデータベースアカウントのパスワードをリセットします。 |
| TagResources | TagResources | 1 つ以上のインスタンスにタグを追加します。 |
| UntagResources | UntagResources | インスタンスからタグを削除します。 |
| UpgradeDBInstanceDeployScheme | UpgradeDBInstanceDeployScheme | ローカル冗長インスタンスをゾーン冗長インスタンスにアップグレードします。 |
| UpgradeDBInstanceEngineVersion | UpgradeDBInstanceEngineVersion | 指定された ApsaraDB SelectDB インスタンスのデータベースバージョンをスペックアップします。 |