/** * 腾讯云智能媒资托管服务API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { CreateSpace201Response } from '../models'; import type { CreateSpaceRequest } from '../models'; import type { GetContentsView200Response } from '../models'; import type { GetFileCountInSpace200Response } from '../models'; import type { GetLibrarySpaceCount200Response } from '../models'; import type { GetSpaceExtension200Response } from '../models'; import type { GetSpaceSize200Response } from '../models'; import type { ListSpace200Response } from '../models'; import type { SetSpaceTrafficLimitRequest } from '../models'; import type { UpdateSpaceExtensionRequest } from '../models'; /** * SpaceApi - axios parameter creator */ export declare const SpaceApiAxiosParamCreator: (configuration?: Configuration) => { /** * 用于创建租户空间。需要 admin 或 create_space 权限,有关权限详情请参见生成访问令牌接口。 * @summary 创建租户空间 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {string} [spaceId] 租户空间的空间 ID,名称不能以“-”开头或结尾,只支持英文小写字母和数字[a-z,0-9]、中划线“-”及其组合,长度为2到32个字符。 * @param {CreateSpaceRequest} [createSpaceRequest] 租户空间的扩展属性 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSpace: (libraryId: string, accessToken?: string, librarySecret?: string, userId?: string, spaceId?: string, createSpaceRequest?: CreateSpaceRequest, options?: RawAxiosRequestConfig) => Promise; /** * 用于删除租户空间。 要求权限:admin 或 delete_space * @summary 删除租户空间 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {DeleteSpaceForceEnum} [force] 是否强制删除,1:强制删除,不判断space是否为空; 0:非强制删除,不允许删除非空的space * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSpace: (libraryId: string, spaceId: string, accessToken?: string, librarySecret?: string, userId?: string, force?: DeleteSpaceForceEnum, options?: RawAxiosRequestConfig) => Promise; /** * 用于列出空间首页内容,会忽略目录的层级关系,列出空间下所有文件。 要求权限:read_only 或 space_admin 或 admin * @summary 列出空间首页内容 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {GetContentsViewFilterEnum} filter 筛选方式 * @param {string} [marker] 用于顺序列出分页的标识 * @param {number} [limit] 用于顺序列出分页时本地列出的项目数限制 * @param {GetContentsViewOrderByEnum} [orderBy] 排序字段 * @param {GetContentsViewOrderByTypeEnum} [orderByType] 排序方式 * @param {boolean} [withPath] 是否返回 path * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {string} [category] 文件自定义的分类 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContentsView: (libraryId: string, spaceId: string, filter: GetContentsViewFilterEnum, marker?: string, limit?: number, orderBy?: GetContentsViewOrderByEnum, orderByType?: GetContentsViewOrderByTypeEnum, withPath?: boolean, accessToken?: string, librarySecret?: string, userId?: string, category?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于空间文件数量统计。 需要拥有 admin 或 space_admin 权限。 * @summary 空间文件数量统计 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileCountInSpace: (libraryId: string, spaceId: string, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于查询媒体库中的租户空间数量 * @summary 查询媒体库租户空间数量 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLibrarySpaceCount: (libraryId: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于查询租户空间的扩展属性 * @summary 查询租户空间属性 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpaceExtension: (libraryId: string, spaceId: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于查询租户空间大小 * @summary 查询租户空间大小 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpaceSize: (libraryId: string, spaceId: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于列出租户空间列表信息。 - 要求权限:如需列出所有租户空间,需要 admin 权限,否则仅列出当前访问令牌所代表的用户所创建的租户空间; - 列出模式: - 默认模式(不传 Ordered 或 Ordered 取值不为 1)与旧版本行为完全一致,保证向后兼容; - 当 Ordered=1 时,启用\"全局有序列出\"模式,会按 spaceId 升序跨分片合并返回结果,并支持通过 Prefix/StartName 参数进行前缀过滤和起始游标过滤; - 有序模式下返回的 nextMarker 编码格式与非有序模式不同,但对使用方透明:继续将其透传给下一次请求的 marker 参数即可完成翻页。 * @summary 列出租户空间 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {string} [marker] 用于顺序列出分页的标识,即上一次请求返回的 nextMarker 字段。 * @param {number} [limit] 用于顺序列出分页时本地列出的项目数限制,默认为 1000,不能超过 1000。 * @param {ListSpaceOrderedEnum} [ordered] 是否启用全局有序列出(按 spaceId 升序),取值为 1 表示启用,0 或不传表示不启用;启用后 prefix 与 start_name 才会生效。 * @param {string} [prefix] 按 spaceId 前缀过滤,仅返回 spaceId 以该前缀开头的租户空间;仅在 ordered=1 时生效。 * @param {string} [startName] 分页起始游标(不包含),仅返回 spaceId > start_name 的租户空间;仅在 ordered=1 时生效;当与 marker 同时传入时 marker 优先,start_name 会被忽略。 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSpace: (libraryId: string, accessToken?: string, librarySecret?: string, userId?: string, marker?: string, limit?: number, ordered?: ListSpaceOrderedEnum, prefix?: string, startName?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于设置租户空间的下载限速,要求权限:admin或space_admin * @summary 设置租户空间限速 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {SetSpaceTrafficLimitRequest} setSpaceTrafficLimitRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ setSpaceTrafficLimit: (libraryId: string, spaceId: string, setSpaceTrafficLimitRequest: SetSpaceTrafficLimitRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于修改租户空间属性。 要求权限:非 acl 鉴权:admin 或 space_admin; acl 鉴权:无权限 * @summary 修改租户空间属性 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {UpdateSpaceExtensionRequest} [updateSpaceExtensionRequest] 租户空间的扩展属性 * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSpaceExtension: (libraryId: string, spaceId: string, accessToken?: string, librarySecret?: string, userId?: string, updateSpaceExtensionRequest?: UpdateSpaceExtensionRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * SpaceApi - functional programming interface */ export declare const SpaceApiFp: (configuration?: Configuration) => { /** * 用于创建租户空间。需要 admin 或 create_space 权限,有关权限详情请参见生成访问令牌接口。 * @summary 创建租户空间 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {string} [spaceId] 租户空间的空间 ID,名称不能以“-”开头或结尾,只支持英文小写字母和数字[a-z,0-9]、中划线“-”及其组合,长度为2到32个字符。 * @param {CreateSpaceRequest} [createSpaceRequest] 租户空间的扩展属性 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSpace(libraryId: string, accessToken?: string, librarySecret?: string, userId?: string, spaceId?: string, createSpaceRequest?: CreateSpaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于删除租户空间。 要求权限:admin 或 delete_space * @summary 删除租户空间 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {DeleteSpaceForceEnum} [force] 是否强制删除,1:强制删除,不判断space是否为空; 0:非强制删除,不允许删除非空的space * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSpace(libraryId: string, spaceId: string, accessToken?: string, librarySecret?: string, userId?: string, force?: DeleteSpaceForceEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于列出空间首页内容,会忽略目录的层级关系,列出空间下所有文件。 要求权限:read_only 或 space_admin 或 admin * @summary 列出空间首页内容 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {GetContentsViewFilterEnum} filter 筛选方式 * @param {string} [marker] 用于顺序列出分页的标识 * @param {number} [limit] 用于顺序列出分页时本地列出的项目数限制 * @param {GetContentsViewOrderByEnum} [orderBy] 排序字段 * @param {GetContentsViewOrderByTypeEnum} [orderByType] 排序方式 * @param {boolean} [withPath] 是否返回 path * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {string} [category] 文件自定义的分类 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContentsView(libraryId: string, spaceId: string, filter: GetContentsViewFilterEnum, marker?: string, limit?: number, orderBy?: GetContentsViewOrderByEnum, orderByType?: GetContentsViewOrderByTypeEnum, withPath?: boolean, accessToken?: string, librarySecret?: string, userId?: string, category?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于空间文件数量统计。 需要拥有 admin 或 space_admin 权限。 * @summary 空间文件数量统计 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileCountInSpace(libraryId: string, spaceId: string, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于查询媒体库中的租户空间数量 * @summary 查询媒体库租户空间数量 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLibrarySpaceCount(libraryId: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于查询租户空间的扩展属性 * @summary 查询租户空间属性 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpaceExtension(libraryId: string, spaceId: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于查询租户空间大小 * @summary 查询租户空间大小 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpaceSize(libraryId: string, spaceId: string, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于列出租户空间列表信息。 - 要求权限:如需列出所有租户空间,需要 admin 权限,否则仅列出当前访问令牌所代表的用户所创建的租户空间; - 列出模式: - 默认模式(不传 Ordered 或 Ordered 取值不为 1)与旧版本行为完全一致,保证向后兼容; - 当 Ordered=1 时,启用\"全局有序列出\"模式,会按 spaceId 升序跨分片合并返回结果,并支持通过 Prefix/StartName 参数进行前缀过滤和起始游标过滤; - 有序模式下返回的 nextMarker 编码格式与非有序模式不同,但对使用方透明:继续将其透传给下一次请求的 marker 参数即可完成翻页。 * @summary 列出租户空间 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {string} [marker] 用于顺序列出分页的标识,即上一次请求返回的 nextMarker 字段。 * @param {number} [limit] 用于顺序列出分页时本地列出的项目数限制,默认为 1000,不能超过 1000。 * @param {ListSpaceOrderedEnum} [ordered] 是否启用全局有序列出(按 spaceId 升序),取值为 1 表示启用,0 或不传表示不启用;启用后 prefix 与 start_name 才会生效。 * @param {string} [prefix] 按 spaceId 前缀过滤,仅返回 spaceId 以该前缀开头的租户空间;仅在 ordered=1 时生效。 * @param {string} [startName] 分页起始游标(不包含),仅返回 spaceId > start_name 的租户空间;仅在 ordered=1 时生效;当与 marker 同时传入时 marker 优先,start_name 会被忽略。 * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSpace(libraryId: string, accessToken?: string, librarySecret?: string, userId?: string, marker?: string, limit?: number, ordered?: ListSpaceOrderedEnum, prefix?: string, startName?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于设置租户空间的下载限速,要求权限:admin或space_admin * @summary 设置租户空间限速 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {SetSpaceTrafficLimitRequest} setSpaceTrafficLimitRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ setSpaceTrafficLimit(libraryId: string, spaceId: string, setSpaceTrafficLimitRequest: SetSpaceTrafficLimitRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于修改租户空间属性。 要求权限:非 acl 鉴权:admin 或 space_admin; acl 鉴权:无权限 * @summary 修改租户空间属性 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {UpdateSpaceExtensionRequest} [updateSpaceExtensionRequest] 租户空间的扩展属性 * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSpaceExtension(libraryId: string, spaceId: string, accessToken?: string, librarySecret?: string, userId?: string, updateSpaceExtensionRequest?: UpdateSpaceExtensionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SpaceApi - factory interface */ export declare const SpaceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 用于创建租户空间。需要 admin 或 create_space 权限,有关权限详情请参见生成访问令牌接口。 * @summary 创建租户空间 * @param {SpaceApiCreateSpaceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSpace(requestParameters: SpaceApiCreateSpaceRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于删除租户空间。 要求权限:admin 或 delete_space * @summary 删除租户空间 * @param {SpaceApiDeleteSpaceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSpace(requestParameters: SpaceApiDeleteSpaceRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于列出空间首页内容,会忽略目录的层级关系,列出空间下所有文件。 要求权限:read_only 或 space_admin 或 admin * @summary 列出空间首页内容 * @param {SpaceApiGetContentsViewRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContentsView(requestParameters: SpaceApiGetContentsViewRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于空间文件数量统计。 需要拥有 admin 或 space_admin 权限。 * @summary 空间文件数量统计 * @param {SpaceApiGetFileCountInSpaceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileCountInSpace(requestParameters: SpaceApiGetFileCountInSpaceRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于查询媒体库中的租户空间数量 * @summary 查询媒体库租户空间数量 * @param {SpaceApiGetLibrarySpaceCountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLibrarySpaceCount(requestParameters: SpaceApiGetLibrarySpaceCountRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于查询租户空间的扩展属性 * @summary 查询租户空间属性 * @param {SpaceApiGetSpaceExtensionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpaceExtension(requestParameters: SpaceApiGetSpaceExtensionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于查询租户空间大小 * @summary 查询租户空间大小 * @param {SpaceApiGetSpaceSizeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpaceSize(requestParameters: SpaceApiGetSpaceSizeRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于列出租户空间列表信息。 - 要求权限:如需列出所有租户空间,需要 admin 权限,否则仅列出当前访问令牌所代表的用户所创建的租户空间; - 列出模式: - 默认模式(不传 Ordered 或 Ordered 取值不为 1)与旧版本行为完全一致,保证向后兼容; - 当 Ordered=1 时,启用\"全局有序列出\"模式,会按 spaceId 升序跨分片合并返回结果,并支持通过 Prefix/StartName 参数进行前缀过滤和起始游标过滤; - 有序模式下返回的 nextMarker 编码格式与非有序模式不同,但对使用方透明:继续将其透传给下一次请求的 marker 参数即可完成翻页。 * @summary 列出租户空间 * @param {SpaceApiListSpaceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSpace(requestParameters: SpaceApiListSpaceRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于设置租户空间的下载限速,要求权限:admin或space_admin * @summary 设置租户空间限速 * @param {SpaceApiSetSpaceTrafficLimitRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setSpaceTrafficLimit(requestParameters: SpaceApiSetSpaceTrafficLimitRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于修改租户空间属性。 要求权限:非 acl 鉴权:admin 或 space_admin; acl 鉴权:无权限 * @summary 修改租户空间属性 * @param {SpaceApiUpdateSpaceExtensionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSpaceExtension(requestParameters: SpaceApiUpdateSpaceExtensionRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createSpace operation in SpaceApi. */ export interface SpaceApiCreateSpaceRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; /** * 租户空间的空间 ID,名称不能以“-”开头或结尾,只支持英文小写字母和数字[a-z,0-9]、中划线“-”及其组合,长度为2到32个字符。 */ readonly spaceId?: string; /** * 租户空间的扩展属性 */ readonly createSpaceRequest?: CreateSpaceRequest; } /** * Request parameters for deleteSpace operation in SpaceApi. */ export interface SpaceApiDeleteSpaceRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; /** * 是否强制删除,1:强制删除,不判断space是否为空; 0:非强制删除,不允许删除非空的space */ readonly force?: DeleteSpaceForceEnum; } /** * Request parameters for getContentsView operation in SpaceApi. */ export interface SpaceApiGetContentsViewRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 筛选方式 */ readonly filter: GetContentsViewFilterEnum; /** * 用于顺序列出分页的标识 */ readonly marker?: string; /** * 用于顺序列出分页时本地列出的项目数限制 */ readonly limit?: number; /** * 排序字段 */ readonly orderBy?: GetContentsViewOrderByEnum; /** * 排序方式 */ readonly orderByType?: GetContentsViewOrderByTypeEnum; /** * 是否返回 path */ readonly withPath?: boolean; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; /** * 文件自定义的分类 */ readonly category?: string; } /** * Request parameters for getFileCountInSpace operation in SpaceApi. */ export interface SpaceApiGetFileCountInSpaceRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for getLibrarySpaceCount operation in SpaceApi. */ export interface SpaceApiGetLibrarySpaceCountRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for getSpaceExtension operation in SpaceApi. */ export interface SpaceApiGetSpaceExtensionRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for getSpaceSize operation in SpaceApi. */ export interface SpaceApiGetSpaceSizeRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for listSpace operation in SpaceApi. */ export interface SpaceApiListSpaceRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; /** * 用于顺序列出分页的标识,即上一次请求返回的 nextMarker 字段。 */ readonly marker?: string; /** * 用于顺序列出分页时本地列出的项目数限制,默认为 1000,不能超过 1000。 */ readonly limit?: number; /** * 是否启用全局有序列出(按 spaceId 升序),取值为 1 表示启用,0 或不传表示不启用;启用后 prefix 与 start_name 才会生效。 */ readonly ordered?: ListSpaceOrderedEnum; /** * 按 spaceId 前缀过滤,仅返回 spaceId 以该前缀开头的租户空间;仅在 ordered=1 时生效。 */ readonly prefix?: string; /** * 分页起始游标(不包含),仅返回 spaceId > start_name 的租户空间;仅在 ordered=1 时生效;当与 marker 同时传入时 marker 优先,start_name 会被忽略。 */ readonly startName?: string; } /** * Request parameters for setSpaceTrafficLimit operation in SpaceApi. */ export interface SpaceApiSetSpaceTrafficLimitRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; readonly setSpaceTrafficLimitRequest: SetSpaceTrafficLimitRequest; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for updateSpaceExtension operation in SpaceApi. */ export interface SpaceApiUpdateSpaceExtensionRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; /** * 租户空间的扩展属性 */ readonly updateSpaceExtensionRequest?: UpdateSpaceExtensionRequest; } /** * SpaceApi - object-oriented interface */ export declare class SpaceApi extends BaseAPI { /** * 用于创建租户空间。需要 admin 或 create_space 权限,有关权限详情请参见生成访问令牌接口。 * @summary 创建租户空间 * @param {SpaceApiCreateSpaceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSpace(requestParameters: SpaceApiCreateSpaceRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于删除租户空间。 要求权限:admin 或 delete_space * @summary 删除租户空间 * @param {SpaceApiDeleteSpaceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSpace(requestParameters: SpaceApiDeleteSpaceRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于列出空间首页内容,会忽略目录的层级关系,列出空间下所有文件。 要求权限:read_only 或 space_admin 或 admin * @summary 列出空间首页内容 * @param {SpaceApiGetContentsViewRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContentsView(requestParameters: SpaceApiGetContentsViewRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于空间文件数量统计。 需要拥有 admin 或 space_admin 权限。 * @summary 空间文件数量统计 * @param {SpaceApiGetFileCountInSpaceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileCountInSpace(requestParameters: SpaceApiGetFileCountInSpaceRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于查询媒体库中的租户空间数量 * @summary 查询媒体库租户空间数量 * @param {SpaceApiGetLibrarySpaceCountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLibrarySpaceCount(requestParameters: SpaceApiGetLibrarySpaceCountRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于查询租户空间的扩展属性 * @summary 查询租户空间属性 * @param {SpaceApiGetSpaceExtensionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpaceExtension(requestParameters: SpaceApiGetSpaceExtensionRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于查询租户空间大小 * @summary 查询租户空间大小 * @param {SpaceApiGetSpaceSizeRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSpaceSize(requestParameters: SpaceApiGetSpaceSizeRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于列出租户空间列表信息。 - 要求权限:如需列出所有租户空间,需要 admin 权限,否则仅列出当前访问令牌所代表的用户所创建的租户空间; - 列出模式: - 默认模式(不传 Ordered 或 Ordered 取值不为 1)与旧版本行为完全一致,保证向后兼容; - 当 Ordered=1 时,启用\"全局有序列出\"模式,会按 spaceId 升序跨分片合并返回结果,并支持通过 Prefix/StartName 参数进行前缀过滤和起始游标过滤; - 有序模式下返回的 nextMarker 编码格式与非有序模式不同,但对使用方透明:继续将其透传给下一次请求的 marker 参数即可完成翻页。 * @summary 列出租户空间 * @param {SpaceApiListSpaceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSpace(requestParameters: SpaceApiListSpaceRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于设置租户空间的下载限速,要求权限:admin或space_admin * @summary 设置租户空间限速 * @param {SpaceApiSetSpaceTrafficLimitRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setSpaceTrafficLimit(requestParameters: SpaceApiSetSpaceTrafficLimitRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于修改租户空间属性。 要求权限:非 acl 鉴权:admin 或 space_admin; acl 鉴权:无权限 * @summary 修改租户空间属性 * @param {SpaceApiUpdateSpaceExtensionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSpaceExtension(requestParameters: SpaceApiUpdateSpaceExtensionRequest, options?: RawAxiosRequestConfig): Promise>; } export declare const DeleteSpaceForceEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type DeleteSpaceForceEnum = typeof DeleteSpaceForceEnum[keyof typeof DeleteSpaceForceEnum]; export declare const GetContentsViewFilterEnum: { readonly OnlyDir: "onlyDir"; readonly OnlyFile: "onlyFile"; }; export type GetContentsViewFilterEnum = typeof GetContentsViewFilterEnum[keyof typeof GetContentsViewFilterEnum]; export declare const GetContentsViewOrderByEnum: { readonly Name: "name"; readonly ModificationTime: "modificationTime"; readonly Size: "size"; readonly CreationTime: "creationTime"; readonly UploadTime: "uploadTime"; readonly LocalCreationTime: "localCreationTime"; readonly LocalModificationTime: "localModificationTime"; }; export type GetContentsViewOrderByEnum = typeof GetContentsViewOrderByEnum[keyof typeof GetContentsViewOrderByEnum]; export declare const GetContentsViewOrderByTypeEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type GetContentsViewOrderByTypeEnum = typeof GetContentsViewOrderByTypeEnum[keyof typeof GetContentsViewOrderByTypeEnum]; export declare const ListSpaceOrderedEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type ListSpaceOrderedEnum = typeof ListSpaceOrderedEnum[keyof typeof ListSpaceOrderedEnum];