Jump to

• Request
• Response
• Examples

View All Rules

get

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

Returns information about all Oracle Cloud Infrastructure Compute Classic security rules defined for a Database Classic Cloud Service instance.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

• serviceId: string
  Name of the Database Classic Cloud Service instance.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

Back to Top

Response

Supported Media Types

• application/json

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

• accessRules(optional): array accessRules Array
  Title: accessRules Array

  Array of JSON objects, with one element for each rule.
• activities(optional): array activities Array
  Title: activities Array

  Groups details about ongoing and failed activity messages, if available.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "accessRules":{
            "title":"accessRules Array",
            "type":"array",
            "description":"Array of JSON objects, with one element for each rule.",
            "items":{
                "$ref":"#/definitions/view-rules-accessRules-array-item"
            }
        },
        "activities":{
            "title":"activities Array",
            "type":"array",
            "description":"Groups details about ongoing and failed activity messages, if available.",
            "items":{
                "$ref":"#/definitions/view-rules-activities-array-item"
            }
        }
    }
}

Nested Schema : accessRules Array

Type: array

Title: accessRules Array

Array of JSON objects, with one element for each rule.

Show Source

• Array of: object accessRules Array Item
  Title: accessRules Array Item

{
    "title":"accessRules Array",
    "type":"array",
    "description":"Array of JSON objects, with one element for each rule.",
    "items":{
        "$ref":"#/definitions/view-rules-accessRules-array-item"
    }
}

Nested Schema : activities Array

Type: array

Title: activities Array

Groups details about ongoing and failed activity messages, if available.

Show Source

• Array of: object activities Array Item
  Title: activities Array Item

{
    "title":"activities Array",
    "type":"array",
    "description":"Groups details about ongoing and failed activity messages, if available.",
    "items":{
        "$ref":"#/definitions/view-rules-activities-array-item"
    }
}

Nested Schema : accessRules Array Item

Type: object

Title: accessRules Array Item

Show Source

• description(optional): string
  The Description of the rule.
• destination(optional): string
  The value DB_1.
• ports(optional): string
  The ports for the rule.
• ruleName(optional): string
  The name of the rule.
• ruleType(optional): string
  The type of the rule; one of: DEFAULT, SYSTEM or USER.
• source(optional): string
  IP addresses and subnets from which traffic is allowed.
• status(optional): string
  The status of the rule; one of: disabled or enabled.

{
    "title":"accessRules Array Item",
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The Description of the rule."
        },
        "destination":{
            "type":"string",
            "description":"The value <code>DB_1</code>."
        },
        "ports":{
            "type":"string",
            "description":"The ports for the rule."
        },
        "ruleName":{
            "type":"string",
            "description":"The name of the rule."
        },
        "ruleType":{
            "type":"string",
            "description":"The type of the rule; one of: <code>DEFAULT</code>, <code>SYSTEM</code> or <code>USER</code>."
        },
        "source":{
            "type":"string",
            "description":"IP addresses and subnets from which traffic is allowed."
        },
        "status":{
            "type":"string",
            "description":"The status of the rule; one of: <code>disabled</code> or <code>enabled</code>."
        }
    }
}

Nested Schema : activities Array Item

Type: object

Title: activities Array Item

Show Source

• activity(optional): object activity Object
  Title: activity Object

{
    "title":"activities Array Item",
    "type":"object",
    "properties":{
        "activity":{
            "$ref":"#/definitions/view-rules-activities-array-item-activity"
        }
    }
}

Nested Schema : activity Object

Type: object

Title: activity Object

Show Source

• errors(optional): string
  Error encountered for an ongoing or failed activity.
• message(optional): string
  Message of an ongoing or failed activity.

{
    "title":"activity Object",
    "type":"object",
    "properties":{
        "errors":{
            "type":"string",
            "description":"Error encountered for an ongoing or failed activity."
        },
        "message":{
            "type":"string",
            "description":"Message of an ongoing or failed activity."
        }
    }
}

Back to Top

Examples

The following example shows how to view the rules for a Database Classic Cloud Service instance by submitting a GET request on the REST endpoint using cURL.

This example uses a traditional cloud account, so the {identityDomainId} path parameter and the X-ID-TENANT-NAME header parameter are set to the account's domain name, which is usexample. The service instance is db12c-xp-si and the Oracle Cloud user name of the user making the call is dbcsadmin.

cURL Command

$ curl --include --request GET \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db12c-xp-si/accessrules

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Content-Length: 1298
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
X-Frame-Options: DENY
Vary: Accept-Encoding,User-Agent
Content-Language: en
Content-Type: application/json

Response Body

{
  "accessRules":[
    {
      "ruleName":"ora_p2_ssh",
      "description":"",
      "status":"enabled",
      "source":"PUBLIC-INTERNET",
      "destination":"DB_1",
      "ports":"22",
      "ruleType":"DEFAULT"
    },
    {
      "ruleName":"ora_p2_dblistener",
      "description":"",
      "status":"disabled",
      "source":"PUBLIC-INTERNET",
      "destination":"DB_1",
      "ports":"1521",
      "ruleType":"DEFAULT"
    },
    {
      "ruleName":"ora_p2_http",
      "description":"",
      "status":"disabled",
      "source":"PUBLIC-INTERNET",
      "destination":"DB_1",
      "ports":"80",
      "ruleType":"DEFAULT"
    },
    {
      "ruleName":"ora_p2_httpssl",
      "description":"",
      "status":"enabled",
      "source":"PUBLIC-INTERNET",
      "destination":"DB_1",
      "ports":"443",
      "ruleType":"DEFAULT"
    },
    {
      "ruleName":"ora_p2_httpadmin",
      "description":"",
      "status":"disabled",
      "source":"PUBLIC-INTERNET",
      "destination":"DB_1",
      "ports":"4848",
      "ruleType":"DEFAULT"
    },
    {
      "ruleName":"ora_p2_dbconsole",
      "description":"",
      "status":"disabled",
      "source":"PUBLIC-INTERNET",
      "destination":"DB_1",
      "ports":"1158",
      "ruleType":"DEFAULT"
    },
    {
      "ruleName":"ora_p2_dbexpress",
      "description":"",
      "status":"disabled",
      "source":"PUBLIC-INTERNET",
      "destination":"DB_1",
      "ports":"5500",
      "ruleType":"DEFAULT"
    },
    {
      "ruleName":"ora_trusted_hosts_dblistener",
      "description":"DO NOT MODIFY: A secrule to allow specific IPs to connect to this db",
      "status":"enabled",
      "source":"127.0.0.1\/32",
      "destination":"DB_1",
      "ports":"1521",
      "ruleType":"SYSTEM"
    },
    {
      "ruleName":"example-dblistener",
      "description":"",
      "status":"enabled",
      "source":"192.0.2.0\/24",
      "destination":"DB_1",
      "ports":"1521",
      "ruleType":"USER"
    }
  ],
  "activities":[
    {
      "activity":{
        "message":"Creation of [example-https] access rule(s) is in progress."
      }
    }
  ]
}

Back to Top