Debugging
Authorization information
Request syntax
PUT /openapi/ha3/instances/{instanceId}/indexes/{indexName}
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| instanceId | string | Yes | The instance ID. | ha-cn-0ju2rq6610a |
| indexName | string | Yes | The index name. | test_api |
| dryRun | boolean | No | Specifies whether to check the validity of input parameters. Default value: false. Valid values:
| true |
| body | object | No | The request body. | |
| dataSourceInfo | object | No | The information about the data source, which is required for the new version of OpenSearch Vector Search Edition. | |
| buildMode | string | No | The reindexing method. Valid values: api: API data source. indexRecover: data recovery by using indexing. | api |
| generation | long | No | The ID of the index version from which data is restored. | 4 |
| dataTimeSec | integer | No | The start timestamp from which incremental data is retrieved. | 1709715164 |
| processPartitionCount | integer | No | The number of resources used for data update. | 4 |
| name | string | No | The name of the data source. | ha-cn-35t3n1yuj0d_index_1 |
| type | string | No | The type of the data source. Valid values: odps, swift, saro, oss, and unKnow. | odps |
| domain | string | No | The offline deployment name of the data source. | vpc_hz_domain_1 |
| config | object | No | The configurations of the MaxCompute data source. | |
| endpoint | string | No | The endpoint of the MaxCompute data source. | http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api |
| accessKey | string | No | The AccessKey ID of the MaxCompute data source. | L***p |
| accessSecret | string | No | The AccessKey secret of the MaxCompute data source. | 5**9a6 |
| project | string | No | The name of the MaxCompute project that is used as the data source. | bbt_algo_pai |
| partition | string | No | The partition in the MaxCompute table. Example: ds=20180102. | ds=20230114 |
| table | string | No | The name of the MaxCompute table that is used as the data source. | item |
| namespace | string | No | The namespace. This parameter is applicable to the SARO data source used in the intranet of Alibaba Group. | test-namespace |
| path | string | No | The file path in the Apsara File Storage for HDFS file system. | test-hdfs-path |
| ossPath | string | No | The Object Storage Service (OSS) path. | /opensearch/oss.json |
| bucket | string | No | The name of the OSS bucket. | test-bucket |
| saroConfig | object | No | The configurations of the SARO data source. | |
| namespace | string | No | The namespace to which the SARO data source belongs. | flink-test-fjx-default |
| tableName | string | No | The name of the SARO table. | device_event_shy_summary_ |
| autoBuildIndex | boolean | No | Specifies whether to enable the automatic full indexing feature. | true |
| processParallelNum | integer | No | The maximum number of full indexes that can be concurrently processed. | 2 |
| description | string | No | The description of the data source. | test |
| content | string | No | The file content. | {\"summarys\":{\"summary_fields\":[\"id\"]},\"indexs\":[{\"index_name\":\"index_id\",\"index_type\":\"PRIMARYKEY64\",\"index_fields\":\"id\",\"has_primary_key_attribute\":true,\"is_primary_key_sorted\":false}],\"attributes\":[\"id\"],\"fields\":[{\"field_name\":\"id\",\"field_type\":\"UINT16\"}],\"table_name\":\"index_2\"} |
| partition | integer | No | The number of shards. | 2 |
| dataSource | string | No | The name of the data source. | ha-cn-35t3n1yuj0d_index_1 |
| domain | string | No | The name of the data center in which the data source is deployed. | vpc_hz_domain_1 |
| buildParallelNum | integer | No | The maximum number of full indexes that can be concurrently built. | 2 |
| mergeParallelNum | integer | No | The maximum number of full indexes that can be concurrently merged. | 2 |
| cluster | object | No | The cluster information. | |
| object | No | The cluster information. | ||
| object | No | The content to be modified in the configuration file. | ||
| value | string | No | The variable. | partition |
| description | string | No | The description of the variable. | test |
| disableModify | boolean | No | Specifies whether the variable is not allowed to be modified. | true |
| isModify | boolean | No | Specifies whether the variable is modified. | false |
| type | string | No | The variable type. Valid values: NORMAL: common variable. FUNCTION: function variable. | NORMAL |
| clusterConfigName | string | No | The name of the configuration file. | ha-cn-35t3r02iq03@ha-cn-35t3r02iq03_test_api@hz_pre_vpc_domain_1@test_api@index_config_v1 |
| config | object | No | The information about the offline configuration. | |
| object | No | The offline configuration. | ||
| desc | string | No | The description of the offline configuration. | test |
| files | array<object> | No | The files to be modified. | |
| object | No | |||
| operateType | string | No | The operation type. Valid values: UPDATE and DELETE. Default value: UPDATE. | UPDATE |
| parentFullPath | string | No | The path of the parent directory. | / |
| fileName | string | No | The file name. | |
| config | object | No | The configuration to be modified. | |
| content | string | No | The file content. | $dictContent |
| variables | object | No | The variables. | |
| object | No | The variable information. | ||
| description | string | No | The description of the variable. | test |
| disableModify | boolean | No | Specifies whether the variable is not allowed to be modified. | true |
| isModify | boolean | No | Specifies whether the variable is modified. | false |
| type | string | No | The variable type. Valid values: NORMAL: common variable. FUNCTION: function variable. | NORMAL |
| value | string | No | The variable value. | test |
| dirName | string | No | The directory name. | /test |
| pushMode | string | No | The push mode of the configuration. By default, only the configuration is pushed. | PUSH_ONLY |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
"result": "{}"
}Error codes
For a list of error codes, visit the Service error codes.