第 15 章 数据库服务命令行客户端

子命令

backup-copy

从另一个备份创建备份。

backup-create

创建实例的备份。

backup-delete

删除备份。

backup-list

列出可用的备份。

backup-list-instance

列出实例的可用备份。

backup-show

显示备份详情。

cluster-create

创建新集群。

cluster-delete

删除集群。

cluster-grow

在集群中添加更多实例。

cluster-instances

列出集群的所有实例。

cluster-list

列出所有集群。

cluster-show

显示集群详情。

cluster-shrink

从集群中丢弃实例。

configuration-attach

将配置组附加到实例。

configuration-create

创建配置组。

configuration-default

显示实例的默认配置。

configuration-delete

删除配置组。

configuration-detach

将配置组从实例分离。

configuration-instances

列出与配置组关联的所有实例。

configuration-list

列出所有配置组。

configuration-parameter-list

列出配置组的可用参数。

configuration-parameter-show

显示配置参数的详细信息。

configuration-patch

对配置组进行补丁。

configuration-show

显示配置组的详细信息。

configuration-update

更新配置组。

create

创建新实例。

database-create

在实例上创建数据库。

database-delete

从实例删除数据库。

database-list

列出实例上的可用数据库。

Datastore-list

列出可用的数据存储。

Datastore-show

显示数据存储的详细信息。

Datastore-version-list

列出数据存储的可用版本。

Datastore-version-show

显示数据存储版本的详细信息。

delete

删除实例。

detach-replica

将副本实例从其复制源中分离。

eject-replica-source

从其集合中弹出一个副本源。

flavor-list

列出可用的类别。

flavor-show

显示类别的详细信息。

limit-list

列出租户的限制。

list

列出所有实例。

metadata-create

在数据库中为 <id> 创建元数据。

metadata-delete

删除实例 <id> 的元数据。

metadata-edit

使用新值替换 metadata 值，这是非破坏性。

metadata-list

显示实例 <id> 的所有元数据。

metadata-show

显示键 <key> 和实例 <id> 的元数据条目。

metadata-update

更新元数据，这是破坏性。

promote-to-replica-source

将副本提升为集合的新副本源。

resize-instance

使用新类别重新定义实例大小。

resize-volume

调整实例的卷大小。

restart

重启实例。

root-enable

为实例启用 root，并在已存在时重置。

root-show

如果实例或集群启用了 root，则获取状态。

secgroup-add-rule

创建安全组规则。

secgroup-delete-rule

删除安全组规则。

secgroup-list

列出所有安全组。

secgroup-list-rules

列出安全组的所有规则。

secgroup-show

显示安全组的详细信息。

显示

显示实例的详细信息。

update

更新实例：编辑名称、配置或副本源。

user-create

在实例上创建用户。

user-delete

从实例删除用户。

user-grant-access

授予用户数据库的访问权限。

user-list

列出实例的用户。

user-revoke-access

撤销用户对数据库的访问权限。

user-show

显示实例用户的详细信息。

user-show-access

显示实例的用户访问详细信息。

user-update-attributes

更新实例上用户的属性。

bash-completion

输出 bash_completion 的参数。

帮助

显示关于该程序或其子命令的帮助信息。

--version

显示程序的版本号并退出

--debug

打印调试输出。

--os-auth-system <auth-system>

默认为 env[OS_AUTH_SYSTEM]。

--service-type <service-type>

对于大多数操作，默认为 database。

--service-name <service-name>

默认为 env[TROVE_SERVICE_NAME]。

--bypass-url <bypass-url>

默认为 env[TROVE_BYPASS_URL]。

--database-service-name <database-service-name>

默认为 env[TROVE_DATABASE_SERVICE_NAME]。

--endpoint-type <endpoint-type>

默认为 env[TROVE_ENDPOINT_TYPE] 或 publicURL。

--os-database-api-version <database-api-ver>

接受 1，默认为 env[OS_DATABASE_API_VERSION]。

--retries <retries>

重试次数。

--json, --os-json-output

输出 JSON 而不是 prettyprint。默认为 env[OS_JSON_OUTPUT]。

--profile HMAC_KEY

在分析操作性能时，用于加密上下文数据的 HMAC 密钥。此密钥应设置为 Trove 中配置的 HMAC 密钥之一（它们位于 api-paste.ini 中，通常在 /etc/trove 中找到）。如果没有密钥，即使没有密钥，也不会触发性能分析，即使它在服务器端启用了它。默认为 env[OS_PROFILE_HMACKEY]。

--insecure

