Retrieve Details of an OrchestrationV2
/platform/v1/orchestration/{name}
Required Role: To complete this task, you must have the 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
- application/oracle-compute-v3+json
-
name: string
The three-part name of the object (
/Compute-identity_domain/user/object
).
-
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.
Response
- application/oracle-compute-v3+json
200 Response
-
set-cookie: string
The cookie value is returned if the session is extended
object
-
account(optional):
string
The default Compute Classic account, such as /Compute-acme/default.
-
description(optional):
string
Description of this orchestration
-
desired_state(optional):
string
The
desired_state
specified in the orchestration JSON file. A unique identifier for this orchestration. -
id(optional):
string
Unique identifier of this orchestration
-
name(optional):
string
The three-part name (
/Compute-identity_domain/user/object
) of the orchestration. -
objects(optional):
array objects
List of orchestration objects
-
status(optional):
string
Current status of this orchestration
-
tags(optional):
array tags
Strings that describe the orchestration and help you identify it.
-
time_audited(optional):
string
Time the orchestration was last audited
-
time_created(optional):
string
The time when the orchestration was added to Compute Classic.
-
time_updated(optional):
string
The time when the orchestration was last updated in Compute Classic.
-
uri(optional):
string
Uniform Resource Identifier
-
user(optional):
string
Name of the user who added this orchestration or made the most recent update to this orchestration.
-
version(optional):
integer
Version of this orchestration. It is automatically generated by the server.
object
-
account(optional):
string
/Compute-identity_domain/default
-
description(optional):
string
Description of this object
-
desired_state(optional):
string
The desired state of this object
-
health(optional):
object health
Additional Properties Allowed: additionalPropertiesDictionary containing the current state of the object
-
label(optional):
string
Human-readable identifier for this object
-
name(optional):
string
Name of this object, generated by the server
-
orchestration(optional):
string
The orchestration to which this object belongs
-
persistent(optional):
boolean
If the value is
true
, it indicates that the object is not deleted when the associated orchestration is suspended. If persistent is set tofalse
, the object is deleted when the associated orchestration is suspended. -
relationships(optional):
array relationships
List of relationships to other objects
-
template(optional):
object template
Additional Properties Allowed: additionalPropertiesTemplate of this object object
-
time_audited(optional):
string
Time the object was last audited
-
time_created(optional):
string
Object creation time
-
time_updated(optional):
string
Object modification time
-
type(optional):
string
Type of object this object represents
-
uri(optional):
string
Uniform Resource Identifier
-
user(optional):
string
User acting on this object
-
version(optional):
integer
Version of this object, generated by the server
object
array
-
Array of:
object items
Additional Properties Allowed: additionalProperties
object
object
object
object
Examples
cURL Command
The following example shows how to retrieve 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 "Content-Type: application/oracle-compute-v3+json" -H "Accept: application/oracle-compute-v3+json" https://api-z999.compute.us0.oraclecloud.com/platform/v1/orchestration/Compute-acme/jack.jones@example.com/firstOrchestration
-
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
andjack.jones@example.com
are example values. Replaceacme
with the identity domain ID of your Compute Classic account, andjack.jones@example.com
with your user name.
Example of Response Body
The following example shows the response body in JSON format.
{ "status": "active", "account": "/Compute-acme/default", "time_updated": "2017-03-08T17:00:20Z", "description": "", "tags": [], "uri": "https://api-z999.compute.us0.oraclecloud.com/platform/v1/orchestration/Compute-acme/jack.jones@example.com/firstOrchestration", "time_created": "2017-03-08T14:14:25Z", "name": "/Compute-acme/jack.jones@example.com/firstOrchestration", "time_audited": "2017-03-08T18:34:32Z", "objects": [{ "relationships": [], "account": "/Compute-acme/default", "time_updated": "2017-03-08T17:00:20Z", "description": "", "user": "/Compute-acme/jack.jones@example.com", "persistent": false, "uri": "https://api-z999.compute.us0.oraclecloud.com/platform/v1/object/Compute-acme/jack.jones@example.com/firstOrchestration/c18a1d1b-fdf4-48fd-b6f7-271bfa4d8bd7", "template": { "name": "/Compute-acme/jack.jones@example.com/seclist" }, "label": "my-first-seclist", "time_audited": "2017-03-08T18:34:23Z", "version": 2, "health": { "status": "active", "object": { "account": "/Compute-acme/default", "description": "", "uri": "https://api-z999.compute.us0.oraclecloud.com/seclist/Compute-acme/jack.jones@example.com/seclist", "outbound_cidr_policy": "PERMIT", "policy": "DENY", "name": "/Compute-acme/jack.jones@example.com/seclist" } }, "time_created": "2017-03-08T14:14:25Z", "orchestration": "/Compute-acme/jack.jones@example.com/firstOrchestration", "type": "SecList", "name": "/Compute-acme/jack.jones@example.com/firstOrchestration/c18a1d1b-fdf4-48fd-b6f7-271bfa4d8bd7" }], "user": "/Compute-acme/jack.jones@example.com", "version": 2, "id": "dd3d3d40-a2ab-434f-be5c-1acfbb200872", "desired_state": "active" }