backupRBAC()

This operation backs up the current RBAC configurations.

await milvusClient.backupRBAC(data?)

Request Syntax

await milvusClient.backupRBAC({
   timeout?: number
 })

PARAMETERS:

• timeout (number) -

  The timeout duration for this operation.

  Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.

RETURNS Promise

This method returns a promise that resolves to a BackupRBACResponse object.

{
    RBAC_meta: RBACMeta,
    status:  ResStatus
}

PARAMETERS:

• RBAC_meta (RBACMeta) - A snapshot of all RBAC metadata in the current Milvus instance. Pass this value to restoreRBAC() to recreate the same users, roles, grants, and privilege groups in another instance.

  • users (User[]) -

    All users defined in the instance.

  • roles (RoleEntity[]) -

    All roles defined in the instance.

  • grants (GrantEntity[]) -

    All grants attached to the instance’s roles. For the full GrantEntity field reference, refer to the describeRole() doc.

  • privilege_groups (PrivelegeGroup[]) -

    All privilege groups defined in the instance. For the full PrivelegeGroup field reference, refer to the listPrivilegeGroups() doc.

• ResStatus A ResStatus object.

  • code (number) -

    A code that indicates the operation result. It remains 0 if this operation succeeds.

  • error_code (string | number) -

    An error code that indicates an occurred error. It remains Success if this operation succeeds.

  • reason (string) -

    The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.

Example

milvusClient.backupRBAC();