DescribeDBClusterServerlessConf を介した PolarDB サーバーレス構成の取得 - PolarDB - Alibaba Cloud - PolarDB

サーバーレスクラスターの構成を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeDBClusterServerlessConf

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	サーバーレスクラスターの ID。	pc-bp10gr51qasnl****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	5E71541A-6007-4DCC-A38A-F872C31FEB45
ScaleMin	string	シングルノードの最小計算容量 (PolarDB 容量単位 (PCU))。有効な値：1～31。	1
ScaleMax	string	シングルノードの最大計算容量 (PCU)。有効な値：1～32。	3
ScaleRoNumMin	string	スケーリング用の読み取り専用ノードの最小数。有効な値：0～15。	2
ScaleRoNumMax	string	スケーリング用の読み取り専用ノードの最大数。有効な値：0～15。	4
AllowShutDown	string	無操作サスペンド機能が有効になっているかどうかを示します。有効な値： true：有効 false：無効 (デフォルト)	true
SecondsUntilAutoPause	string	無操作サスペンドの検出期間 (秒単位)。値は 300～86,400 の整数で、300 の倍数である必要があります。	10
DBClusterId	string	サーバーレスクラスターの ID。	pc-bp10gr51qasnl****
ScaleApRoNumMin	string	読み取り専用カラムストアノードの最小数。有効な値：0～15。	1
ScaleApRoNumMax	string	読み取り専用カラムストアノードの最大数。有効な値：0～15。	1
Switchs	string	定常状態モードが有効になっているかどうかを示します。有効な値： 1：有効 0：無効	1
ServerlessRuleMode	string	弾力性の感度。有効な値： normal：標準 flexible：フレキシブル	normal
ServerlessRuleCpuEnlargeThreshold	string	CPU スケールアップのしきい値。	60
ServerlessRuleCpuShrinkThreshold	string	CPU スケールダウンのしきい値。	30
TraditionalScaleMaxThreshold	string	定常状態モードのクラスターの最大容量 (PCU)。定常状態モードでは、固定仕様のノードにサーバーレス機能が追加されます。	16
AgileScaleMax	string	アジャイルモードのクラスターの最大容量 (PCU)。アジャイルモードでは、クラスターはサーバーレスノードのみで構成されます。	32

例

成功レスポンス

JSONJSON

{
  "RequestId": "5E71541A-6007-4DCC-A38A-F872C31FEB45",
  "ScaleMin": "1",
  "ScaleMax": "3",
  "ScaleRoNumMin": "2",
  "ScaleRoNumMax": "4",
  "AllowShutDown": "true",
  "SecondsUntilAutoPause": "10",
  "DBClusterId": "pc-bp10gr51qasnl****",
  "ScaleApRoNumMin": "1",
  "ScaleApRoNumMax": "1",
  "Switchs": "1",
  "ServerlessRuleMode": "normal",
  "ServerlessRuleCpuEnlargeThreshold": "60",
  "ServerlessRuleCpuShrinkThreshold": "30",
  "TraditionalScaleMaxThreshold": "16",
  "AgileScaleMax": "32"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidEngine.Unsupported	The specified Engine does not support this feature.
403	OperationDenied.ClusterCategory	The operation is not permitted due to cluster category.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

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

変更履歴

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