Properties

$auth

$auth

$config

$config

Methods

__construct()

__construct(\Qiniu\Auth  $auth, \Qiniu\Config  $config = null) : mixed

Parameters

\Qiniu\Auth $auth
\Qiniu\Config $config

Returns

mixed —

buckets()

buckets(bool  $shared = true) : array

获取指定账号下所有的空间名

Parameters

bool $shared

指定共享空间,rw:读写权限空间,rd:读权限空间

Returns

array —

包含所有空间名

listbuckets()

listbuckets(string  $region = null, string  $line = 'false', string  $shared = 'false') : array

列举空间,返回bucket列表

Parameters

string $region

区域

string $line
string $shared

指定共享空间,rw:读写权限空间,rd:读权限空间

Returns

array —

createBucket()

createBucket(string  $name, string  $region = 'z0') : array

创建空间

Parameters

string $name

创建的空间名

string $region

创建的区域,默认华东

Returns

array —

deleteBucket()

deleteBucket(string  $name) : array

删除空间

Parameters

string $name

需要删除的目标空间名

Returns

array —

domains()

domains(string  $bucket) : array

获取指定空间绑定的所有的域名

Parameters

string $bucket

空间名称

Returns

array —

bucketInfo()

bucketInfo(string  $bucket) : array

获取指定空间的相关信息

Parameters

string $bucket

空间名称

Returns

array —

bucketInfos()

bucketInfos(string  $region = null, string  $shared = 'false', string  $fs = 'false') : array

获取指定zone的空间信息列表

Parameters

string $region

区域

string $shared

指定共享空间,rw:读写权限空间,rd:读权限空间

string $fs

如果为 true,会返回每个空间当前的文件数和存储量(实时数据)

Returns

array —

listFiles()

listFiles(string  $bucket, string  $prefix = null, string  $marker = null, int  $limit = 1000, string  $delimiter = null) : array

列取空间的文件列表

Parameters

string $bucket

空间名

string $prefix

列举前缀

string $marker

列举标识符

int $limit

单次列举个数限制

string $delimiter

指定目录分隔符

Returns

array —

listFilesv2()

listFilesv2(string  $bucket, string  $prefix = null, string  $marker = null, int  $limit = 1000, string  $delimiter = null, bool  $skipconfirm = true) : array

列取空间的文件列表

Parameters

string $bucket

空间名

string $prefix

列举前缀

string $marker

列举标识符

int $limit

单次列举个数限制

string $delimiter

指定目录分隔符

bool $skipconfirm

是否跳过已删除条目的确认机制

Returns

array —

bucketLifecycleRule()

bucketLifecycleRule(string  $bucket, string  $name, string  $prefix, int  $delete_after_days, int  $to_line_after_days) : array

增加bucket生命规则

Parameters

string $bucket

空间名

string $name

规则名称 bucket 内唯一,长度小于50,不能为空,只能为 字母、数字、下划线

string $prefix

同一个 bucket 里面前缀不能重复

int $delete_after_days

指定上传文件多少天后删除,指定为0表示不删除, 大于0表示多少天后删除,需大于 to_line_after_days

int $to_line_after_days

指定文件上传多少天后转低频存储。指定为0表示 不转低频存储,小于0表示上传的文件立即变低频存储

Returns

array —

updateBucketLifecycleRule()

updateBucketLifecycleRule(string  $bucket, string  $name, string  $prefix, int  $delete_after_days, int  $to_line_after_days) : array

更新bucket生命规则

Parameters

string $bucket

空间名

string $name

规则名称 bucket 内唯一,长度小于50,不能为空,只能为字母、 数字、下划线

string $prefix

同一个 bucket 里面前缀不能重复

int $delete_after_days

指定上传文件多少天后删除,指定为0表示不删除, 大于0表示多少天后删除,需大于 to_line_after_days

int $to_line_after_days

指定文件上传多少天后转低频存储。指定为0表示不 转低频存储,小于0表示上传的文件立即变低频存储

Returns

array —

getBucketLifecycleRules()

getBucketLifecycleRules(string  $bucket) : array

获取bucket生命规则

Parameters

string $bucket

空间名

Returns

array —

deleteBucketLifecycleRule()

deleteBucketLifecycleRule(string  $bucket, string  $name) : array

