ListInstanceSpecs API でインスタンス仕様を取得 - OpenSearch

操作説明

メソッド

GET

URI

/openapi/ha3/instances/{instanceId}/specs?type=qrs

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

searchengine:ListInstanceSpecs

get

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエスト構文

GET /openapi/ha3/instances/{instanceId}/specs HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	ha-cn-pl32rf0****

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
type	string	必須	ノードタイプ。有効な値： qrs：Query Result Searcher (QRS) Worker search：Searcher Worker index：インデックスノード cluster：クラスター	search

リクエスト例

GET /openapi/ha3/instances/ha3_instance_name/specs

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
requestId	string	リクエスト ID。	10D5E615-69F7-5F49-B850-00169ADE513C
result	array<object>	インスタンスタイプ。
	object	インスタンス仕様のリスト
cpu	integer	vCPU の数。	1
mem	integer	インスタンスのメモリ。単位：GB。	16
minDisk	integer	単一データノードの最小ストレージ。単位：GB。	100
maxDisk	integer	単一データノードの最大ストレージ。単位：GB。	600

レスポンス例

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": [
    {
      "cpu": 1
      "mem": 2,
      "disk": 100
    },
    {
      "cpu": 2
      "mem": 4,
      "disk": 100      
    }    
  ]
}

例

成功レスポンス

JSONJSON

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": [
    {
      "cpu": 1,
      "mem": 16,
      "minDisk": 100,
      "maxDisk": 600
    }
  ]
}

エラーコード

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

変更履歴

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