Jump to

• Request
• Response
• Examples

Retrieve Details of all Storage Properties in a Container

get

/property/storage/{container}/

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

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

Note: Other storage properties might be listed. But don't use any of them. For storage volumes that require low latency and high IOPS, such as for storing database files, select /oracle/public/storage/latency. For all other storage volumes, select /oracle/public/storage/default.

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

• container: string
  /oracle/public

Query Parameters

• name(optional): string
  Specify one of the following storage properties:

  • oracle/public/storage/default
  • oracle/public/storage/latency

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 : StorageProperty-list-response

Type: object

Show Source

• result(optional): array result

{
    "properties":{
        "result":{
            "items":{
                "$ref":"#/definitions/StorageProperty-response"
            },
            "type":"array"
        }
    }
}

Nested Schema : result

Type: array

Show Source

• Array of: object StorageProperty-response

{
    "items":{
        "$ref":"#/definitions/StorageProperty-response"
    },
    "type":"array"
}

Nested Schema : StorageProperty-response

Type: object

Show Source

• description(optional): string
  Description of this property.
• name(optional): string
  one of the following storage properties:

  • oracle/public/storage/default
  • oracle/public/storage/latency
• uri(optional): string
  Uniform Resource Identifier

{
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of this property."
        },
        "name":{
            "type":"string",
            "description":"one of the following storage properties:<ul><li>oracle/public/storage/default</li><li>oracle/public/storage/latency</li>"
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        }
    }
}

Back to Top

Examples

cURL Command

The following example shows how to retrieve details about all storage properties in the /oracle/public container 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/property/storage/oracle/public/

• 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.

Example of Response Body

The following example shows the response body in JSON format.

{
  "result": [
    {
      "description": "Default storageproperty for all StoragePools and StorageVolumes",
      "uri": "https://api-z999.compute.us0.oraclecloud.com/property/storage/oracle/public/storage/default",
      "name": "/oracle/public/storage/default"
    },
    {
      "description": "for accessing iSCSI volumes optimized for latency",
      "uri": "https://api-z999.compute.us0.oraclecloud.com/property/storage/oracle/public/storage/latency",
      "name": "/oracle/public/storage/latency"
    },
    {
      "description": "Default property used for storing snapshot",
      "uri": "http://api-z999.compute.us0.oraclecloud.com/property/storage/oracle/public/storage/snapshot/default",
      "name": "/oracle/public/storage/snapshot/default"
    }
   ]
}

Back to Top