Update a Service Instance Configuration
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/config
- License type value - You can update the
isBYOL
value but only in certain situations. See theisBYOL
description in the Request section. - WebLogic Server Administration Console URL - See the
WLS_ROOT
description in the Request section. - Sample application URL - See the
SAMPLE_ROOT
description in the Request section. - Email Notification - See the
notificationEmail
description in the Request section.
Request
- application/vnd.com.oracle.oracloud.provisioning.Service+json
-
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
serviceId: string
Name of the Oracle Java Cloud Service instance.
-
Authorization: string
Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle Java Cloud Service account.
object
-
isBYOL(optional):
boolean
Flag that specifies whether to apply (
true
) or remove (false
) an existing on-premises license for Oracle WebLogic Server on the specified Oracle Java Cloud Service instance. A Universal Credits subscription or a Government subscription is required in order to use an existing license.Note the following:
- If the Oracle Cloud account does not have BYOL entitlements, the default value is
false
if you did not specify otherwise during service instance provisioning. You cannot change it totrue
. - If the Oracle Cloud account only has BYOL entitlements, the default value is
true
if you did not specify otherwise during service instance provisioning. You cannot change it tofalse
. - If the Oracle Cloud account has a mix of BYOL entitlements and non-BYOL resources, the default value is
true
if you did not specify otherwise during service instance provisioning. You can change it tofalse
, and vice versa later on.
Note that you are responsible for ensuring that you have the required licenses for all BYOL instances in Oracle Java Cloud Service. For example, before you scale up or scale out a BYOL instance, you must have enough WebLogic Server licenses for the additional OCPUs that will be allocated to the instance after it is scaled.
See Frequently Asked Questions: Oracle BYOL to PaaS. For the processor conversion ratios and license requirements, refer to the document titled Oracle PaaS and IaaS Universal Credits Service Descriptions.
- If the Oracle Cloud account does not have BYOL entitlements, the default value is
-
notificationEmail(optional):
string
The email to which notifications will be sent.
To receive notifications,
enableNotification
must be set totrue
. -
SAMPLE_ROOT(optional):
string
The new sample application URL.
For example, to specify a path prefix:
https://ip-address/path-prefix/sample-app
-
WLS_ROOT(optional):
string
The new WebLogic Server Administration Console URL.
For example:
https://some.domain.name/console
Response
- application/json
202 Response
Location
header returns a URI that can be used to view the job status. See View the Status of an Operation by Job Id.object
issues
array for warning messages.-
details:
object details
Groups details of the operation.
object
-
issues(optional):
array issues
Groups strings of warning messages, if any.
-
jobId:
string
Job ID for the operation. Not available if the response status code is 400.
-
message:
string
System message that describes the operation.
400 Response
See Status Codes for information about other possible HTTP status codes.
object
issues
array for validation error messages.-
details(optional):
object details
Groups details of the request.
object
-
issues(optional):
array issues
Groups strings of validation error messages, if any.
-
message(optional):
string
System message that describes the request.
Examples
The following example shows how to change certain parameter values on an existing Oracle Java Cloud Service instance. A POST request is submitted on the REST resource using cURL.
Note: The command in this example uses the URL structure https://rest_server_url/resource-path
, where rest_server_url
is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.
cURL Command
curl -i -X POST -u username:password -d @changebyol.json @./update_email.json -H "Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/config
Example of Request Body
The following shows an example of the request body.
{
"isBYOL": "false",
"WLS_ROOT":"https://sample.domain.name/console",
"SAMPLE_ROOT":"https://myinstance-loadbalancer-url/mycluster/sample-app/",
"notificationEmail":"newme.foo@bar.com"
}
Example of Response Header
The following shows an example of the response header. The Location
header returns the URI that can be used to view the job status. See View the Status of an Operation by Job Id.
HTTP/1.1 202 Accepted
Date: Tue, 4 Sep 2018 18:37:36 GMT
Location: https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/290349
Content-Type: application/json
Example of Response Body
The following shows an example of the response body returned in JSON format.
{
"details": {
"message": "Submitted job to update the service configuration for [ExampleInstance] in domain [ExampleIdentityDomain].",
"jobId": "290349"
}
}