DescribeAutoScalingConfig API リファレンス - DAS - Alibaba Cloud - Database Autonomy Service

インスタンスの auto scaling 設定を照会します。

操作説明

開始する前に:

Alibaba Cloud または DAS SDK の最新バージョンを使用してください。
SDK を使用して DAS を呼び出す場合は、リージョンを cn-shanghai に設定してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hdm:DescribeAutoScalingConfig

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。	pc-2ze1prap1k46r****

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	返される状態コード。	200
Message	string	返されるメッセージ。説明リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。	Successful
RequestId	string	リクエストの ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	リクエストが成功したかどうかを示します。有効な値: true: リクエストが成功しました。 false: リクエストが失敗しました。	true
Data	object	インスタンスの弾力的スケーリング特徴の設定。
Spec	object	スペックの弾力的スケーリング特徴の設定。
Upgrade	boolean	自動スペックアップが有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
CpuUsageUpperThreshold	integer	自動スペックアップをトリガーする平均 CPU 使用率のしきい値。単位: %。	70
MemUsageUpperThreshold	integer	自動スペックアップをトリガーする平均メモリ使用率のしきい値。単位: %。	70
MaxSpec	string	自動スペックアップのノードスペックの最大値。詳細については、各データベースインスタンスのプロダクト仕様ドキュメントを参照してください。 PolarDB for MySQL Cluster Edition の場合、「コンピュートノードの仕様」を参照してください。クラウドディスクを使用する ApsaraDB RDS for MySQL High-Availability Edition の場合、「プロダクトの仕様」を参照してください。 Redis コミュニティクラウドディスクエディションの場合、「インスタンスの仕様」を参照してください。 PolarDB for MySQL Cluster Edition の場合、「コンピュートノードの仕様」を参照してください。クラウドディスクを使用する ApsaraDB RDS for MySQL High-Availability Edition の場合、「プロダクトの仕様」を参照してください。	polar.mysql.x8.12xlarge
MaxReadOnlyNodes	integer	インスタンスの読み取り専用ノードの最大値。	10
ObservationWindowSize	string	観測ウィンドウ。値は数値と時間単位のサフィックスで構成されます。時間単位のサフィックスは以下の通りです。 s: 秒。 m: 分。 h: 時間。 d: 日。説明たとえば、5m は 5 分を示します。	5m
CoolDownTime	string	クールダウン期間。値は数値と時間単位のサフィックスで構成されます。時間単位のサフィックスは以下の通りです。 s: 秒。 m: 分。 h: 時間。 d: 日。説明たとえば、5m は 5 分を示します。	5m
Downgrade	boolean	自動スペックダウンが有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
Storage	object	インスタンスの自動ストレージスケーリング特徴の設定。
Upgrade	boolean	自動ストレージスケーリングが有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
DiskUsageUpperThreshold	integer	自動ストレージスケーリングをトリガーする平均ストレージ使用率のしきい値。単位: %。	70
MaxStorage	integer	ストレージ容量の最大値。単位: GB。	32000
Resource	object	インスタンスのローカルリソース弾力的スケーリング特徴の設定。
Enable	boolean	ローカルリソース弾力的スケーリングが有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
CpuUsageUpperThreshold	integer	自動ローカルリソーススケールアップをトリガーする平均 CPU 使用率のしきい値。単位: %。	70
CpuStep	integer	CPU スケールアップの増分。	2
UpgradeObservationWindowSize	string	スケールアップの観測ウィンドウ。値は数値と時間単位のサフィックスで構成されます。時間単位のサフィックスは以下の通りです。 s: 秒。 m: 分。 h: 時間。 d: 日。説明たとえば、5m は 5 分を示します。	5m
DowngradeObservationWindowSize	string	スケールダウンの観測ウィンドウ。値は数値と時間単位のサフィックスで構成されます。時間単位のサフィックスは以下の通りです。 s: 秒。 m: 分。 h: 時間。 d: 日。説明たとえば、5m は 5 分を示します。	5m
Shard	object	インスタンスのシャード弾力的スケーリング特徴の設定。
Upgrade	boolean	自動シャード追加が有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
MemUsageUpperThreshold	integer	自動シャード追加をトリガーする平均メモリ使用率のしきい値。単位: %。	70
MaxShards	integer	インスタンスのシャードの合計数の最大値。	16
UpgradeObservationWindowSize	string	自動シャード追加の観測ウィンドウ。値は数値と時間単位のサフィックスで構成されます。時間単位のサフィックスは以下の通りです。 s: 秒。 m: 分。 h: 時間。 d: 日。説明たとえば、5m は 5 分を示します。	5m
Downgrade	boolean	自動シャード削除が有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
MemUsageLowerThreshold	integer	自動シャード削除をトリガーする平均メモリ使用率のしきい値。単位: %。	30
MinShards	integer	インスタンスのシャードの合計数の最小値。	4
DowngradeObservationWindowSize	string	自動シャード削除の観測ウィンドウ。値は数値と時間単位のサフィックスで構成されます。時間単位のサフィックスは以下の通りです。 s: 秒。 m: 分。 h: 時間。 d: 日。説明たとえば、1d は 1 日を示します。	1d
Bandwidth	object	インスタンスの帯域幅弾力的スケーリング特徴の設定。
Upgrade	boolean	自動帯域幅スペックアップが有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
BandwidthUsageUpperThreshold	integer	自動帯域幅スペックアップをトリガーする平均帯域幅使用量のしきい値。単位: %。	70
ObservationWindowSize	string	自動帯域幅スペックアップの観測ウィンドウ。値は数値と時間単位のサフィックスで構成されます。時間単位のサフィックスは以下の通りです。 s: 秒。 m: 分。 h: 時間。 d: 日。説明たとえば、5m は 5 分を示します。	5m
Downgrade	boolean	自動帯域幅スペックダウンが有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
BandwidthUsageLowerThreshold	integer	自動帯域幅スペックダウンをトリガーする平均帯域幅使用量のしきい値。単位: %。	30

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "Spec": {
      "Upgrade": true,
      "CpuUsageUpperThreshold": 70,
      "MemUsageUpperThreshold": 70,
      "MaxSpec": "polar.mysql.x8.12xlarge",
      "MaxReadOnlyNodes": 10,
      "ObservationWindowSize": "5m",
      "CoolDownTime": "5m",
      "Downgrade": true
    },
    "Storage": {
      "Upgrade": true,
      "DiskUsageUpperThreshold": 70,
      "MaxStorage": 32000
    },
    "Resource": {
      "Enable": true,
      "CpuUsageUpperThreshold": 70,
      "CpuStep": 2,
      "UpgradeObservationWindowSize": "5m",
      "DowngradeObservationWindowSize": "5m"
    },
    "Shard": {
      "Upgrade": true,
      "MemUsageUpperThreshold": 70,
      "MaxShards": 16,
      "UpgradeObservationWindowSize": "5m",
      "Downgrade": true,
      "MemUsageLowerThreshold": 30,
      "MinShards": 4,
      "DowngradeObservationWindowSize": "1d"
    },
    "Bandwidth": {
      "Upgrade": true,
      "BandwidthUsageUpperThreshold": 70,
      "ObservationWindowSize": "5m",
      "Downgrade": true,
      "BandwidthUsageLowerThreshold": 30
    }
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The request parameters are invalid.	リクエストパラメーターが無効です。
403	NoPermission	You are not authorized to do this action.	この操作を実行する権限がありません。

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

変更履歴

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