UpdateInstance によるインスタンス構成の変更 - OpenSearch

操作説明

メソッド

PUT

URI

/openapi/ha3/instances/{instanceId}

今すぐお試しください

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

update

*Instance

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

なし

リクエスト構文

PUT /openapi/ha3/instances/{instanceId} HTTP/1.1

パスパラメーター

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディ。	{}
components	array<object>	任意	インスタンスの仕様に関する情報。
	object	任意	リクエストボディ。
code	string	任意	仕様のコード。購入ページで指定した値と一致している必要があります。	searcherdocsizesum
value	string	任意	仕様の値。	200
orderType	string	任意	注文のタイプ。有効な値：UPGRADE および DOWNGRADE。UPGRADE はインスタンスの仕様をスペックアップします。DOWNGRADE はインスタンスの仕様をスペックダウンします。	UPGRAGE
description	string	任意	インスタンスの説明。	实例描述

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
result	object	返された結果。
description	string	インスタンスの説明。	测试实例
resourceGroupId	string	リソースグループの ID。	ha-cn-pl32rf0****
expiredTime	string	インスタンスの有効期限が切れる時間。	2019-01-06T16:00:00.0
commodityCode	string	インスタンスの商品コード。	opensearch_ha3post_public_cn
status	string	インスタンスのステータス。	READY
instanceId	string	インスタンス ID。	ha-cn-pl32rf0****
createTime	string	インスタンスが作成された時間。	2018-12-06T11:17:49.0
lockMode	string	ロックステータス。	Unlock
chargeType	string	課金方法。	POSTPAY
updateTime	string	インスタンスが最後に更新された時間。	2018-12-06T11:17:49.0
inDebt	boolean	支払い遅延があるかどうかを示します。	false
requestId	string	リクエスト ID。	90D6B8F5-FE97-4509-9AAB-367836C51818

例

成功レスポンス

JSONJSON

{
  "result": {
    "description": "测试实例",
    "resourceGroupId": "ha-cn-pl32rf0****",
    "expiredTime": "2019-01-06T16:00:00.0",
    "commodityCode": "opensearch_ha3post_public_cn",
    "status": "READY",
    "instanceId": "ha-cn-pl32rf0****",
    "createTime": "2018-12-06T11:17:49.0",
    "lockMode": "Unlock",
    "chargeType": "POSTPAY",
    "updateTime": "2018-12-06T11:17:49.0",
    "inDebt": false
  },
  "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"
}

エラーコード

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

変更履歴

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