mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-03-09 14:38:01 +00:00
* Added second paragraph to Stack traces option Signed-off-by: carolxob <carolxob@amazon.com> * Update _opensearch/common-parameters.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _opensearch/common-parameters.md * Update common-parameters.md Signed-off-by: carolxob <carolxob@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
1.5 KiB
1.5 KiB
layout | title | nav_order |
---|---|---|
default | Common REST Parameters | 93 |
Common REST parameters
OpenSearch supports the following parameters for all REST operations:
Option | Description | Example |
---|---|---|
Human-readable output | To convert output units to human-readable values (for example, 1h for 1 hour and 1kb for 1,024 bytes), add ?human=true to the request URL. |
GET <index_name>/_search?human=true |
Pretty result | To get back JSON responses in a readable format, add ?pretty=true to the request URL. |
GET <index_name>/_search?pretty=true |
Content type | To specify the type of content in the request body, use the Content-Type key name in the request header. Most operations support JSON, YAML, and CBOR formats. |
POST _scripts/<template_name> -H 'Content-Type: application/json |
Request body in query string | If the client library does not accept a request body for non-POST requests, use the source query string parameter to pass the request body. Also, specify the source_content_type parameter with a supported media type such as application/json . |
GET _search?source_content_type=application/json&source={"query":{"match_all":{}}} |
Stack traces | To include the error stack trace in the response when an exception is raised, add error_trace=true to the request URL. When the configuration setting http.detailed_errors.enabled is set to false in opensearch.yml, error_trace=true will not contain a detailed error message. |
GET <index_name>/_search?error_trace=true |