REST API Reference

Back Next

Getting configuration details

You can request the details for a specific configuration.

GET request

To get configuration details, use the following URI:

/public/core/v3/ClusterConfig/<config_id>

GET response

If successful, returns the following information for a configuration:

Field	Type	Description
id	String	Configuration ID.
orgId	String	ID of the organization the configuration belongs to.
infaManaged	Boolean	Whether the configuration is managed by Informatica.
clusterName	String	Name of the configuration.
description	String	Description of the configuration.
cloudPlatform	String	Cloud platform hosting the configuration.
haEnabled	Boolean	Whether high availability is enabled.
region	String	Region in which the configuration is located.
subnets	Array	Subnets used within the network.
masterNodeInstanceType	String	Instance type to host the master node.
maxWorkerNodes	Integer	Maximum number of worker nodes to use.
minWorkerNodes	Integer	Minimum number of worker nodes to use.
workerNodeIdleTimeout	Integer	Amount of time in minutes before a worker node times out.
workerNodeInstanceType	String	Instance type to host a worker node.
workerNodeVolumeSize	Integer	Volume size of a worker node.
systemDiskConfig	Escaped string representation of JSON	Properties of the system storage, if configured. Includes the file system, source mount, and access point.
dataDisksConfig	Escaped string representation of JSON	Properties of the data storage, if configured. Includes the file system, source mount, and access point.
initScriptPath	String	Not used. An elastic runtime environment doesn't use initialization scripts.
masterNodeIAMRole	String	IAM role for the master node.
workerNodeIAMRole	String	IAM role for the worker nodes.
imageRegistryHost	String	Domain name or IP address of the registry hosting the container images.
imageRegistryUser	String	User name to log into the image registry host.
imageRegistryPassword	String	Password to log into the image registry host.
dateDeployed	Date	Date when the image was deployed.
miscTags	Escaped string representation of JSON	Tags associated with the cloud ecosystem.

GET response example

To get configuration details, use the following request:

GET <baseApiUrl>/public/core/v3/ClusterConfig/<config_id>
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

If successful, you might receive a response like the following example:

[
   {
    "id": "5MdLmj0YXoce2osMD2mT0r",
    "orgId": "dx7DSOIGiiPh6XQoZKpAmC",
    "infaManaged": false,
    "clusterName": "test-cluster",
    "description": "Description of the cluster",
    "cloudPlatform": "AWS",
    "haEnabled": false,
    "region": "us-west-1",
    "subnets": [
        "subnet-1",
        "subnet-2"
    ],
    "masterNodeInstanceType": "m5.large",
    "maxWorkerNodes": 10,
    "minWorkerNodes": 1,
    "workerNodeIdleTimeout": 5,
    "workerNodeInstanceType": "m5.xlarge",
    "workerNodeVolumeSize": 100,
    "systemDiskConfig": "{\"id\": \"\", \"sourceMount\": \"\", \"accessPoint\": \"\"}",
    "dataDisksConfig": "[{\"id\": \"\", \"sourceMount\": \"\", \"targetMount\": \"\", \"accessPoint\": \"\"}]",
    "initScriptPath": "/path/to/script",
    "masterNodeIAMRole": "masterRole",
    "workerNodeIAMRole": "workerRole",
    "imageRegistryHost": "registry.example.com",
    "imageRegistryUser": null,
    "imageRegistryPassword": null,
    "dateDeployed": null,
    "miscTags": "{\"cloudEcosystemTags\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}],\"runtimeProperties\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}]}"
  }
]

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Getting configuration details

Getting configuration details

GET request

GET response

GET response example