删除bucket生命规则

Parameters

string $bucket

空间名

string $name

规则名称 bucket 内唯一,长度小于50,不能为空, 只能为字母、数字、下划线()

Returns

array —

putBucketEvent()

putBucketEvent(string  $bucket, string  $name, string  $prefix, string  $suffix, array  $event, string  $callbackURL, string  $access_key = null, string  $host = null) : array

增加bucket事件通知规则

Parameters

string $bucket

空间名

string $name

规则名称 bucket 内唯一,长度小于50,不能为空, 只能为字母、数字、下划线()

string $prefix

同一个 bucket 里面前缀不能重复

string $suffix

可选,文件配置的后缀

array $event

事件类型,可以指定多个,包括 put,mkfile,delete,copy,move,append, disable,enable,deleteMarkerCreate

string $callbackURL

通知URL,可以指定多个,失败依次重试

string $access_key

可选,设置的话会对通知请求用对应的ak、sk进行签名

string $host

可选,通知请求的host

Returns

array —

updateBucketEvent()

updateBucketEvent(string  $bucket, string  $name, string  $prefix, string  $suffix, array  $event, string  $callbackURL, string  $access_key = null, string  $host = null) : array

更新bucket事件通知规则

Parameters

string $bucket

空间名

string $name

规则名称 bucket 内唯一,长度小于50,不能为空, 只能为字母、数字、下划线()

string $prefix

同一个 bucket 里面前缀不能重复

string $suffix

可选,文件配置的后缀

array $event

事件类型,可以指定多个,包括 put,mkfile,delete,copy,move,append,disable, enable,deleteMarkerCreate

string $callbackURL

通知URL,可以指定多个,失败依次重试

string $access_key

可选,设置的话会对通知请求用对应的ak、sk进行签名

string $host

可选,通知请求的host

Returns

array —

getBucketEvents()

getBucketEvents(string  $bucket) : array

获取bucket事件通知规则

Parameters

string $bucket

空间名

Returns

array —

deleteBucketEvent()

deleteBucketEvent(string  $bucket, string  $name) : array

删除bucket事件通知规则

Parameters

string $bucket

空间名

string $name

规则名称bucket内唯一,长度小于50,不能为空,只能为字母、数字、下划线

Returns

array —

getCorsRules()

getCorsRules(string  $bucket) : array

获取bucket的跨域信息

Parameters

string $bucket

空间名

Returns

array —

putBucketAccessStyleMode()

putBucketAccessStyleMode(string  $bucket, int  $mode) : array

开关原图保护

Parameters

string $bucket

空间名称

int $mode

mode 为1表示开启原图保护,0表示关闭

Returns

array —

putBucketAccessMode()

putBucketAccessMode(string  $bucket, int  $private) : array

设置私有属性

Parameters

string $bucket

空间名称

int $private

private为0表示公开,为1表示私有

Returns

array —

putReferAntiLeech()

putReferAntiLeech(string  $bucket, int  $mode, string  $norefer, string  $pattern, int  $enabled = 1) : array

设置 referer 防盗链

Parameters

string $bucket

空间名称

int $mode

0:关闭Referer(使用此选项将会忽略以下参数并将恢复默认值); 1:设置Referer白名单; 2:设置Referer黑名单

string $norefer

0:不允许空 Refer 访问; 1:表示允许空Refer访问

string $pattern

规则字符串

int $enabled

源站是否支持,默认为0只给CDN配置, 设置为1表示开启源站防盗链

Returns

array —

putBucketMaxAge()

putBucketMaxAge(string  $bucket, int  $maxAge) : array

设置Bucket的maxAge

Parameters

string $bucket

空间名称

int $maxAge

maxAge为0或者负数表示为默认值(31536000)

Returns

array —

putBucketQuota()

putBucketQuota(string  $bucket, string  $size, string  $count) : array

设置空间配额

Parameters

string $bucket

空间名称,不支持授权空间

string $size

空间存储量配额,参数传入0或不传表示不更改当前配置,传入-1表示取消限额,新创建的空间默认没有限额

string $count

空间文件数配额,参数含义同

Returns

array —

getBucketQuota()

getBucketQuota(string  $bucket) : array

获取空间配额

Parameters

string $bucket

