リファレンス / database
コマンド一覧
- Basic Commands
- Power Management Commands
- Monitoring Commands
- Other Commands
list
Usage
Usage:
list [flags]
Aliases:
list, ls, find, select
Flags:
=== Filter options ===
--names strings
--tags strings
=== Limit/Offset options ===
--count int (aliases: --max, --limit)
--from int (aliases: --offset)
=== Zone options ===
--zone string (*required)
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
create
Usage
Usage:
create [flags]
Flags:
=== Common options ===
--name string (*required)
--description string
--tags strings
--icon-id int
=== Plan options ===
--database-type string (*required) options: [postgresql/postgres/mariadb]
--plan string (*required) options: [10g/30g/90g/240g/500g/1t]
=== Database-specific options ===
--database-parameters strings
=== WebUI options ===
--enable-web-ui
=== Backup options ===
--enable-backup
--backup-weekdays strings (*required when --enable-backup is specified) options: [all/sun/mon/tue/wed/thu/fri/sat]
--backup-start-time-hour int
--backup-start-time-minute int options: [0/15/30/45]
=== Network options ===
--switch-id int (*required)
--ip-address strings (*required) (aliases: --ipaddress)
--netmask int (*required) (aliases: --network-mask-len)
--gateway string (aliases: --default-route)
--port int
--source-range strings (aliases: --source-network)
=== Replication options ===
--enable-replication
--replica-user-password string (*required when --enable-replication is specified)
=== User options ===
--username string (*required)
--password string (*required)
=== Zone options ===
--zone string (*required)
=== Wait options ===
--no-wait
=== Input options ===
-y, --assumeyes Assume that the answer to any question which would be asked is yes
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
Parameter Examples
{
"Zone": "tk1a | tk1b | is1a | is1b | tk1v",
"Name": "example",
"Description": "example",
"Tags": [
"tag1=example1",
"tag2=example2"
],
"IconID": 123456789012,
"DatabaseType": "postgresql | postgres | mariadb",
"PlanID": "10g | 30g | 90g | 240g | 500g | 1t",
"SwitchID": 123456789012,
"IPAddresses": [
"192.0.2.11"
],
"NetworkMaskLen": 24,
"DefaultRoute": "192.0.2.1",
"Port": 5432,
"SourceNetwork": [
"192.0.2.0/24"
],
"Username": "username",
"Password": "password",
"EnableReplication": true,
"ReplicaUserPassword": "password",
"EnableWebUI": true,
"EnableBackup": true,
"BackupWeekdays": [
"all | sun | mon | tue | wed | thu | fri | sat"
],
"BackupStartTimeHour": 1,
"BackupStartTimeMinute": 30,
"DatabaseParameters": {
"max_connections": "150"
},
"NoWait": false
}
read
Usage
Usage:
read { ID | NAME | TAG } [flags]
Aliases:
read, show
Flags:
=== Zone options ===
--zone string (*required)
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
update
Usage
Usage:
update { ID | NAME | TAG }... [flags]
Flags:
=== Common options ===
--name string
--description string
--tags strings
--icon-id int
=== Database-specific options ===
--database-parameters strings
=== WebUI options ===
--enable-web-ui
=== Backup options ===
--enable-backup
--backup-weekdays strings options: [all/sun/mon/tue/wed/thu/fri/sat]
--backup-start-time-hour int
--backup-start-time-minute int
=== Network options ===
--source-range strings (aliases: --source-network)
=== Replication options ===
--enable-replication
--replica-user-password string (*required when --enable-replication is specified)
=== Zone options ===
--zone string (*required)
=== Wait options ===
--no-wait
=== Input options ===
-y, --assumeyes Assume that the answer to any question which would be asked is yes
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
Parameter Examples
{
"Zone": "tk1a | tk1b | is1a | is1b | tk1v",
"Name": "example",
"Description": "example",
"Tags": [
"tag1=example1",
"tag2=example2"
],
"IconID": 123456789012,
"SourceNetwork": [
"192.0.2.0/24"
],
"EnableReplication": true,
"ReplicaUserPassword": "password",
"EnableWebUI": true,
"EnableBackup": true,
"BackupWeekdays": [
"all | sun | mon | tue | wed | thu | fri | sat"
],
"BackupStartTimeHour": 1,
"BackupStartTimeMinute": 30,
"DatabaseParameters": null,
"NoWait": false
}
delete
Usage
Usage:
delete { ID | NAME | TAG }... [flags]
Aliases:
delete, rm
Flags:
=== Delete options ===
-f, --force
=== Zone options ===
--zone string (*required)
=== Error handling options ===
--fail-if-not-found
=== Input options ===
-y, --assumeyes Assume that the answer to any question which would be asked is yes
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
list-parameters
Usage
Usage:
list-parameters { ID | NAME | TAG }... [flags]
Aliases:
list-parameters, list-parameter
Flags:
=== Zone options ===
--zone string (*required)
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
boot
Usage
Usage:
boot { ID | NAME | TAG }... [flags]
Aliases:
boot, power-on
Flags:
=== Zone options ===
--zone string (*required)
=== Wait options ===
--no-wait
=== Input options ===
-y, --assumeyes Assume that the answer to any question which would be asked is yes
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Parameter example ===
--example Output example parameters with JSON format
shutdown
Usage
Usage:
shutdown { ID | NAME | TAG }... [flags]
Aliases:
shutdown, power-off
Flags:
=== Database-specific options ===
-f, --force-shutdown (aliases: --force)
=== Zone options ===
--zone string (*required)
=== Wait options ===
--no-wait
=== Input options ===
-y, --assumeyes Assume that the answer to any question which would be asked is yes
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Parameter example ===
--example Output example parameters with JSON format
reset
Usage
Usage:
reset { ID | NAME | TAG }... [flags]
Flags:
=== Zone options ===
--zone string (*required)
=== Input options ===
-y, --assumeyes Assume that the answer to any question which would be asked is yes
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Parameter example ===
--example Output example parameters with JSON format
monitor-cpu
Usage
Usage:
monitor-cpu { ID | NAME | TAG }... [flags]
Flags:
=== Monitor options ===
--end string
--start string
=== Zone options ===
--zone string (*required)
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
monitor-database
Usage
Usage:
monitor-database { ID | NAME | TAG }... [flags]
Flags:
=== Monitor options ===
--end string
--start string
=== Zone options ===
--zone string (*required)
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
monitor-disk
Usage
Usage:
monitor-disk { ID | NAME | TAG }... [flags]
Flags:
=== Monitor options ===
--end string
--start string
=== Zone options ===
--zone string (*required)
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
monitor-interface
Usage
Usage:
monitor-interface { ID | NAME | TAG }... [flags]
Aliases:
monitor-interface, monitor-nic
Flags:
=== Monitor options ===
--end string
--start string
=== Zone options ===
--zone string (*required)
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Output options ===
--format string Output format in Go templates (aliases: --fmt)
-o, --output-type string Output format options: [table/json/yaml] (aliases: --out)
--query string Query for JSON output
--query-driver string Name of the driver that handles queries to JSON output options: [jmespath/jq]
-q, --quiet Output IDs only
=== Parameter example ===
--example Output example parameters with JSON format
wait-until-ready
Usage
Usage:
wait-until-ready { ID | NAME | TAG }... [flags]
Aliases:
wait-until-ready, wait-for-boot
Flags:
=== Zone options ===
--zone string (*required)
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Parameter example ===
--example Output example parameters with JSON format
wait-until-shutdown
Usage
Usage:
wait-until-shutdown { ID | NAME | TAG }... [flags]
Aliases:
wait-until-shutdown, wait-for-down
Flags:
=== Zone options ===
--zone string (*required)
=== Input options ===
--generate-skeleton Output skeleton of parameters with JSON format (aliases: --skeleton)
--parameters string Input parameters in JSON format
=== Parameter example ===
--example Output example parameters with JSON format