Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. RunAJob utility
  8. REST API codes
  9. REST API resource quick references

REST API Reference

REST API Reference

runtimeEnvironment

runtimeEnvironment

Use the runtimeEnvironment resource to get information about runtime environments for an organization.
To request runtime environment information, use the following URI:
/api/v2/runtimeEnvironment
To request the details of a particular runtime environment, you can include the runtime environment ID or name in the URI. Use one of the following URIs:
/api/v2/runtimeEnvironment
/<id>
/api/v2/runtimeEnvironment/name/<name>
If you use the runtime environment name in the URI and the runtime environment name includes a space, replace the space with
%20
. For example:
/api/v2/runtimeEnvironment/name/my%20runtime%20environment

GET Response

Returns runtime environment information for the requested runtime environment. The runtimeEnvironment object includes the following attributes:
Field
Type
Description
id
String
Runtime environment ID.
orgId
String
Organization ID.
name
String
Runtime environment name.
description
String
Description of the runtime environment.
createTime
Date/time
Date and time the runtime environment was created.
updateTime
Date/time
Date and time that the runtime environment was last updated.
createdBy
String
User who created the runtime environment.
updatedBy
String
User who last updated the runtime environment.
agents
Agents assigned to the runtime environment. Returns an empty object.
isShared
Boolean
Indicates whether the Secure Agent group is shared. Returns one of the following values:
  • true. The Secure Agent group is shared.
  • false. The Secure Agent group is not shared.
federatedId
String
Federated ID.
serverlessConfig
Attribute that defines serverless runtime environment properties.
If you get information about a serverless runtime environment, the runtimeEnvironment object also includes the serverlessConfig object. The serverlessConfig object includes the following attributes:
Field
Type
Description
platform
String
Cloud platform that hosts the serverless runtime environment.
applicationType
String
Application that can use the serverless runtime environment.
status
String
Status of the serverless runtime environment.
statusMessage
String
Status message for the serverless runtime environment.
statusMessageDetails
String
Validation error data from AWS for the serverless runtime environment.
cloudProviderConfig
Defines basic properties and
Data Integration
properties.
infaAccountNumber
String
Included in the cloudProviderConfig object.
Informatica's account number on the cloud platform.
externalId
String
Included in the cloudProviderConfig object.
External ID to associate with the role.
configurationName
String
Included in the cloudProviderConfig object.
Name of the serverless runtime environment.
configurationDescription
String
Included in the cloudProviderConfig object.
Description of the serverless runtime environment.
params
Defines the AWS resource configuration properties.
s3
String
Included in the params object.
Location on Amazon S3 to store supplementary files.
subnet
String
Included in the params object.
ID of the subnet.
role
String
Included in the params object.
Name of the role that the serverless runtime environment assumes.
vpc
String
Included in the params object.
ID of the VPC (Amazon Virtual Private Cloud).
externalId
String
Included in the params object.
External ID that is configured for the role.
securityGroup
String
Included in the params object.
Security group ID.
accountNumber
String
Included in the params object.
Your account number on the cloud platform.
referenceId
String
Included in the params object.
Internal ID used to reference the serverless runtime environment.
computeUnits
String
Included in the params object.
Maximum number of serverless compute units that a task can use.
executionTimeout
String
Included in the params object.
Amount of time in minutes to wait for a task to complete.
cloudInstanceId
String
Included in the params object.
Instance ID.
zone
String
Included in the params object.
Availability zone ID.
region
String
Included in the params object.
Region on the cloud platform.
infaAccountNumber
String
Included in the params object.
Informatica's account number on the cloud platform.
awsTags
String
Included in the params object.
AWS tags.
maxComputeUnits
String
Maximum number of serverless compute units that a task can use.
executionTimeout
String
Amount of time in minutes to wait for a task to complete.

Get Example

To request the details of a particular runtime environment, you might use the following request:
GET <serverUrl>/api/v2/runtimeEnvironment/00000425000000000004 Accept:application/json icSessionId: <icSessionId>
The following text is a sample return in JSON:
{ "@type": "runtimeEnvironment", "id": "00000425000000000004", "orgId": "000004", "name": "SUT_Agent", "createTime": "2016-12-09T12:34:01.000Z", "updateTime": "2016-12-09T17:54:00.000Z", "createdBy": "org1@infa.com", "updatedBy": "org1@infa.com", "agents": [], "isShared": true, "federatedId": "6iPQuOsH1YAfnJxhZWPZjI" }
The following text is a sample return for a serverless runtime environment:
{ "@type": "runtimeEnvironment", "id": "01000000000000000039", "orgId": "010211", "name": "Serverless runtime environment 1", "description": "My serverless runtime environment", "createTime": "2020-08-25T13:21:16.000Z", "updateTime": "2020-08-25T13:29:43.000Z", "createdBy": "admin", "updatedBy": "admin", "agents": [], "isShared": false, "federatedId": "4sddtYsgbpnpTBjSZB12fs", "serverlessConfig": { "platform": "AWS", "applicationType": "CDI", "status": "RUNNING", "statusMessage": "Serverless runtime is running", "cloudProviderConfig": { "cloudConfig": [ { "infaAccountNumber": "064942996470", "externalId": "7eeafa7c-6dd1-4666-8ac8-7431b1d72def", "configurationName": "Serverless runtime environment 1", "configurationDescription": "My serverless runtime environment", "params": { "s3": "s3://discale-qa-west2/test1", "subnet": "subnet-08123adayy51ed327", "role": "CDI_Serverless_Role", "vpc": "vpc-02ef05yy73fb7f063", "externalId": "7eeafa7c-6dd1-4666-8ac8-7431b1d72def", "securityGroup": "sg-025d67343b0655372", "accountNumber": "778525666549", "referenceId": "4sddtYsgbpnpTBjSZB12fs", "computeUnits": "1", "executionTimeout": "2880", "cloudInstanceId": "i-0e3e6g02r1g1364a3", "zone": "usw2-az3", "region": "us-west-2", "infaAccountNumber": "064942996470", "awsTags": "Key=NAME,Value=test1 Key=EMAIL,Value=test1@informatica.com" } } ] }, "maxComputeUnits": "1", "executionTimeout": "2880" }


Updated May 03, 2021