View All Rule Parameters
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/accessrules/ruleParameters
Returns information about all rule parameters defined for an Oracle Java Cloud Service instance.
Use the rule parameter names returned in ruleSources
and ruleDestinations
when creating an access rule.
Note: On Oracle Cloud Infrastructure, all the required rules are preconfigured out-of-the-box upon service instance provisioning. To modify the rules using the REST API, use the security-related Core Services APIs in Oracle Cloud Infrastructure API Documentation. See also Security Lists in the Oracle Cloud Infrastructure documentation.
Request
-
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.
Response
- application/json
200 Response
object
-
ruleDestinations:
array ruleDestinations
List of rule parameter names that can be used as a destination (that is, the service component to allow traffic to). For example:
OTD_OTD_SERVER
,OTD_ADMIN_HOST
,WLS_ADMIN_HOST
,WLS_ADMIN
,WLS_MS
-
ruleSources:
array ruleSources
List of rule parameter names that can be used as a source (that is, a host from which traffic is allowed). For example:
OTD_OTD_SERVER
,OTD_ADMIN_HOST
,WLS_ADMIN_HOST
,WLS_ADMIN
,WLS_MS
,PUBLIC-INTERNET
,PAAS-INFRA
,DBaaS:MyDBCS1:DB
-
serviceTypeDescriptions:
array serviceTypeDescriptions
Simlar to
sourceServices
. -
sourceServices:
array sourceServices
List of services associated with the Oracle Java Cloud Service instance. For example:
DBaaS:MyDB2
,DBaaS:MyDBCS1
,DBaaS:MyDB
-
supportedProtocols:
array supportedProtocols
List of communication protocols. For example:
tcp
,udp
array
OTD_OTD_SERVER
, OTD_ADMIN_HOST
, WLS_ADMIN_HOST
, WLS_ADMIN
, WLS_MS
array
OTD_OTD_SERVER
, OTD_ADMIN_HOST
, WLS_ADMIN_HOST
, WLS_ADMIN
, WLS_MS
, PUBLIC-INTERNET
, PAAS-INFRA
, DBaaS:MyDBCS1:DB
array
DBaaS:MyDB2
, DBaaS:MyDBCS1
, DBaaS:MyDB
array
tcp
, udp
Examples
The following example shows how to retrieve all the rule parameters defined for an Oracle Java Cloud Service instance, by submitting a GET request 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 GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/accessrules/ruleParameters
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK
Date: Mon, 16 Oct 2017 17:40:41 GMT
Content-Length: 400
Content-Type: application/json
Example of Response Body
The following shows an example of the response returned in JSON format.
{
"ruleSources":
["OTD_OTD_SERVER","OTD_ADMIN_HOST","WLS_ADMIN_HOST","WLS_ADMIN","WLS_MS","DBaaS:MyDBCS1:DB","PUBLIC-INTERNET","PAAS-INFRA"],
"ruleDestinations":
["OTD_OTD_SERVER","OTD_ADMIN_HOST","WLS_ADMIN_HOST","WLS_ADMIN","WLS_MS"],
"sourceServices":
["DBaaS:MyDB2","DBaaS:MyDBCS1","DBaaS:MyDB"],
"serviceTypeDescriptions":
["DBaaS:MyDB2","DBaaS:MyDBCS1","DBaaS:MyDB"],
"supportedProtocols":
["tcp","udp"]
}