Skip to content

Commit 6995410

Browse files
replace api links (#432)
1 parent b85ff6e commit 6995410

File tree

48 files changed

+199
-199
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+199
-199
lines changed

manage-data/data-store/aliases.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Aliases enable you to:
1111

1212
* Query multiple indices/data streams together with a single name
1313
* Change which indices/data streams your application uses in real time
14-
* [Reindex](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html) data without downtime
14+
* [Reindex](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex) data without downtime
1515

1616

1717
## Alias types [alias-types]
@@ -26,7 +26,7 @@ An alias cannot point to both data streams and indices. You also cannot add a da
2626

2727
## Add an alias [add-alias]
2828

29-
To add an existing data stream or index to an alias, use the [aliases API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html)'s `add` action. If the alias doesn’t exist, the request creates it.
29+
To add an existing data stream or index to an alias, use the [aliases API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases)'s `add` action. If the alias doesn’t exist, the request creates it.
3030

3131
```console
3232
POST _aliases
@@ -169,7 +169,7 @@ Allowing the action list to succeed partially may not provide the desired result
169169

170170
## Add an alias at index creation [add-alias-at-creation]
171171

172-
You can also use a [component](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html) or [index template](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-template.html) to add index or data stream aliases when they are created.
172+
You can also use a [component](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template) or [index template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template) to add index or data stream aliases when they are created.
173173

174174
```console
175175
# Component template with index aliases
@@ -201,7 +201,7 @@ PUT _index_template/my-index-template
201201
}
202202
```
203203

204-
You can also specify index aliases in [create index API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html) requests.
204+
You can also specify index aliases in [create index API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create) requests.
205205

206206
```console
207207
# PUT <my-index-{now/d}-000001>
@@ -216,7 +216,7 @@ PUT %3Cmy-index-%7Bnow%2Fd%7D-000001%3E
216216

217217
## View aliases [view-aliases]
218218

219-
To get a list of your cluster’s aliases, use the [get alias API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-alias.html) with no argument.
219+
To get a list of your cluster’s aliases, use the [get alias API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias) with no argument.
220220

221221
```console
222222
GET _alias
@@ -306,7 +306,7 @@ POST _aliases
306306
```
307307

308308
::::{note}
309-
Filters are only applied when using the [Query DSL](../../explore-analyze/query-filter/languages/querydsl.md), and are not applied when [retrieving a document by ID](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html).
309+
Filters are only applied when using the [Query DSL](../../explore-analyze/query-filter/languages/querydsl.md), and are not applied when [retrieving a document by ID](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get).
310310
::::
311311

312312

manage-data/data-store/index-types/downsampling-time-series-data-stream.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Fields in the target, downsampled index are created based on fields in the origi
7474

7575
## Running downsampling on time series data [running-downsampling]
7676

77-
To downsample a time series index, use the [Downsample API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-downsample-data-stream.html) and set `fixed_interval` to the level of granularity that you’d like:
77+
To downsample a time series index, use the [Downsample API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample) and set `fixed_interval` to the level of granularity that you’d like:
7878

