Jump to

• Request
• Response

Get Environment Group

get

/rpa/v1/environmentGroups/{identifier}

Gets a Environment Group by identifier

Request

Path Parameters

• identifier(required): string
  Unique Environment Group Identifier

Query Parameters

• projectId(required): string
  Project identifier
• q: string
  A filter to search resources by name, identifier, or description. The search query can be a simple string or a JSON object with operators and criteria. Example JSON format: { "operator": "AND", "criteria": [ {"name": "example"}, {"version": "1.0"} ] }

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieves the Environment Group with the given id

Headers

• etag:
  For optimistic concurrency control. See `if-match`.
• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : EnvironmentGroup

Type: object

Details of Environment Group

Show Source

• associatedEnvironments: array associatedEnvironments
  The associated environments. Only when areAssociatedEnvironmentsNeeded queri parameter is true
• autonomousConfig: object AutonomousEnvironmentPoolConfig
  Holds Autonomous Environment Pool Specification
• createdBy: string
  user Id whom created the Env. Group
• description: string
  Minimum Length: 0

  Maximum Length: 1024

  Description of the Env. Group.
• displayName(required): string
  Maximum Length: 50

  User friendly display name for the environment group
• identifier: string
  Maximum Length: 32

  Envrinoment Group identifier
• isSharedEnvironmentGroup: boolean
  shared environment group
• keywords: string
  Minimum Length: 0

  Maximum Length: 1024

  Keywords.
• lifecycleState: string
  Allowed Values: [ "ACTIVE" ]

  The current state of the environment group
• subType: string
  Allowed Values: [ "CUSTOMER_MANAGED", "ORACLE_MANAGED" ]

  Ownership model.
• timeCreated: string (date-time)
  The time at which environment group was created. An RFC3339 formatted datetime string.
• timeUpdated: string (date-time)
  The time at which environment group was last updated. An RFC3339 formatted datetime string
• type: string
  Allowed Values: [ "AUTONOMOUS", "MANUAL" ]

  Pool management mode.
• updatedBy: string
  user Id whom made the last update

{
    "description":"Details of Environment Group",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"environmentGroup",
        "adLocality":"regional",
        "getOperationId":"GetEnvironmentGroup",
        "listResourcesOperationId":"ListEnvironmentGroups",
        "activeLifecycleStates":[
            "active"
        ],
        "ocidEntityType":"environmentGroup"
    },
    "required":[
        "displayName"
    ],
    "properties":{
        "identifier":{
            "description":"Envrinoment Group identifier",
            "type":"string",
            "maxLength":32
        },
        "displayName":{
            "description":"User friendly display name for the environment group",
            "type":"string",
            "maxLength":50
        },
        "lifecycleState":{
            "description":"The current state of the environment group",
            "type":"string",
            "enum":[
                "ACTIVE"
            ]
        },
        "associatedEnvironments":{
            "description":"The associated environments. Only when areAssociatedEnvironmentsNeeded queri parameter is true",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnvironmentSummary"
            }
        },
        "description":{
            "description":"Description of the Env. Group.",
            "type":"string",
            "minLength":0,
            "maxLength":1024
        },
        "keywords":{
            "description":"Keywords.",
            "type":"string",
            "minLength":0,
            "maxLength":1024
        },
        "updatedBy":{
            "description":"user Id whom made the last update",
            "type":"string"
        },
        "createdBy":{
            "description":"user Id whom created the Env. Group",
            "type":"string"
        },
        "timeCreated":{
            "description":"The time at which environment group was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time at which environment group was last updated. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "isSharedEnvironmentGroup":{
            "description":"shared environment group",
            "type":"boolean"
        },
        "type":{
            "type":"string",
            "enum":[
                "AUTONOMOUS",
                "MANUAL"
            ],
            "description":"Pool management mode."
        },
        "subType":{
            "type":"string",
            "enum":[
                "CUSTOMER_MANAGED",
                "ORACLE_MANAGED"
            ],
            "description":"Ownership model."
        },
        "autonomousConfig":{
            "$ref":"#/components/schemas/AutonomousEnvironmentPoolConfig"
        }
    }
}

Nested Schema : associatedEnvironments

Type: array

The associated environments. Only when areAssociatedEnvironmentsNeeded queri parameter is true

Show Source

• Array of: object EnvironmentSummary
  Summary of an environment

{
    "description":"The associated environments. Only when areAssociatedEnvironmentsNeeded queri parameter is true",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EnvironmentSummary"
    }
}

Nested Schema : AutonomousEnvironmentPoolConfig

Type: object

Holds Autonomous Environment Pool Specification

Show Source

• availabilityDomain: string
  Availability Domain ID.
• category: string
  Allowed Values: [ "REMOTE_INSTANCE_POOL" ]

  Type of backend for the environment specification
• instancePoolId(required): string
  OCID of the instance pool associated with this environment
• lifecycleConfig: object EnvironmentLifecycleConfig
  Agent Lifecycle Management
• region: string
  Region identifier where the instance pool is deployed
• scalingConfig(required): object EnvironmentScalingConfig
  Holds ScalingConfig