空间名称

Returns

array —

stat()

stat(string  $bucket, string  $key) : array

获取资源的元信息,但不返回文件内容

Parameters

string $bucket

待获取信息资源所在的空间

string $key

待获取资源的文件名

Returns

array —

delete()

delete(string  $bucket, string  $key) : array

删除指定资源

Parameters

string $bucket

待删除资源所在的空间

string $key

待删除资源的文件名

Returns

array —

rename()

rename(string  $bucket, string  $oldname, string  $newname) : array

给资源进行重命名,本质为move操作。

Parameters

string $bucket

待操作资源所在空间

string $oldname

待操作资源文件名

string $newname

目标资源文件名

Returns

array —

copy()

copy(string  $from_bucket, string  $from_key, string  $to_bucket, string  $to_key, mixed  $force = false) : array

对资源进行复制。

Parameters

string $from_bucket

待操作资源所在空间

string $from_key

待操作资源文件名

string $to_bucket

目标资源空间名

string $to_key

目标资源文件名

mixed $force

Returns

array —

move()

move(string  $from_bucket, string  $from_key, string  $to_bucket, string  $to_key, mixed  $force = false) : array

将资源从一个空间到另一个空间

Parameters

string $from_bucket

待操作资源所在空间

string $from_key

待操作资源文件名

string $to_bucket

目标资源空间名

string $to_key

目标资源文件名

mixed $force

Returns

array —

changeMime()

changeMime(string  $bucket, string  $key, string  $mime) : array

主动修改指定资源的文件元信息

Parameters

string $bucket

待操作资源所在空间

string $key

待操作资源文件名

string $mime

待操作文件目标mimeType

Returns

array —

changeType()

changeType(string  $bucket, string  $key, int  $fileType) : array

修改指定资源的存储类型

Parameters

string $bucket

待操作资源所在空间

string $key

待操作资源文件名

int $fileType

0 表示标准存储;1 表示低频存储;2 表示归档存储

Returns

array —

changeStatus()

changeStatus(string  $bucket, string  $key, int  $status) : array

修改文件的存储状态,即禁用状态和启用状态间的的互相转换

Parameters

string $bucket

待操作资源所在空间

string $key

待操作资源文件名

int $status

0表示启用;1表示禁用

Returns

array —

fetch()

fetch(string  $url, string  $bucket, string  $key = null) : array

从指定URL抓取资源,并将该资源存储到指定空间中

Parameters

string $url

指定的URL

string $bucket

目标资源空间

string $key

目标资源文件名

Returns

array —

asynchFetch()

asynchFetch(string  $url, string  $bucket, string  $host = null, string  $key = null, string  $md5 = null, string  $etag = null, string  $callbackurl = null, string  $callbackbody = null, string  $callbackbodytype = 'application/x-www-form-urlencoded', string  $callbackhost = null, int  $file_type, bool  $ignore_same_key = false) : array

从指定URL异步抓取资源,并将该资源存储到指定空间中

Parameters

string $url

需要抓取的url

string $bucket

所在区域的bucket

string $host

从指定url下载数据时使用的Host

string $key

文件存储的key

string $md5

文件md5

string $etag

文件etag

string $callbackurl

回调URL

string $callbackbody

回调Body

string $callbackbodytype

回调Body内容类型,默认为"application/x-www-form-urlencoded"

string $callbackhost

回调时使用的Host

int $file_type

存储文件类型 0:标准存储(默认),1:低频存储,2:归档存储

bool $ignore_same_key

如果空间中已经存在同名文件则放弃本次抓取

Returns

array —

asynchFetchStatus()

asynchFetchStatus(string  $zone, string  $id) : array

查询异步第三方资源抓取任务状态

Parameters

string $zone
string $id

Returns

array —

prefetch()

prefetch(string  $bucket, string  $key) : array

从镜像源站抓取资源到空间中,如果空间中已经存在,则覆盖该资源

Parameters

string $bucket

待获取资源所在的空间

string $key

代获取资源文件名

Returns

array —

batch()

batch(array  $operations) : array

在单次请求中进行多个资源管理操作

Parameters

array $operations

资源管理操作数组

Returns

array —

