Jump to

• Request
• Response
• Examples

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

• application/oracle-compute-v3+json

Path Parameters

• name: string

  The three-part name of the object (/Compute-identity_domain/user/object).

Header Parameters

• Cookie: string
  The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.

Back to Top

Response

Supported Media Types

• application/oracle-compute-v3+json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Headers

• set-cookie: string
  The cookie value is returned if the session is extended

Body ()

Root Schema : Orchestration-response

Type: object

Show Source

• account(optional): string
  Shows the default account for your identity domain.
• description(optional): string
  Description of this orchestration plan.
• info(optional): object info
  Additional Properties Allowed: additionalProperties

  The nested parameter errors shows which object in the orchestration has encountered an error. Empty if there are no errors.
• name(optional): string

  The three-part name of the object (/Compute-identity_domain/user/object).

• oplans(optional): array oplans
  List of oplans. An object plan, or oplan, is a top-level orchestration attribute.
• relationships(optional): array relationships
  The relationship between the objects that are created by this orchestration.
• schedule(optional): object schedule
  The schedule for an orchestration consists of the start and stop dates and times.
• status(optional): string
  Shows the current status of the orchestration.
• status_timestamp(optional): string
  This information is generally displayed at the end of the orchestration JSON. It indicates the time that the current view of the orchestration was generated. This information shows only when the orchestration is running.
• uri(optional): string
  Uniform Resource Identifier
• user(optional): string
  Two-part name of the user (/Compute-identity_domain/user) who has most recently taken an action on the orchestration.

{
    "properties":{
        "account":{
            "type":"string",
            "description":"Shows the default account for your identity domain."
        },
        "description":{
            "type":"string",
            "description":"Description of this orchestration plan."
        },
        "info":{
            "additionalProperties":{
                "type":"object"
            },
            "type":"object",
            "description":"The nested parameter <code>errors</code> shows which object in the orchestration has encountered an error. Empty if there are no errors."
        },
        "name":{
            "type":"string",
            "description":"<p>The three-part name of the object (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>)."
        },
        "oplans":{
            "items":{
                "$ref":"#/definitions/OPlan-response"
            },
            "type":"array",
            "description":"List of oplans. An object plan, or oplan, is a top-level orchestration attribute."
        },
        "relationships":{
            "items":{
                "additionalProperties":{
                    "type":"object"
                },
                "type":"object"
            },
            "type":"array",
            "description":"The relationship between the objects that are created by this orchestration."
        },
        "schedule":{
            "type":"object",
            "description":"The schedule for an orchestration consists of the start and stop dates and times."
        },
        "status":{
            "type":"string",
            "description":"Shows the current status of the orchestration."
        },
        "status_timestamp":{
            "type":"string",
            "description":"This information is generally displayed at the end of the orchestration JSON. It indicates the time that the current view of the orchestration was generated. This information shows only when the orchestration is running."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        },
        "user":{
            "type":"string",
            "description":"Two-part name of the user (<code>/Compute-<em>identity_domain</em>/<em>user</em></code>) who has most recently taken an action on the orchestration."
        }
    }
}

Nested Schema : info

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "type":"object",
    "description":"The nested parameter <code>errors</code> shows which object in the orchestration has encountered an error. Empty if there are no errors."
}

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

• Array of: object OPlan-response

{
    "items":{
        "$ref":"#/definitions/OPlan-response"
    },
    "type":"array",
    "description":"List of oplans. An object plan, or oplan, is a top-level orchestration attribute."
}

Nested Schema : relationships

Type: array

The relationship between the objects that are created by this orchestration.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "items":{
        "additionalProperties":{
            "type":"object"
        },
        "type":"object"
    },
    "type":"array",
    "description":"The relationship between the objects that are created by this orchestration."
}

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

• ha_policy(optional): string
• info(optional): object info
  Additional Properties Allowed: additionalProperties

  Info dictionary for the oplan.
• label(optional): string
  Description of this object plan.
• obj_type(optional): string
  Type of the object.
• objects(optional): array objects
  List of object dictionaries or object names.
• status(optional): string
  Most recent status.
• status_timestamp(optional): string
  Timestamp of the most-recent status change.

{
    "properties":{
        "ha_policy":{
            "type":"string",
            "description":""
        },
        "info":{
            "additionalProperties":{
                "type":"object"
            },
            "type":"object",
            "description":"Info dictionary for the oplan."
        },
        "label":{
            "type":"string",
            "description":"Description of this object plan."
        },
        "obj_type":{
            "type":"string",
            "description":"Type of the object."
        },
        "objects":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of object dictionaries or object names."
        },
        "status":{
            "type":"string",
            "description":"Most recent status."
        },
        "status_timestamp":{
            "type":"string",
            "description":"Timestamp of the most-recent status change."
        }
    }
}

Nested Schema : info

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "type":"object",
    "description":"Info dictionary for the oplan."
}

Info dictionary for the oplan.

Nested Schema : objects

Type: array

List of object dictionaries or object names.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of object dictionaries or object names."
}

Nested Schema : additionalProperties

Type: object

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "type":"object"
}

Nested Schema : additionalProperties

Type: object

Back to Top

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/[e-mail]/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 [e-mail] are example values. Replace acme with the identity domain ID of your Compute Classic account, and [e-mail] 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/[e-mail]/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/[e-mail]/primary_webserver",
                            "label": "primary_webserver"
                        }
                    ]
                }
            ]
        }
    ],
    "info": {},
    "name": "/Compute-acme/[e-mail]/webportal"
}

Back to Top