GetWarehouseDetail API による計算グループ詳細の取得 - Hologres

計算グループの詳細。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hologram:GetWarehouseDetail

get

*Instance

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエスト構文

GET /api/v1/instances/{instanceId}/getWarehouseDetail HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	任意	インスタンス ID。このパラメーターは必須です。	hgprecn-cn-i7m2ucpyu005

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマです。
RequestId	string	リクエスト ID。	D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
WarehouseDetail	object	戻り値。
ReservedCpu	string	予約済みコンピューティングリソース。インスタンス内のすべての実行中の仮想ウェアハウスの合計コンピューティングリソースは、この値を超えることはできません。	64
RemainingCpu	string	インスタンス内の未割り当てコンピューティングリソース。	32
WarehouseList	array<object>	倉庫一覧。
	object	ウェアハウス
Cpu	integer	CPU コア数。	32
Mem	integer	メモリサイズ。	128
Id	integer	ID。	2
Status	string	ステータス。列挙値: kRunning : 仮想ウェアハウスは実行中です。 kSuspended : 仮想ウェアハウスは一時停止中です。 kInit : 仮想ウェアハウスは初期化中です。 kFailed : 仮想ウェアハウスの起動に失敗しました。 kAllocating : 仮想ウェアハウスにリソースが割り当てられています。	kRunning
NodeCount	integer	計算ノード数。	2
Name	string	仮想ウェアハウスの名前。	MyWarehouse
ElasticCpu	integer	エラスティックコンピューティングリソース。	32
DefaultWarehouse	boolean	これがデフォルトの計算グループであるかどうかを示します。列挙値: ture : 計算グループはデフォルトのものです。 false : いいえ	true
RebalanceStatus	string	仮想ウェアハウスのリバランスステータス。列挙値: DONE : リバランスが完了しました。 DOING : リバランスが進行中です。	DONE
ClusterCpu	string	クラスター仕様。	32
ElasticType	string	エラスティシティのタイプ。	auto
InitClusterCount	string	予約済みクラスター数。	2
ClusterCount	string	クラスター数。	2
MaxClusterCount	string	最大クラスター数。	4
AutoScaleType	string	自動スケーリングタイプ。	Standard
TimedElasticCpu	string	仮想ウェアハウスの現在の合計スケジュール済みエラスティックコンピューティングリソース。	64
AutoElasticCpu	string	仮想ウェアハウスの現在の合計自動エラスティックコンピューティングリソース。	32

例

成功レスポンス

JSONJSON

{
  "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
  "WarehouseDetail": {
    "ReservedCpu": "64",
    "RemainingCpu": "32",
    "WarehouseList": [
      {
        "Cpu": 32,
        "Mem": 128,
        "Id": 2,
        "Status": "kRunning",
        "NodeCount": 2,
        "Name": "MyWarehouse",
        "ElasticCpu": 32,
        "DefaultWarehouse": true,
        "RebalanceStatus": "DONE",
        "ClusterCpu": "32",
        "ElasticType": "auto",
        "InitClusterCount": "2",
        "ClusterCount": "2",
        "MaxClusterCount": "4",
        "AutoScaleType": "Standard"
      }
    ],
    "TimedElasticCpu": "64",
    "AutoElasticCpu": "32"
  }
}

エラーコード

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

変更履歴

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