ModifyPausePolicy API でインスタンスのスケジューリングを制御する - OpenSearch

操作説明

メソッド

PUT

URI

/openapi/ha3/instances/{instanceId}/pause-policies

今すぐお試しください

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

update

*Instance

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

なし

リクエスト構文

PUT /openapi/ha3/instances/{instanceId}/pause-policies HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	ha-cn-pl32rf0****
body	object	任意	リクエストボディ。
	object	任意	リクエストボディ。
pauseAll	boolean	任意	すべてのデプロイメントを一時停止します。	true
pauseIndex	boolean	任意	新しいフルインデックスバージョンのデプロイメントを一時停止します。	true
pauseIndexBatch	boolean	任意	増分バッチのデプロイメントを一時停止します。	true
pauseBiz	boolean	任意	構成のデプロイメントを一時停止します。	true
pauseRuntime	boolean	任意	リアルタイムの増分更新を一時停止します。	true

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID。	0B1FF998-BB8D-5182-BFC0-E471AA77095A
result	object	返されたデータ。	{}

例

成功レスポンス

JSONJSON

{
  "requestId": "0B1FF998-BB8D-5182-BFC0-E471AA77095A",
  "result": {}
}

エラーコード

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

変更履歴

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