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

Update mappings-api.md (#4692) 

Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
This commit is contained in:
kolchfa-aws 2023-08-03 20:04:58 -04:00 committed by GitHub
parent 96a9ecc9a1
commit c0f7315158
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
_security-analytics/api-tools/mappings-api.md
View File

@ -12,19 +12,18 @@ The following APIs can be used for a number of tasks related to mappings, from c
--- ---
## Get Mappings View ## Get Mappings View
This API returns a view of the fields contained in an index used as a log source.
this API returns a view of the fields contained in an index used as a log source.
### Request fields ### Request fields
The following fields are used to get field mappings. The following fields are used to get field mappings.
Field | Type | Description Field | Type | Description
:--- | :--- |:--- | :--- | :--- |:---
| `index_name` | String | The name of the index used for log ingestion. | `index_name` | String | The name of the index used for log ingestion.
| `rule_topic` | String | The log type of the index. | `rule_topic` | String | The log type of the index.
### Example request #### Example request
```json ```json
GET /_plugins/_security_analytics/mappings/view GET /_plugins/_security_analytics/mappings/view
@ -35,7 +34,7 @@ GET /_plugins/_security_analytics/mappings/view
} }
``` ```
### Example response #### Example response
```json ```json
{ {
@ -79,7 +78,7 @@ GET /_plugins/_security_analytics/mappings/view
--- ---
## Create Mappings ## Create Mappings
### Example request #### Example request
```json ```json
POST /_plugins/_security_analytics/mappings POST /_plugins/_security_analytics/mappings
@ -99,7 +98,7 @@ POST /_plugins/_security_analytics/mappings
} }
``` ```
### Example response #### Example response
```json ```json
{ {
@ -110,13 +109,13 @@ POST /_plugins/_security_analytics/mappings
--- ---
## Get Mappings ## Get Mappings
### Example request #### Example request
```json ```json
GET /_plugins/_security_analytics/mappings GET /_plugins/_security_analytics/mappings
``` ```
### Example response #### Example response
```json ```json
{ {
@ -140,7 +139,7 @@ GET /_plugins/_security_analytics/mappings
--- ---
## Update Mappings ## Update Mappings
### Example request #### Example request
```json ```json
PUT /_plugins/_security_analytics/mappings PUT /_plugins/_security_analytics/mappings
@ -152,7 +151,7 @@ PUT /_plugins/_security_analytics/mappings
} }
``` ```
### Example response #### Example response
```json ```json
{ {