Get Deployment Integrations Server Resource Info
Get info about an Integrations Server Resource belonging to a given Deployment.
Path parameters
-
Identifier for the Deployment
-
User-specified RefId for the Resource (or '_main' if there is only one).
Query parameters
-
show_metadata boolean
Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.
Default value is
false
. -
show_plans boolean
Whether to include the full current and pending plan information in the response - can be large per cluster.
Default value is
true
. -
show_plan_logs boolean
Whether to include with the current and pending plan information the attempt log - can be very large per cluster.
Default value is
false
. -
show_plan_history boolean
Whether to include with the current and pending plan information the plan history- can be very large per cluster.
Default value is
false
. -
show_plan_defaults boolean
If showing plans, whether to show values that are left at their default value (less readable but more informative).
Default value is
false
. -
show_settings boolean
Whether to show cluster settings in the response.
Default value is
false
. -
clear_transient boolean
If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
Default value is
false
.
curl \
-X GET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/integrations_server/{ref_id}
{
"ref_id": "string",
"elasticsearch_cluster_ref_id": "string",
"id": "string",
"region": "string",
"info": {
"id": "string",
"name": "string",
"elasticsearch_cluster": {
"elasticsearch_id": "string",
"links": {
"additionalProperty1": {
"need_elevated_permissions": true
},
"additionalProperty2": {
"need_elevated_permissions": true
}
}
},
"deployment_id": "string",
"healthy": true,
"status": "initializing",
"plan_info": {
"healthy": true,
"current": {
"plan_attempt_id": "string",
"plan_attempt_name": "string",
"healthy": true,
"attempt_start_time": "2024-05-04T09:42:00+00:00",
"attempt_end_time": "2024-05-04T09:42:00+00:00",
"plan_end_time": "2024-05-04T09:42:00+00:00",
"plan": {
"cluster_topology": [
{
"instance_configuration_id": "string",
"instance_configuration_version": 42,
"size": {
"value": 42,
"resource": "memory"
},
"zone_count": 42,
"integrations_server": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"kibana_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_token": "string",
"debug_enabled": true
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string",
"mode": "standalone"
}
}
],
"integrations_server": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"kibana_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_token": "string",
"debug_enabled": true
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string",
"mode": "standalone"
},
"transient": {
"strategy": {
"rolling": {
"group_by": "string",
"allow_inline_resize": true,
"skip_synced_flush": true,
"shard_init_wait_time": 42
},
"grow_and_shrink": {},
"rolling_grow_and_shrink": {},
"autodetect": {}
},
"plan_configuration": {
"timeout": 42,
"calm_wait_time": 42,
"extended_maintenance": true,
"cluster_reboot": "forced"
}
}
},
"plan_attempt_log": [
{
"step_id": "string",
"started": "2024-05-04T09:42:00+00:00",
"completed": "2024-05-04T09:42:00+00:00",
"duration_in_millis": 42,
"status": "success",
"stage": "starting",
"info_log": [
{
"timestamp": "2024-05-04T09:42:00+00:00",
"delta_in_millis": 42,
"stage": "starting",
"message": "string",
"details": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"failure_type": "string"
}
]
}
],
"source": {
"facilitator": "string",
"action": "string",
"date": "2024-05-04T09:42:00+00:00",
"user_id": "string",
"admin_id": "string",
"remote_addresses": [
"string"
]
},
"warnings": [
{
"code": "string",
"message": "string",
"step_id": "string"
}
],
"error": {
"timestamp": "2024-05-04T09:42:00+00:00",
"message": "string",
"details": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"failure_type": "string"
}
},
"pending": {
"plan_attempt_id": "string",
"plan_attempt_name": "string",
"healthy": true,
"attempt_start_time": "2024-05-04T09:42:00+00:00",
"attempt_end_time": "2024-05-04T09:42:00+00:00",
"plan_end_time": "2024-05-04T09:42:00+00:00",
"plan": {
"cluster_topology": [
{
"instance_configuration_id": "string",
"instance_configuration_version": 42,
"size": {
"value": 42,
"resource": "memory"
},
"zone_count": 42,
"integrations_server": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"kibana_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_token": "string",
"debug_enabled": true
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string",
"mode": "standalone"
}
}
],
"integrations_server": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"kibana_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_token": "string",
"debug_enabled": true
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string",
"mode": "standalone"
},
"transient": {
"strategy": {
"rolling": {
"group_by": "string",
"allow_inline_resize": true,
"skip_synced_flush": true,
"shard_init_wait_time": 42
},
"grow_and_shrink": {},
"rolling_grow_and_shrink": {},
"autodetect": {}
},
"plan_configuration": {
"timeout": 42,
"calm_wait_time": 42,
"extended_maintenance": true,
"cluster_reboot": "forced"
}
}
},
"plan_attempt_log": [
{
"step_id": "string",
"started": "2024-05-04T09:42:00+00:00",
"completed": "2024-05-04T09:42:00+00:00",
"duration_in_millis": 42,
"status": "success",
"stage": "starting",
"info_log": [
{
"timestamp": "2024-05-04T09:42:00+00:00",
"delta_in_millis": 42,
"stage": "starting",
"message": "string",
"details": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"failure_type": "string"
}
]
}
],
"source": {
"facilitator": "string",
"action": "string",
"date": "2024-05-04T09:42:00+00:00",
"user_id": "string",
"admin_id": "string",
"remote_addresses": [
"string"
]
},
"warnings": [
{
"code": "string",
"message": "string",
"step_id": "string"
}
],
"error": {
"timestamp": "2024-05-04T09:42:00+00:00",
"message": "string",
"details": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"failure_type": "string"
}
},
"history": [
{
"plan_attempt_id": "string",
"plan_attempt_name": "string",
"healthy": true,
"attempt_start_time": "2024-05-04T09:42:00+00:00",
"attempt_end_time": "2024-05-04T09:42:00+00:00",
"plan_end_time": "2024-05-04T09:42:00+00:00",
"plan": {
"cluster_topology": [
{
"instance_configuration_id": "string",
"instance_configuration_version": 42,
"size": {
"value": 42,
"resource": "memory"
},
"zone_count": 42,
"integrations_server": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"kibana_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_token": "string",
"debug_enabled": true
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string",
"mode": "standalone"
}
}
],
"integrations_server": {
"version": "string",
"docker_image": "string",
"system_settings": {
"elasticsearch_url": "string",
"kibana_url": "string",
"elasticsearch_username": "string",
"elasticsearch_password": "string",
"secret_token": "string",
"debug_enabled": true
},
"user_settings_json": {},
"user_settings_yaml": "string",
"user_settings_override_json": {},
"user_settings_override_yaml": "string",
"mode": "standalone"
},
"transient": {
"strategy": {
"rolling": {
"group_by": "string",
"allow_inline_resize": true,
"skip_synced_flush": true,
"shard_init_wait_time": 42
},
"grow_and_shrink": {},
"rolling_grow_and_shrink": {},
"autodetect": {}
},
"plan_configuration": {
"timeout": 42,
"calm_wait_time": 42,
"extended_maintenance": true,
"cluster_reboot": "forced"
}
}
},
"plan_attempt_log": [
{
"step_id": "string",
"started": "2024-05-04T09:42:00+00:00",
"completed": "2024-05-04T09:42:00+00:00",
"duration_in_millis": 42,
"status": "success",
"stage": "starting",
"info_log": [
{
"timestamp": "2024-05-04T09:42:00+00:00",
"delta_in_millis": 42,
"stage": "starting",
"message": "string",
"details": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"failure_type": "string"
}
]
}
],
"source": {
"facilitator": "string",
"action": "string",
"date": "2024-05-04T09:42:00+00:00",
"user_id": "string",
"admin_id": "string",
"remote_addresses": [
"string"
]
},
"warnings": [
{
"code": "string",
"message": "string",
"step_id": "string"
}
],
"error": {
"timestamp": "2024-05-04T09:42:00+00:00",
"message": "string",
"details": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"failure_type": "string"
}
}
]
},
"metadata": {
"version": 42,
"last_modified": "2024-05-04T09:42:00+00:00",
"endpoint": "string",
"service_url": "string",
"aliased_endpoint": "string",
"aliased_url": "string",
"cloud_id": "string",
"raw": {},
"ports": {
"http": 42,
"https": 42,
"transport_passthrough": 42
},
"services_urls": [
{
"service": "string",
"url": "string"
}
]
},
"topology": {
"healthy": true,
"instances": [
{
"instance_name": "string",
"instance_configuration": {
"id": "string",
"name": "string",
"config_version": 42,
"resource": "memory"
},
"service_version": "string",
"healthy": true,
"container_started": true,
"service_running": true,
"maintenance_mode": true,
"zone": "string",
"allocator_id": "string",
"memory": {
"instance_capacity": 42,
"instance_capacity_planned": 42,
"memory_pressure": 42,
"native_memory_pressure": 42
},
"disk": {
"disk_space_available": 42,
"disk_space_used": 42,
"storage_multiplier": 42.0
},
"service_roles": [
"string"
],
"node_roles": [
"master"
],
"instance_overrides": {
"capacity": 42,
"storage_multiplier": 42.0
}
}
]
},
"external_links": [
{
"id": "string",
"label": "string",
"uri": "string"
}
],
"links": {
"additionalProperty1": {
"need_elevated_permissions": true
},
"additionalProperty2": {
"need_elevated_permissions": true
}
},
"settings": {
"metadata": {
"name": "string"
}
},
"region": "string",
"apm_server_mode": "standalone"
}
}
# Headers
x-cloud-error-codes: deployments.deployment_not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}