{
    "type":"object",
    "description":"Holds Autonomous Environment Pool Specification",
    "required":[
        "instancePoolId",
        "scalingConfig"
    ],
    "properties":{
        "category":{
            "type":"string",
            "description":"Type of backend for the environment specification",
            "enum":[
                "REMOTE_INSTANCE_POOL"
            ]
        },
        "instancePoolId":{
            "type":"string",
            "description":"OCID of the instance pool associated with this environment"
        },
        "region":{
            "type":"string",
            "description":"Region identifier where the instance pool is deployed"
        },
        "availabilityDomain":{
            "type":"string",
            "description":"Availability Domain ID."
        },
        "scalingConfig":{
            "$ref":"#/components/schemas/EnvironmentScalingConfig"
        },
        "lifecycleConfig":{
            "$ref":"#/components/schemas/EnvironmentLifecycleConfig"
        }
    }
}

Nested Schema : EnvironmentSummary

Type: object

Summary of an environment

Show Source

• agentVersion: string
  Minimum Length: 1

  Maximum Length: 50

  The agent version.
• createdBy: string
  Records the user who create the environment.
• description: string
  User given description of the environment.
• displayName(required): string
  User friendly display name for the environment.
• environmentGroupDisplayName(required): string
  The environment group display name if this environment is added to the environment group.
• environmentGroupIdentifier(required): string
  The environment group identifier if this environment is added to the environment group.
• environmentType: string
  The type of the environment.
• identifier(required): string
  Unique identifier that is immutable on creation.
• instanceMetadataProperties: object instanceMetadataProperties
  Additional Properties Allowed: additionalProperties

  Map for the instance Metadata System Properties
• keywords: string
  The keywords of the environment given by user.
• lifecycleState(required): string
  The current state of the environment.
• previousAgentVersion: string
  The previous agent version.
• projectId(required): string
  The environment group project Id if this environment is added to the environment group.
• systemProperties: object systemProperties
  Additional Properties Allowed: additionalProperties

  Map for the Environment System Properties
• timeAgentVersionUpdated: string (date-time)
  The time at which agent version was last updated.
• timeCreated: string (date-time)
  The time at which environment was created. An RFC3339 formatted datetime string.
• timeUpdated: string (date-time)
  The time at which environment was last updated. An RFC3339 formatted datetime string.
• updatedBy: string
  Records to user who last update the environment.

{
    "description":"Summary of an environment",
    "type":"object",
    "required":[
        "identifier",
        "displayName",
        "lifecycleState",
        "environmentGroupIdentifier",
        "environmentGroupDisplayName",
        "projectId"
    ],
    "properties":{
        "identifier":{
            "description":"Unique identifier that is immutable on creation.",
            "type":"string"
        },
        "displayName":{
            "description":"User friendly display name for the environment.",
            "type":"string"
        },
        "description":{
            "description":"User given description of the environment.",
            "type":"string"
        },
        "environmentGroupIdentifier":{
            "description":"The environment group identifier if this environment is added to the environment group.",
            "type":"string"
        },
        "environmentGroupDisplayName":{
            "description":"The environment group display name if this environment is added to the environment group.",
            "type":"string"
        },
        "projectId":{
            "description":"The environment group project Id if this environment is added to the environment group.",
            "type":"string"
        },
        "keywords":{
            "description":"The keywords of the environment given by user.",
            "type":"string"
        },
        "environmentType":{
            "description":"The type of the environment.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Environment/environmentType"
        },
        "agentVersion":{
            "description":"The agent version.",
            "type":"string",
            "minLength":1,
            "maxLength":50
        },
        "previousAgentVersion":{
            "description":"The previous agent version.",
            "type":"string"
        },
        "timeAgentVersionUpdated":{
            "description":"The time at which agent version was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"Records the user who create the environment.",
            "type":"string"
        },
        "updatedBy":{
            "description":"Records to user who last update the environment.",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the environment.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Environment/lifecycleState"
        },
        "timeCreated":{
            "description":"The time at which environment was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time at which environment was last updated. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "systemProperties":{
            "description":"Map<propName,value> for the Environment System Properties",
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "minLength":0,
                "maxLength":1024
            },
            "example":{
                "HostName":"JANEDOE-MACBOOKPRO",
                "OperatingSystemVersion":"12.6.5",
                "OperatingSystemName":"Mac OS X",
                "OperatingSystemArchitecture":"x86_64",
                "IPAddress":"10.0.1.3",
                "MacAddress":"F8-4D-89-87-F6-9D"
            }
        },
        "instanceMetadataProperties":{
            "description":"Map<propName,value> for the instance Metadata System Properties",
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "minLength":0,
                "maxLength":1024
            },
            "example":{
                "InstanceId":"ocid.instance",
                "InstancePoolId":"ocid.instancePool",
                "CompartmentId":"ocid.compartment",
                "Region":"us-ashburn-1"
            }
        }
    }
}

Nested Schema : instanceMetadataProperties

Type: object

Additional Properties Allowed

Show Source

• string
  Minimum Length: 0

  Maximum Length: 1024

