CreateAppGroup API で OpenSearch アプリグループを作成 - OpenSearch

OpenSearch アプリケーションを作成します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

opensearch:CreateAppGroup

create

*AppGroup

acs:opensearch:{#regionId}:{#accountId}:app-groups/*

なし

リクエスト構文

POST /v4/openapi/app-groups HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディ。
name	string	任意	アプリケーションの名前。	jmbon_analyzer
chargeType	string	任意	課金方法。有効な値: POSTPAY: 従量課金 PREPAY: サブスクリプション	POSTPAY
type	string	任意	アプリケーションタイプ。有効な値: standard: Standard Edition enhanced: プレミアムエディション	enhanced
resourceGroupId	string	任意	インスタンスが属するリソースグループの ID。	rg-acfm2ij6pwxsvua
tags	array<object>	任意	タグ。
	object	任意	タグオブジェクト。
key	string	任意	タグキー。	a
value	string	任意	タグの値。	1
quota	object	任意	クォータ。
docSize	integer	任意	ストレージ容量。単位: GB。	1
computeResource	integer	任意	計算リソース。単位: 論理コンピューティングユニット (LCU)。	20
spec	string	任意	仕様。有効な値: opensearch.share.junior: ベーシック opensearch.share.common: 共有汎用 opensearch.share.compute: 共有コンピューティング最適化 opensearch.share.storage: 共有ストレージ最適化 opensearch.private.common: 排他的汎用 opensearch.private.compute: 排他的コンピューティング最適化 opensearch.private.storage: 排他的ストレージ最適化	opensearch.share.common

リクエストボディ

パラメーター	タイプ	必須	例	説明
name	String	はい	"my_app"	アプリケーションの名前。
type	String	はい	"standard"	アプリケーションタイプ。有効な値: standard: Standard Edition enhanced: プレミアムエディション
quota	Object	はい		アプリケーションのクォータ情報。詳細については、「クォータ
chargeType	String	いいえ	"POSTPAY"	課金方法。有効な値: POSTPAY: 従量課金 (デフォルト) PREPAY: サブスクリプション
order	Object	いいえ	{"duration": 1,"pricingCycle": "Year"}	サブスクリプションの詳細。
order.duration	Integer	--	1	サブスクリプション期間。最小値は 0 です。
order.pricingCycle	String	--	"Year"	サブスクリプション期間の単位。有効な値: Year Month
order.autoRenew	Boolean	いいえ	true	自動更新を有効にするかどうかを指定します。このパラメーターは、chargeType パラメーターが PREPAY に設定されている場合にのみ有効です。有効な値: true: 自動更新が有効になります。 false: 自動更新は無効になります。(デフォルト)

レスポンスフィールド

フィールド	型	説明	例
	object	応答本文。
requestId	string	リクエスト ID。	766CF6DB-CA02-3E12-7CBA-6AC21FC978FD
result	object	このパラメーターは空のままです。
created	integer	アプリケーションが作成されたときのタイムスタンプ。	1590139542
currentVersion	string	現在のオンラインバージョンの ID。	100302903
lockMode	string	ロック状態。有効な値: Unlock: インスタンスはロック解除されています。 LockByExpiration: インスタンスは有効期限が切れると自動的にロックされます。 ManualLock: インスタンスは手動でロックされます。	Unlock
updated	integer	アプリケーションが最後に変更されたときのタイムスタンプ。	1590978265
id	string	アプリケーション ID。	100302881
chargeType	string	課金方法。有効な値: POSTPAY: 従量課金 PREPAY: サブスクリプション	POSTPAY
hasPendingQuotaReviewTask	integer	クォータの承認ステータス。有効な値: 0: アプリケーションは正常に実行されています。 1: クォータの変更はレビュー中です。	0
name	string	アプリケーションの名前。	lsh_test_1
instanceId	string	インスタンス ID。	-
chargingWay	integer	課金タイプ。有効な値: 1: 計算リソース 2: クエリ/秒 (QPS)	1
type	string	アプリケーションタイプ。有効な値: standard: Standard Edition advance: プレミアムエディションの古いバージョン。このタイプの新しいアプリケーションは作成できません。 enhanced: プレミアムエディションの新しいバージョン	enhanced
status	string	アプリケーションのステータス。有効な値: producing: アプリケーションは作成中です。 review_pending: アプリケーションはレビュー中です。 config_pending: アプリケーションは設定待ちです。 normal: アプリケーションは正常に実行されています。 frozen: アプリケーションは凍結されています。	normal
projectId	string	A/B テストプロジェクトの名前。	-
switchedTime	integer	現在のオンラインバージョンが公開されたときのタイムスタンプ。	1590486386
commodityCode	string	商品コード。	opensearch
expireOn	string	有効期限。	-
domain	string	業界タイプ。有効な値: GENERAL ECOMMERCE IT_CONTENT	GENERAL
description	string	アプリケーションの説明。	-
produced	integer	アプリケーションが作成されたかどうかを示します。有効な値: 0: アプリケーションは作成中です。 1: アプリケーションは作成されました。	1
quota	object	アプリケーションのクォータ情報。
spec	string	仕様。有効な値: opensearch.share.junior: ベーシック opensearch.share.common: 共有汎用 opensearch.share.compute: 共有コンピューティング最適化 opensearch.share.storage: 共有ストレージ最適化 opensearch.private.common: 排他的汎用 opensearch.private.compute: 排他的コンピューティング最適化 opensearch.private.storage: 排他的ストレージ最適化	opensearch.share.common
docSize	integer	ストレージ容量。単位: GB。	1
computeResource	integer	計算リソース。単位: LCU。	20
engineType	string	エンジンタイプ。	ha3

例

成功レスポンス

JSONJSON

{
  "requestId": "766CF6DB-CA02-3E12-7CBA-6AC21FC978FD",
  "result": {
    "created": 1590139542,
    "currentVersion": "100302903",
    "lockMode": "Unlock",
    "updated": 1590978265,
    "id": "100302881",
    "chargeType": "POSTPAY",
    "hasPendingQuotaReviewTask": 0,
    "name": "lsh_test_1",
    "instanceId": "-",
    "chargingWay": 1,
    "type": "enhanced",
    "status": "normal",
    "projectId": "-",
    "switchedTime": 1590486386,
    "commodityCode": "opensearch",
    "expireOn": "-",
    "domain": "GENERAL",
    "description": "-",
    "produced": 1,
    "quota": {
      "spec": "opensearch.share.common",
      "docSize": 1,
      "computeResource": 20
    },
    "engineType": "ha3"
  }
}

エラーコード

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

変更履歴

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