iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Address Keith's feedback. 

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
This commit is contained in:
Naarcha-AWS 2022-02-07 12:49:43 -06:00
parent d5ef881c56
commit 0b73c7bdb6
5 changed files with 37 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
_opensearch/rest-api/ingest-apis/create-update-ingest.md
View File

@ -13,7 +13,7 @@ The create ingest pipeline API operation creates or updates an ingest pipeline.
## Example
```
PUT _ingest/pipeline/{id}
PUT _ingest/pipeline/12345
{
"description" : "A description for your pipeline",
"processors" : [
@ -34,10 +34,10 @@ PUT _ingest/pipeline/{id}
## Request body fields
Field | Type | Description
:--- | :--- | :---
`description` (optional) | string | Description of your ingest pipeline.
`processors` | processor objects | A processor that transforms documents. Runs in the order specified. Appears in index once ran.
Field | Required | Type | Description
:--- | :--- | :--- | :---
description | Optional | string | Description of your ingest pipeline.
processors | **Required** | Array of processor objects | A processor that transforms documents. Runs in the order specified. Appears in index once ran.
```json
{
@ -55,6 +55,8 @@ Field | Type | Description
## URL parameters
All URL parameters are optional.
Parameter | Type | Description
:--- | :--- | :---
master_timeout | time | How long to wait for a connection to the master node.

11
_opensearch/rest-api/ingest-apis/delete-ingest.md
View File

@ -13,12 +13,21 @@ If you no longer want to use an ingest pipeline, use the delete ingest pipeline
## Example
```
DELETE _ingest/pipeline/{id}
DELETE _ingest/pipeline/12345
```
## Path and HTTP methods
Delete an ingest pipeline based on that pipeline's ID.
```
DELETE _ingest/pipeline/
```
## URL parameters
All URL parameters are optional.
Parameter | Type | Description
:--- | :--- | :---
master_timeout | time | How long to wait for a connection to the master node.

3
_opensearch/rest-api/ingest-apis/get-ingest.md
View File

@ -13,7 +13,7 @@ After you create a pipeline, use the get ingest pipeline API operation to return
## Example
```
GET _ingest/pipeline/{id}
GET _ingest/pipeline/12345
```
## Path and HTTP methods
@ -24,7 +24,6 @@ Return all ingest pipelines.
GET _ingest/pipeline
```
Returns a single ingest pipeline based on the pipeline's ID.
```

4
_opensearch/rest-api/ingest-apis/index.md
View File

@ -10,6 +10,6 @@ redirect_from:
# Ingest APIs
Before you index your data, OpenSearch's ingest APIs help transform your data through the creation of ingest pipelines. Pipelines are made up of processors, a customizable task that run in the order they appear in the request body. The transformed data appears in your data stream or index after each of the processors completes.
Before you index your data, OpenSearch's ingest APIs help transform your data by creating and managing ingest pipelines. Pipelines consist of **processors**, customizable tasks that run in the order they appear in the request body. The transformed data appears in your index after each of the processor completes.
Ingest pipelines in OpenSearch are managed using ingest API operations. In production environments, your cluster should contain at least one node with the node roles permission set to `ingest`. For more information on setting up node roles within a cluster, see [Cluster Formation]({{site.url}}{{site.baseurl}}/cluster/).
Ingest pipelines in OpenSearch can only be managed using ingest API operations. When using ingest in production environments, your cluster should contain at least one node with the node roles permission set to `ingest`. For more information on setting up node roles within a cluster, see [Cluster Formation]({{site.url}}{{site.baseurl}}/opensearch/cluster/).

31
_opensearch/rest-api/ingest-apis/simulate-ingest.md
View File

@ -13,7 +13,7 @@ Simulates an ingest pipeline with any example documents you specify.
## Example
```
POST /_ingest/pipeline/{id}/_simulate
POST /_ingest/pipeline/35678/_simulate
{
"docs": [
{
@ -52,27 +52,31 @@ POST _ingest/pipeline/{id}/_simulate
## URL parameters
All URL parameters are optional.
Parameter | Type | Description
:--- | :--- | :---
verbose | boolean | Verbose mode. Display data output for each processor in executed pipeline.
## Request body fields
Field | Type | Description
:--- | :--- | :---
`pipeline` | object | The pipeline you want to simulate. When included without the pipeline `{id}` inside the request path, the response simulates the last pipeline created.
`docs` | array of objects | The documents you want to use to test the pipeline.
Field | Required | Type | Description
:--- | :--- | :--- | :---
`pipeline` | Optional | object | The pipeline you want to simulate. When included without the pipeline `{id}` inside the request path, the response simulates the last pipeline created.
`docs` | Required | array of objects | The documents you want to use to test the pipeline.
The `docs` field can include the following subfields:
Field | Type | Description
Field | Required | Type | Description
:--- | :--- | :---
`id` (Optional) | string | An optional identifier for the document. The identifier cannot be used elsewhere in the index.
`index` (Optional) | string | The index where the document's transformed data will be stored.
`source` | object | The document's JSON body.
`id` | Optional |string | An optional identifier for the document. The identifier cannot be used elsewhere in the index.
`index` | Optional | string | The index where the document's transformed data appears.
`source` | Required | object | The document's JSON body.
## Response
Responses vary based on on which path and HTTP method you choose.
### Specify pipeline in request body
```json
@ -88,7 +92,7 @@ Field | Type | Description
"field2" : "_value"
},
"_ingest" : {
"timestamp" : "2022-02-03T23:12:11.337706671Z"
"timestamp" : "2022-02-07T18:47:57.479230835Z"
}
}
},
@ -102,15 +106,14 @@ Field | Type | Description
"field2" : "_value"
},
"_ingest" : {
"timestamp" : "2022-02-03T23:12:11.337721296Z"
"timestamp" : "2022-02-07T18:47:57.47933496Z"
}
}
}
]
}
```
### Specify pipeline ID inside path
### Specify pipeline ID inside HTTP path
```json
{
@ -149,7 +152,7 @@ Field | Type | Description
### Receive verbose response
With the `verbose` parameter set to `true`, the response shows how each processor transform the specified document.
With the `verbose` parameter set to `true`, the response shows how each processor transforms the specified document.
```json
{