1. REST API for Oracle Cloud Infrastructure Compute Classic
  2. Tasks
  3. OrchestrationObjects

Retrieve Details of all Orchestration Objects in a Container

get

/platform/v1/object/{container}/

Retrieves details of all the orchestration objects that are available and match the specified query criteria. If you don't specify any query criteria, then details of all the orchestration objects in the container are displayed. To filter the search results, you can pass one or more of the documented query parameters by appending them to the URI in the following syntax:

?parameter1=value1&parameter2=value2&parameterN=valueN

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

Supported Media Types
Path Parameters
  • Specify /Compute-identity_domain/user or /Compute-identity_domain.

    Specify the three-part name of the orchestration (/Compute-identity_domain/user/orchestration) to retrieve details of all the objects in that orchestration.

Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Headers
Body ()
Root Schema : OrchestrationObject-list-response
Type: object
Show Source
Nested Schema : result
Type: array
Show Source
Nested Schema : OrchestrationObject-response
Type: object
Show Source
Nested Schema : health
Type: object
Additional Properties Allowed
Show Source
Dictionary containing the current state of the object
Nested Schema : relationships
Type: array
List of relationships to other objects
Show Source
Nested Schema : template
Type: object
Additional Properties Allowed
Show Source
Template of this object object
Nested Schema : additionalProperties
Type: object
Nested Schema : items
Type: object
Additional Properties Allowed
Show Source
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Back to Top

Examples

cURL Command

The following example shows how to retrieve details about all orchestration objects in the /Compute-acme/jack.jones@example.com/firstOrchestration 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/object/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 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.

{
  "result": [
     {
      "relationships": [
        
      ],
      "account": "/Compute-acme/default",
      "time_updated": "2017-03-10T08:42:39Z",
      "desired_state": "inherit",
      "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/my-seclist",
      "template": {
        "name": "/Compute-acme/jack.jones@example.com/my-seclist"
      },
      "label": "my-seclist",
      "time_audited": "2017-03-10T12:29:43Z",
      "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/my-seclist",
          "outbound_cidr_policy": "PERMIT",
          "policy": "DENY",
          "name": "/Compute-acme/jack.jones@example.com/my-seclist"
        }
      },
      "time_created": "2017-03-09T11:05:43Z",
      "orchestration": "/Compute-acme/jack.jones@example.com/firstOrchestration",
      "type": "SecList",
      "name": "/Compute-acme/jack.jones@example.com/firstOrchestration/my-seclist"
    },
    {
      "relationships": [
        
      ],
      "account": "/Compute-acme/default",
      "time_updated": "2017-03-10T08:44:45Z",
      "desired_state": "inherit",
      "description": "a persistent storage volume",
      "user": "/Compute-acme/jack.jones@example.com",
      "persistent": true,
      "uri": "https://api-z999.compute.us0.oraclecloud.com/platform/v1/object/Compute-acme/jack.jones@example.com/firstOrchestration/volume1",
      "template": {
        "size": "2G",
        "properties": [
          "/oracle/public/storage/default"
        ],
        "name": "/Compute-acme/jack.jones@example.com/volume1"
      },
      "label": "myVolume1",
      "time_audited": "2017-03-20T16:04:20Z",
      "version": 4,
      "health": {
        "status": "active",
        "object": {
          "managed": true,
          "snapshot_id": null,
          "snapshot_account": null,
          "machineimage_name": null,
          "status_timestamp": "2017-03-20T15:57:57Z",
          "imagelist": null,
          "writecache": false,
          "size": "2147483648",
          "platform": null,
          "readonly": false,
          "storage_pool": "/Compute-acme/storagepool/iscsi/thruput_1",
          "shared": false,
          "status": "Online",
          "hash": 1665999033,
          "description": null,
          "tags": [
            
          ],
          "quota": null,
          "status_detail": null,
          "properties": [
            "/oracle/public/storage/default"
          ],
          "account": "/Compute-acme/default",
          "name": "/Compute-acme/jack.jones@example.com/volume1",
          "bootable": false,
          "hypervisor": null,
          "uri": "http://10.252.131.5/storage/volume/Compute-acme/jack.jones@example.com/volume1",
          "imagelist_entry": -1,
          "snapshot": null
        }
      },
      "time_created": "2017-03-10T07:05:24Z",
      "orchestration": "/Compute-acme/jack.jones@example.com/firstOrchestration",
      "type": "StorageVolume",
      "name": "/Compute-acme/jack.jones@example.com/firstOrchestration/volume1"
    }
  ]
}
Back to Top