每个资源的处理情况,结果类似: [ { "code" => <HttpCode int>, "data" => <Data> }, { "code" => <HttpCode int> }, { "code" => <HttpCode int> }, { "code" => <HttpCode int> }, { "code" => <HttpCode int>, "data" => { "error": "<ErrorMessage string>" } }, ... ]

deleteAfterDays()

deleteAfterDays(string  $bucket, string  $key, int  $days) : array

设置文件的生命周期

Parameters

string $bucket

设置文件生命周期文件所在的空间

string $key

设置文件生命周期文件的文件名

int $days

设置该文件多少天后删除,当$days设置为0时表示取消该文件的生命周期

Returns

array —

buildBatchCopy()

buildBatchCopy(mixed  $source_bucket, mixed  $key_pairs, mixed  $target_bucket, mixed  $force) : mixed

Parameters

mixed $source_bucket
mixed $key_pairs
mixed $target_bucket
mixed $force

Returns

mixed —

buildBatchRename()

buildBatchRename(mixed  $bucket, mixed  $key_pairs, mixed  $force) : mixed

Parameters

mixed $bucket
mixed $key_pairs
mixed $force

Returns

mixed —

buildBatchMove()

buildBatchMove(mixed  $source_bucket, mixed  $key_pairs, mixed  $target_bucket, mixed  $force) : mixed

Parameters

mixed $source_bucket
mixed $key_pairs
mixed $target_bucket
mixed $force

Returns

mixed —

buildBatchDelete()

buildBatchDelete(mixed  $bucket, mixed  $keys) : mixed

Parameters

mixed $bucket
mixed $keys

Returns

mixed —

buildBatchStat()

buildBatchStat(mixed  $bucket, mixed  $keys) : mixed

Parameters

mixed $bucket
mixed $keys

Returns

mixed —

buildBatchDeleteAfterDays()

buildBatchDeleteAfterDays(mixed  $bucket, mixed  $key_day_pairs) : mixed

Parameters

mixed $bucket
mixed $key_day_pairs

Returns

mixed —

buildBatchChangeMime()

buildBatchChangeMime(mixed  $bucket, mixed  $key_mime_pairs) : mixed

Parameters

mixed $bucket
mixed $key_mime_pairs

Returns

mixed —

buildBatchChangeType()

buildBatchChangeType(mixed  $bucket, mixed  $key_type_pairs) : mixed

Parameters

mixed $bucket
mixed $key_type_pairs

Returns

mixed —

getRsfHost()

getRsfHost() : mixed

Returns

mixed —

getRsHost()

getRsHost() : mixed

Returns

mixed —

getApiHost()

getApiHost() : mixed

Returns

mixed —

getUcHost()

getUcHost() : mixed

Returns

mixed —

rsPost()

rsPost(mixed  $path, mixed  $body = null) : mixed

Parameters

mixed $path
mixed $body

Returns

mixed —

apiPost()

apiPost(mixed  $path, mixed  $body = null) : mixed

Parameters

mixed $path
mixed $body

Returns

mixed —

ucPost()

ucPost(mixed  $path, mixed  $body = null) : mixed

Parameters

mixed $path
mixed $body

Returns

mixed —

ucGet()

ucGet(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

apiGet()

apiGet(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

rsGet()

rsGet(mixed  $path) : mixed

Parameters

mixed $path

Returns

mixed —

get()

get(mixed  $url) : mixed

Parameters

mixed $url

Returns

mixed —

getV2()

getV2(mixed  $url) : mixed

Parameters

mixed $url

Returns

mixed —

post()

post(mixed  $url, mixed  $body) : mixed

Parameters

mixed $url
mixed $body

Returns

mixed —

postV2()

postV2(mixed  $url, mixed  $body) : mixed

Parameters

mixed $url
mixed $body

Returns

mixed —

oneKeyBatch()

oneKeyBatch(mixed  $operation, mixed  $bucket, mixed  $keys) : mixed

Parameters

mixed $operation
mixed $bucket
mixed $keys

Returns

mixed —

twoKeyBatch()

twoKeyBatch(mixed  $operation, mixed  $source_bucket, mixed  $key_pairs, mixed  $target_bucket, mixed  $force) : mixed

Parameters

mixed $operation
mixed $source_bucket
mixed $key_pairs
mixed $target_bucket
mixed $force

Returns

mixed —