ModifyAppGroup API でアプリグループバージョンとクォータを更新 - 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:ModifyAppGroup

update

*AppGroup

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

なし

リクエスト構文

PUT /v4/openapi/app-groups/{appGroupIdentity} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーションの名前です。	my_app_group_name

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディです。
description	string	任意	アプリケーショングループの説明です。	"实例描述"
currentVersion	string	任意	アプリケーションのオンラインバージョンです。	1223232
domain	string	任意	業界。有効な値: general: 一般。 ecommerce: eコマース。 education: 教育。 esports: ゲーム。 community: コンテンツコミュニティ。	"ecommerce"
resourceGroupId	string	任意	インスタンスが属するリソースグループの ID です。	rg-****
dryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true および false。	true

リクエストボディ

パラメーター	タイプ	必須	例	説明
chargingWay	Integer	いいえ	1	課金モデル。 - 1: 計算リソース。 - 2: クエリ/秒 (QPS)。
description	String	いいえ	"my_first_app"	アプリケーションの説明です。
currentVersion	Integer	いいえ	12345678	アプリケーションバージョンの ID です。

注: この操作は、アプリケーションのオンラインバージョンの設定を優先します。リクエストに `currentVersion` パラメーターを含めると、他のパラメーターは無視されます。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディです。	{}
requestId	string	リクエスト ID です。	D77D0DAF-790D-F5F5-A9C0-133738165014
result	object	返されたデータです。	{}
created	integer	アプリケーションが作成されたときの UNIX タイムスタンプです。	159013954
currentVersion	string	現在のオンラインバージョンの ID です。	100302903
lockMode	string	インスタンスのロックモード。有効な値: Unlock: インスタンスはロックされていません。 LockByExpiration: インスタンスは有効期限が切れると自動的にロックされます。 ManualLock: インスタンスは手動でロックされます。	Unlock
updated	integer	アプリケーションが最後に変更されたときの UNIX タイムスタンプです。	1590978265
id	string	アプリケーション ID です。	100302881
chargeType	string	課金方法。有効な値: POSTPAY: 従量課金。 PREPAY: サブスクリプション。	POSTPAY
hasPendingQuotaReviewTask	integer	クォータの承認ステータス。有効な値: 0: 通常。 1: 承認中。	0
name	string	アプリケーションの名前です。	lsh_test_1
instanceId	string	インスタンス ID です。	10030288
chargingWay	integer	課金項目。有効な値: 1: 計算リソース。 2: QPS。	1
type	string	アプリケーションのタイプ。有効な値: standard: Standard Edition アプリケーション。 advance: 旧バージョンの Advanced Edition アプリケーション。新しいアプリケーションではこのタイプはサポートされていません。 enhanced: Enhanced Edition アプリケーション。	enhanced
status	string	アプリケーションのステータス。有効な値: producing: アプリケーションは作成中です。 review_pending: アプリケーションはレビュー中です。 config_pending: アプリケーションには構成が必要です。 normal: アプリケーションは実行中です。 frozen: アプリケーションは凍結されています。	normal
projectId	string	A/B テストプロジェクトの名前です。	1
switchedTime	integer	現在のオンラインバージョンが公開されたときの UNIX タイムスタンプです。	1590486386
commodityCode	string	商品コードです。	opensearch
expireOn	string	有効期限です。	1
domain	string	業界。有効な値: GENERAL: 一般。 ECOMMERCE: eコマース。 IT_CONTENT: IT コンテンツ。	GENERAL
description	string	アプリケーションの説明です。	1
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
resourceGroupId	string	インスタンスが属するリソースグループの ID です。	rg-acfmoiyerh6nzly

例

成功レスポンス

JSONJSON

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 159013954,
    "currentVersion": "100302903",
    "lockMode": "Unlock",
    "updated": 1590978265,
    "id": "100302881",
    "chargeType": "POSTPAY",
    "hasPendingQuotaReviewTask": 0,
    "name": "lsh_test_1",
    "instanceId": "10030288",
    "chargingWay": 1,
    "type": "enhanced",
    "status": "normal",
    "projectId": "1",
    "switchedTime": 1590486386,
    "commodityCode": "opensearch",
    "expireOn": "1",
    "domain": "GENERAL",
    "description": "1",
    "produced": 1,
    "quota": {
      "spec": "opensearch.share.common",
      "docSize": 1,
      "computeResource": 20
    },
    "engineType": "ha3",
    "resourceGroupId": "rg-acfmoiyerh6nzly"
  }
}

エラーコード

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

変更履歴

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