Overview
Configuration is provided for establishing connections with Elasticsearch service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from the service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Elasticsearch REST API using COZYROC's REST Connection Manager and Basic authentication.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From the drop-down menu Configuration select Elasticsearch. Enter the required parameters in the places shown in the screenshot.
Step 3. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Elasticsearch instance.
In this guide, we will show how to read data from the Elasticsearch service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Elasticsearch connection from the combo. Select from available Elasticsearch resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Elasticsearch resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Elasticsearch service.
In this guide, we will show how to write data to Elasticsearch service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Elasticsearch connection from the combo. Also, select resource action and Elasticsearch resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into Elasticsearch resource.
Configuration
Base URL address: http://[ServerHost]:9200.
- Basic
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Username: Required. Specify user name.
- Password: Required. Specify password.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.Username + ':' + connection.user.Password)}} -
format:
json
Documentation: https://en.wikipedia.org/wiki/Basic_access_authentication.
- Amazon AWS Signature v4
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Access Key: Required. Specify access key.
- Secret Key: Required. Specify secret key.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
{{=aws4s.authorizationHeader (request, connection)}} -
Host:
{{=request.signedRequest.headers['Host']}} -
X-Amz-Content-Sha256:
{{=request.signedRequest.headers['X-Amz-Content-Sha256']}} -
X-Amz-Date:
{{=request.signedRequest.headers['X-Amz-Date']}}
Documentation: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_cat/{{=parameters.object}}.The action has the following user-defined parameters:
- object: Required. Specify object you want to read.
- [External]
-
The external fields URL address:
/_cat/{{=parameters.object}}. The external fields list is extracted from:{{=ES.getCatFields(response)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_nodes/usage.
The result is extracted from:{{=_.map(response.nodes, function(v, k) { return _.extend({ node: k }, v); })}}.
- node
Template: ShortText.
- timestamp
Template: UnixTime.
- since
Template: UnixTime.
- rest_actions
Field components:
- Contains the following components: nodes_usage_action, cluster_get_settings_action, pending_cluster_tasks_action, cat_plugins_action, cat_action, nodes_info_action, remote_cluster_info_action, cat_alias_action, cat_indices_action, cat_count_action, nodes_stats_action, nodes_hot_threads_action, cat_nodes_action, cat_segments_action, cluster_state_action, cat_health_action, cluster_stats_action, cat_fielddata_action, document_get_action, cat_allocation_action, cat_master_action, cluster_health_action, list_tasks_action, cat_templates_action.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_nodes.
The result is extracted from:{{=_.map(response.nodes, function(v, k) { return _.extend({ id: k }, v); })}}.
- id
Template: ShortText.
- name
Template: ShortText.
- transport_address
Template: ShortText.
- host
Template: ShortText.
- ip
Template: ShortText.
- version
Template: ShortText.
- build_flavor
Template: ShortText.
- build_type
Template: ShortText.
- build_hash
Template: ShortText.
- total_indexing_buffer
Data type: DT_I4
- roles
Template: LongText. A composite field.
- settings
Field components:
- Contains the following components: cluster, node, path, discovery, action, client, http, transport, gateway, network.
- os
Field components:
-
Uses template:
ShortText. - Contains the following components: refresh_interval_in_millis, name, pretty_name, arch, version, available_processors, allocated_processors.
-
Uses template:
- process
Field components:
- Contains the following components: refresh_interval_in_millis, id, mlockall.
- jvm
Field components:
-
Uses template:
ShortText. - Contains the following components: pid, version, vm_name, vm_version, vm_vendor, bundled_jdk, using_bundled_jdk, start_time_in_millis, mem, gc_collectors, memory_pools, using_compressed_ordinary_object_pointers, input_arguments.
-
Uses template:
- thread_pool
Field components:
-
Uses template:
Pool. - Contains the following components: force_merge, fetch_shard_started, listener, refresh, generic, warmer, search, flush, fetch_shard_store, management, get, analyze, write, snapshot, search_throttled.
-
Uses template:
- transport
Field components:
-
Uses template:
LongText. - Contains the following components: bound_address, publish_address, profiles.
-
Uses template:
- http
Field components:
-
Uses template:
LongText. - Contains the following components: bound_address, publish_address, max_content_length_in_bytes.
-
Uses template:
- plugins
Template: LongText. A composite field.
- modules
Field components:
- An array.
- Contains the following components: name, version, elasticsearch_version, java_version, description, classname, extended_plugins, has_native_controller.
- ingest
Field components:
- Contains the following components: processors.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_nodes/stats.
The result is extracted from:{{=_.map(response.nodes, function(v, k) { return _.extend({ id: k }, v); })}}.
- id
Template: ShortText.
- timestamp
Template: UnixTime.
- name
Template: ShortText.
- transport_address
Template: ShortText.
- host
Template: ShortText.
- ip
Template: ShortText.
- roles
Template: LongText. A composite field.
- indices
Field components:
- Contains the following components: docs, store, indexing, get, search, merges, refresh, flush, warmer, query_cache, fielddata, completion, segments, translog, request_cache, recovery.
- os
Field components:
-
Uses template:
ShortText. - Contains the following components: timestamp, cpu, mem, swap, cgroup.
-
Uses template:
- process
Field components:
-
Uses template:
UnixTime. - Contains the following components: timestamp, open_file_descriptors, max_file_descriptors, cpu, mem.
-
Uses template:
- jvm
Field components:
-
Uses template:
UnixTime. - Contains the following components: timestamp, uptime_in_millis, mem, threads, gc, buffer_pools, classes.
-
Uses template:
- thread_pool
Field components:
-
Uses template:
PoolStat. - Contains the following components: analyze, fetch_shard_started, fetch_shard_store, flush, force_merge, generic, get, listener, management, refresh, search, search_throttled, snapshot, warmer, write.
-
Uses template:
- fs
Field components:
-
Uses template:
UnixTime. - Contains the following components: timestamp, total, least_usage_estimate, most_usage_estimate, data, io_stats.
-
Uses template:
- transport
Field components:
- Contains the following components: server_open, rx_count, rx_size_in_bytes, tx_count, tx_size_in_bytes.
- http
Field components:
- Contains the following components: current_open, total_opened.
- breakers
Field components:
-
Uses template:
BreakerStat. - Contains the following components: request, fielddata, in_flight_requests, accounting, parent.
-
Uses template:
- script
Field components:
- Contains the following components: compilations, cache_evictions, compilation_limit_triggered.
- discovery
Field components:
- Contains the following components: cluster_state_queue, published_cluster_states.
- ingest
Field components:
-
Uses template:
LongText. - Contains the following components: total, pipelines.
-
Uses template:
- adaptive_selection
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_cluster/pending_tasks.
The result is extracted from:{{=response.tasks}}.
- insert_order
Data type: DT_I4
- priority
Template: ShortText.
- source
Template: ShortText.
- time_in_queue_millis
Template: UnixTime.
- time_in_queue
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_tasks.
The result is extracted from:{{=function() { var result = []; _.each(response.nodes, function(node) { result.push.apply(result, _.values(node.tasks)); } return result; }()}}.
- id
A key field. Data type: DT_I4
- node
Template: ShortText.
- type
Template: ShortText.
- action
Template: ShortText.
- start_time_in_millis
Template: UnixTime.
- running_time_in_nanos
Data type: DT_I4
- cancellable
Data type: DT_BOOL
- parent_task_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.index}}/_mget.
The result is extracted from:{{=_.map(response.docs, function(doc) { return _.extend(_.omit(doc, '_source'), doc._source); })}}.
The action uses POST method.The action has the following user-defined parameters:
- index: Required. Specify index where to search for document.
- ids: Required. Comma (,) separated list of document identifiers to get.
The following request parameters will be automatically processed:
-
application/json:
{{={ ids: parameters.ids.split(',') } }}
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html.
- [Read search] action
-
Endpoint URL address:
/{{=parameters.index}}/_search.
The result is extracted from:{{=_.map(response.hits.hits, function(hit) { return _.extend({ _index: hit._index, _id: hit._id }, hit._source); })}}.
The result is paginated.The action has the following user-defined parameters:
- index: Required. Specify index where to search for document.
- query: Required. Specify Lucene query string.
The following request parameters will be automatically processed:
-
size:
{{=parameters.batchSize}} -
from:
{{=parameters.iterator}} -
q:
{{=parameters.query}}
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html.
- [Create] action
-
Endpoint URL address:
/{{=item._index}}/_doc/.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html.
- [Update] action
-
Endpoint URL address:
/{{=item._index}}/_doc/{{=item._id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html.
- [Delete] action
-
Endpoint URL address:
/{{=item._index}}/_doc/{{=item._id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html.
- _id
A key field. Template: ShortText.
- _index
A key field. Template: ShortText.
- _score
Data type: DT_R8 A read-only field.
- _version
Data type: DT_I4 A read-only field.
- _seq_no
Data type: DT_I4 A read-only field.
- _primary_term
Data type: DT_I4 A read-only field.
- [External]
-
The external fields URL address:
/{{=parameters.index}}/_mappings. The external fields list is extracted from:{{=ES.getDocFields(response[parameters.index].mappings.properties)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.index}}/_graph/explore.
The action uses POST method.The action has the following user-defined parameters:
- index: Required. Specify index for graph explore.
- query: A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.
- vertices
Field components:
- An array.
- Contains the following components: field, size, min_doc_count, shard_min_doc_count.
- connections
Field components:
- An array.
- Contains the following components: source, target, weight, doc_count.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_cat/indices.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/6.8/cat-indices.html.
- [Create] action
-
Endpoint URL address:
/{{=item.name}}.
The action uses PUT method.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html.
- [Update] action
-
Endpoint URL address:
/{{=item.name}}/_settings.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html.
- [Delete] action
-
Endpoint URL address:
/{{=item.name}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html.
- name
Template: ShortText. The gathered value is processed with
{{=item.index}}expression.- health
Template: ShortText. A read-only field.
- status
Template: ShortText. A read-only field.
- uuid
Template: ShortText. A read-only field.
- pri
Data type: DT_I8 A read-only field.
- rep
Data type: DT_I8 A read-only field.
- docs.count
Data type: DT_I8 A read-only field.
- docs.deleted
Data type: DT_I8 A read-only field.
- store.size
Template: ShortText.
- pri.store.size
Template: ShortText.
- settings
The value is gathered from
/{{=item.name}}/_settingsaddress. The gathered value is processed with{{=response[item.name].settings}}expression. Field components:- Contains the following components: index.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_ingest/pipeline.
The result is extracted from:{{=_.map(response, function(v, k) { return _.extend({ id: k }, v); })}}.
- [Create] action
-
Endpoint URL address:
/_ingest/pipeline/{{=item.id}}.
The action uses PUT method.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html.
- [Delete] action
-
Endpoint URL address:
/_ingest/pipeline/{{=item.id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html.
- id
Template: ShortText.
- description
Template: ShortText.
- processors
Field components:
- An array.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_ml/anomaly_detectors/.
The result is extracted from:{{=response.jobs}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html.
- [Create] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=item.job_id}}.
The action uses PUT method.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html.
- [Update] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=item.job_id}}/_update.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html.
- [Delete] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=item.job_id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html.
- job_id
Template: ShortText.
- job_type
Template: ShortText.
- job_version
Template: ShortText.
- groups
Template: LongText. A composite field.
- description
Template: ShortText.
- create_time
Template: UnixTime. A read-only field.
- analysis_config
Field components:
-
Uses template:
ShortText. - Contains the following components: bucket_span, detectors, influencers.
-
Uses template:
- analysis_limits
Field components:
-
Uses template:
ShortText. - Contains the following components: model_memory_limit, categorization_examples_limit.
-
Uses template:
- data_description
Field components:
-
Uses template:
ShortText. - Contains the following components: time_field, time_format.
-
Uses template:
- model_plot_config
Field components:
- Contains the following components: enabled.
- model_snapshot_retention_days
Data type: DT_I4
- custom_settings
Field components:
-
Uses template:
ShortText. - Contains the following components: created_by.
-
Uses template:
- model_snapshot_id
Template: ShortText.
- results_index_name
Template: ShortText.
- allow_lazy_open
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_ml/filters/.
The result is extracted from:{{=response.filters}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html.
- [Create] action
-
Endpoint URL address:
/_ml/filters/{{=item.filter_id}}.
The action uses PUT method.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html.
- [Update] action
-
Endpoint URL address:
/_ml/filters/{{=item.filter_id}}/_update.
The action uses POST method.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html.
- [Delete] action
-
Endpoint URL address:
/_ml/filters/{{=item.filter_id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html.
- filter_id
Template: ShortText.
- description
Template: ShortText.
- items
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_ml/datafeeds/.
The result is extracted from:{{=response.datafeeds}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html.
- [Create] action
-
Endpoint URL address:
/_ml/datafeeds/{{=item.datafeed_id}}.
The action uses PUT method.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html.
- [Update] action
-
Endpoint URL address:
/_ml/datafeeds/{{=item.datafeed_id}}/_update.
The action uses POST method.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html.
- [Delete] action
-
Endpoint URL address:
/_ml/datafeeds/{{=item.datafeed_id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html.
- datafeed_id
Template: ShortText.
- job_id
Template: ShortText.
- query_delay
Template: ShortText.
- indices
Template: LongText. A composite field.
- query
Field components:
- Contains the following components: bool.
- scroll_size
Data type: DT_I4
- chunking_config
Field components:
-
Uses template:
ShortText. - Contains the following components: mode.
-
Uses template:
- delayed_data_check_config
Field components:
- Contains the following components: enabled.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=parameters.job_id}}/model_snapshots.
The result is extracted from:{{=response.model_snapshots}}.The action has the following user-defined parameters:
- job_id: Required. Specify job identifier.
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html.
- [Update] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=item.job_id}}/model_snapshots/{{=item.snapshot_id}}/_update.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html.
- [Delete] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=item.job_id}}/model_snapshots/{{=item.snapshot_id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html.
- job_id
Template: ShortText.
- min_version
Template: ShortText.
- timestamp
Template: UnixTime.
- description
Template: ShortText.
- snapshot_id
Template: ShortText.
- snapshot_doc_count
Data type: DT_I4
- model_size_stats
Field components:
-
Uses template:
ShortText. - Contains the following components: job_id, result_type, model_bytes, model_bytes_exceeded, model_bytes_memory_limit, total_by_field_count, total_over_field_count, total_partition_field_count, bucket_allocation_failures_count, memory_status, log_time, timestamp.
-
Uses template:
- latest_record_time_stamp
Template: UnixTime.
- latest_result_time_stamp
Template: UnixTime.
- retain
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=parameters.job_id}}/results/buckets.
The result is extracted from:{{=response.buckets}}.The action has the following user-defined parameters:
- job_id: Required. Specify job identifier.
- job_id
Template: ShortText.
- timestamp
Template: UnixTime.
- anomaly_score
Data type: DT_R8
- bucket_span
Data type: DT_I4
- initial_anomaly_score
Data type: DT_R8
- event_count
Data type: DT_I4
- is_interim
Data type: DT_BOOL
- bucket_influencers
Field components:
- An array.
- Contains the following components: job_id, result_type, influencer_field_name, initial_anomaly_score, anomaly_score, raw_anomaly_score, probability, timestamp, bucket_span, is_interim.
- processing_time_ms
Data type: DT_I4
- result_type
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=parameters.job_id}}/results/overall_buckets.
The result is extracted from:{{=response.overall_buckets}}.The action has the following user-defined parameters:
- job_id: Required. Specify job identifier.
- timestamp
Template: UnixTime.
- bucket_span
Data type: DT_I4
- overall_score
Data type: DT_R8
- jobs
Field components:
- An array.
- Contains the following components: job_id, max_anomaly_score.
- is_interim
Data type: DT_BOOL
- result_type
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=parameters.job_id}}/results/categories.
The result is extracted from:{{=response.categories}}.The action has the following user-defined parameters:
- job_id: Required. Specify job identifier.
- job_id
Template: ShortText.
- category_id
Data type: DT_I4
- terms
Template: ShortText.
- regex
Template: ShortText.
- max_matching_length
Data type: DT_I4
- examples
Template: LongText. A composite field.
- grok_pattern
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=parameters.job_id}}/results/influencers.
The result is extracted from:{{=response.influencers}}.The action has the following user-defined parameters:
- job_id: Required. Specify job identifier.
- job_id
Template: ShortText.
- result_type
Template: ShortText.
- influencer_field_name
Template: ShortText.
- influencer_field_value
Template: ShortText.
- customer_full_name.keyword
Template: ShortText.
- influencer_score
Data type: DT_R8
- initial_influencer_score
Data type: DT_R8
- probability
Data type: DT_R8
- bucket_span
Data type: DT_I4
- is_interim
Data type: DT_BOOL
- timestamp
Template: UnixTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_ml/anomaly_detectors/{{=parameters.job_id}}/results/records.
The result is extracted from:{{=response.records}}.The action has the following user-defined parameters:
- job_id: Required. Specify job identifier.
- job_id
Template: ShortText.
- result_type
Template: ShortText.
- probability
Data type: DT_R8
- multi_bucket_impact
Data type: DT_R8
- record_score
Data type: DT_R8
- initial_record_score
Data type: DT_R8
- bucket_span
Data type: DT_I4
- detector_index
Data type: DT_I4
- is_interim
Data type: DT_BOOL
- timestamp
Template: UnixTime.
- function
Template: ShortText.
- function_description
Template: ShortText.
- typical
Template: LongText. A composite field.
- actual
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_security/privilege.
The result is extracted from:{{=_.values(response)}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html.
- [Create] action
-
Endpoint URL address:
/_security/privilege.The following request parameters will be automatically processed:
-
application/json:
{{=function() { var result = {}; result[item.application] = item; return result; }()}}
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/_security/privilege/{{=item.read.application}}/{{=item.privilege}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html.
- application
Template: ShortText.
- privilege
Template: ShortText.
- read
Field components:
-
Uses template:
ShortText. - Contains the following components: application, name, actions, metadata.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_security/role_mapping.
The result is extracted from:{{=_.map(response, function(v, k) { return _.extend({ id: k }, v); })}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html.
- [Create] action
-
Endpoint URL address:
/_security/role_mapping/{{=item.id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html.
- [Delete] action
-
Endpoint URL address:
/_security/role_mapping/{{=item.id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html.
- id
Template: ShortText.
- enabled
Data type: DT_BOOL
- roles
Template: LongText. A composite field.
- rules
Field components:
- Contains the following components: field.
- metadata
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_security/role.
The result is extracted from:{{=_.map(response, function(v, k) { return _.extend({ id: k }, v); })}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html.
- [Create] action
-
Endpoint URL address:
/_security/role/{{=item.id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html.
- [Delete] action
-
Endpoint URL address:
/_security/role/{{=item.id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html.
- id
Template: ShortText.
- cluster
Template: LongText. A composite field.
- indices
Field components:
- An array.
- Contains the following components: names, privileges, allow_restricted_indices, field_security, query.
- applications
Field components:
- An array.
- Contains the following components: application, privileges, resources.
- run_as
Template: LongText. A composite field.
- metadata
Field components:
- Contains the following components: version.
- transient_metadata
Field components:
- Contains the following components: enabled.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_security/user.
The result is extracted from:{{=_.values(response)}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html.
- [Create] action
-
Endpoint URL address:
/_security/user/{{=item.username}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html.
- [Delete] action
-
Endpoint URL address:
/_security/user/{{=item.username}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html.
- username
Template: ShortText.
- password
Template: ShortText.
- roles
Template: LongText. A composite field.
- full_name
Template: ShortText.
Template: ShortText.
- metadata
Field components:
- Contains the following components: intelligence.
- enabled
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_slm/policy.
The result is extracted from:{{=_.map(response, function(v, k) { return _.extend({ id: k }, v); })}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html.
- [Create] action
-
Endpoint URL address:
/_slm/policy/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=item.policy}}
Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/_slm/policy/{{=item.id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html.
- id
Template: ShortText.
- version
Data type: DT_I4 A read-only field.
- modified_date
Template: ShortText. A read-only field.
- modified_date_millis
Template: ShortText. A read-only field.
- policy
Field components:
-
Uses template:
ShortText. - Contains the following components: schedule, name, repository, config, retention.
-
Uses template:
- stats
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: policy, snapshots_taken, snapshots_failed, snapshots_deleted, snapshot_deletion_failures.
-
Uses template:
- next_execution
Template: ShortText.
- next_execution_millis
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/_transform/.
The result is extracted from:{{=response.transforms}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html.
- [Create] action
-
Endpoint URL address:
/_transform/{{=item.id}}.
The action uses PUT method.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html.
- [Update] action
-
Endpoint URL address:
/_transform/{{=item.id}}/_update.
The action uses POST method.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html.
- [Delete] action
-
Endpoint URL address:
/_transform/{{=item.id}}.Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html.
- id
Template: ShortText.
- source
Field components:
-
Uses template:
LongText. - Contains the following components: index, query.
-
Uses template:
- dest
Field components:
-
Uses template:
ShortText. - Contains the following components: index.
-
Uses template:
- frequency
Template: ShortText.
- pivot
Field components:
- Contains the following components: group_by, aggregations.
- sync
Field components:
- Contains the following components: time.
- description
Template: ShortText.
- version
Template: ShortText.
- create_time
Template: UnixTime.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(value).toUTCString()}}expression.- Pool
Field components:
-
Uses template:
ShortText. - Contains the following components: type, core, max, keep_alive, queue_size.
-
Uses template:
- PoolStat
Field components:
- Contains the following components: threads, queue, active, rejected, largest, completed.
- BreakerStat
Field components:
-
Uses template:
ShortText. - Contains the following components: limit_size_in_bytes, limit_size, estimated_size_in_bytes, estimated_size, overhead, tripped.
-
Uses template:
- IoStat
Field components:
- Contains the following components: operations, read_operations, write_operations, read_kilobytes, write_kilobytes.
- PoolMemStat
Field components:
- Contains the following components: used_in_bytes, max_in_bytes, peak_used_in_bytes, peak_max_in_bytes.
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.