CreateElasticPlan API を使用したスケーリングプランの作成 - AnalyticDB

AnalyticDB for MySQL クラスター向けのスケーリングプランを作成します。

操作説明

AnalyticDB for MySQL のエンドポイント一覧については、「エンドポイント」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:CreateElasticPlan

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ElasticPlanName	string	必須	スケーリングプランの名前です。説明名前の長さは 2～30 文字で、英字、数字、アンダースコア (_) を使用できます。先頭文字は英字である必要があります。	test
ResourceGroupName	string	任意	リソースグループの名前です。説明インタラクティブなリソースグループを使用するスケーリングプランを作成する場合は、このパラメーターを指定する必要があります。エラスティック I/O ユニット (EIU) を使用するスケーリングプランを作成する場合は、このパラメーターを指定する必要はありません。クラスターのリソースグループ名を照会するには、DescribeDBResourceGroup 操作を呼び出します。	test
StartTime	string	任意	スケーリングプランの開始時刻です。説明 ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。	2022-01-01T12:01:00Z
EndTime	string	任意	スケーリングプランの終了時刻です。説明 ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。	2025-01-01T12:01:00Z
Enabled	boolean	必須	スケーリングプランを作成後に直ちに有効化するかどうかを指定します。有効な値は以下のとおりです。 true false	true
CronExpression	string	任意	スケーリングプランのスケーリング周期および実行時刻を指定する CRON 式です。	0 20 14 * * ?
TargetSize	string	任意	スケーリング後のエラスティックリソースの目標仕様です。説明スケーリングプランが EIU を使用し、かつ EIU 向けデフォルト比例スケーリングが有効になっている場合、このパラメーターを指定する必要はありません。その他の場合は、このパラメーターを指定する必要があります。スケーリングプランでサポートされる仕様を照会するには、DescribeElasticPlanSpecifications 操作を呼び出します。	32ACU
Type	string	必須	スケーリングプランのタイプです。有効な値は以下のとおりです。 EXECUTOR：インタラクティブなリソースグループタイプ（コンピューティングリソースのタイプ） WORKER：EIU タイプ	EXECUTOR
AutoScale	boolean	任意	EIU 向けデフォルト比例スケーリングを有効化するかどうかを指定します。有効な値は以下のとおりです。 true：ストレージリソースがコンピューティングリソースに連動してスケーリングされます。この場合、TargetSize および CronExpression パラメーターはサポートされません。 false 説明 Type が WORKER に設定されている場合、このパラメーターを指定する必要があります。Type が EXECUTOR に設定されている場合は、このパラメーターは必須ではありません。 EIU 向けデフォルト比例スケーリングは、クラスターに対して 1 つのみのスケーリングプランで有効化できます。	false
DBClusterId	string	必須	クラスター ID です。説明リージョン内のすべての AnalyticDB for MySQL クラスターの ID を照会するには、DescribeDBClusters 操作を呼び出します。	amv-wz9509beptiz****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
RequestId	string	リクエスト ID です。	A5C433C2-001F-58E3-99F5-3274C14DF8BD

例

成功レスポンス

JSONJSON

{
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ACS.ElasticPlan.InvalidEndTime	The end time should be later than current time.
400	ACS.ElasticPlan.NameAlreadyExists	The name already exists.
400	ACS.ElasticPlan.WorkerNotFound	Worker not found.
400	ACS.ElasticPlan.AutoWorkerPlanExists	Failed to enable the elastic plan. The instance already has an active elastic plan.
400	ACS.ElasticPlan.WorkerPlanExists	Failed to enable the elastic plan. At least one active elastic plan already exists.
400	ACS.ElasticPlan.InvalidStartTimeInterval	The start time of this elastic plan is too closed to another one.
400	ACS.ElasticPlan.InvalidTodayPlan	Failed to enable this elastic plan. Today's schedule time is missed and you should prepare at least %s minutes for us to prepare resource.
400	ACS.ElasticPlan.InvalidTargetSize	Invalid target size.
400	ACS.ElasticPlan.InvalidStartTime	Invalid start time.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。