Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


ListAclsResponse (Version: 0) => error_code error_message [resource]
error_code => INT16
error_message => NULLABLE_STRING
resource => resource_type resource_name [acl]
resource_type => INT8
resource_name => STRING
acl => principal host operation permission_type
principal => STRING
host => STRING
operation => INT8
permission_type => INT8

 

The error_code field will be non-zero if there was an error processing the request.  If the error_code is non-zero, the resource results list will be empty.Each resource_info   Otherwise, each listed resource object describes the a specific resource, and the ACLs bound to that resource.  Note that if filters were specified in the ListAclsRequest, this may not be a complete list of all the ACLs bound to the resource, but only the ones which matched the supplied filters.In contrast to ListAclsRequest, none   None of the fields in the ACL 4-tuple or the resource 2-tuple are ever set to null or none in the response.

...

CreateAclsRequest (Version: 0) => [creation_request]
creation_request => resource_type resource_name principal host operation permission_type
 resource_type => INT8
resource_name => STRING
principal => STRING
host => STRING
  operation => INT8
permission_type => INT8

 

CreateAclsRequest receives contains a list of ACLs to add.  It must be sent to the controller broker.  The request is not transactional: if one addition fails, the others may proceed.  Errors are reported independently for each addition. 

CreateAclsResponse (Version: 0) => [creation_response]
addition_response => error_code error_message
 error_code => INT16
error_message => NULLABLE_STRING

There will be a creation_response for each creation in the CreateAclsRequest.  The responses will be appear in the same order which the requests appeared.  If the request For creations which completed successfully, error_code will be 0 and error_message will be null.  If there was an error, the error_code will be non-zero and the error_message will give a detailed error message describing why the creation could not be performed.

...

DeleteAclsRequest (Version: 0) => [filter]
filter => resource_type resource_name principal host operation permission_type
 resource_type => INT8
resource_name => NULLABLE_STRING
principal => NULLABLE_STRING
host => NULLABLE_STRING
  operation => INT8
permission_type => INT8

 

DeleteAclsRequest receives contains a list of filters.  It will attempt to remove all the ACLs which match each filter.

Just like CreateAclsRequest, DeleteAclsRequest must be sent to the controller broker.  The request is not transactional: if one addition fails, the others may proceed.  Results are reported independently for each removal. 

DeleteAclsResponse (Version: 0) => [filter_response]
 filter_response => error_code error_message [matching_aclmatch]
 error_pair =>
 error_code => INT16
error_message => NULLABLE_STRING
matching_aclmatch => error_code error_pairmessage resource_type resource_name principal host operation permission_type
  error_code => INT16
error_message => NULLABLE_STRING
resource_type => INT8
resource_name => STRING
principal => STRING
host => STRING
operation => INT8
permission_type => INT8

...

Filter responses will be appear in the same order which the filters appeared.  If the filter_response has a non-zero error_code, that means that the filter could not be applied by the server, and the matching_acl match array will be empty.  Otherwise, the matching_acl match array contains a list of all the ACLs that matched the filter.  Each matching_acl match will have a non-zero error code and error message if it could not be removed.  When a filters fails to match an ACLs, it is not an error.  This will simply result in getting back a filter_response with an empty matching_acl match list.

New AdminClient APIs

...