すべてのプロダクト
Search

このプロダクト

    OpenSearch:UpdateFunctionInstance

    ドキュメントセンター

    OpenSearch:UpdateFunctionInstance

    最終更新日:Nov 24, 2025

    関数インスタンスの構成を更新します。

    今すぐお試しください

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

    update

    *FunctionInstance

    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

    		 なし なし

    リクエスト構文

    PUT /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    appGroupIdentity

    string

    必須

    OpenSearch アプリケーションの名前です。

    "app_group_name"
    functionName

    string

    必須

    機能の名前です。

    "ctr"
    instanceName

    string

    必須

    インスタンスの名前です。

    "ctr_test"

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Body

    object

    任意

    リクエストボディです。

    {}
    cron

    string

    任意

    定期的なトレーニングのスケジュールです。値は、`分 時 日 月 曜日` の形式の cron 式である必要があります。このパラメーターを空のままにすると、定期的なトレーニングはデフォルトで無効になります。曜日については、0 は日曜日を示します。

    "0 3 ? * 0,1,3,5"
    createParameters

    array<object>

    任意

    作成パラメーターのリストです。

    { "name": "title_field", "value": "title" }

    object

    任意

    パラメーターの詳細です。

    {}
    name

    string

    任意

    パラメーターの名前です。

    title_field
    value

    string

    任意

    パラメーターの値です。

    title
    usageParameters

    array<object>

    任意

    使用パラメーターのリストです。

    object

    任意

    パラメーターの詳細です。

    name

    string

    任意

    パラメーターの名前です。

    allow_dict_id
    value

    string

    任意

    パラメーターの値です。

    123
    description

    string

    任意

    インスタンスの説明です。

    测试实例

    例: createParameters と cron のみを更新する

    PUT /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test

    {
    "createParameters": [
        {
            "name": "param1",
            "value": "new value"
        }
    ],
    "cron": ""
}

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    {}
    Status

    string

    リクエストのステータスです。

    • OK: リクエストは成功しました。


    • FAIL: リクエストは失敗しました。

    OK
    HttpCode

    integer

    HTTP ステータスコードです。

    200
    RequestId

    string

    リクエストの ID です。

    "3A809095-C554-5CF5-8FCE-BE19D4673790"
    Message

    string

    エラーメッセージです。

    "instance not exist."
    Code

    string

    エラーコードです。

    "Instance.NotExist"
    Latency

    integer

    リクエストが消費した時間です。単位: ミリ秒 (ms)。

    10

    例

    成功レスポンス

    JSONJSON

    {
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "\"3A809095-C554-5CF5-8FCE-BE19D4673790\"",
  "Message": "\"instance not exist.\"",
  "Code": "\"Instance.NotExist\"",
  "Latency": 10
}

    エラーコード

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

    変更履歴

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