{
    "description":"Map<propName,value> for the instance Metadata System Properties",
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "minLength":0,
        "maxLength":1024
    },
    "example":{
        "InstanceId":"ocid.instance",
        "InstancePoolId":"ocid.instancePool",
        "CompartmentId":"ocid.compartment",
        "Region":"us-ashburn-1"
    }
}

Map for the instance Metadata System Properties

Example:

{
    "InstanceId":"ocid.instance",
    "InstancePoolId":"ocid.instancePool",
    "CompartmentId":"ocid.compartment",
    "Region":"us-ashburn-1"
}

Nested Schema : systemProperties

Type: object

Additional Properties Allowed

Show Source

• string
  Minimum Length: 0

  Maximum Length: 1024

{
    "description":"Map<propName,value> for the Environment System Properties",
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "minLength":0,
        "maxLength":1024
    },
    "example":{
        "HostName":"JANEDOE-MACBOOKPRO",
        "OperatingSystemVersion":"12.6.5",
        "OperatingSystemName":"Mac OS X",
        "OperatingSystemArchitecture":"x86_64",
        "IPAddress":"10.0.1.3",
        "MacAddress":"F8-4D-89-87-F6-9D"
    }
}

Map for the Environment System Properties

Example:

{
    "HostName":"JANEDOE-MACBOOKPRO",
    "OperatingSystemVersion":"12.6.5",
    "OperatingSystemName":"Mac OS X",
    "OperatingSystemArchitecture":"x86_64",
    "IPAddress":"10.0.1.3",
    "MacAddress":"F8-4D-89-87-F6-9D"
}

Nested Schema : EnvironmentLifecycleConfig

Type: object

Agent Lifecycle Management

Show Source

• isAutoUpgrade(required): boolean
  Auto upgrade agents?
• retirementPolicy: string
  Agent retirement policy.

{
    "description":"Agent Lifecycle Management",
    "type":"object",
    "required":[
        "isAutoUpgrade"
    ],
    "properties":{
        "isAutoUpgrade":{
            "type":"boolean",
            "description":"Auto upgrade agents?"
        },
        "retirementPolicy":{
            "type":"string",
            "description":"Agent retirement policy."
        }
    }
}

Nested Schema : EnvironmentScalingConfig

Type: object

Holds ScalingConfig

Show Source

• evaluationMode: string
  Allowed Values: [ "AVERAGE", "MAX", "MEDIAN", "WEIGHTED_AVG", "P95", "P99" ]

  probing duration in sec.
• maxAgentVm(required): integer
  Maximum agent VM count.
• maxVmProvisionedAtOnce: integer
  maximum number of VM can be provisioned at a time.
• metricIntervalSec: integer
  how often metrics are collected.
• minAgentVm(required): integer
  Minimum agent VM count.
• noOfAgentPerVm: integer
  Number of agent per VM
• probingDurationSec: integer
  probing duration in sec.
• scaleInRule(required): object EnvironmentScaleRule
  Holds ScaleRule
• scaleOutRule(required): object EnvironmentScaleRule
  Holds ScaleRule

{
    "type":"object",
    "description":"Holds ScalingConfig",
    "required":[
        "minAgentVm",
        "maxAgentVm",
        "scaleOutRule",
        "scaleInRule"
    ],
    "properties":{
        "minAgentVm":{
            "type":"integer",
            "description":"Minimum agent VM count."
        },
        "maxAgentVm":{
            "type":"integer",
            "description":"Maximum agent VM count."
        },
        "noOfAgentPerVm":{
            "type":"integer",
            "description":"Number of agent per VM"
        },
        "probingDurationSec":{
            "type":"integer",
            "description":"probing duration in sec."
        },
        "maxVmProvisionedAtOnce":{
            "type":"integer",
            "description":"maximum number of VM can be provisioned at a time."
        },
        "metricIntervalSec":{
            "type":"integer",
            "description":"how often metrics are collected."
        },
        "evaluationMode":{
            "type":"string",
            "description":"probing duration in sec.",
            "enum":[
                "AVERAGE",
                "MAX",
                "MEDIAN",
                "WEIGHTED_AVG",
                "P95",
                "P99"
            ]
        },
        "scaleOutRule":{
            "$ref":"#/components/schemas/EnvironmentScaleRule"
        },
        "scaleInRule":{
            "$ref":"#/components/schemas/EnvironmentScaleRule"
        }
    }
}

Nested Schema : EnvironmentScaleRule

Type: object

Holds ScaleRule

Show Source

• cooldownPeriodSec: integer
  Cooldown period (sec).
• utilizationThreshold(required): integer
  Utilization threshold (%).

{
    "description":"Holds ScaleRule",
    "type":"object",
    "required":[
        "utilizationThreshold"
    ],
    "properties":{
        "utilizationThreshold":{
            "type":"integer",
            "description":"Utilization threshold (%)."
        },
        "cooldownPeriodSec":{
            "type":"integer",
            "description":"Cooldown period (sec)."
        }
    }
}

400 Response

Bad Request

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Default Response

Unknown Error

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Back to Top