Jump to

• Request
• Response

ListNetworkSecurityGroups

get

/20160918/networkSecurityGroups

List network security groups, either NSGs in the specified compartment or NSGs associated with the specified VLAN. Specify either a compartmentId or a vlanId but not both. If you specify a vlanId, all other parameters are ignored.

Request

Supported Media Types

• application/json

Query Parameters

• compartmentId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.

  Default Value: none
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match the entire display name given.
• lifecycleState: string
  A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: oracle.doceng.json.BetterJsonNull@2c07545f
• sortBy: string
  The optional field to sort the results by.

  Default Value: NAME

  Allowed Values: [ "ID", "NAME", "TIME_CREATED" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Allowed Values: [ "ASC", "DESC" ]
• vcnId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the VCN.
• vlanId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the VLAN.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list is being retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object NetworkSecurityGroup
  A network security group (NSG) provides virtual firewall rules for a specific set of VNICs in a VCN. Compare NSGs with SecurityLists, which provide virtual firewall rules to all the VNICs in a subnet. A network security group consists of two items: - The set of VNICs that all have the same security rule needs (for example, a group of Compute instances all running the same application). - A set of NSG SecurityRules that apply to the VNICs in the group. After creating an NSG, you can add VNICs and security rules to it. For example, when you create an instance, you can specify one or more NSGs to add the instance to (see CreateVnicDetails). Or you can add an existing instance to an NSG with UpdateVnic. To add security rules to an NSG, see AddNetworkSecurityGroupSecurityRules. To list the VNICs in an NSG, see ListNetworkSecurityGroupVnics. To list the security rules in an NSG, see ListNetworkSecurityGroupSecurityRules. Important: Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure all of the following are set correctly: - Any security rules in any NSGs the instance's VNIC belongs to. - Any SecurityLists associated with the instance's subnet. - The instance's OS firewall rules.

{
    "items":{
        "$ref":"#/definitions/NetworkSecurityGroup"
    },
    "type":"array"
}

Nested Schema : NetworkSecurityGroup

Type: object

A network security group (NSG) provides virtual firewall rules for a specific set of VNICs in a VCN. Compare NSGs with SecurityLists, which provide virtual firewall rules to all the VNICs in a subnet. A network security group consists of two items: - The set of VNICs that all have the same security rule needs (for example, a group of Compute instances all running the same application). - A set of NSG SecurityRules that apply to the VNICs in the group. After creating an NSG, you can add VNICs and security rules to it. For example, when you create an instance, you can specify one or more NSGs to add the instance to (see CreateVnicDetails). Or you can add an existing instance to an NSG with UpdateVnic. To add security rules to an NSG, see AddNetworkSecurityGroupSecurityRules. To list the VNICs in an NSG, see ListNetworkSecurityGroupVnics. To list the security rules in an NSG, see ListNetworkSecurityGroupSecurityRules. Important: Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure all of the following are set correctly: - Any security rules in any NSGs the instance's VNIC belongs to. - Any SecurityLists associated with the instance's subnet. - The instance's OS firewall rules.

Show Source

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment the network security group is in.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the network security group.
• lifecycleState(required): string
  Allowed Values: [ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" ]

  The network security group's current state.
• timeCreated(required): string(date-time)
  The date and time the network security group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
• vcnId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the network security group's VCN.

{
    "description":"A network security group (NSG) provides virtual firewall rules for a specific set of VNICs in a VCN. Compare NSGs with SecurityLists, which provide virtual firewall rules to all the VNICs in a subnet. A network security group consists of two items: - The set of VNICs that all have the same security rule needs (for example, a group of Compute instances all running the same application). - A set of NSG SecurityRules that apply to the VNICs in the group. After creating an NSG, you can add VNICs and security rules to it. For example, when you create an instance, you can specify one or more NSGs to add the instance to (see CreateVnicDetails). Or you can add an existing instance to an NSG with UpdateVnic. To add security rules to an NSG, see AddNetworkSecurityGroupSecurityRules. To list the VNICs in an NSG, see ListNetworkSecurityGroupVnics. To list the security rules in an NSG, see ListNetworkSecurityGroupSecurityRules. Important: Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure all of the following are set correctly: - Any security rules in any NSGs the instance's VNIC belongs to. - Any SecurityLists associated with the instance's subnet. - The instance's OS firewall rules.",
    "x-obmcs-splat":{
        "resourceKind":"network-security-group",
        "adLocality":"regional"
    },
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment the network security group is in.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "id":{
            "description":"The OCID of the network security group.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The network security group's current state.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "TERMINATING",
                "TERMINATED"
            ],
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the network security group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "vcnId":{
            "description":"The OCID of the network security group's VCN.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "compartmentId",
        "id",
        "lifecycleState",
        "timeCreated",
        "vcnId"
    ],
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top