CreateInstance API を呼び出して Havenask インスタンスを作成 - OpenSearch - Alibaba Cloud -

Wentian エンジンインスタンスを作成します。

操作説明

メソッド

POST

URI

/openapi/ha3/instances
```.

今すぐお試しください

この 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:CreateInstance

create

*Instance

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

なし

リクエスト構文

POST /openapi/ha3/instances HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエスト構造体。	{}
chargeType	string	任意	インスタンスの課金方法。有効な値: PREPAY: サブスクリプション。この課金方法を選択する場合、アカウントが残高払いまたはクレジット払いに対応していることを確認してください。対応していない場合、InvalidPayMethod エラーが返されます。paymentInfo パラメーターも指定する必要があります。POSTPAY: 従量課金（現在サポートされていません）。	PREPAY
components	array<object>	任意	インスタンスに関連するスペック情報のリスト。
	object	任意	インスタンスに関連するスペック情報のリスト。
code	string	任意	スペックコード。販売パラメーターと一致します。	searcherdocsize
value	string	任意	コントロールに入力されたデータ。	200
order	object	任意	支払い情報。
autoRenew	boolean	任意	自動更新を有効にするかどうかを指定します。有効な値: true および false。	true
duration	integer	任意	課金サイクル。有効な値: 1、2、3、4、5、6、7、8、9、10、12。	29
pricingCycle	string	任意	課金サイクルの単位。有効な値: Month および Year。	Month
tags	array<object>	任意
	object	任意
key	string	任意
value	string	任意
resourceGroupId	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
requestId	string	リクエスト ID。	D39EE0F1-D7EF-5F46-B781-6BF4185308B0
result	object	返された結果。
instanceId	string	インスタンス ID。	ha-cn-pl32rf0****

レスポンス例

成功レスポンス例

{
	"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
  "result": {
      "instanceId": "deeprec-cn-xxxxxx1"
    }
}

エラーレスポンス例

{
	"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
  "code": "InternalServerError",
  "message":"internal server error"
}

詳細については、レスポンス構造体を参照してください。

例

成功レスポンス

JSONJSON

{
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0",
  "result": {
    "instanceId": "ha-cn-pl32rf0****"
  }
}

エラーコード

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

変更履歴

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