Jump to

• Request
• Response
• Examples

View IORM shares

get

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/iorm

Returns the current IORM share allocations.

Request

Path Parameters

• identityDomainId: string

  The value depends on the type of Exadata Cloud Service account that is used to make the request:

  • For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.

  • For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.

• serviceId: string
  Name of the Exadata Cloud Service database deployment.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
• X-ID-TENANT-NAME: string

  The value depends on the type of Exadata Cloud Service account that is used to make the request:

  • For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.

  • For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.

  For more information, see Security, Authentication and Authorization.

Back to Top

Response

Supported Media Types

• application/json

200 Response

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

Body ()

Root Schema : iorm-getresponse

Type: object

The response containing IORM shares.

Show Source

• DbPlan(optional): array DbPlan
  Output of the IORM dbplan.

{
    "description":"The response containing IORM shares.",
    "properties":{
        "DbPlan":{
            "type":"array",
            "description":"Output of the IORM dbplan.",
            "items":{
                "$ref":"#/definitions/iorm-get-db-response"
            }
        }
    }
}

Nested Schema : DbPlan

Type: array

Output of the IORM dbplan.

Show Source

• Array of: object iorm-get-db-response
  Contains details of the IORM shares.

{
    "type":"array",
    "description":"Output of the IORM dbplan.",
    "items":{
        "$ref":"#/definitions/iorm-get-db-response"
    }
}

Nested Schema : iorm-get-db-response

Type: object

Contains details of the IORM shares.

Show Source

• dbname(optional): string
  The database name associated with the Exadata Cloud Service database deployment.
• flashcachelimit(optional): string
  The amount of Exadata Smart Flash Cache allocated to the database deployment.
• share(optional): string
  The number of IORM shares to allocated to the database deployment.

{
    "description":"Contains details of the IORM shares.",
    "properties":{
        "dbname":{
            "type":"string",
            "description":"The database name associated with the Exadata Cloud Service database deployment."
        },
        "share":{
            "type":"string",
            "description":"The number of IORM shares to allocated to the database deployment."
        },
        "flashcachelimit":{
            "type":"string",
            "description":"The amount of Exadata Smart Flash Cache allocated to the database deployment."
        }
    }
}

Back to Top

Examples

The following example shows how to view information about the Exadata I/O Resource Management (IORM) plan associated with an Exadata Cloud Service database deployment by submitting a GET request on the REST endpoint using cURL.

In this example:

• The identity domain associated with the request is usexample.

• The user name and password for the Oracle Cloud user performing the request are serviceadmin and Pa55_word.

• The name of the database deployment associated with the request is db12c.

cURL Command

curl -i -X GET --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample"  https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c/iorm

HTTP Status Code and Response Headers

HTTP/2.0 200
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
content-language: en
access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
x-oracle-dms-ecid: 005MPEZ7e_u6uHFpR0H7id0003mK0002ps
x-oracle-dms-ecid: 005MPEZ7e_u6uHFpR0H7id0003mK0002ps
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Tue, 19 Sep 2017 23:59:03 GMT
content-length: 184

Response Body

{
	"DbPlan": [{
			"dbname": "DB12C",
			"share": "4",
			"flashcachelimit": "6358G"
		}, {
			"dbname": "STRT",
			"share": "6",
			"flashcachelimit": "9538G"
		}, {
			"dbname": "default",
			"share": "5",
			"flashcachelimit": "7948G"
		}
	]
}

Back to Top