Jump to

• Request
• Response

UpdateNetworkSecurityGroups

put

/20170115/loadBalancers/{load_balancer_id}/networkSecurityGroups

Update the network security groups associated with the specified load balancer.

Request

Supported Media Types

• application/json

Path Parameters

• loadBalancerId(required): string
  The OCID of the load balancer to update the NSGs for.

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the ETag from a previous GET or POST response for that resource. The resource is updated or deleted only if the ETag you provide matches the resource's current ETag value.

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

  Default Value:
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Body ()

The details for updating the NSGs associated with the specified load balancer.

Root Schema : UpdateNetworkSecurityGroupsDetails

Type: object

An object representing an updated list of network security groups that overwrites the existing list of network security groups. If the network load balancer has no configured network security groups, then the network load balancer uses the network security groups in this list. If the network load balancer has a list of configured network security groups, then this list replaces the existing list. If the network load balancer has a list of configured network security groups and this list is empty, then the operation removes all of the network security groups associated with the network load balancer.

Show Source

• networkSecurityGroupIds: array networkSecurityGroupIds
  Maximum Number of Items: 5

  An array of network security group OCIDs associated with the network load balancer. During the creation of the network load balancer, the service adds the new network load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

{
    "type":"object",
    "description":"An object representing an updated list of network security groups that overwrites the existing list of network security groups. If the network load balancer has no configured network security groups, then the network load balancer uses the network security groups in this list. If the network load balancer has a list of configured network security groups, then this list replaces the existing list. If the network load balancer has a list of configured network security groups and this list is empty, then the operation removes all of the network security groups associated with the network load balancer.",
    "properties":{
        "networkSecurityGroupIds":{
            "type":"array",
            "maxItems":"5",
            "items":{
                "type":"string",
                "minLength":"1",
                "maxLength":"255",
                "uniqueItems":true
            },
            "description":"An array of network security group OCIDs associated with the network load balancer. During the creation of the network load balancer, the service adds the new network load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access."
        }
    },
    "x-example":"{   \"networkSecurityGroupIds\": [     \"ocid1.networksecuritygroup.<var>unique_ID1</var>\",     \"ocid1.networksecuritygroup.<var>unique_ID2</var>\"   ] } "
}

Nested Schema : networkSecurityGroupIds

Type: array

Maximum Number of Items: 5

An array of network security group OCIDs associated with the network load balancer. During the creation of the network load balancer, the service adds the new network load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 255

{
    "type":"array",
    "maxItems":"5",
    "items":{
        "type":"string",
        "minLength":"1",
        "maxLength":"255",
        "uniqueItems":true
    },
    "description":"An array of network security group OCIDs associated with the network load balancer. During the creation of the network load balancer, the service adds the new network load balancer to the specified network security groups. The benefits of associating the network load balancer with network security groups include: - Network security groups define network security rules to govern ingress and egress traffic for the network load balancer. - The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access."
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

The request was accepted for processing.

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.
• opc-work-request-id: string
  The OCID of the work request.

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."
        }
    }
}

412 Response

Precondition Failed

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