1. REST API for Lifecycle Management in Oracle API Platform Cloud Service
  2. Tasks
  3. Access Rules

View All Rules

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/APICS/instances/{serviceId}/accessrules

Returns information about all Oracle Compute Cloud Service security rules defined for an API Platform Cloud Service instance.

Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

Request

Path Parameters
  • Name of the identity domain for the API Platform Cloud Service account.
  • Name of the API Platform Cloud Service instance.

    Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

Header Parameters

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : Response Body
Type: object
Title: Response Body
Show Source
Nested Schema : accessRules Array
Type: array
Title: accessRules Array
Array of JSON objects, with one element for each rule.
Show Source
Nested Schema : activities Array
Type: array
Title: activities Array
Groups details about ongoing and failed activity messages, if available.
Show Source
Nested Schema : accessRules Array Item
Type: object
Title: accessRules Array Item
Show Source
  • The Description of the rule.
  • The destination to which traffic is allowed. Valid values include:

    • OTD: The Oracle Traffic Director load balancer

    • OTD_ADMIN_HOST: The administration host for the Oracle Traffic Director load balancer

    • WLS_ADMIN_SERVER: The WebLogic Server Administration Server

    • WLS_ADMIN_HOST: The administration host for WebLogic Server

    • WLS_MANAGED_SERVER: A WebLogic Server Managed Server

  • The ports for the rule.
  • The name of the rule.
  • The type of the rule; one of: DEFAULT, SYSTEM or USER.
  • The source from which traffic is allowed. Valid values include:

    • PUBLIC-INTERNET: Any host on the internet

    • OTD: The Oracle Traffic Director load balancer

    • OTD_ADMIN_HOST: The administration host for the Oracle Traffic Director load balancer

    • WLS_ADMIN_SERVER: The WebLogic Server Administration Server

    • WLS_MANAGED_SERVER: A WebLogic Server Managed Server

    • DB: The database specified when the API Platform Cloud Service instance was created.

    • A single IP address or a comma-separated list of subnets (in CIDR format) or IPv4 addresses.

  • The status of the rule; one of: disabled or enabled.
Nested Schema : activities Array Item
Type: object
Title: activities Array Item
Show Source
Nested Schema : activity Object
Type: object
Title: activity Object
Show Source

Examples

The following example shows how to view details of all the existing access rules by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Examples. 

curl -i -X GET 
-u apicsadmin:password  
-H "Content-Type: application/json"
https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/testsundBackup/accessrules

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Thu, 01 Dec 2016 18:08:48 GMT
Transfer-Encoding: chunked
Content-Type: application/json
X-ORACLE-DMS-ECID: 7077e58cc81a37d2:-4cd90f8:15878a7e3f0:-8000-0000000000010eb6
X-Frame-Options: DENY
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Access-Control-Allow-Origin: *

Example of Response Body

The following example shows the contents of the response body in JSON format, including details on all of the existing access rules.

{
	"accessRules": [{
		"ruleName": "sys_ms2db_dblistener",
		"description": "DO NOT MODIFY: Permit listener connection to database from managed servers",
		"status": "enabled",
		"source": "WLS_MANAGED_SERVER",
		"destination": "DBaaS:dbinstance:DB_1",
		"ports": "1521",
		"protocol": "tcp",
		"ruleType": "SYSTEM"
	}, {
		"ruleName": "sys_ms2db_ssh",
		"description": "DO NOT MODIFY: Permit managed servers to ssh to db",
		"status": "enabled",
		"source": "WLS_MANAGED_SERVER",
		"destination": "DBaaS:dbinstance:DB_1",
		"ports": "22",
		"protocol": "tcp",
		"ruleType": "SYSTEM"
	}, {
		"ruleName": "my_corp_vnc",
		"description": "corporate to VNC to Admin Server",
		"status": "enabled",
		"source": "192.168.0.1/32",
		"destination": "WLS_ADMIN_SERVER",
		"ports": "5900",
		"protocol": "tcp",
		"ruleType": "USER"
	}, {
		"ruleName": "ora_p2admin_ssh",
		"description": "Permit public to ssh to admin server",
		"status": "enabled",
		"source": "PUBLIC-INTERNET",
		"destination": "WLS_ADMIN_SERVER",
		"ports": "22",
		"protocol": "tcp",
		"ruleType": "DEFAULT"
	}, {
		"ruleName": "ora_p2admin_ahttps",
		"description": "Permit public to https to admin server",
		"status": "disabled",
		"source": "PUBLIC-INTERNET",
		"destination": "WLS_ADMIN_SERVER",
		"ports": "7002",
		"protocol": "tcp",
		"ruleType": "DEFAULT"
	}, {
		"ruleName": "ora_p2ms_chttp",
		"description": "Permit http connection to managed servers from public",
		"status": "enabled",
		"source": "PUBLIC-INTERNET",
		"destination": "WLS_MANAGED_SERVER",
		"ports": "80",
		"protocol": "tcp",
		"ruleType": "DEFAULT"
	}, {
		"ruleName": "ora_p2ms_chttps",
		"description": "Permit https connection to managed servers from public",
		"status": "enabled",
		"source": "PUBLIC-INTERNET",
		"destination": "WLS_MANAGED_SERVER",
		"ports": "443",
		"protocol": "tcp",
		"ruleType": "DEFAULT"
	}],
	"activities": []
}