Retrieve Details of an Orchestration

get

/orchestration/{name}

Required Role: To complete this task, you must have the Compute_Monitor or Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types
Path Parameters
  • The three-part name of the object (/Compute-identity_domain/user/object).

Header Parameters

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Headers
Body ()
Root Schema : Orchestration-response
Type: object
Show Source
Nested Schema : info
Type: object
Additional Properties Allowed
Show Source
The nested parameter errors shows which object in the orchestration has encountered an error. Empty if there are no errors.
Nested Schema : oplans
Type: array
List of oplans. An object plan, or oplan, is a top-level orchestration attribute.
Show Source
Nested Schema : relationships
Type: array
The relationship between the objects that are created by this orchestration.
Show Source
Nested Schema : schedule
Type: object
The schedule for an orchestration consists of the start and stop dates and times.
Nested Schema : additionalProperties
Type: object
Nested Schema : OPlan-response
Type: object
Show Source
Nested Schema : info
Type: object
Additional Properties Allowed
Show Source
Info dictionary for the oplan.
Nested Schema : objects
Type: array
List of object dictionaries or object names.
Show Source
Nested Schema : additionalProperties
Type: object
Nested Schema : items
Type: object
Additional Properties Allowed
Show Source
Nested Schema : additionalProperties
Type: object

Examples

cURL Command

The following example shows how to view details of an orchestration by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Accept: application/oracle-compute-v3+json"
     https://api-z999.compute.us0.oraclecloud.com/orchestration/Compute-acme/jack.jones@example.com/webportal
  • COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.

  • api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.

  • acme and jack.jones@example.com are example values. Replace acme with the identity domain ID of your Compute Classic account, and jack.jones@example.com with your user name.

Example of Response Body

The following example shows the response body in JSON format.

{
    "relationships": [],
    "status": "stopped",
    "account": "/Compute-acme/default",
    "description": "simple orchestration",
    "schedule": {
        "start_time": null,
        "stop_time": null
    },
    "uri": "https://api-z999.compute.us0.oraclecloud.com/orchestration/Compute-acme/jack.jones@example.com/webportal",
    "oplans": [
        {
            "status": "stopped",
            "info": {},
            "obj_type": "launchplan",
            "ha_policy": "active",
            "label": "webserver_lp",
            "objects": [
                {
                    "instances": [
                        {
                            "shape": "medium",
                            "imagelist": "/oracle/public/compute_oel_6.4_2GB",
                            "name": "/Compute-acme/jack.jones@example.com/primary_webserver",
                            "label": "primary_webserver"
                        }
                    ]
                }
            ]
        }
    ],
    "info": {},
    "name": "/Compute-acme/jack.jones@example.com/webportal"
}