Jump to

• Request
• Response

Create Environment Group

post

/rpa/v1/environmentGroups

Creates a new Environment Group.

Request

Header Parameters

• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

The information for creating a new Environment Group

Show Source

• autonomousConfig: object AutonomousEnvironmentPoolConfig
  Holds Autonomous Environment Pool Specification
• description: string
  Minimum Length: 0

  Maximum Length: 1024

  Description of the Env. Group.
• displayName(required): string
  Minimum Length: 1

  Maximum Length: 50

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

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

  Maximum Length: 1024

  Keywords.
• projectId(required): string
  Maximum Length: 32

  Project where the env. group belongs
• projectType: string
  Project Type
• subType: string
  Ownership model.
• type: string
  Pool management mode.

{
    "description":"The information for creating a new Environment Group",
    "type":"object",
    "required":[
        "projectId",
        "identifier",
        "displayName"
    ],
    "properties":{
        "projectId":{
            "description":"Project where the env. group belongs",
            "type":"string",
            "maxLength":32
        },
        "projectType":{
            "description":"Project Type",
            "type":"string"
        },
        "identifier":{
            "description":"Envrinoment Group identifier",
            "type":"string",
            "maxLength":32
        },
        "displayName":{
            "description":"User friendly display name for the environment group",
            "type":"string",
            "minLength":1,
            "maxLength":50
        },
        "description":{
            "description":"Description of the Env. Group.",
            "type":"string",
            "minLength":0,
            "maxLength":1024
        },
        "keywords":{
            "description":"Keywords.",
            "type":"string",
            "minLength":0,
            "maxLength":1024
        },
        "isSharedEnvironmentGroup":{
            "description":"shared environment group",
            "type":"boolean"
        },
        "type":{
            "type":"string",
            "description":"Pool management mode.",
            "x-obmcs-enumref":"#/definitions/EnvironmentGroup/type"
        },
        "subType":{
            "type":"string",
            "description":"Ownership model.",
            "x-obmcs-enumref":"#/definitions/EnvironmentGroup/subType"
        },
        "autonomousConfig":{
            "$ref":"#/components/schemas/AutonomousEnvironmentPoolConfig"
        }
    }
}

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 : 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)."
        }
    }
}

Back to Top

Response

202 Response

Accepted the request. The Environment Group will be created.

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.
• opc-work-request-id:
  Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

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"
        }
    }
}

409 Response

Conflict

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