通过CLI使用CDN服务
BCE CLI通过cdn子命令来访问CDN服务,缓存刷新和缓存预加载。
CLI使用多层命令结构,所有的命令以bce
开头,[options]
表示BCE CLI支持的选项,<service>
表示CLI所支持的服务,如BOS、CDN等,每个服务拥有多个特定的子命令。
$ bce [options] [<service> <command> [parameters [options]]]
参数解释
参数项 | 取值 | 说明 |
---|---|---|
options | BCE通用的Option,取值为-c、-v、-h、-d和--conf-path。 | - |
service | 使用CDN服务取值为cdn | - |
command | 取值为:ls、prefetch、purge。 | 各命令的作用请参见命令功能描述。 |
parameters | 各命令的parameters请参见命令功能描述。 | - |
+options | cdn命令的Option,取值为-a或-h等。 | cdn各命令可配置的option不一样,详细的使用方法请参见各命令行解释。 |
CLI通用Option
-
查看帮助:可以在任意命令后面添加
-h
或--help
来查看该命令的帮助信息。$ bce -h $ bce cdn -h $ bce cdn ls --help
-
查看、设置AK、SK等配置信息:
-c/--configure
$ bce -c [<conf-path>]
-
查看版本信息:
-v/--version
$ bce -v
-
查看debug信息:
-d/--debug
$ bce -d cdn ls
-d/--debug
命令不能单独使用,必须与service
结合使用。
-
使用指定配置文件:
--conf-path
$ bce --conf-path ./conf-sample/ cdn ls
不使用--conf-path
命令时,默认使用用户主目录~/.bce
下的配置。
域名管理
列举域名
描述: 列举所有域名。
命令格式: $ bce cdn ls [-a, --all]
操作示例: $ bce cdn ls
返回示例:
my.domain.com
my1.domain.com
my10.domain.com
...
缓存管理
刷新缓存
描述: 用于清除已经缓存的文件,用户24小时之内最多提交20000个URL刷新请求或者200个目录刷新请求。
命令格式: bce cdn purge [--url] [--directory] <url> <path>
说明:
- --url:提交文件刷新请求
- --directory:提交目录刷新请求,此时path 必须以/结尾
操作示例:
-
提交文件刷新请求
$ bce cdn purge --url http://my.domain.com/1.jpg
-
提交目录刷新请求
$ bce cdn purge --directory http://my.domain.com/to/path/
返回示例: purge ok, id: e0e9c9fc-a8c6-4c60-b9c7-6118a8d44698
查询刷新状态
描述: 查询刷新请求的状态。
命令格式: $ bce cdn purge --query <purge-id>
说明:
purge-id 为之前提交刷新缓存任务后返回的Id
操作示例: $ bce cdn purge --query e0e9c9fc-a8c6-4c60-b9c7-6118a8d44698
返回示例:
task 1
url: http://my.domain.com/to/path/ , type: directory
status: completed
createdAt: 2017-08-10T03:02:28Z
startedAt: None
finishedAt: 2017-08-10T03:03:11Z
progress: 100
参数 | 说明 |
---|---|
url | purge任务的URL和类型 |
status | in-progress / completed / failed |
createdAt | purge任务的创建时间 |
startedAt | purge任务开始执行的时间 |
finishedAt | purge任务的结束时间,结束可能是Completed/Failed。如果任务未结束,则不返回该项 |
progress | 进度百分比 |
预加载管理
预加载缓存
描述: 用于通知CDN提前缓存指定的URL,支持批量提交,一次最多提交100个url,用户24小时之内最多提交20000个URL。
命令格式: bce cdn prefetch [--url] [--bos --domain] [--file] <url> <bos:/<bucket-name>/[prefix], domain> <file> [--batch] <batch>
说明
- --url:提交单个url预加载请求
- --bos:提交bos bucket中的预加载请求
- --file:提交文件中的预加载请求,文件中每个url占一行
- --batch:在一次性提交多个url时,每批最多上传的url个数,默认为10,最大为100
操作示例:
-
提交单个url预加载请求
bce cdn prefetch --url http://my.domain.com/1.jpg
-
提交bos bucket中的预加载请求
bce cdn prefetch --bos bos:/fcc-test/ --domain my.domain.com
-
提交文件中的预加载请求
bce cdn prefetch --file list.txt
-
指定每批最大提交个数
bce cdn prefetch --file list.txt --batch 10
返回示例: prefetch ['http://my.domain.com/1.jpg', 'http://my.domain.com/2.jpg'] ok, id: eJyzMLc0NDUx1bEA02YAGQYDHA==
查询预加载状态
描述: 查询预加载请求状态。
命令格式: bce cdn prefetch --query <prefetch-id>
说明:
prefetch-id 为之前提交刷新缓存任务后返回的Id
操作示例: bce cdn prefetch --query eJyzMLc0NDUx1bEA02YAGQYDHA==
返回示例:
task 1
url: http://my.domain.com/2.jpg
status: failed
createdAt: 2017-08-10T03:26:31Z
startedAt: 2017-08-10T03:26:31Z
finishedAt: None
progress: 100
task 2
url: http://my.domain.com/1.jpg
status: failed
createdAt: 2017-08-10T03:26:31Z
startedAt: 2017-08-10T03:26:31Z
finishedAt: None
progress: 100
参数 | 说明 |
---|---|
url | prefetch任务的URL和类型 |
status | waiting / in-progress / completed / failed |
createdAt | prefetch任务的创建时间 |
startedAt | prefetch任务开始执行的时间 |
finishedAt | prefetch任务的结束时间,结束可能是Completed/Failed。如果任务未结束,则不返回该项 |
progress | 进度百分比 |