7979
```console
8080
POST /my-time-series-index/_downsample/my-downsampled-time-series-index
@@ -105,7 +105,7 @@ PUT _ilm/policy/my_policy
105105

106106
## Querying downsampled indices [querying-downsampled-indices]
107107

108-
You can use the [`_search`](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html) and [`_async_search`](https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html) endpoints to query a downsampled index. Multiple raw data and downsampled indices can be queried in a single request, and a single request can include downsampled indices at different granularities (different bucket timespan). That is, you can query data streams that contain downsampled indices with multiple downsampling intervals (for example, `15m`, `1h`, `1d`).
108+
You can use the [`_search`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search) and [`_async_search`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit) endpoints to query a downsampled index. Multiple raw data and downsampled indices can be queried in a single request, and a single request can include downsampled indices at different granularities (different bucket timespan). That is, you can query data streams that contain downsampled indices with multiple downsampling intervals (for example, `15m`, `1h`, `1d`).
109109

110110
The result of a time based histogram aggregation is in a uniform bucket size and each downsampled index returns data ignoring the downsampling time interval. For example, if you run a `date_histogram` aggregation with `"fixed_interval": "1m"` on a downsampled index that has been downsampled at an hourly resolution (`"fixed_interval": "1h"`), the query returns one bucket with all of the data at minute 0, then 59 empty buckets, and then a bucket with data again for the next hour.
111111

manage-data/data-store/index-types/modify-data-stream.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ To add a mapping for a new field to a data stream, following these steps:
5555

5656
1. Adds a mapping for the new `message` field.
5757

58-
2. Use the [update mapping API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html) to add the new field mapping to the data stream. By default, this adds the mapping to the stream’s existing backing indices, including the write index.
58+
2. Use the [update mapping API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping) to add the new field mapping to the data stream. By default, this adds the mapping to the stream’s existing backing indices, including the write index.
5959

6060
The following update mapping API request adds the new `message` field mapping to `my-data-stream`.
6161

@@ -89,7 +89,7 @@ To add a mapping for a new field to a data stream, following these steps:
8989

9090
### Change an existing field mapping in a data stream [change-existing-field-mapping-in-a-data-stream]
9191

92-
The documentation for each [mapping parameter](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-params.html) indicates whether you can update it for an existing field using the [update mapping API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html). To update these parameters for an existing field, follow these steps:
92+
The documentation for each [mapping parameter](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-params.html) indicates whether you can update it for an existing field using the [update mapping API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping). To update these parameters for an existing field, follow these steps:
9393

9494
1. Update the index template used by the data stream. This ensures the updated field mapping is added to future backing indices created for the stream.
9595

@@ -122,9 +122,9 @@ The documentation for each [mapping parameter](https://www.elastic.co/guide/en/e
122122

123123
1. Changes the `host.ip` field’s `ignore_malformed` value to `true`.
124124

125-
2. Use the [update mapping API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html) to apply the mapping changes to the data stream. By default, this applies the changes to the stream’s existing backing indices, including the write index.
125+
2. Use the [update mapping API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping) to apply the mapping changes to the data stream. By default, this applies the changes to the stream’s existing backing indices, including the write index.
126126

127-
The following [update mapping API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html) request targets `my-data-stream`. The request changes the argument for the `host.ip` field’s `ignore_malformed` mapping parameter to `true`.
127+
The following [update mapping API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping) request targets `my-data-stream`. The request changes the argument for the `host.ip` field’s `ignore_malformed` mapping parameter to `true`.
128128

129129
```console
130130
PUT /my-data-stream/_mapping
@@ -194,7 +194,7 @@ To change a [dynamic index setting](https://www.elastic.co/guide/en/elasticsearc
194194

195195
1. Changes the `index.refresh_interval` setting to `30s` (30 seconds).
196196

197-
2. Use the [update index settings API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html) to update the index setting for the data stream. By default, this applies the setting to the stream’s existing backing indices, including the write index.
197+
2. Use the [update index settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings) to update the index setting for the data stream. By default, this applies the setting to the stream’s existing backing indices, including the write index.
198198

199199
The following update index settings API request updates the `index.refresh_interval` setting for `my-data-stream`.
200200

@@ -209,14 +209,14 @@ To change a [dynamic index setting](https://www.elastic.co/guide/en/elasticsearc
209209

210210

211211
::::{important}
212-
To change the `index.lifecycle.name` setting, first use the [remove policy API](https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html) to remove the existing {{ilm-init}} policy. See [Switch lifecycle policies](../../lifecycle/index-lifecycle-management/configure-lifecycle-policy.md#switch-lifecycle-policies).
212+
To change the `index.lifecycle.name` setting, first use the [remove policy API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-remove-policy) to remove the existing {{ilm-init}} policy. See [Switch lifecycle policies](../../lifecycle/index-lifecycle-management/configure-lifecycle-policy.md#switch-lifecycle-policies).
213213
::::
214214

215215

216216

217217
### Change a static index setting for a data stream [change-static-index-setting-for-a-data-stream]
218218

219-
[Static index settings](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings) can only be set when a backing index is created. You cannot update static index settings using the [update index settings API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html).
219+
[Static index settings](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings) can only be set when a backing index is created. You cannot update static index settings using the [update index settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings).
220220

221221
To apply a new static setting to future backing indices, update the index template used by the data stream. The setting is automatically applied to any backing index created after the update.
222222

@@ -319,7 +319,7 @@ Follow these steps:
319319
2. Adds the `sort.field` index setting.
320320
3. Adds the `sort.order` index setting.
321321

322-
3. Use the [create data stream API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-data-stream.html) to manually create the new data stream. The name of the data stream must match the index pattern defined in the new template’s `index_patterns` property.
322+
3. Use the [create data stream API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream) to manually create the new data stream. The name of the data stream must match the index pattern defined in the new template’s `index_patterns` property.
323323

324324
We do not recommend [indexing new data to create this data stream](set-up-data-stream.md#create-data-stream). Later, you will reindex older data from an existing data stream into this new stream. This could result in one or more backing indices that contains a mix of new and old data.
325325

@@ -341,7 +341,7 @@ Follow these steps:
341341
4. If you do not want to mix new and old data in your new data stream, pause the indexing of new documents. While mixing old and new data is safe, it could interfere with data retention. See [Mixing new and old data in a data stream](modify-data-stream.md#data-stream-mix-new-old-data).
342342
5. If you use {{ilm-init}} to [automate rollover](../../lifecycle/index-lifecycle-management/tutorial-automate-rollover.md), reduce the {{ilm-init}} poll interval. This ensures the current write index doesn’t grow too large while waiting for the rollover check. By default, {{ilm-init}} checks rollover conditions every 10 minutes.
343343

344-
The following [cluster update settings API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html) request lowers the `indices.lifecycle.poll_interval` setting to `1m` (one minute).
344+
The following [cluster update settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings) request lowers the `indices.lifecycle.poll_interval` setting to `1m` (one minute).
345345

346346
```console
347347
PUT /_cluster/settings
@@ -354,7 +354,7 @@ Follow these steps:
354354

355355
6. Reindex your data to the new data stream using an `op_type` of `create`.
356356

357-
If you want to partition the data in the order in which it was originally indexed, you can run separate reindex requests. These reindex requests can use individual backing indices as the source. You can use the [get data stream API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-data-stream.html) to retrieve a list of backing indices.
357+
If you want to partition the data in the order in which it was originally indexed, you can run separate reindex requests. These reindex requests can use individual backing indices as the source. You can use the [get data stream API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream) to retrieve a list of backing indices.
358358

359359
For example, you plan to reindex data from `my-data-stream` into `new-data-stream`. However, you want to submit a separate reindex request for each backing index in `my-data-stream`, starting with the oldest backing index. This preserves the order in which the data was originally indexed.
360360

@@ -406,7 +406,7 @@ Follow these steps:
406406
1. First item in the `indices` array for `my-data-stream`. This item contains information about the stream’s oldest backing index, `.ds-my-data-stream-2099.03.07-000001`.
407407

408408

409-
The following [reindex API](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html) request copies documents from `.ds-my-data-stream-2099.03.07-000001` to `new-data-stream`. The request’s `op_type` is `create`.
409+
The following [reindex API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex) request copies documents from `.ds-my-data-stream-2099.03.07-000001` to `new-data-stream`. The request’s `op_type` is `create`.
410410

411411
```console
412412
POST /_reindex
@@ -423,7 +423,7 @@ Follow these steps:
423423

424424
You can also use a query to reindex only a subset of documents with each request.
425425

426-
The following [reindex API](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html) request copies documents from `my-data-stream` to `new-data-stream`. The request uses a [`range` query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html) to only reindex documents with a timestamp within the last week. Note the request’s `op_type` is `create`.
426+
The following [reindex API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex) request copies documents from `my-data-stream` to `new-data-stream`. The request uses a [`range` query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html) to only reindex documents with a timestamp within the last week. Note the request’s `op_type` is `create`.
427427

428428
```console
429429
POST /_reindex
@@ -462,7 +462,7 @@ Follow these steps:
462462
8. Resume indexing using the new data stream. Searches on this stream will now query your new data and the reindexed data.
463463
9. Once you have verified that all reindexed data is available in the new data stream, you can safely remove the old stream.
464464

465-
The following [delete data stream API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-data-stream.html) request deletes `my-data-stream`. This request also deletes the stream’s backing indices and any data they contain.
465+
The following [delete data stream API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream) request deletes `my-data-stream`. This request also deletes the stream’s backing indices and any data they contain.
466466

467467
```console
468468
DELETE /_data_stream/my-data-stream
@@ -472,7 +472,7 @@ Follow these steps:
472472

473473
## Update or add an alias to a data stream [data-streams-change-alias]
474474

475-
Use the [aliases API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html) to update an existing data stream’s aliases. Changing an existing data stream’s aliases in its index pattern has no effect.
475+
Use the [aliases API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases) to update an existing data stream’s aliases. Changing an existing data stream’s aliases in its index pattern has no effect.
476476

477477
For example, the `logs` alias points to a single data stream. The following request swaps the stream for the alias. During this swap, the `logs` alias has no downtime and never points to both streams at the same time.
478478

manage-data/data-store/index-types/run-downsampling-manually.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ This returns:
349349

350350
Before a backing index can be downsampled, the TSDS needs to be rolled over and the old index needs to be made read-only.
351351

352-
Roll over the TSDS using the [rollover API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html):
352+
Roll over the TSDS using the [rollover API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover):
353353

354354
```console
355355
POST /my-data-stream/_rollover/
@@ -363,7 +363,7 @@ The old index needs to be set to read-only mode. Run the following request:
363363
PUT /.ds-my-data-stream-2023.07.26-000001/_block/write
364364
```
365365

366-
Next, use the [downsample API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-downsample-data-stream.html) to downsample the index, setting the time series interval to one hour:
366+
Next, use the [downsample API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample) to downsample the index, setting the time series interval to one hour:
367367

368368
```console
369369
POST /.ds-my-data-stream-2023.07.26-000001/_downsample/.ds-my-data-stream-2023.07.26-000001-downsample
@@ -372,7 +372,7 @@ POST /.ds-my-data-stream-2023.07.26-000001/_downsample/.ds-my-data-stream-2023.0
372372
}
373373
```
374374

375-
Now you can [modify the data stream](https://www.elastic.co/guide/en/elasticsearch/reference/current/modify-data-streams-api.html), and replace the original index with the downsampled one:
375+
Now you can [modify the data stream](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-modify-data-stream), and replace the original index with the downsampled one:
376376

377377
```console
378378
POST _data_stream/_modify

0 commit comments

Comments
 (0)