DescribeAutoScalingConfig API リファレンス - DAS

インスタンスの自動スケーリング機能の設定を照会します。

操作説明

この操作を呼び出す前に、次の点にご注意ください。

Alibaba Cloud SDK または Database Autonomy Service (DAS) SDK を使用してこの操作を呼び出す場合は、最新バージョンの SDK を使用することを推奨します。
SDK を使用して DAS の操作を呼び出す場合は、リージョン ID を 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

*All Resource

*

なし

リクエストパラメーター

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

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	返される HTTP ステータスコード。	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 クラスター版インスタンス：PolarDB for MySQL Enterprise Edition のコンピュートノード仕様標準 SSD または ESSD を使用する ApsaraDB RDS for MySQL 高可用性版インスタンス：仕様	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.

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

変更履歴

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