明确允许客户端执行"不安全"TLS (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。

--os-cacert <ca-certificate>

指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为 env[OS_CACERT]。

--os-cert <certificate>

默认为 env[OS_CERT]。

--os-key <key>

默认为 env[OS_KEY]。

--timeout <seconds>

设置请求超时（以秒为单位）。

--os-auth-url OS_AUTH_URL

身份验证 URL

--os-domain-id OS_DOMAIN_ID

域 ID 范围

--os-domain-name OS_DOMAIN_NAME

域名范围为

--os-project-id OS_PROJECT_ID

项目 ID 到范围

--os-project-name OS_PROJECT_NAME

项目名称到范围

--os-project-domain-id OS_PROJECT_DOMAIN_ID

包含项目的域 ID

--os-project-domain-name OS_PROJECT_DOMAIN_NAME

包含项目的域名

--os-trust-id OS_TRUST_ID

信任 ID

--os-user-id OS_USER_ID

用户 ID

--os-user-name OS_USERNAME, --os-username OS_USERNAME

用户名

--os-user-domain-id OS_USER_DOMAIN_ID

用户的域 ID

--os-user-domain-name OS_USER_DOMAIN_NAME

用户的域名

--os-password OS_PASSWORD

用户密码

--os-tenant-name <auth-tenant-name>

用于请求授权的租户。默认为 env[OS_TENANT_NAME]。

--os-tenant-id <tenant-id>

用于请求授权的租户。默认为 env[OS_TENANT_ID]。

--os-auth-token OS_AUTH_TOKEN

默认为 env[OS_AUTH_TOKEN]

--os-region-name <region-name>

指定要使用的区域。默认为 env[OS_REGION_NAME]。

positional 参数

<name>

备份的名称。

<backup>

源备份的备份 ID。

可选参数

--region <region>

源备份所在的区域。

--description <description>

备份的可选描述。

positional 参数

<instance>

实例的 ID 或名称。

<name>

备份的名称。

可选参数

--description <description>

备份的可选描述。

--parent <parent>

从中执行增量备份的父备份的可选 ID。

positional 参数

<backup>

备份 ID。

可选参数

--limit <limit>

返回最新备份的 N 号。

--marker <ID>

开始显示大于指定标记的 ID 的结果。与 --limit 一起使用时，将其设置为上一个运行中显示的最后一个 ID。

--datastore <datastore>

用于列出备份的数据存储名称或 ID。

positional 参数

<instance>

实例的 ID 或名称。

可选参数

--limit <limit>

返回最新备份的 N 号。

--marker <ID>

开始显示大于指定标记的 ID 的结果。与 --limit 一起使用时，将其设置为上一个运行中显示的最后一个 ID。

positional 参数

<backup>

备份 ID。

positional 参数

<name>

集群的名称。

<datastore>

数据存储名称或 UUID。

<datastore_version>

数据存储版本名称或 UUID。

可选参数

--instance <flavor=flavor_name_or_id,volume=volume>

为集群创建一个实例。指定多次来创建多个实例。

positional 参数

<cluster>

集群的 ID 或名称。

positional 参数

<cluster>

集群的 ID 或名称。

可选参数

--instance <name=name,flavor=flavor_name_or_id,volume=volume>

在集群中添加实例。指定多次来创建多个实例。

positional 参数

<cluster>

集群的 ID 或名称。

可选参数

--limit <limit>

限制所显示的结果数量。

--marker <ID>

开始显示大于指定标记的 ID 的结果。与 --limit 一起使用时，将其设置为上一个运行中显示的最后一个 ID。

positional 参数

<cluster>

集群的 ID 或名称。

positional 参数

<cluster>

集群的 ID 或名称。

<instance>

从集群中删除实例。指定多个 id 来丢弃多个实例。

positional 参数

<instance>

实例的 ID 或名称。

<configuration>

要附加到实例的配置组的 ID。

positional 参数

<name>

配置组的名称。

<values>

要设置的值的字典。

可选参数

--datastore <datastore>

分配给配置组的数据存储。如果没有配置默认数据存储，则需要此项。

--datastore_version <datastore_version>

分配给配置组的数据存储版本 ID。

--description <description>

配置组的可选描述。

positional 参数

<instance>

实例的 ID 或名称。

positional 参数

<configuration_group>

配置组的 ID。

positional 参数

<instance>

实例的 ID 或名称。

positional 参数

<configuration_group>

配置组的 ID。

positional 参数

<datastore_version>

分配给配置组的数据存储版本名称或 ID。

可选参数

--datastore <datastore>

用于列出配置参数的数据存储的 ID 或名称。如果提供了 datastore_version 的 ID，则可选。

positional 参数

<datastore_version>

分配给配置组的数据存储版本名称或 ID。

<parameter>

配置参数的名称。

可选参数

--datastore <datastore>

用于列出配置参数的数据存储的 ID 或名称。如果提供了 datastore_version 的 ID，则可选。

positional 参数

<configuration_group>

配置组的 ID。

<values>

要设置的值的字典。

positional 参数

<configuration_group>

配置组的 ID。

positional 参数

<configuration_group>

配置组的 ID。

<values>

要设置的值的字典。

可选参数

--name <name>

配置组的名称。

--description <description>

配置组的可选描述。

positional 参数

<name>

实例的名称。

<flavor>

实例的类别 ID 或名称。

可选参数

--size <size>

以 GB 为单位的实例磁盘卷的大小。启用卷支持时需要。

--databases <databases> [<databases> ...]

可选的数据库列表。

--users <users> [<users> ...]

以 user:password 格式的可选用户列表。

--backup <backup>

备份 ID。

--availability_zone <availability_zone>

要提供给 nova 的 Zone hint。

--datastore <datastore>

数据存储名称或 ID。

--datastore_version <datastore_version>

数据存储版本名称或 ID。

--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid>

在实例上创建 NIC。多次指定创建多个 NIC 的选项。net- id: 将 NIC 附加到带有此 ID 的网络（必须指定 port-id 或 net-id）、v4-fixed-ip: 用于 NIC 的 IPv4 固定地址（可选）、port-id: 将 NIC 附加到带有此 ID 的端口（必须指定 port-id 或 net-id）。

--configuration <configuration>

要附加到实例的配置组的 ID。

--replica_of <source_instance>

要从中复制的现有实例的 ID 或名称。

--replica_count <count>

要创建的副本数（默认为 1）。

positional 参数

<instance>

实例的 ID 或名称。

<name>

数据库的名称。

可选参数

--character_set <character_set>

数据库的可选字符集。

--ollate <collate>

数据库的可选协调类型。

positional 参数

<instance>

实例的 ID 或名称。

<database>

数据库的名称。

positional 参数

<instance>

实例的 ID 或名称。

positional 参数

<datastore>

数据存储的 ID。

positional 参数

<datastore>

数据存储的 ID 或名称。

positional 参数

<datastore_version>

数据存储版本的 ID 或名称。

可选参数

--datastore <datastore>

数据存储的 ID 或名称。如果提供了 datastore_version 的 ID，则可选。

positional 参数

<instance>

实例的 ID 或名称。

positional 参数

<instance>

实例的 ID 或名称。

positional 参数

<instance>

实例的 ID 或名称。

可选参数

--datastore_type <datastore_type>

数据存储的类型。例如：mysql。

--datastore_version_id <datastore_version_id>

数据存储版本的 ID。

positional 参数

<flavor>

类别的 ID 或名称。

可选参数

--limit <limit>

限制所显示的结果数量。

--marker <ID>

开始显示大于指定标记的 ID 的结果。与 --limit 一起使用时，将其设置为上一个运行中显示的最后一个 ID。

--include-clustered

包括属于集群一部分的实例（默认 false）。

positional 参数

<instance_id>

实例的 UUID。

<key>

分配的密钥。

<value>

要分配给 <key> 的值。

positional 参数

<instance_id>

实例的 UUID。

<key>

要删除的元数据密钥。

positional 参数

<instance_id>

实例的 UUID。

<key>

要替换的关键。

<value>

分配给 <key> 的新值。

positional 参数

<instance_id>

实例的 UUID。

positional 参数

<instance_id>

实例的 UUID。

<key>

要显示的密钥。

positional 参数

<instance_id>

实例的 UUID。

<key>

要更新的密钥。

<newkey>

新密钥。

<value>

要分配给 <newkey> 的值。

positional 参数

<instance>

实例的 ID 或名称。

positional 参数

<instance>

实例的 ID 或名称。

<flavor>

实例的新类别。

positional 参数

<instance>

实例的 ID 或名称。

<size>

实例磁盘卷的新大小（以 GB 为单位）。

positional 参数

<instance>

实例的 ID 或名称。

positional 参数

<instance_or_cluster>

实例或集群的 ID 或名称。

可选参数

--root_password <root_password>

要设置的 root 密码。

positional 参数

<instance_or_cluster>

实例或集群的 ID 或名称。

positional 参数

<security_group>

安全组 ID。

<cidr>

CIDR 地址。

positional 参数

<security_group_rule>

安全组规则的名称。

positional 参数

<security_group>

安全组 ID。

positional 参数

<security_group>

安全组 ID。

positional 参数

<instance>

实例的 ID 或名称。

positional 参数

<instance>

实例的 ID 或名称。

可选参数

--name <name>

实例的名称。

--configuration <configuration>

要附加的配置引用的 ID。

--detach-replica-source

将副本实例从其复制源中分离。

--remove_configuration

丢弃当前的配置参考。

positional 参数

<instance>

实例的 ID 或名称。

<name>

用户名称。

<password>

用户的密码。

可选参数

--host <host>

用户的可选主机。

--databases <databases> [<databases> ...]

可选的数据库列表。

positional 参数

<instance>

实例的 ID 或名称。

<name>

用户名称。

可选参数

--host <host>

用户的可选主机。

positional 参数

<instance>

实例的 ID 或名称。

<name>

用户名称。

<databases>

数据库列表。

可选参数

--host <host>

用户的可选主机。

positional 参数

<instance>

实例的 ID 或名称。

positional 参数

<instance>

实例的 ID 或名称。

<name>

用户名称。

<database>

单个数据库。

可选参数

--host <host>

用户的可选主机。

positional 参数

<instance>

实例的 ID 或名称。

<name>

用户名称。

可选参数

--host <host>

用户的可选主机。

positional 参数

<instance>

实例的 ID 或名称。

<name>

用户名称。

可选参数

--host <host>

用户的可选主机。

positional 参数

<instance>

实例的 ID 或名称。

<name>

用户名称。

可选参数

--host <host>

用户的可选主机。

--new_name <new_name>

可选的 user 名称。

--new_password <new_password>

用户的可选新密码。

--new_host <new_host>

用户的可选新主机。