The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/available-patches-response" } } }, "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-patches-available-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-patches-available-get" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/{patchId}":{ "put":{ "tags":[ "Manage Patching" ], "summary":"Apply a Patch", "description":"Applies a patch to an Exadata Cloud at Customer database deployment.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"The request body contains details of the patch request. There are no required values.", "required":true, "schema":{ "$ref":"#/definitions/apply-request" } } ], "responses":{ "202":{ "description":"Accepted. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/put-response" } } }, "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-patches-{patchId}-put", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-patches-patchid-put" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/applied":{ "get":{ "tags":[ "Manage Patching" ], "summary":"View Applied Patches", "description":"Returns a list of all applied patches for an Exadata Cloud at Customer database deployment.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/applied-patches-response" } } }, "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-patches-applied-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-patches-applied-get" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/applied/job/{jobId}":{ "get":{ "tags":[ "Manage Patching" ], "summary":"View a Patch Operation", "description":"Returns information about the specified patching operation for an Exadata Cloud at Customer database deployment.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/applied-patch" } } }, "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-patches-applied-job-{jobId}-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-patches-applied-job-jobid-get" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/checks/{patchId}":{ "put":{ "tags":[ "Manage Patching" ], "summary":"Perform a Patching Precheck", "description":"Performs a precheck to identity potential issues that might prevent the specified patch from completing successfully. Specifically, the patching precheck reports on the following conditions:Prechecks do not check whether another administration task (such as backup or restoration) is in progress, which would prevent patching.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"The request body contains details of the patch request. There are no required values.", "required":true, "schema":{ "$ref":"#/definitions/precheck-request" } } ], "responses":{ "202":{ "description":"Accepted. See Status Codes for information about other possible HTTP status codes.The Location header returns a REST URI that can be used to access the status of the patching precheck operation.",
"schema":{
"$ref":"#/definitions/put-response"
}
}
},
"x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-patches-checks-{patchId}-put",
"x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-patches-checks-patchid-put"
}
},
"/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/checks":{
"get":{
"tags":[
"Manage Patching"
],
"summary":"View All Patching Precheck Operations",
"description":"Returns the status of all patching precheck operations that have been executed against the service instance.",
"produces":[
"application/json"
],
"parameters":[
{
"name":"identityDomainId",
"in":"path",
"description":"
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-precheck-response" } } }, "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-patches-checks-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-patches-checks-get" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/checks/job/{jobId}":{ "get":{ "tags":[ "Manage Patching" ], "summary":"View the Status of a Patching Precheck Operation", "description":"Returns the status of a patching precheck operation.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "202":{ "description":"Accepted. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-precheck-response" } } }, "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-patches-checks-job-{jobId}-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-patches-checks-job-jobid-get" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/{rollbackId}/rollback":{ "put":{ "tags":[ "Manage Patching" ], "summary":"Rollback a Patch", "description":"Rolls back a patch for an Exadata Cloud at Customer database deployment.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"", "required":true, "schema":{ "$ref":"#/definitions/rollback-request" } } ], "responses":{ "202":{ "description":"Accepted. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/put-response" } } }, "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-patches-{rollbackId}-rollback-put", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-patches-rollbackid-rollback-put" } }, "/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups":{ "get":{ "summary":"View All Backup Operations", "description":"Returns a list of all available backups for an Exadata Cloud at Customer database deployment, including both scheduled and on-demand backups.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-all-backups" } } }, "tags":[ "Manage Backup and Recovery" ], "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-backups-get", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-backups-get" }, "post":{ "summary":"Start a Backup Operation", "description":"Starts an on-demand backup for an Exadata Cloud at Customer database deployment.", "consumes":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"", "required":true, "schema":{ "$ref":"#/definitions/start-backup" } } ], "responses":{ "202":{ "headers":{ "Location":{ "description":"A REST URI you can use to check the progress and completion of the backup operation, as described in View the Job Status of an Operation.", "type":"string" } }, "description":"Accepted. See Status Codes for information about other possible HTTP status codes." } }, "tags":[ "Manage Backup and Recovery" ], "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-backups-post", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-backups-post" } }, "/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups/recovery":{ "post":{ "summary":"Start a Recovery Operation", "description":"Starts a recovery operation on an Exadata Cloud at Customer database deployment using the latest backup or to a point in time specified by a backup tag, timestamp, or SCN (System Change Number).", "consumes":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"", "required":true, "schema":{ "$ref":"#/definitions/start-recovery" } } ], "responses":{ "202":{ "headers":{ "Location":{ "description":"A REST URI you can use to check the progress and completion of the recovery operation, as described in View the Job Status of an Operation.", "type":"string" } }, "description":"Accepted. See Status Codes for information about other possible HTTP status codes." } }, "tags":[ "Manage Backup and Recovery" ], "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-backups-recovery-post", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-backups-recovery-post" } }, "/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups/recovery/history":{ "get":{ "summary":"View All Recovery Operations", "description":"Returns a list of recovery operations performed on an Exadata Cloud at Customer database deployment.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-all-recoveries" } } }, "tags":[ "Manage Backup and Recovery" ], "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-backups-recovery-history-get", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-backups-recovery-history-get" } }, "/paas/service/dbcs/api/v1.1/instances/{identityDomainId}":{ "post":{ "tags":[ "Manage Database Deployments" ], "summary":"Create a Database Deployment", "description":"Creates an Exadata Cloud at Customer database deployment.", "consumes":[ "application/vnd.com.oracle.oracloud.provisioning.Service+json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"payload", "in":"body", "description":"The request body defines the details of the request. Bold indicates a required value.", "required":true, "schema":{ "$ref":"#/definitions/create-postrequest" } } ], "responses":{ "202":{ "description":"Accepted. See Status Codes for information about other possible HTTP status codes.The Location header returns a REST URI that can be used to access the status of the operation, as described in View the Status of an Operation." } }, "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-post", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-post" }, "get":{ "tags":[ "View Details" ], "summary":"View All Database Deployments", "description":"Returns information about all database deployments in an identity domain.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"outputLevel", "in":"query", "description":"Set this parameter toverbose to generate a response that contains the full set of details for all database deployments.",
"required":false,
"type":"boolean"
}
],
"responses":{
"202":{
"description":"Accepted. See Status Codes for information about other possible HTTP status codes.",
"schema":{
"$ref":"#/definitions/allinstances-response"
}
}
},
"x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-get",
"x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-get"
}
},
"/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}":{
"get":{
"tags":[
"View Details"
],
"summary":"View a Database Deployment",
"description":"Returns information about an Exadata Cloud at Customer database deployment.",
"produces":[
"application/json"
],
"parameters":[
{
"name":"identityDomainId",
"in":"path",
"description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "202":{ "description":"Accepted. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/instance-response" } } }, "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-get", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-get" }, "post":{ "tags":[ "Stop, Start or Restart a Compute Node" ], "summary":"Stop, Start or Restart a Compute Node", "description":"Stops, starts or restarts a compute node associated with an Exadata Cloud at Customer database deployment. These operations impact all databases running on the compute node.", "consumes":[ "application/vnd.com.oracle.oracloud.provisioning.Service+json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"payload", "in":"body", "description":"The request body defines the details of the compute node lifecycle request. Bold indicates a required value.", "required":true, "schema":{ "$ref":"#/definitions/stopstart-postrequest" } } ], "responses":{ "202":{ "description":"Accepted. See Status Codes for information about other possible HTTP status codes.The Location header returns a REST URI that can be used to access the status of the operation, as described in View the Status of an Operation." } }, "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-post", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-post" }, "delete":{ "tags":[ "Manage Database Deployments" ], "summary":"Delete a Database Deployment", "description":"Deletes an Exadata Cloud at Customer database deployment.", "consumes":[ "application/vnd.com.oracle.oracloud.provisioning.Service+json" ], "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
true deletes all backups of the database from the Oracle Cloud Storage container. Use caution in specifying this option. If this option is specified, the database cannot be recovered as all backups will be deleted. Default value is false.",
"required":false,
"type":"boolean"
},
{
"name":"Authorization",
"in":"header",
"description":"Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.",
"required":true,
"type":"string"
},
{
"name":"X-ID-TENANT-NAME",
"in":"header",
"description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "202":{ "description":"Accepted. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/delete-response" } } }, "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-delete", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-delete" } }, "/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/servers":{ "get":{ "tags":[ "View Details" ], "summary":"View Compute Nodes", "description":"Returns information about the compute nodes associated with an Exadata Cloud at Customer database deployment.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "202":{ "description":"Accepted. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/instance-response" } } }, "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-servers-get", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-servers-get" } }, "/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/status/{requestName}/job/{jobId}":{ "get":{ "tags":[ "View Details" ], "summary":"View the Status of an Operation", "description":"Returns the status of an operation on Exadata Cloud at Customer.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
Name of the request for which you want to view status.
Valid values include:
create: View the status for a create operation, as described in Create a Database Deployment.delete: View the status of a delete operation, as described in Delete a Database Deployment.control: View the status of a compute node lifecycle state control operation, as described in Stop, Start or Restart a Compute Node.The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/jobstatus-response" } } }, "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-status-{requestName}-job-{jobId}-get", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-status-requestname-job-jobid-get" } }, "/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/iorm":{ "put":{ "tags":[ "Control Exadata IORM" ], "summary":"Set IORM shares", "description":"Specify IORM shares for Exadata Cloud at Customer database deployments.", "consumes":[ "application/vnd.com.oracle.oracloud.provisioning.Service+json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"payload", "in":"body", "description":"The request body defines the details of the request. Bold indicates a required value.", "required":true, "schema":{ "$ref":"#/definitions/iorm-putrequest" } } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes." } }, "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-iorm-put", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-iorm-put" }, "get":{ "tags":[ "Control Exadata IORM" ], "summary":"View IORM shares", "description":"Returns the current IORM share allocations.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/iorm-getresponse" } } }, "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-iorm-get", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-iorm-get" } }, "/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/ibkup":{ "put":{ "tags":[ "Manage Database Deployments" ], "summary":"Replace a Database Using a Cloud Backup", "description":"Replace the database in an existing Exadata Cloud at Customer database deployment using a backup of another database.
The backup must be have been created by Oracle Database Backup Cloud Service and stored in an Oracle Storage Cloud Service container. Additionally, the database contained by the cloud backup must meet certain suitability requirements:
It must be at version 12.2.0.1, 12.1.0.2 or 11.2.0.4.0 with the latest PSU (patch set update) applied.
If it is an Oracle 12c database, it must be a multitenant container database (CDB). Exadata Cloud at Customer does not support non-CDB Oracle 12c databases.
It must use File System or ASM as its storage method for data files.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"payload", "in":"formData", "description":"String containing a JSON object with the following parameters:
Use this option to indicate the origin of the source database backup. The origin of the backup may be another Exadata Cloud at Customer database deployment in the same identity domain or another (on-premise) database that was backed up to cloud storage using Database Backup Cloud Service. Valid values are true for an on-premise database backup and false for another Exadata Cloud at Customer database backup. Default value is true.
Database id of the database from which the existing cloud backup was created. This parameter is required if ibkupOnPremise is set to true.
Password used to create the existing, password-encrypted cloud backup. This password is used to decrypt the backup. Specify either ibkupDecryptionKey or walletArchiveFile for decrypting the backup. A decryption key or wallet is required if ibkupOnPremise is set to true.
Name of the Oracle Storage Cloud Service container where the existing cloud backup is stored. This parameter is required if ibkupOnPremise is set to true.
User name of an Oracle Cloud user who has read access to the container specified in ibkupCloudStorageContainer. This parameter is required if ibkupOnPremise is set to true.
Password of the Oracle Cloud user specified in ibkupCloudStorageUser. This parameter is required if ibkupOnPremise is set to true.
Exadata Cloud at Customer database deployment name whose backup is being used as the source of the instantiate from backup operation. This parameter is required if ibkupOnPremise is set to false.
Synchronize the attributes of a database deployment to update the control plane in case outside updates were applied.
Update values such as Grid Infrastructure software version, Oracle Database software version, pluggable database name, etc.
", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"payload", "in":"body", "description":"The request body defines the details of the request. Bold indicates a required value.", "required":true, "schema":{ "$ref":"#/definitions/synch-request" } } ], "responses":{ "200":{ "description":"Accepted. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/synch-response" } } }, "x-internal-id":"paas-service-dbcs-api-v1.1-instances-{identityDomainId}-{serviceId}-synch-put", "x-filename-id":"paas-service-dbcs-api-v1.1-instances-identitydomainid-serviceid-synch-put" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/snapshots":{ "get":{ "summary":"View All Snapshot Masters", "description":"Returns infomation about all snapshot masters for an Exadata Cloud at Customer database deployment.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-all-snapshots" } } }, "tags":[ "Manage Snapshots" ], "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-snapshots-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-snapshots-get" }, "post":{ "summary":"Create a Snapshot Master", "description":"Creates a snapshot master based on the selected Exadata Cloud at Customer database deployment.", "consumes":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"", "required":true, "schema":{ "$ref":"#/definitions/create-snapshot" } } ], "responses":{ "202":{ "headers":{ "Location":{ "description":"A REST URI you can use to check the progress and completion of the snapshot master creation operation, as described in View the Status of an Operation.", "type":"string" } }, "description":"Accepted. See Status Codes for information about other possible HTTP status codes." } }, "tags":[ "Manage Snapshots" ], "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-snapshots-post", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-snapshots-post" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/snapshots/{snapshotName}":{ "get":{ "summary":"View a Snapshot Master", "description":"Returns information about a snapshot master and linked clones associated with an Exadata Cloud at Customer database deployment.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-snapshot" } } }, "tags":[ "Manage Snapshots" ], "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-snapshots-{snapshotName}-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-snapshots-snapshotname-get" }, "delete":{ "summary":"Delete a Snapshot Master", "description":"Deletes a snapshot master associated with an Exadata Cloud at Customer database deployment.Note: A snapshot master cannot be deleted if there are any linked clones associated with it.
", "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "202":{ "headers":{ "Location":{ "description":"A REST URI you can use to check the progress and completion of the delete operation, as described in View the Status of an Operation.", "type":"string" } }, "description":"Accepted. See Status Codes for information about other possible HTTP status codes." } }, "tags":[ "Manage Snapshots" ], "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-snapshots-{snapshotName}-delete", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-snapshots-snapshotname-delete" } }, "/paas/api/v1.1/activitylog/{identityDomainId}/job/{jobId}":{ "get":{ "summary":"View the Status of an SSH Add Key Job", "description":"Returns information about the job to add an SSH Key.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-job-status" } } }, "tags":[ "Manage SSH Access" ], "x-internal-id":"paas-api-v1.1-activitylog-{identityDomainId}-job-{jobId}-get", "x-filename-id":"paas-api-v1.1-activitylog-identitydomainid-job-jobid-get" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/credentials":{ "get":{ "summary":"View Details for Selected SSH Keys", "description":"Returns detailed information about SSH keys for Exadata Cloud at Customer as determined by query parameters you provide.By default, a single request returns a maximum of 50 keys. Use the limitRowCount query parameter to control maximum number returned, and use the offset query parameter to fetch additional results, if available.",
"produces":[
"application/json"
],
"parameters":[
{
"name":"identityDomainId",
"in":"path",
"description":"
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-details-selected" } } }, "tags":[ "Manage SSH Access" ], "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-credentials-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-credentials-get" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/credentials/crednames":{ "get":{ "summary":"View Summaries for Selected SSH Keys", "description":"Returns summary information about SSH keys for Exadata Cloud at Customer as determined by query parameters you provide.By default, a single request returns a maximum of 50 keys. Use the limitRowCount query parameter to control maximum number returned, and use the offset query parameter to fetch additional results, if available.",
"produces":[
"application/json"
],
"parameters":[
{
"name":"identityDomainId",
"in":"path",
"description":"
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-summaries-selected" } } }, "tags":[ "Manage SSH Access" ], "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-credentials-crednames-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-credentials-crednames-get" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/credentials/crednames/{credentialName}":{ "get":{ "summary":"View the Summary for an SSH Key", "description":"Returns summary information about an SSH key. This API returns information relating to only one SSH key associated with the Exadata Cloud at Customer environment that supports the specified database deployment. Other keys may exist. To view summary information about all of the keys associated with the Exadata Cloud at Customer environment see View Summaries for Selected SSH Keys.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
vmspublickey.",
"required":true,
"type":"string"
},
{
"name":"Authorization",
"in":"header",
"description":"Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.",
"required":true,
"type":"string"
},
{
"name":"X-ID-TENANT-NAME",
"in":"header",
"description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-summary" } } }, "tags":[ "Manage SSH Access" ], "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-credentials-crednames-{credentialName}-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-credentials-crednames-credentialname-get" }, "post":{ "summary":"Add an SSH Public Key", "description":"Adds an SSH public key for access to Exadata Cloud at Customer.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
vmspublickey.",
"required":true,
"type":"string"
},
{
"name":"Authorization",
"in":"header",
"description":"Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.",
"required":true,
"type":"string"
},
{
"name":"X-ID-TENANT-NAME",
"in":"header",
"description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" }, { "name":"body", "in":"body", "description":"", "required":true, "schema":{ "$ref":"#/definitions/add-key-request" } } ], "responses":{ "202":{ "headers":{ "Location":{ "description":"A REST URI you can use to check the progress and completion of the operation, as described in View Status of an Add SSH Key Job.", "type":"string" } }, "description":"Accepted. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/add-key-response" } } }, "tags":[ "Manage SSH Access" ], "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-credentials-crednames-{credentialName}-post", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-credentials-crednames-credentialname-post" } }, "/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/credentials/{credentialName}":{ "get":{ "summary":"View the Details for an SSH Key", "description":"Returns detailed information about an SSH key. This API returns information relating to only one SSH key associated with the Exadata Cloud at Customer environment that supports the specified database deployment. Other keys may exist. To view detailed information about all of the keys associated with the Exadata Cloud at Customer environment see View Details for Selected SSH Keys.", "produces":[ "application/json" ], "parameters":[ { "name":"identityDomainId", "in":"path", "description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
vmspublickey.",
"required":true,
"type":"string"
},
{
"name":"Authorization",
"in":"header",
"description":"Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.",
"required":true,
"type":"string"
},
{
"name":"X-ID-TENANT-NAME",
"in":"header",
"description":"The value depends on the type of Exadata Cloud at Customer 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 is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"OK. See Status Codes for information about other possible HTTP status codes.", "schema":{ "$ref":"#/definitions/view-details" } } }, "tags":[ "Manage SSH Access" ], "x-internal-id":"paas-api-v1.1-instancemgmt-{identityDomainId}-services-dbaas-instances-{serviceId}-credentials-{credentialName}-get", "x-filename-id":"paas-api-v1.1-instancemgmt-identitydomainid-services-dbaas-instances-serviceid-credentials-credentialname-get" } } }, "definitions":{ "available-patches-response":{ "description":"The response body contains information about the available patches.", "properties":{ "availablePatchGuiMetadata":{ "type":"object", "description":"Instruction to the metadata UI about the patch.", "properties":{ "supportsPreCheck":{ "type":"boolean", "description":"Flag that indicates whether the patch supports precheck via UI." } } }, "patchId":{ "type":"string", "description":"Patch ID." }, "patchNumber":{ "type":"string", "description":"Patch number." }, "patchCategory":{ "type":"string", "description":"Category of the patch. For example:General, Upgrade, Multiple, Security, and so on."
},
"patchSeverity":{
"type":"string",
"description":"Severity of the patch. For example Normal, Mandatory, Recommended, and so on."
},
"includesConfigUpgrade":{
"type":"boolean",
"description":"Flag that indicates whether the patch includes a configuration upgrade."
},
"patchDescription":{
"type":"string",
"description":"Description of the patch."
},
"patchReleaseUrl":{
"type":"string",
"description":"URL that provides more information about the patch."
},
"serviceType":{
"type":"string",
"description":"Service type dbaas."
},
"serviceVersion":{
"type":"string",
"description":"Exadata Cloud at Customer deployment version to which the patch can be applied. For example: 12.1.0.2. Or Any, where Any indicates that the patch can be applied to any version."
},
"releaseDate":{
"type":"string",
"description":"Date and time the patch is released."
},
"entryDate":{
"type":"string",
"description":"Date and time the patch is created."
},
"entryUserId":{
"type":"string",
"description":"Name of the user that created the patch."
},
"componentPatches":{
"type":"array",
"description":"Group the details of each patches in the component.",
"items":{
"$ref":"#/definitions/component-patch"
}
},
"patchComponents":{
"type":"array",
"description":"Group the details of the patch to be applied.",
"items":{
"$ref":"#/definitions/patch-component"
}
},
"patchType":{
"type":"string",
"description":"Patch type classification. For example, PSU, Security."
},
"requiresRestart":{
"type":"boolean",
"description":"Flag that indicates whether the patch requires a restart of the service instance."
},
"serviceTypeVersions":{
"type":"string",
"description":"Exadata Cloud at Customer deployment version to which the patch can be applied. For example: 12.1.0.2. Or Any, where Any indicates that the patch can be applied to any version."
},
"isDeleted":{
"type":"boolean",
"description":"Flag that indicates whether the patch has been deleted and is no longer available. The information about the patch is not removed from the list of available patches in order to maintain an historical record of all patches."
},
"displayName":{
"type":"string",
"description":"Display name of the patch."
},
"metaVersion":{
"type":"string",
"description":"The release version of metadata service manager."
},
"supportedStrategy":{
"type":"string",
"description":"Supported patching strategy. For example: In Place."
},
"releaseVersion":{
"type":"string",
"description":"Release version of the component in this patch."
}
}
},
"component-patch":{
"description":"Group the details of each patch in the component.",
"properties":{
"id":{
"type":"integer",
"description":"ID of a component patch."
},
"version":{
"type":"string",
"description":"Version of the patch component."
},
"releaseVersion":{
"type":"string",
"description":"Release version of the component in this patch."
},
"displayName":{
"type":"string",
"description":"Display name of the component in this patch."
},
"description":{
"type":"string",
"description":"Brief description of the patch."
},
"zipBundles":{
"type":"array",
"description":"Zips that contain the patched binaries or patches.",
"items":{
"$ref":"#/definitions/view-zip-bundles"
}
},
"preserveFiles":{
"type":"array",
"description":"List of files to be preserved during patching.",
"items":{
"type":"string"
}
}
}
},
"patch-component":{
"description":"Group the details of the patch to be applied.",
"properties":{
"id":{
"type":"integer",
"description":"ID of a component patch."
},
"component":{
"type":"string",
"description":"Name of the component in this patch db."
},
"version":{
"type":"string",
"description":"Version of the patch component."
},
"md5sum":{
"type":"string",
"description":"Checksum used to validate the patch binary."
},
"provisioningObjectRef":{
"type":"string",
"description":"Location of binary to use when creating a new service instance."
},
"patchingObjectRef":{
"type":"string",
"description":"Location of binary to use when patching a service instance."
},
"preserveFiles":{
"type":"array",
"description":"List of files to be preserved during patching.",
"items":{
"type":"string"
}
}
}
},
"view-zip-bundles":{
"description":"Group the details of zips for the patched binaries.",
"properties":{
"id":{
"type":"integer",
"description":"ID of a component patch."
},
"md5sum":{
"type":"string",
"description":"Checksum used to validate the patch binary."
},
"provisioningObjectRef":{
"type":"string",
"description":"Location of binary to use when creating a new service instance."
},
"storageKey":{
"type":"string",
"description":"Location of the patch zip on the cloud."
},
"zipVersion":{
"type":"string",
"description":"Software version that is included in the zip."
},
"releaseDate":{
"type":"string",
"description":"Release date of this version."
},
"releaseUrl":{
"type":"string",
"description":"URL for more information about this release."
},
"displayName":{
"type":"string",
"description":"Display name of this component."
}
}
},
"apply-request":{
"title":"Request Body",
"type":"object",
"description":"",
"properties":{
"additionalNote":{
"type":"string",
"description":"Free-form text to provide additional information about the patching operation."
},
"forceApply":{
"type":"boolean",
"description":"Specifies whether the patch should be applied even if the precheck finds conflicts. Valid values are true and false. When true is specified, patch conflicts or errors discovered during the precheck stage of the patching operation are ignored and the patch is applied (space permitting). Otherwise, if conflicts or errors are discovered, the patch is not applied.
Default value is false.
Specifies whether a Data Guard switchover operation is performed on the primary database before applying the patch. Valid values are true and false.
Default value is false.
(Applicable only to deployments associated with a Data Guard configuration.)
" } } }, "precheck-request":{ "title":"Request Body", "type":"object", "description":"", "properties":{ "additionalNote":{ "type":"string", "description":"Free-form text to provide additional information about the precheck operation." } } }, "rollback-request":{ "title":"Request Body", "type":"object", "description":"", "properties":{ "additionalNote":{ "type":"string", "description":"Free-form text to provide additional information about the rollback operation." }, "switchOver":{ "type":"boolean", "description":"Specifies whether a Data Guard switchover operation is performed on the primary database before rolling back the patch. Valid values are true and false.
Default value is false.
(Applicable only to deployments associated with a Data Guard configuration.)
" } } }, "put-response":{ "title":"Response Body", "type":"object", "description":"", "properties":{ "status":{ "type":"string", "description":"Status of the request to start a job for the operation. Usually the valueCompleted."
},
"details":{
"$ref":"#/definitions/put-response-details-object"
}
}
},
"put-response-details-object":{
"title":"Details Object",
"type":"object",
"description":"",
"properties":{
"message":{
"type":"string",
"description":"Message describing the operation."
},
"jobId":{
"type":"string",
"description":"Job ID of the job that was started to perform the operation."
}
}
},
"applied-patches-response":{
"description":"Details of all applied patches.",
"type":"array",
"items":{
"$ref":"#/definitions/applied-patch"
}
},
"applied-patch":{
"description":"Information about an applied patch.",
"properties":{
"backupStatus":{
"type":"string",
"description":"Whether a backup of the software was created before the patch was applied. Valid values include: Available, SameVersion, Unavailable, Unknown."
},
"additionalNote":{
"type":"string",
"description":"Free-form text to provide additional information about the patch."
},
"appliedBy":{
"type":"string",
"description":"Name of the user that applied the patch. system displays if the patch was applied by an auto-update scheduled job."
},
"appliedDate":{
"type":"string",
"description":"Date and time that the patch was applied."
},
"totalTime":{
"type":"string",
"description":"Duration of the patch operation."
},
"patchId":{
"type":"string",
"description":"Patch ID."
},
"patchDescription":{
"type":"string",
"description":"Description of the patch."
},
"patchReleaseUrl":{
"type":"string",
"description":"URL that provides more information about the patch."
},
"releaseDate":{
"type":"string",
"description":"Date and time patch was released."
},
"lastStatus":{
"type":"string",
"description":"Status of the patch operation. For example: IN PROGRESS, COMPLETED, and FAILED. COMPLETED_ROLLBACK is displayed when an applied patch has been rolled back."
},
"lastStatusMessage":{
"type":"string",
"description":"Last message logged for the patch operation."
},
"componentPatches":{
"type":"array",
"description":"Group the details of each patches in the component.",
"items":{
"$ref":"#/definitions/component-patch"
}
},
"patchComponents":{
"type":"array",
"description":"Group the details of the patch to be applied.",
"items":{
"$ref":"#/definitions/patch-component"
}
},
"patchType":{
"type":"string",
"description":"Patch type classification. For example, Quarterly, Security."
},
"patchCategory":{
"type":"string",
"description":"Category of the patch. For example: General, Multiple, Security, and so on."
},
"patchSeverity":{
"type":"string",
"description":"Severity of the patch. For example Normal, Mandatory, Recommended, and so on."
},
"jobId":{
"type":"string",
"description":"Job ID for the patch operation."
},
"displayName":{
"type":"string",
"description":"Display name of the patch."
},
"toVersion":{
"type":"string",
"description":"Version of Exadata Cloud at Customer deployment that was patched."
},
"backupId":{
"type":"string",
"description":"Backup ID. You can use the backup ID to manage the backup."
},
"inProgress":{
"type":"boolean",
"description":"Flag that specifies whether the patch is still in progress."
},
"operationType":{
"type":"string",
"description":"Patch operating being performed. Valid values include: Rollback, Patching, and None."
},
"id":{
"type":"integer",
"description":"Unique ID of the patching operation. Use this ID to get details of a patching operation."
},
"patchingResult":{
"$ref":"#/definitions/patching-result"
},
"rollbackResult":{
"$ref":"#/definitions/rollback-result"
},
"rollbackId":{
"type":"string",
"description":"ID of the rollback that is associated to the completed patching operation. The ID is used to rollback a patch operation."
},
"rollbackVersion":{
"type":"string",
"description":"Version to which the patched component will be rolled back."
},
"currentPatchLevel":{
"type":"string",
"description":"Current patch level for the component."
},
"progressMessages":{
"type":"array",
"description":"List of progress messages for the patch.",
"items":{
"type":"string"
}
}
}
},
"patching-result":{
"type":"object",
"description":"Information about the results of the patch.",
"properties":{
"additionalNote":{
"type":"string",
"description":"Free-form text to provide additional information about the rollback.",
"properties":{
"patchingId":{
"type":"integer",
"description":"ID of the applied patch operation."
},
"backupId":{
"type":"string",
"description":"Backup ID. You can use the backup ID to manage the backup."
},
"versionBeforeThisPatch":{
"type":"string",
"description":"Version of the component before the patch was applied."
},
"strategy":{
"type":"string",
"description":"Patching strategy. For example, Rolling. To minimize service disruption, the patch is applied in a rolling pattern, patching a single node at a time."
},
"metaVersionBeforeThisPatch":{
"type":"string",
"description":"Version of the metadata service manager before the patch was applied."
},
"customRollbackId":{
"type":"string",
"description":"ID to be used in a rollback operation."
},
"startDate":{
"type":"string",
"description":"Date and time that the patch operation started."
},
"endDate":{
"type":"string",
"description":"Date the patch operation ended."
},
"patchingStatus":{
"type":"string",
"description":"Status of the patching operation. For example, COMPLETED. COMPLETED_ROLLBACK is displayed when an applied patch has been rolled back."
},
"resultMessage":{
"type":"string",
"description":"System message that describes the patching operation."
},
"additionalNote":{
"type":"string",
"description":"Free-form text to provide additional information about the patch."
},
"appliedBy":{
"type":"string",
"description":"Name of the user that applied the patch. system displays if the patch was applied by an auto-update scheduled job."
},
"jobId":{
"type":"string",
"description":"Job ID for the patch operation."
},
"completeLog":{
"type":"string",
"description":"System messages that track the patch operations."
},
"progressMessages":{
"type":"array",
"description":"List of progress messages for the patch.",
"items":{
"type":"string"
}
}
}
}
}
},
"rollback-result":{
"type":"object",
"description":"Information about the results of the rollback operation, which displays only when a rollback of the patch had been performed.",
"properties":{
"rollbackId":{
"type":"integer",
"description":"ID of the rollback operation."
},
"startDate":{
"type":"string",
"description":"Date and time that the rollback operation started."
},
"endDate":{
"type":"string",
"description":"Date the rollback operation ended."
},
"patchingStatus":{
"type":"string",
"description":"Status of the rollback operation. For example, COMPLETED_ROLLBACK."
},
"resultMessage":{
"type":"string",
"description":"System message that describes the rollback operation."
},
"additionalNote":{
"type":"string",
"description":"Free-form text to provide additional information about the rollback."
},
"appliedBy":{
"type":"string",
"description":"Name of the user that performed the rollback."
},
"jobId":{
"type":"string",
"description":"Job ID for the rollback operation."
},
"completeLog":{
"type":"string",
"description":"System messages that track the rollback operations."
},
"progressMessages":{
"type":"array",
"description":"List of progress messages for the rollback.",
"items":{
"type":"string"
}
}
}
},
"view-precheck-response":{
"description":"The response body includes information about the requested patch prechecks.",
"properties":{
"id":{
"type":"integer",
"description":"ID of the operation."
},
"jobId":{
"type":"string",
"description":"Job ID for the patching precheck operation."
},
"patchId":{
"type":"string",
"description":"Patch ID."
},
"startDate":{
"type":"string",
"description":"Date and time that the patching precheck operation started."
},
"endDate":{
"type":"string",
"description":"Date and time that the patching precheck operation stopped."
},
"performedBy":{
"type":"string",
"description":"Name of the user account used to perform the patch precheck."
},
"inProgress":{
"type":"boolean",
"description":"Flag that specifies whether the patch precheck is still in progress."
},
"status":{
"type":"string",
"description":"Status of the patching precheck operation. Valid values include: PASSED_PRECHECK - Patching precheck passed.DIDNT_PASS_PRECHECK - Patching precheck did not pass. Check the preCheckMessages attribute for more information.DIDNT_FINISHED_PRECHECK - An internal error was encountered and the patching precheck could not be performed."
},
"href":{
"type":"string",
"description":"URL for checking the status of the patching precheck job. This attribute displays only when viewing all patching precheck operations."
},
"preCheckMessages":{
"type":"array",
"description":"List of patching precheck messages. No patching precheck messages are returned when the precheck completes successfully.",
"items":{
"type":"string"
}
},
"jsonResult":{
"type":"object",
"description":"System messages. This attribute displays only when viewing the status of one patching precheck operation.",
"properties":{
"statusMessage":{
"type":"string",
"description":"Describes the status of the executed precheck and describes if the operation completed or encountered any errors."
},
"messages":{
"type":"array",
"description":"Precheck status detailed messages, if any.",
"items":{
"type":"string"
}
}
}
}
}
},
"view-all-backups":{
"title":"Response Body",
"type":"object",
"description":"",
"properties":{
"backupList":{
"title":"backupList Array",
"type":"array",
"description":"Array of JSON object elements, with one element for each backup operation.",
"items":{
"$ref":"#/definitions/view-all-backups-backupList-array-item"
}
}
}
},
"view-all-backups-backupList-array-item":{
"title":"backupList Array Item",
"type":"object",
"properties":{
"backupCompletedDate":{
"type":"string",
"description":"The date-and-time stamp when the backup operation completed. Applies to completed backups only."
},
"backupStartDate":{
"type":"string",
"description":"The date-and-time stamp when the backup operation started. Applies to in-progress and failed backups only."
},
"dbTag":{
"type":"string",
"description":"Tag that uniquely identifies the backup. Applies to completed backups only."
},
"status":{
"type":"string",
"description":"Status of the backup; one of IN PROGRESS, FAILED, or COMPLETED. Note that there is only one in-progress backup at any given time, and that only the last failed backup is listed."
},
"keepForever":{
"type":"boolean",
"description":"Boolean indicating if the backup is a long term backup."
}
}
},
"view-all-recoveries":{
"title":"Response Body",
"type":"object",
"description":"",
"properties":{
"recoveryList":{
"title":"recoveryList Array",
"type":"array",
"description":"Array of JSON object elements, with one element for each recovery operation.",
"items":{
"$ref":"#/definitions/view-all-recoveries-recoveryList-array-item"
}
}
}
},
"view-all-recoveries-recoveryList-array-item":{
"title":"recoveryList Array Item",
"type":"object",
"properties":{
"dbTag":{
"type":"string",
"description":"Database Tag used if the recovery was performed using a tag."
},
"latest":{
"type":"string",
"description":"True if the recovery was performed to the latest available backup."
},
"recoveryCompleteDate":{
"type":"string",
"description":"The date-and-time stamp when the recovery operation completed. Applies to completed recovery operations only."
},
"recoveryStartDate":{
"type":"string",
"description":"The date-and-time stamp when the recovery operation started. Applies to in-progress and failed recovery operations only."
},
"scn":{
"type":"string",
"description":"SCN (System Change Number) used if the recovery was performed using an SCN."
},
"status":{
"type":"string",
"description":"Status of the recovery operation; one of IN PROGRESS, FAILED, or COMPLETED."
},
"timestamp":{
"type":"string",
"description":"Timestamp used if the recovery was performed using a timestamp."
}
}
},
"start-backup":{
"title":"Request Body for backup",
"type":"object",
"description":"",
"properties":{
"keepForever":{
"type":"boolean",
"description":"Specify true for a long term backup. Valid values are true or false. Default is false."
}
}
},
"start-recovery":{
"title":"Request Body",
"type":"object",
"description":"",
"properties":{
"latest":{
"type":"string",
"description":"Recover using the latest available backup."
},
"scn":{
"type":"string",
"description":"Recover using a System Change Number."
},
"tag":{
"type":"string",
"description":"Recover using a database tag."
},
"timestamp":{
"type":"string",
"description":"Recover using a timestamp. The timestamp must be of the format dd-MMM-yyyy HH:mm:ss."
}
}
},
"create-postrequest":{
"description":"The request body defines the details of the request.",
"properties":{
"serviceName":{
"type":"string",
"description":"Name for the Exadata Cloud at Customer database deployment.
Name:
Must not exceed 50 characters.
Must start with a letter.
Must contain only letters, numbers, or hyphens.
Must not end with a hyphen.
Must not contain any other special characters.
Must be unique within the identity domain.
The text of an SSH public key.
The key is used for authentication when connecting to Exadata Cloud at Customer using an SSH client. You generate an SSH public-private key pair using a standard SSH key generation tool. See Generating a Secure Shell (SSH) Public/Private Key Pair and Connecting to a Compute Node Through Secure Shell (SSH).
" }, "subscriptionType":{ "type":"string", "description":"The billing frequency. For Exadata Cloud at Customer the only valid value isMONTHLY."
},
"level":{
"type":"string",
"description":"The service level. For Exadata Cloud at Customer the only valid value is PAAS_EXADATA."
},
"version":{
"type":"string",
"description":"The Oracle Database software version; one of: 11.2.0.4, 12.1.0.2 or 12.2.0.1."
},
"edition":{
"type":"string",
"description":"The Oracle Database software edition. For Exadata Cloud at Customer the only valid value is EE_EP."
},
"exadataSystemName":{
"type":"string",
"description":"Name of the Exadata system on which to create the Exadata Cloud at Customer database deployment."
},
"clusterName":{
"type":"string",
"description":"Name of the cluster supporting the Exadata Cloud at Customer database deployment."
},
"nodelist":{
"type":"string",
"description":"Specifies the list of compute nodes that host database instances for the database deployment. Separate compute node names with a comma. If nodelist is not specified the database is deployed across all compute nodes."
},
"dbTemplate":{
"type":"string",
"description":"The template to use for the starter database:
oltp - configures the starter database for a transactional workload, with a bias towards high volumes of random data access.
dw - configures the starter database for a decision support or data warehouse workload, with a bias towards large data scanning operations.
Include this parameter only when creating a starter database. The starter database is the first Exadata Cloud at Customer database deployment that you create on your Exadata system. Subsequent databases are created with a standardized database configuration.
" }, "standbys":{ "type":"array", "description":"Standby database parameters. This attribute is applicable only iffailoverDatabase is set to yes.",
"items":{
"$ref":"#/definitions/standby-parameters"
}
},
"parameters":{
"type":"array",
"description":"Additional database configuration parameters.",
"items":{
"$ref":"#/definitions/parameters"
}
}
},
"required":[
"serviceName",
"subscriptionType",
"level",
"version",
"edition",
"parameters"
]
},
"parameters":{
"properties":{
"type":{
"type":"string",
"description":"The component type to which the set of parameters applies. For Exadata Cloud at Customer the only valid value is db."
},
"adminPassword":{
"type":"string",
"description":"The administrator password for the Exadata Cloud at Customer database deployment. This password is assigned to the Oracle Database administrator users sys and system.
The password must:
Be 8 to 30 characters in length.
Contain at least one lowercase letter
Contain at least one uppercase letter
Contain at least one number
Contain at least one of these symbols: _ (underscore), # (hash sign), or - (dash or minus sign).
The database system identifier (SID) name for the Exadata Cloud at Customer database deployment.
Name:
Must not exceed 8 characters.
Must start with a letter.
Must contain only letters and numbers.
The default value is ORCL.
The pluggable database (PDB) name for the Exadata Cloud at Customer database deployment.
This parameter is only valid for deployments using Oracle Database 12c.
Name:
Must not exceed 8 characters.
Must start with a letter.
Must contain only letters and numbers.
The default value is pdb1.
" }, "backupDestination":{ "type":"string", "description":"
The backup configuration for the Exadata Cloud at Customer database deployment:
OSS - Configure backups to an Oracle Storage Cloud container.
BOTH - Configure backups to local storage on the Exadata system and to an Oracle Storage Cloud container.
NONE - Configure no backups.
Name of an existing Oracle Storage Cloud Service container in the format:
instance-id_domain/container
where instance is the name of the Oracle Storage Cloud Service instance, id_domain is the name of the identity domain, and container is the name of the container.
Do not use the Oracle Storage Cloud Service container that you are using to back up Exadata Cloud at Customer databases to cloud storage for any other purpose. For example, do not also use it to back up Oracle Java Cloud Service instances to cloud storage. Using the container for multiple purposes can result in billing errors.
" }, "cloudStorageUser":{ "type":"string", "description":"The user name of a user who has read/write access to the container specified incloudStorageContainer."
},
"cloudStoragePwd":{
"type":"string",
"description":"The password of the user specified in cloudStorageUser."
},
"goldenGate":{
"type":"string",
"description":"Specify if the database is configured for use as the replication database of an Oracle GoldenGate Cloud Service instance. Valid values are yes and no. The default value is no."
},
"ncharset":{
"type":"string",
"description":"The National Character Set for the Exadata Cloud at Customer database deployment. The default value is AL16UTF16. Valid values are AL16UTF16 and UTF8."
},
"charset":{
"type":"string",
"description":"The Character Set for the Exadata Cloud at Customer database deployment. The default value is AL32UTF8.
Valid values are AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS."
},
"isRac":{
"type":"string",
"description":"Exadata Cloud at Customer supports cluster databases only. For Exadata Cloud at Customer the only valid value is yes."
},
"failoverDatabase":{
"type":"string",
"description":"Specify yes if an Oracle Data Guard configuration comprising a primary database and a standby database should be created. Default value is no."
},
"sourceServiceName":{
"type":"string",
"description":"When present, indicates that the database deployment should be created as a snapshot clone. Provide the name of the existing snapshot master being used as the source for the new snapshot clone."
},
"snapshotName":{
"type":"string",
"description":"Name of the existing snapshot master being used as the source for the new snapshot clone. This parameter is valid only if sourceServiceName is specified, and should be set to the same value as that supplied for sourceServiceName."
},
"ibkup":{
"type":"string",
"description":"Specify if the database should be instantiated using a database stored in an existing cloud backup that was created using Oracle Database Backup Cloud Service. Valid values are yes and no. Default value is no."
},
"ibkupOnPremise":{
"type":"boolean",
"description":"Use this option to indicate the origin of the source database backup. The origin of the backup may be another Exadata Cloud at Customer database deployment in the same identity domain or another (on-premise) database that was backed up to cloud storage using Database Backup Cloud Service. Valid values are true for an on-premise database backup and false for another Exadata Cloud at Customer database backup. Default value is true."
},
"ibkupDatabaseID":{
"type":"string",
"description":"Database id of the database from which the existing cloud backup was created. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to true."
},
"ibkupDecryptionKey":{
"type":"string",
"description":"Password used to create the existing, password-encrypted cloud backup. This password is used to decrypt the backup. Specify either ibkupDecryptionKey or ibkupWalletFileContent for decrypting the backup. A decryption key or wallet is required if ibkup is set to yes and ibkupOnPremise is set to true."
},
"ibkupWalletFileContent":{
"type":"string",
"description":"Base 64 encoded wallet file content. This wallet is used to decrypt the backup. Specify either ibkupDecryptionKey or ibkupWalletFileContent for decrypting the backup. A decryption key or wallet is required if ibkup is set to yes and ibkupOnPremise is set to true."
},
"ibkupCloudStorageContainer":{
"type":"string",
"description":"Name of the Oracle Storage Cloud Service container where the existing cloud backup is stored. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to true."
},
"ibkupCloudStorageUser":{
"type":"string",
"description":"User name of an Oracle Cloud user who has read access to the container specified in ibkupCloudStorageContainer. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to true."
},
"ibkupCloudStoragePassword":{
"type":"string",
"description":"Password of the Oracle Cloud user specified in ibkupCloudStorageUser. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to true."
},
"ibkupServiceID":{
"type":"string",
"description":"Exadata Cloud at Customer database deployment name whose backup is being used as the source of the instantiate from backup operation. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to false."
},
"oracleHomeName":{
"type":"string",
"description":"Name for the Oracle Home directory location that you want to use for the database deployment. If you specify the name for an existing Oracle Home directory location, then the database deployment shares the existing Oracle Database binaries at that location if useExistingOracleHome is also set to yes. If you specify a new name, then a new Oracle Home is created. See Viewing Information About Oracle Homes."
},
"useExistingOracleHome":{
"type":"string",
"description":"This parameter is required with a value of yes if you want to create a database deployment in an existing Oracle Home directory location. Default value is no."
}
},
"required":[
"type",
"adminPassword",
"sid",
"backupDestination",
"isRac"
]
},
"allinstances-response":{
"description":"The response body contains information about database deployments.",
"properties":{
"service_name":{
"type":"string",
"description":"Name of the database deployment."
},
"identity_domain":{
"type":"string",
"description":"The identity domain associated with the database deployment."
},
"description":{
"type":"string",
"description":"The database deployment description."
},
"status":{
"type":"string",
"description":"
The database deployment status.
Values include: Running, In Progress, Maintenance, Stopped, Terminating, and Failed.
The billing frequency.
For Exadata Cloud at Customer the value is always MONTHLY.
This attribute is returned when you set the ?outputLevel=verbose query parameter.
The service level.
For Exadata Cloud at Customer the value is always PAAS_EXADATA.
This attribute is returned when you set the ?outputLevel=verbose query parameter.
The Oracle Database software edition.
For Exadata Cloud at Customer the value is always EE_EP.
This attribute is returned when you set the ?outputLevel=verbose query parameter.
The number of compute nodes associated with the database deployment.
This attribute is returned when you set the ?outputLevel=verbose query parameter.
The job ID for the job that created the database deployment.
This attribute is returned when you set the ?outputLevel=verbose query parameter.
The job ID for the job that deleted the database deployment.
This attribute is returned when you set the ?outputLevel=verbose query parameter.
The job ID of a compute node lifecycle state control operation (start, stop or restart a compute node).
This attribute appears only if an operation is in progress.
You can use this ID to check the status of the operation, as described in View the Status of an Operation.
This attribute is returned when you set the ?outputLevel=verbose query parameter.
EE_EP."
},
"error_status_desc":{
"type":"string",
"description":"A description of the reason why a database deployment is in an error state."
},
"identity_domain":{
"type":"string",
"description":"The identity domain associated with the database deployment."
},
"last_modified_time":{
"type":"string",
"description":"The date and time of last modification."
},
"level":{
"type":"string",
"description":"The service level. For Exadata Cloud at Customer the value is always PAAS_EXADATA."
},
"lifecycle_control_job_id":{
"type":"integer",
"description":"The job ID of a compute node lifecycle state control operation (start, stop or restart a compute node).
This attribute appears only if an operation is in progress.
You can use this ID to check the status of the operation, as described in View the Status of an Operation.
" }, "num_nodes":{ "type":"integer", "description":"The number of compute nodes associated with the database deployment." }, "psm_plugin_version":{ "type":"string", "description":"The Platform Service Manager version associated with the database deployment." }, "service_name":{ "type":"string", "description":"Name of the database deployment." }, "service_url":{ "type":"string", "description":"The resource URL for the database deployment." }, "status":{ "type":"string", "description":"The database deployment status.
Values include: Running, In Progress, Maintenance, Stopped, Terminating, and Failed.
The billing frequency.
For Exadata Cloud at Customer the value is always MONTHLY.
db."
},
"version":{
"type":"string",
"description":"The Oracle Database software version in use."
}
}
},
"stopstart-postrequest":{
"description":"The request body defines the details of the compute node lifecycle request. Bold indicates a required value.",
"properties":{
"lifecycleState":{
"type":"string",
"description":"The operation being performed:stop - Stop a running compute node.
start - Start a stopped compute node.
restart - Restart a running compute node.
The operation timeout for the request.
The range of valid values is 1 to 300 minutes.
The default is 60 minutes.
The database deployment status.
Values include: Running, In Progress, Maintenance, Stopped, Terminating, and Failed.
Current status of the job.
Values include: In Progress, Succeded, Failed.
nodelist is not specified the database is deployed across all compute nodes."
}
}
},
"iorm-put-parameters":{
"description":"The parameters for setting IORM shares.",
"properties":{
"dbname":{
"type":"string",
"description":"The database name, as contained in the DBNAME database initialization parameter."
},
"share":{
"type":"string",
"description":"The number of IORM shares allocated to the database deployment. Specify a value between 1 and 32."
}
}
},
"iorm-getresponse":{
"description":"The response containing IORM shares.",
"properties":{
"DbPlan":{
"type":"array",
"description":"Output of the IORM dbplan.",
"items":{
"$ref":"#/definitions/iorm-get-db-response"
}
}
}
},
"iorm-get-db-response":{
"description":"Contains details of the IORM shares.",
"properties":{
"dbname":{
"type":"string",
"description":"The database name associated with the Exadata Cloud at Customer 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."
}
}
},
"synch-request":{
"description":"Contains the details of the synchronization request.",
"properties":{
"action":{
"type":"string",
"description":"This is a fixed value, which is always syncproperties.
No other values are accepted.
" }, "DBVersion":{ "type":"string", "description":"One of the supported database versions.
The value contains 5 period-separated numbers. Valid values include 11.2.0.4.0, 12.1.0.2.0, 12.2.0.1.0, 18.0.0.0.0, 19.0.0.0.0.
Grid Infrastructure software version in case of update.
The value contains 4 period-separated numbers. For example: 19.0.0.0.
Name of the pluggable database (PDB) to update in the database.
This needs to be specified if an 11g database deployment is upgraded to 12c or later versions.
If this is a Non-CDB database specify the Oracle SID in this parameter.
" }, "oracleHomeName":{ "type":"string", "description":"Oracle Home name to update in the database deployment.
" }, "oracleHome":{ "type":"string", "description":"Path of the Oracle Home to update in the database deployment.
" }, "currentOSVersion":{ "type":"string", "description":"Version of the Exadata system software to update in the database deployment.
The value contains 5 period-separated numbers. For example: 12.2.0.0.0.
Connect Descriptor to update in the database deployment.
" }, "connectDescriptorWithPublicIP":{ "type":"string", "description":"Connect Descriptor with public IP to update in the database deployment.
" } }, "required":[ "action" ] }, "synch-response":{ "description":"Contains the details of the synchronization response.", "properties":{ "status":{ "type":"string", "description":"Description of the status of the new request. If accepted, status is New.
String containing the action name, which is syncproperties.
In Progress or Succeeded."
}
}
},
"view-snapshot":{
"title":"Response Body",
"type":"object",
"description":"",
"properties":{
"clonedServices":{
"title":"clonedServices Array",
"type":"array",
"description":"Array of JSON object elements, with one element for each linked clone created from the snapshot master.",
"items":{
"$ref":"#/definitions/view-snapshot-clonedServices-array-item"
}
},
"clonedServicesSize":{
"type":"integer",
"description":"Number of linked clones created from the snapshot master."
},
"creationTime":{
"type":"string",
"description":"The date-and-time stamp when the snapshot master was created."
},
"description":{
"type":"string",
"description":"Description of the snapshot master."
},
"name":{
"type":"string",
"description":"Name of the snapshot master."
}
}
},
"view-snapshot-clonedServices-array-item":{
"title":"clonedServices Array Item",
"type":"object",
"properties":{
"clonedServiceCreationTime":{
"type":"string",
"description":"The date-and-time stamp when the linked clone was created."
},
"clonedServiceName":{
"type":"string",
"description":"Name of the linked cloned database deployment."
}
}
},
"create-snapshot":{
"title":"Request Body",
"type":"object",
"description":"",
"properties":{
"name":{
"type":"string",
"description":"Name of the snapshot master."
},
"description":{
"type":"string",
"description":"Description of the snapshot master."
},
"sid":{
"type":"string",
"description":"SID for the snapshot master."
},
"adminPassword":{
"type":"string",
"description":"Password for the snapshot master."
}
}
},
"view-details-selected":{
"title":"Response Body",
"type":"object",
"description":"",
"properties":{
"hasMore":{
"type":"boolean",
"description":"Indicates whether more keys are available to be requested, with the value true indicating that more are available."
},
"items":{
"title":"items Array",
"type":"array",
"description":"Array of JSON objects, with one element for each key returned.",
"items":{
"$ref":"#/definitions/view-details-selected-items-array-item"
}
},
"totalResults":{
"type":"integer",
"description":"Number of keys returned by this request."
}
}
},
"view-details-selected-items-array-item":{
"title":"items Array Item",
"type":"object",
"properties":{
"componentType":{
"type":"string",
"description":"The value DB."
},
"computeKeyName":{
"type":"string",
"description":"The fully qualified name of the SSH Key."
},
"credName":{
"type":"string",
"description":"The value vmspublickey."
},
"credType":{
"type":"string",
"description":"The value SSH."
},
"description":{
"type":"string",
"description":"A description of the key."
},
"identityDomain":{
"type":"string",
"description":"Name of the identity domain."
},
"lastUpdateMessage":{
"type":"string",
"description":"The message returned from the last update of the SSH key. For example: newly created, updated by username."
},
"lastUpdateStatus":{
"type":"string",
"description":"Status of the last update of the SSH key."
},
"lastUpdateTime":{
"type":"string",
"description":"Date and time of the last update of the SSH key."
},
"osUserName":{
"type":"string",
"description":"The value opc."
},
"parentType":{
"type":"string",
"description":"The value SERVICE."
},
"publicKey":{
"type":"string",
"description":"The value of the SSH public key, with any slashes (/) it contains preceded by backslashes, as in \\/."
},
"serviceName":{
"type":"string",
"description":"Name of the Exadata Cloud at Customer database deployment."
},
"serviceState":{
"type":"string",
"description":"The status of the database deployment. For example, RUNNING."
},
"serviceType":{
"type":"string",
"description":"The value DBaaS."
}
}
},
"view-summaries-selected":{
"title":"Response Body",
"type":"object",
"description":"",
"properties":{
"hasMore":{
"type":"boolean",
"description":"Indicates whether more keys are available to be requested, with the value true indicating that more are available."
},
"items":{
"title":"items Array",
"type":"array",
"description":"Array of JSON objects, with one element for each key returned.",
"items":{
"$ref":"#/definitions/view-summaries-selected-items-array-item"
}
},
"totalResults":{
"type":"integer",
"description":"Number of keys returned by this request."
}
}
},
"view-summaries-selected-items-array-item":{
"title":"items Array Item",
"type":"object",
"properties":{
"canonicalUrl":{
"type":"string",
"description":"URL to query the credential key value."
},
"credName":{
"type":"string",
"description":"The value vmspublickey."
},
"credType":{
"type":"string",
"description":"The value SSH."
},
"description":{
"type":"string",
"description":"A description of the key."
},
"identityDomain":{
"type":"string",
"description":"Name of the identity domain."
},
"serviceName":{
"type":"string",
"description":"Name of the Exadata Cloud at Customer database deployment."
},
"serviceType":{
"type":"string",
"description":"The value DBaaS."
}
}
},
"view-summary":{
"title":"Response Body",
"type":"object",
"description":"",
"properties":{
"canonicalUrl":{
"type":"string",
"description":"URL to query the credential key value."
},
"credName":{
"type":"string",
"description":"The value vmspublickey."
},
"credType":{
"type":"string",
"description":"The value SSH."
},
"description":{
"type":"string",
"description":"A description of the key."
},
"identityDomain":{
"type":"string",
"description":"Name of the identity domain."
},
"serviceName":{
"type":"string",
"description":"Name of the Exadata Cloud at Customer database deployment."
},
"serviceType":{
"type":"string",
"description":"The value DBaaS."
}
}
},
"view-details":{
"title":"Response Body",
"type":"object",
"description":"",
"properties":{
"componentType":{
"type":"string",
"description":"The value DB."
},
"computeKeyName":{
"type":"string",
"description":"The fully qualified name of the SSH Key object."
},
"credName":{
"type":"string",
"description":"The value vmspublickey."
},
"credType":{
"type":"string",
"description":"The value SSH."
},
"description":{
"type":"string",
"description":"A description of the key."
},
"identityDomain":{
"type":"string",
"description":"Name of the identity domain."
},
"lastUpdateMessage":{
"type":"string",
"description":"The message returned from the last update of the SSH key. For example: newly created, updated by username."
},
"lastUpdateStatus":{
"type":"string",
"description":"Status of the last update of the SSH key."
},
"lastUpdateTime":{
"type":"string",
"description":"Date and time of the last update of the SSH key."
},
"osUserName":{
"type":"string",
"description":"The value opc."
},
"parentType":{
"type":"string",
"description":"The value SERVICE."
},
"publicKey":{
"type":"string",
"description":"The value of the SSH public key, with any slashes (/) it contains preceded by backslashes, as in \\/."
},
"serviceName":{
"type":"string",
"description":"Name of the Exadata Cloud at Customer database deployment."
},
"serviceType":{
"type":"string",
"description":"The value DBaaS."
}
}
},
"add-key-request":{
"title":"Request Body",
"type":"object",
"description":"",
"required":[
"public-key"
],
"properties":{
"public-key":{
"type":"string",
"description":"The SSH public key value. Note that each slash (/) in the key value must be preceeded by a backslash (\\), as in \\/."
}
}
},
"add-key-response":{
"title":"Response Body",
"type":"object",
"description":"",
"properties":{
"status":{
"type":"string",
"description":"Status description. For example: submitted job."
}
}
},
"view-job-status":{
"title":"Response Body",
"type":"object",
"description":"",
"properties":{
"activityLogId":{
"type":"integer",
"description":"ID of the activity log."
},
"authDomain":{
"type":"string",
"description":"Name of the identity domain associated with the request."
},
"authUser":{
"type":"string",
"description":"Name of the Oracle Cloud user that initiated the add operation."
},
"endDate":{
"type":"string",
"description":"Date and time the job ended."
},
"identityDomain":{
"type":"string",
"description":"Name of the identity domain associated with the request."
},
"initiatedBy":{
"type":"string",
"description":"The value USER."
},
"jobId":{
"type":"integer",
"description":"Job ID returned in the Location header when the Add SSH Key request was made."
},
"messages":{
"title":"messages Array",
"type":"array",
"description":"Array of JSON objects, with one element for each message reported during the job.",
"items":{
"$ref":"#/definitions/view-job-status-messages-item"
}
},
"operationId":{
"type":"integer",
"description":"ID of the operation."
},
"operationType":{
"type":"string",
"description":"The value SSH_PUBLIC_KEY_RESET."
},
"serviceId":{
"type":"integer",
"description":"ID of the Exadata Cloud at Customer database deployment."
},
"serviceName":{
"type":"string",
"description":"Name of the Exadata Cloud at Customer database deployment."
},
"serviceType":{
"type":"string",
"description":"The value dbaas."
},
"startDate":{
"type":"string",
"description":"Date and time the job started."
},
"status":{
"type":"string",
"description":"Status of the job. Valid statuses include RUNNING, SUCCEED and FAILED."
},
"summaryMessage":{
"type":"string",
"description":"The value SSH_PUBLIC_KEY_RESET."
}
}
},
"view-job-status-messages-item":{
"title":"messages Array Item",
"type":"object",
"properties":{
"activityDate":{
"type":"string",
"description":"Date and time the activity was logged."
},
"message":{
"type":"string",
"description":"Details of the activity."
}
}
}
}
}