すべてのプロダクト
Search

このプロダクト

    :ModifyClusterOfflineConfig

    ドキュメントセンター

    :ModifyClusterOfflineConfig

    最終更新日:Dec 24, 2025

    クラスターの設定情報を変更します。

    操作説明

    リクエスト構文

    PUT /openapi/ha3/instances/{instanceId}/cluster-offline-config

    今すぐお試しください

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

    update

    *Instance

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

    		 なし なし

    リクエスト構文

    PUT /openapi/ha3/instances/{instanceId}/cluster-offline-config HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    ha-cn-pl32rf0****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    body

    object

    任意

    リクエストボディ。

    {}
    dataSourceName

    string

    任意

    データソース名。

    ha-cn-pl32rf0****_test_api
    dataSourceType

    string

    任意

    データソースのタイプ。有効な値：odps (MaxCompute)、swift (Swift)、unKnow (不明なタイプ)。

    odps
    domain

    string

    任意

    データソースがデプロイされているデータセンター。

    vpc_hz_domain_1
    config

    object

    任意

    キーとして保存される設定名。

    integer

    任意

    値として保存される設定バージョン。

    1
    partition

    string

    任意

    MaxCompute データソース内の完全データのインデックス構築がトリガーされる場合、このパラメーターは必須です。

    ds=20211202
    dataTimeSec

    integer

    任意

    API データソースを使用したインデックス構築がトリガーされる場合、このパラメーターは必須です。

    1640867288
    buildMode

    string

    任意

    インデックス再作成のメソッド。有効な値：api (API データソース)、indexRecover (インデックスを使用したデータ復元)。

    indexRecover
    generation

    integer

    任意

    完全なインデックスバージョンの ID。

    160142641
    pushMode

    string

    任意

    設定のプッシュモード。デフォルトでは、設定のみがプッシュされます。

    PUSH_ONLY
    パラメーター必須タイプ説明
    dataSourceはいStringデータソース名。
    domainはいStringデータソースがデプロイされているドメイン。
    indexesはいObjectインデックス構造の説明。
    advancedConfigVersionIdはいInteger詳細設定バージョンの ID。
    triggerBuildはいbooleanこのパラメーターを true に設定すると、設定がプッシュされ、インデックスの再作成がトリガーされます。false に設定すると、設定は次回のインデックス再作成後に有効になります。
    buildModeいいえIntegerインデックス再作成のモード。api はデフォルトモードを示し、indexRecover はインデックスを使用してデータソースが復元されることを示します。このパラメーターは、データソースが HDFS タイプの場合にのみ必須です。
    generationいいえLongデータ復元バージョン。
    partitionいいえStringインデックス再作成のために選択されたデータソースのデータパーティション。odps データソースのインデックス再作成がトリガーされる場合、このパラメーターは必須です。
    dataTimeSecいいえIntegerAPI プッシュデータソースのインデックス再作成がトリガーされる時間。このパラメーターの値は秒単位で正確である必要があります。API プッシュデータソースのインデックス再作成がトリガーされる場合、このパラメーターは必須です。
    dataSourceTypeいいえEnumtriggerBuild パラメーターが true に設定されている場合、このパラメーターは必須です。有効な値：odps および swift。

    リクエスト例

    PUT /openapi/ha3/instances/ha3_instance_name/cluster-offline-config

    {
    "dataSource": "test1",
    "domain": "xx",
    "indexes": [
        {
            "name": "index1",
            "versionId": 1
        },
        {
            "name": "index2",
            "versionId": 1
        }
    ],
    "advancedConfigVersionId": 2,
    "triggerBuild": true,
    "partition": "20201010", // odps データソースのインデックス再作成がトリガーされる場合、このパラメーターは必須です。
    "dataSourceType": "odps", // このパラメーターは必須です。odps または swift に設定してください。このパラメーターを設定しない場合、エラーメッセージが返されます。
    "dataTimeSec": 1640867288 // このパラメーターは、API プッシュデータソースのインデックス再作成がトリガーされる時間を指定します。このパラメーターの値は秒単位で正確である必要があります。API プッシュデータソースのインデックス再作成がトリガーされる場合、このパラメーターは必須です。
  
}

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ

    requestId

    string

    リクエスト ID

    E7B7D598-B080-5C8E-AA35-D43EC0D5F886
    result

    object

    結果

    {}

    レスポンス例

    {
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": []
}

    詳細については、「レスポンス構造」をご参照ください。

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {}
}

    エラーコード

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

    変更履歴

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