alist.admin

class alist.admin.AlistAdmin(alist)

基类：object

'/api/admin'相关的API

login()

登录。不建议直接使用此接口。

result = client.admin.login()

返回:

登录成功返回Ture，登录失败触发异常。

clear_cache()

清理所有的缓存数据。

client.admin.clear_cache()

返回:

清理成功返回True，清理失败触发异常。

link(path)

返回真实的链接，且携带头，只提供给中转程序使用。

link = client.admin.link('/path/to/file')

参数:

path -- 文件路径。

返回:

真实的链接。

files(path, names)

删除指定路径下的若干个文件和文件夹。

# 删除文件 '/path/file' 和文件夹 '/path/dir'。
result = client.admin.files('/path', ['file', 'dir'])

参数:

• path -- 文件所在路径。

• names (list) -- 文件名和文件夹列表。

返回:

删除成功返回True。

mkdir(path)

创建文件夹。

client.admin.mkdir('/path/to/new-dir')

参数:

path -- 新文件夹的路径

返回:

创建成功放回True。创建失败触发异常。

rename(path, name)

重命名文件或文件名

# 将文件 '/path/to/old-name' 重命名为 '/path/to/new-name'
client.admin.rename('/path/to/old-name', 'new-name')

参数:

• path -- 旧文件名，完整路径

• name -- 新文件名，不带路径

返回:

重命名成功返回True

move(src_dir, dst_dir, names)

移动文件和文件夹。

# 将文件 '/path/to/old/file' 移动到 '/path/to/new/file'
# 将文件 '/path/to/old/dir' 移动到 '/path/to/new/dir'

client.admin.move('/path/to/old', '/path/to/new', ['file', 'dir'])

参数:

• src_dir -- 源文件夹

• dst_dir -- 目的文件夹

• names (list) -- 文件/文件夹列表

返回:

移动成功返回True

copy(src_dir, dst_dir, names)

复制文件和文件夹。

# 将文件 '/path/to/old/file' 复制到 '/path/to/new/file'
# 将文件 '/path/to/old/dir' 复制到 '/path/to/new/dir'

client.admin.copy('/path/to/old', '/path/to/new', ['file', 'dir'])

参数:

• src_dir -- 源文件夹

• dst_dir -- 目的文件夹

• names (list) -- 文件/文件夹列表

返回:

复制成功返回True

folder(path)

获取指定路径下的所有文件夹。

result = client.admin.folder('/path')

参数:

path -- 指定路径。

返回:

文件夹列表。

refresh(path)

刷新指定路径。

client.admin.refresh('/path')

参数:

path -- 刷新的路径。

返回:

刷新成功返回True，刷新失败触发异常。

admin setting

class alist.admin.AlistAdmin

setting_version()

获取version

version = client.admin.setting_version()

setting_title(new=None)

获取或更新title。

参数:

new -- 如果不为None，则更新title

# 更新标题为'new title'
client.admin.setting_title('new title')

类似的API还有：

• setting_logo(new = None)

• setting_favicon(new = None)

• setting_icon_color(new = None)

• setting_announcement(new = None)

• setting_text_types(new = None)

• setting_audio_types(new = None)

• setting_video_types(new = None)

• setting_hide_files(new = None)

• setting_music_cover(new = None)

• setting_site_beian(new = None)

• setting_global_readme_url(new = None)

• setting_pdf_viewer_url(new = None)

• setting_autoplay_video(new = None)

• setting_autoplay_audio(new = None)

• setting_customize_head(new = None)

• setting_customize_body(new = None)

• setting_home_emoji(new = None)

• setting_animation(new = None)

• setting_artplayer_whitelist(new = None)

• setting_artplayer_autoSize(new = None)

• setting_load_type(new = None)

• setting_default_page_size(new = None)

• setting_password(new = None)

• setting_d_proxy_types(new = None)

• setting_check_parent_folder(new = None)

• setting_check_down_link(new = None)

• setting_WebDAV_username(new = None)

• setting_WebDAV_password(new = None)

• setting_Visitor_WebDAV_username(new = None)

• setting_Visitor_WebDAV_password(new = None)

• setting_ocr_api(new = None)

• setting_enable_search(new = None)

• setting_Aria2_RPC_url(new = None)

• setting_Aria2_RPC_secret(new = None)