UpdateSqlInstanceParams API による HA3 インスタンスのチューニン - OpenSearch

SQL インスタンスのパラメーターを更新します。

操作説明

メソッド

PUT

URI

/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/params

今すぐお試しください

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

update

*Instance

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

なし

リクエスト構文

PUT /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/params HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	ha-cn-pl32rf0****
database	string	必須	データベース名。	general
sqlInstanceId	integer	必須	SQL インスタンス ID。	1
body	object	任意	リクエスト本文。
kvpair	object	任意	インスタンスのキー値 (KV) 構成。
	any	任意	インスタンスのキー値 (KV) 構成。	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
dynamicParam	object	任意	動的パラメーター。
	any	任意	動的パラメーター。	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
staticParam	object	任意	静的パラメーター。
	any	任意	静的パラメーター。	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
params	object	任意	変更するパラメーター。
	any	任意	変更するパラメーター。	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
combineParam	object	任意	結合されたパラメーター。
	any	任意	結合されたパラメーター。	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID。	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	object	返された結果。
gmtCreate	string	インスタンスが作成された時間。	1719221186114
gmtModified	string	インスタンスが最後に変更された時間。	1719220182844
instanceId	integer	インスタンス ID。	1
version	integer	バージョン番号。	1
comment	string	コメント。	Confirm and Execute
relatedTemplateId	integer	テンプレート ID。	1
content	string	コンテンツ。	select * from test
kvpairs	string	KV パラメーター。	{\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
dynamicParams	string	動的パラメーター。	{\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
templateParams	string	テンプレートパラメーター。	{\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
staticParams	string	静的パラメーター。	{\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
combineParams	string	結合されたパラメーター。	{\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}

例

成功レスポンス

JSONJSON

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": {
    "gmtCreate": "1719221186114",
    "gmtModified": "1719220182844",
    "instanceId": 1,
    "version": 1,
    "comment": "Confirm and Execute",
    "relatedTemplateId": 1,
    "content": "select * from test",
    "kvpairs": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "dynamicParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "templateParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "staticParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "combineParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}"
  }
}

エラーコード

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

変更履歴

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