BuildIndex - OpenSearch - Alibaba Cloud Documentation Center

Operation description

Method

POST

URI

/openapi/ha3/instances/{instanceId}/actions/build-index

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:BuildIndex

update

*Instance

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

None

Request syntax

POST /openapi/ha3/instances/{instanceId}/actions/build-index HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance.	ha-cn-pl32rf0****
body	object	No	A JSON string. For more information, see the following details.	{}
dataSourceName	string	No	The name of the data source.	ha-cn-pl32rf0****_test_api
domain	string	No	The data center of the data source.	sz_vpc_domain_1
dataSourceType	string	No	The type of the data source.	odps
partition	string	No	Required if dataSourceType is set to odps.	ds=20201010
dataTimeSec	integer	No	The UNIX timestamp in seconds. This parameter is an integer. This parameter is required if data is pushed to the data source using an API.	1640867288
buildMode	string	No	The method to rebuild the index. Valid values: api and indexRecover.	api
generation	integer	No	The backfill ID.	160131146
tag	string	No	The tag of the Data Lake Formation (DLF) data source.	test
path	string	No	The relative path.	/test/dir

Request examples

POST /openapi/ha3/instances/ha3_instance_name/actions/build-index

 {
    "dataSourceName": "my_data_source",
    "domain": "test", // The data source deployment.
    "indexes": [
      "index1",
      "index2"
    ],
    "dataSourceType": "odps", // Required. Valid values: odps and swift.
    "partition": "20201010", // Required if dataSourceType is set to odps.
    "dataTimeSec": 1640867288 // The UNIX timestamp in seconds. This parameter is an integer. Required if data is pushed to the data source using an API.
  }

{
    "dataSourceName": "my_data_source",
    "domain": "test", // The data source deployment.
    "indexes": [
      "index1",
      "index2"
    ],
    "dataSourceType": "swift", // Required. Valid values: odps and swift.
    "partition": "20201010", // Required if dataSourceType is set to odps.
    "dataTimeSec": 1640867288 // The UNIX timestamp in seconds. This parameter is an integer. Required if data is pushed to the data source using an API.
  }

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The ID of the request.	407BFD91-DE7D-50BA-8F88-CDE52A3B5E46
result	object	The returned result.	{}

Response examples

Sample success response

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

For more information, see Response structure.

Examples

Success response

JSON format

{
  "requestId": "407BFD91-DE7D-50BA-8F88-CDE52A3B5E46",
  "result": {}
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.