Jump to

• Request
• Response
• Examples

Set IORM shares

put

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

Specify IORM shares for Exadata Cloud Service database deployments.

Request

Supported Media Types

• application/vnd.com.oracle.oracloud.provisioning.Service+json

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.

Body ()

The request body defines the details of the request. Bold indicates a required value.

Root Schema : iorm-putrequest

Type: object

The request for setting IORM shares.

Show Source

• DBPlan(optional): array DBPlan
  Parameters for the IORM dbplan.

{
    "description":"The request for setting IORM shares.",
    "properties":{
        "DBPlan":{
            "type":"array",
            "description":"Parameters for the IORM dbplan.",
            "items":{
                "$ref":"#/definitions/iorm-put-parameters"
            }
        }
    }
}

Nested Schema : DBPlan

Type: array

Parameters for the IORM dbplan.

Show Source

• Array of: object iorm-put-parameters
  The parameters for setting IORM shares.

{
    "type":"array",
    "description":"Parameters for the IORM dbplan.",
    "items":{
        "$ref":"#/definitions/iorm-put-parameters"
    }
}

Nested Schema : iorm-put-parameters

Type: object

The parameters for setting IORM shares.

Show Source

• dbname(optional): string
  The database name, as contained in the DBNAME database initialization parameter.
• share(optional): string
  The number of IORM shares allocated to the database deployment. Specify a value between 1 and 32.

{
    "description":"The parameters for setting IORM shares.",
    "properties":{
        "dbname":{
            "type":"string",
            "description":"The database name, as contained in the <code>DBNAME</code> database initialization parameter."
        },
        "share":{
            "type":"string",
            "description":"The number of IORM shares allocated to the database deployment. Specify a value between 1 and 32."
        }
    }
}

Back to Top

Response

200 Response

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

Back to Top

Examples

The following example shows how to set the Exadata I/O Resource Management (IORM) plan associated with an Exadata Cloud Service database deployment by submitting a PUT 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.

• The default IORM share allocation is set to 5.

• The IORM share allocation for the DB12C database is set to 4.

• The IORM share allocation for the STRT database is set to 6.

cURL Command

In the following cURL command, the request body is provided directly in the -d option.

curl -i -X PUT --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample" -H "Content-Type:application/json" -d '{"DBPlan":[{"dbname":"DB12C","share":"4"},{"dbname":"STRT","share":"6"},{"dbname":"default","share":"5"}]}' 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: 005MPBz0^9G6uHFpR0H7id0003mK0002aZ
x-oracle-dms-ecid: 005MPBz0^9G6uHFpR0H7id0003mK0002aZ
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Tue, 19 Sep 2017 23:13:02 GMT
content-length: 85

Response Body

IORM dbplan for Exadata System [exacs] in Identity Domain [usexample] set successfully

Back to Top