client/docs/cloud/disk.md

Disk

云盘目录服务

• /cloud.Disk/CreateDir
• /cloud.Disk/GetDir
• /cloud.Disk/UpdateDir
• /cloud.Disk/DeleteDir
• /cloud.Disk/ListDirs
• /cloud.Disk/GetDirTree
• /cloud.Disk/MoveDir
• /cloud.Disk/UploadFile
• /cloud.Disk/GetFile
• /cloud.Disk/UpdateFile
• /cloud.Disk/DeleteFile
• /cloud.Disk/ListFiles
• /cloud.Disk/MoveFile
• /cloud.Disk/CopyFile
• /cloud.Disk/SearchFiles

/cloud.Disk/CreateDir

创建目录

Request

{
    cloud_id: "0", // type<uint64>
    cloud_identity: "", // type<string>
    parent_id: "0", // type<uint64>, 支持嵌套目录
    name: "", // type<string>, 目录名称
    path: "", // type<string>, 完整路径
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cloud.Disk/GetDir

获取目录详情

Request

{
    id: "0", // type<int64>, 唯一ID
    identity: "", // type<string>, 唯一码
}

Reply

{
    id: "0", // type<uint64>
    identity: "", // type<string>
    parent_id: "0", // type<uint64>, 支持嵌套目录
    name: "", // type<string>, 目录名称
    path: "", // type<string>, 完整路径
    created_at: "", // type<string>
    updated_at: "", // type<string>
    // 自关联
    parent: {}, // type<CloudDiskDirItem>, 父级目录
    subdirectories: [{}], // list<CloudDiskDirItem>, 子级目录
    files: [{
        id: "0", // type<uint64>
        identity: "", // type<string>
        directory_id: "0", // type<uint64>, 文件所属目录
        name: "", // type<string>, 文件名
        original_name: "", // type<string>, 原始文件名
        size: "0", // type<int64>, 文件大小 (bytes)
        mime_type: "", // type<string>, 文件类型
        storage_path: "", // type<string>, 实际存储路径
        hash: "", // type<string>, 文件哈希，用于去重
        created_at: "", // type<string>
        updated_at: "", // type<string>
        // 关联关系
        directory: {}, // type<CloudDiskDirItem>, 文件所属目录
    }], // list<CloudDiskFileItem>, 文件
}

/cloud.Disk/UpdateDir

更新目录

Request

{
    id: "0", // type<uint64>
    identity: "", // type<string>
    parent_id: "0", // type<uint64>, 支持嵌套目录
    name: "", // type<string>, 目录名称
    path: "", // type<string>, 完整路径
    created_at: "", // type<string>
    updated_at: "", // type<string>
    // 自关联
    parent: {}, // type<CloudDiskDirItem>, 父级目录
    subdirectories: [{}], // list<CloudDiskDirItem>, 子级目录
    files: [{
        id: "0", // type<uint64>
        identity: "", // type<string>
        directory_id: "0", // type<uint64>, 文件所属目录
        name: "", // type<string>, 文件名
        original_name: "", // type<string>, 原始文件名
        size: "0", // type<int64>, 文件大小 (bytes)
        mime_type: "", // type<string>, 文件类型
        storage_path: "", // type<string>, 实际存储路径
        hash: "", // type<string>, 文件哈希，用于去重
        created_at: "", // type<string>
        updated_at: "", // type<string>
        // 关联关系
        directory: {}, // type<CloudDiskDirItem>, 文件所属目录
    }], // list<CloudDiskFileItem>, 文件
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cloud.Disk/DeleteDir

删除目录

Request

{
    id: "0", // type<int64>, 唯一ID
    identity: "", // type<string>, 唯一码
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cloud.Disk/ListDirs

获取目录列表

Request

{
    page_no: "0", // type<int64>, 页数
    page_size: "0", // type<int64>, 每页记录数
    params: {
        "": ""
    }, // map<string,string>, 条件参数,key=val,eg key:category_id=?,vlaue=11 
}

Reply

{
    dirs: [{
        id: "0", // type<uint64>
        identity: "", // type<string>
        parent_id: "0", // type<uint64>, 支持嵌套目录
        name: "", // type<string>, 目录名称
        path: "", // type<string>, 完整路径
        created_at: "", // type<string>
        updated_at: "", // type<string>
        // 自关联
        parent: {}, // type<CloudDiskDirItem>, 父级目录
        subdirectories: [{}], // list<CloudDiskDirItem>, 子级目录
        files: [{
            id: "0", // type<uint64>
            identity: "", // type<string>
            directory_id: "0", // type<uint64>, 文件所属目录
            name: "", // type<string>, 文件名
            original_name: "", // type<string>, 原始文件名
            size: "0", // type<int64>, 文件大小 (bytes)
            mime_type: "", // type<string>, 文件类型
            storage_path: "", // type<string>, 实际存储路径
            hash: "", // type<string>, 文件哈希，用于去重
            created_at: "", // type<string>
            updated_at: "", // type<string>
            // 关联关系
            directory: {}, // type<CloudDiskDirItem>, 文件所属目录
        }], // list<CloudDiskFileItem>, 文件
    }], // list<CloudDiskDirItem>
    total: "0", // type<int64>
}

/cloud.Disk/GetDirTree

获取目录树

Request

{
    id: "0", // type<int64>, 唯一ID
    identity: "", // type<string>, 唯一码
}

Reply

{
    id: "0", // type<uint64>
    identity: "", // type<string>
    parent_id: "0", // type<uint64>, 支持嵌套目录
    name: "", // type<string>, 目录名称
    path: "", // type<string>, 完整路径
    created_at: "", // type<string>
    updated_at: "", // type<string>
    // 自关联
    parent: {}, // type<CloudDiskDirItem>, 父级目录
    subdirectories: [{}], // list<CloudDiskDirItem>, 子级目录
    files: [{
        id: "0", // type<uint64>
        identity: "", // type<string>
        directory_id: "0", // type<uint64>, 文件所属目录
        name: "", // type<string>, 文件名
        original_name: "", // type<string>, 原始文件名
        size: "0", // type<int64>, 文件大小 (bytes)
        mime_type: "", // type<string>, 文件类型
        storage_path: "", // type<string>, 实际存储路径
        hash: "", // type<string>, 文件哈希，用于去重
        created_at: "", // type<string>
        updated_at: "", // type<string>
        // 关联关系
        directory: {}, // type<CloudDiskDirItem>, 文件所属目录
    }], // list<CloudDiskFileItem>, 文件
}

/cloud.Disk/MoveDir

移动目录

Request

{
    id: "0", // type<uint64>
    new_parent_id: "0", // type<uint64>
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cloud.Disk/UploadFile

上传文件

Request

{
    cloud_id: "0", // type<uint64>
    cloud_identity: "", // type<string>
    directory_id: "0", // type<uint64>, 文件所属目录
    name: "", // type<string>, 文件名
    original_name: "", // type<string>, 原始文件名
    size: "0", // type<int64>, 文件大小 (bytes)
    mime_type: "", // type<string>, 文件类型
    storage_path: "", // type<string>, 实际存储路径
    hash: "", // type<string>, 文件哈希，用于去重
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cloud.Disk/GetFile

获取文件详情

Request

{
    id: "0", // type<int64>, 唯一ID
    identity: "", // type<string>, 唯一码
}

Reply

{
    id: "0", // type<uint64>
    identity: "", // type<string>
    directory_id: "0", // type<uint64>, 文件所属目录
    name: "", // type<string>, 文件名
    original_name: "", // type<string>, 原始文件名
    size: "0", // type<int64>, 文件大小 (bytes)
    mime_type: "", // type<string>, 文件类型
    storage_path: "", // type<string>, 实际存储路径
    hash: "", // type<string>, 文件哈希，用于去重
    created_at: "", // type<string>
    updated_at: "", // type<string>
    // 关联关系
    directory: {
        id: "0", // type<uint64>
        identity: "", // type<string>
        parent_id: "0", // type<uint64>, 支持嵌套目录
        name: "", // type<string>, 目录名称
        path: "", // type<string>, 完整路径
        created_at: "", // type<string>
        updated_at: "", // type<string>
        // 自关联
        parent: {}, // type<CloudDiskDirItem>, 父级目录
        subdirectories: [{}], // list<CloudDiskDirItem>, 子级目录
        files: [{}], // list<CloudDiskFileItem>, 文件
    }, // type<CloudDiskDirItem>, 文件所属目录
}

/cloud.Disk/UpdateFile

更新文件

Request

{
    id: "0", // type<uint64>
    identity: "", // type<string>
    directory_id: "0", // type<uint64>, 文件所属目录
    name: "", // type<string>, 文件名
    original_name: "", // type<string>, 原始文件名
    size: "0", // type<int64>, 文件大小 (bytes)
    mime_type: "", // type<string>, 文件类型
    storage_path: "", // type<string>, 实际存储路径
    hash: "", // type<string>, 文件哈希，用于去重
    created_at: "", // type<string>
    updated_at: "", // type<string>
    // 关联关系
    directory: {
        id: "0", // type<uint64>
        identity: "", // type<string>
        parent_id: "0", // type<uint64>, 支持嵌套目录
        name: "", // type<string>, 目录名称
        path: "", // type<string>, 完整路径
        created_at: "", // type<string>
        updated_at: "", // type<string>
        // 自关联
        parent: {}, // type<CloudDiskDirItem>, 父级目录
        subdirectories: [{}], // list<CloudDiskDirItem>, 子级目录
        files: [{}], // list<CloudDiskFileItem>, 文件
    }, // type<CloudDiskDirItem>, 文件所属目录
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cloud.Disk/DeleteFile

删除文件

Request

{
    id: "0", // type<int64>, 唯一ID
    identity: "", // type<string>, 唯一码
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cloud.Disk/ListFiles

获取文件列表

Request

{
    page_no: "0", // type<int64>, 页数
    page_size: "0", // type<int64>, 每页记录数
    params: {
        "": ""
    }, // map<string,string>, 条件参数,key=val,eg key:category_id=?,vlaue=11 
}

Reply

{
    files: [{
        id: "0", // type<uint64>
        identity: "", // type<string>
        directory_id: "0", // type<uint64>, 文件所属目录
        name: "", // type<string>, 文件名
        original_name: "", // type<string>, 原始文件名
        size: "0", // type<int64>, 文件大小 (bytes)
        mime_type: "", // type<string>, 文件类型
        storage_path: "", // type<string>, 实际存储路径
        hash: "", // type<string>, 文件哈希，用于去重
        created_at: "", // type<string>
        updated_at: "", // type<string>
        // 关联关系
        directory: {
            id: "0", // type<uint64>
            identity: "", // type<string>
            parent_id: "0", // type<uint64>, 支持嵌套目录
            name: "", // type<string>, 目录名称
            path: "", // type<string>, 完整路径
            created_at: "", // type<string>
            updated_at: "", // type<string>
            // 自关联
            parent: {}, // type<CloudDiskDirItem>, 父级目录
            subdirectories: [{}], // list<CloudDiskDirItem>, 子级目录
            files: [{}], // list<CloudDiskFileItem>, 文件
        }, // type<CloudDiskDirItem>, 文件所属目录
    }], // list<CloudDiskFileItem>
    total: "0", // type<int64>
}

/cloud.Disk/MoveFile

移动文件

Request

{
    id: "0", // type<uint64>
    new_directory_id: "0", // type<uint64>
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cloud.Disk/CopyFile

复制文件

Request

{
    id: "0", // type<uint64>
    target_directory_id: "0", // type<uint64>
    new_name: "", // type<string>
}

Reply

{
    code: 0, // type<int32>, 状态码
    message: "", // type<string>, 状态说明
    details: "", // type<string>, 数据
    timeseq: "0", // type<int64>, 响应时间序列
}

/cloud.Disk/SearchFiles

搜索文件

Request

{
    page_no: "0", // type<int64>, 页数
    page_size: "0", // type<int64>, 每页记录数
    params: {
        "": ""
    }, // map<string,string>, 条件参数,key=val,eg key:category_id=?,vlaue=11 
}

Reply

{
    files: [{
        id: "0", // type<uint64>
        identity: "", // type<string>
        directory_id: "0", // type<uint64>, 文件所属目录
        name: "", // type<string>, 文件名
        original_name: "", // type<string>, 原始文件名
        size: "0", // type<int64>, 文件大小 (bytes)
        mime_type: "", // type<string>, 文件类型
        storage_path: "", // type<string>, 实际存储路径
        hash: "", // type<string>, 文件哈希，用于去重
        created_at: "", // type<string>
        updated_at: "", // type<string>
        // 关联关系
        directory: {
            id: "0", // type<uint64>
            identity: "", // type<string>
            parent_id: "0", // type<uint64>, 支持嵌套目录
            name: "", // type<string>, 目录名称
            path: "", // type<string>, 完整路径
            created_at: "", // type<string>
            updated_at: "", // type<string>
            // 自关联
            parent: {}, // type<CloudDiskDirItem>, 父级目录
            subdirectories: [{}], // list<CloudDiskDirItem>, 子级目录
            files: [{}], // list<CloudDiskFileItem>, 文件
        }, // type<CloudDiskDirItem>, 文件所属目录
    }], // list<CloudDiskFileItem>
    total: "0", // type<int64>
}