Interface AccessRuleApi


  • public interface AccessRuleApi
    The access list management feature allows fine-grained network access controls to be applied to the load balancer's virtual IP address.

    • Method Detail

      • create

        @Named("accessrule:create")
        @POST
        @Consumes("application/json")
        @Path("/accesslist")
        void create​(Iterable<AccessRule> accessRules)
        Create new access rules or append to existing access rules. When creating access rules, one or more AccessRules are required. If populated access rules already exist for the load balancer, it will be appended to with subsequent creates. One access list may include up to 100 AccessRules. A single address or subnet definition is considered unique and cannot be duplicated between rules in an access list.
      • list

        @Named("accessrule:list")
        @GET
        @Consumes("application/json")
        @Path("/accesslist")
        Iterable<AccessRuleWithId> list()
        List the AccessRules.
      • delete

        @Named("accessrule:delete")
        @DELETE
        @Path("/accesslist/{id}")
        @Consumes("*/*")
        boolean delete​(@PathParam("id")
                       int id)
        Delete an access rule from the access list.
        Returns:
        true on a successful delete, false if the access rule was not found
      • delete

        @Named("accessrule:delete")
        @DELETE
        @Path("/accesslist")
        @Consumes("*/*")
        boolean delete​(@QueryParam("id")
                       Iterable<Integer> ids)
        Batch delete the access rules given the specified ids.
        Returns:
        true on a successful delete, false if the access rule was not found
      • deleteAll

        @Named("accessrule:delete")
        @DELETE
        @Path("/accesslist")
        @Consumes("*/*")
        boolean deleteAll()
        Delete the entire access list.
        Returns:
        true on a successful delete, false if the access rule was not found