Deprecation Notice for Service Instances

Review the following notice about about resource paths and endpoints to use for creating and managing service instances, and the resource paths and endpoints that are deprecated.

The URL structure to use for accessing a REST resource is https://rest_server/resource_path, where rest_server is the REST server to contact for your identity domain or Cloud Account, and resource_path is the relative path that defines the REST endpoint.

What Resource Paths and Endpoints Were Changed

The resource paths and endpoints for creating and managing service instances (including scaling and working with Coherence data tiers) were changed in the:

  • October 2017 release of Oracle Java Cloud Service (17.4.1) on Oracle Cloud Infrastructure Classic

  • December 2017 release of Oracle Java Cloud Service (17.4.1) on Oracle Cloud at Customer

What Resource Paths and Endpoints to Use Now

The following resource paths and endpoints are now available on all Oracle Cloud deployments, namely, Oracle Cloud Infrastructure, Oracle Cloud Infrastructure Classic, and Oracle Cloud at Customer. They can be used for creating and managing new service instances, including scaling and working with Coherence data tiers.

They can also be used for managing service instances on Oracle Cloud Infrastructure Classic that were provisioned before the October 2017 release of Oracle Java Cloud Service (17.4.1). On Oracle Cloud at Customer, they can also be used for managing service instances that were provisioned before the December 2017 release of Oracle Java Cloud Service (17.4.1).

Endpoints Resource Paths

Service Instances

These are paths for creating, listing, and managing service instances.

Create a service instance

Method: POST

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances

See Create the Request Document.

List all service instances in an identity domain

Method: GET

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances

List a service instance

Method: GET

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id

Stop, start, and restart a service instance and individual VMs

Method: POST

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id/hosts/stop

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id/hosts/start

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id/hosts/restart

Delete a service instance

Method: PUT

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id

The following request parameter for deleting a service instance isdeprecated:

  • forceDelete

The replacement parameter is force.

Scale out a service instance

Method: POST

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id/servers

Scale in a service instance

Method: PUT

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id/servers

Scale up or scale down a service instance

Method: POST

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id/hosts/scale

Add a local load balancer (OTD) to a service instance

Method: POST

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id/servicecomponent

Add block storage to an existing or new volume

Method: POST

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id/storage/add

Get healthcheck data and metrics for a service instance

Method: GET

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id/healthcheck

List tags for a service instance

Method: GET

Path: /paas/api/v1.1/instancemgmt/identity_domain/services/jaas/instances/service_id/tags

What Resource Paths and Endpoints are Deprecated

The following old resource paths and endpoints (which are not available on Oracle Cloud Infrastructure) are deprecated.

Endpoints Resource Paths

Create, list, control lifecycle state, and delete a service instance

/paas/service/jcs/api/v1.1/instances/identity_domain

/paas/service/jcs/api/v1.1/instances/identity_domain/service_id

/paas/service/jcs/api/v1.1/instances/identity_domain/status/request_name/job/job_id

Add and scale a Coherence data tier using a capacity or scaling unit

Delete a Coherence data tier cluster

/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/clusters

/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/clusters/{clusterName}

/paas/service/jcs/api/v1.1/datagrid/{identityDomainId}/config/scalingUnits/defaultScalingUnits

List managed servers and server operations on a service instance

/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/servers

/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/servers/{msname}

/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/servers/history

/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/servers/history/job/{jobId}

/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/servers/history/{id}

Scale out and scale in a service instance

Scale nodes on a service instance

/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/servers/{name}

/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/{servername}

Note:

  • Although deprecated resource paths and endpoints may continue to be supported for the near term, they will become obsolete in the future. End of deprecation dates will be announced.

  • The deprecated resource path and endpoint for creating new Oracle Java Cloud Service instances will become obsolete in Release 18.4.2. This means starting from 18.4.2, you will no longer be able to use /paas/service/jcs/api/v1.1/instances/{identityDomainId} to create a new service instance.

  • It is recommended that you migrate your applications to use the new paths and endpoints at your earliest convenience. This will minimize any disruption in the future when the deprecated URL structures are no longer supported.