aiven.io客户端库/命令行客户端
aiven-client的Python项目详细描述
所有客户端![BuildStatus](https://warehouse-camo.cmh1.psfhosted.org/78cb16cdc398f7f53cf60e67ccd4a7843e95217e/68747470733a2f2f7472617669732d63692e6f72672f616976656e2f616976656e2d636c69656e742e706e673f6272616e63683d6d6173746572)
aiven是下一代托管云服务平台。它的焦点在 易于采用,高故障恢复能力,客户安心 在竞争价格点的先进功能。参见https://aiven.io/了解 有关后端服务的详细信息。
aiven客户端(avn)是aiven的官方命令行客户端。
`'+;` `'+;` The Aiven Crab '@@@#@@@` '@@@#@@@` ~~~~~~~~~~~~~~ #@. #@. @@. #@. @: ,@@ @@ @: ,@@ @@ ,@ @@@@@ :@ :@ @@@@@ .@ @ #@@@. #@ @` #@@@` @@ @@ `@# @@ `@# @@#. :@@+ @@#. :@@# `+@@@' `#@@@' ,;:` ,;;. @@@@@@# .+@@@@@@@@@@@@@'. `@@@@@@@ @@@@@# @@@@@@@@@@@@@@@@@@@@@@+ @@@@@@ @@@ ;@@@@@@@@@@@@@@@@@@@@@@@@@@@` `@@; ` `@@@@@@@@@@@ ;@@@@@@@@@@@ `@@@ '@@@@@@@@@@@@@ @@@@@@@@@@@@@` @@@ '@@@` .@@@@@@@@@@@@@@@ `@@@@@@@@@@@@@@@ @@@@` @@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@ '@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@ ,:::; @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ ,::: :@ ,@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ #@ @@@ +@#+#@@@@@@@@@@@@@@@@@@@@@@@@@#+#@. @@@ @@@@ '@@@@@@@@@@@@@@@@@@@. @@@@ @@@ @@@@@@+ @@@@@@@@@@@@@@@@@ @@@@@@; @@@ @@ @@@@@@@@@ @@@@@@@@@@@@@@@ `@@@@@@@@@ @+ @@@@@@@@@@@ :@@@@@@@@@@@@@ @@@@@@@@@@@ ' `@@@@@@@@@@@ ``` ,@@@@@@@@@@@ `@@@@@@ '@ :@: @@@@@@ @@@@@: @@@@@@ @@@@@ @@@@@ @@@@# @@@@'
平台要求
aiven客户端已经在linux和mac os x系统上进行了测试和开发。 它是一个python程序,可与python 2.7、3.4或更新版本一起使用。 唯一的外部依赖项是Requests(在windows/osx上是certifi)。
安装
来自pypi(linux/osx):
$ python -m pip install aiven-client
来自PYPI(Windows):
c:\> python -m pip install aiven-client
构建一个RPM包(Linux):
$ make rpm
基本用法
- 注意:在windows上,您可能需要使用python -m aiven.client,而不是avn。
- 所有命令都将输出带有--json 的原始rest api json响应
帮助命令
$ avn help
列出所有命令。您还可以使用帮助来搜索匹配的命令, 例如
$ avn help kafka topic
将列出在其描述中包含kafka和主题的所有命令。
登录和用户
登录:
$ avn user login <your@email>
注销(撤消当前访问令牌,其他会话保持有效):
$ avn user logout
使用户的所有身份验证令牌过期,注销所有Web控制台会话等。 在此之后,您需要再次登录。:
$ avn user tokens-expire
管理单个访问令牌:
$ avn user access-token list $ avn user access-token create --description <usage_description> [--max-age-seconds <secs>] [--extend-when-used] $ avn user access-token update <token|token_prefix> --description <new_description> $ avn user access-token revoke <token|token_prefix>
请注意,系统对您可以创建的令牌数量有硬限制。如果你是 使用令牌永久完成您应该始终使用user access-token revoke操作 撤消令牌,使其不计入配额。
云
列出可用的云区域:
$ avn cloud list
项目
列出您所属的项目:
$ avn project list
项目命令对当前活动的项目或项目进行操作 使用–project name开关指定。更改活动项目cab 使用开关命令:
$ avn project switch <projectname>
显示活动项目的详细信息:
$ avn project details
创建项目并为其设置默认云区域:
$ avn project create myproject --cloud aws-us-east-1
删除空项目:
$ avn project delete myproject
列出项目中的授权用户:
$ avn project user-list
将现有的AIVE用户邀请到项目:
$ avn project user-invite somebody@aiven.io
从项目中删除用户:
$ avn project user-remove somebody@aiven.io
查看项目管理事件日志:
$ avn events
服务
列出(活动项目的)服务:
$ avn service list
列出特定项目中的服务:
$ avn service list --project proj2
仅列出特定服务:
$ avn service list db1
详细列表(包括连接信息等):
$ avn service list db1 -v
json格式的完整服务信息,由aiven rest api返回:
$ avn service list db1 --json
只有输出中的特定字段,自定义格式:
$ avn service list db1 --format "The service is at {service_uri}"
查看服务日志条目(最近的条目并保留在以下日志中,其他选项可用于获取历史记录):
$ avn service logs db1 -f
启动服务
查看可用的服务计划:
$ avn service plans
启动PostgreSQL服务:
$ avn service create mydb -t pg --plan hobbyist
查看特定于服务类型的选项,包括如何设置这些选项的示例:
$ avn service types -v
启动特定版本的PostgreSQL服务(请参阅上面的命令):
$ avn service create mydb96 -t pg --plan hobbyist -c pg_version=9.6
更新服务的允许客户端IP地址列表。请注意,多个 值以逗号分隔的列表形式提供:
$ avn service update mydb96 -c ip_filter=10.0.1.0/24,10.0.2.0/24,1.2.3.4/32
打开psql客户端并连接到postgresql服务(也可用于infloxdb):
$ avn service cli mydb96
将服务更新到其他计划并将其移动到另一个云区域:
$ avn service update mydb --plan startup-4 --cloud aws-us-east-1
关闭服务电源:
$ avn service update mydb --power-off
接通服务电源:
$ avn service update mydb --power-on
终止服务(所有数据都将消失!):
$ avn service terminate mydb
更新服务配置
更多帮助
$ avn help $ avn -h $ avn user -h $ avn service -h $ avn service create -h $ avn project -h
联系人
我们非常欢迎错误报告和补丁,请将它们作为github问题发布 并在https://github.com/aiven/aiven-client