This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Microsoft SQL Server(DBaaS)

1: CLIs

1.1: Add Block Storages

1.1.1: 1.0

1.2: Add Secondary

1.2.1: 1.0

1.3: Add/Remove Databases

1.3.1: 1.0

1.4: Create Cluster

1.4.1: 1.0

1.5: Create Restore Cluster

1.5.1: 1.0

1.6: Export Log

1.6.1: 1.0

1.7: List Backup Histories

1.7.1: 1.0

1.8: List Clusters

1.8.1: 1.0

1.9: List Engine Version Properties

1.9.1: 1.0

1.10: List Engine Versions

1.10.1: 1.0

1.11: List Log Export Configs

1.11.1: 1.0

1.12: List Parameter Groups

1.12.1: 1.0

1.13: List Parameter Values

1.13.1: 1.0

1.14: List Parameters

1.14.1: 1.0

1.15: List Server Types

1.15.1: 1.0

1.16: Patch Minor Version

1.16.1: 1.0

1.17: Register Log Export Config

1.17.1: 1.0

1.18: Remove Backup Histories

1.18.1: 1.0

1.19: Restart Cluster

1.19.1: 1.0

1.20: Set Audit Log

1.20.1: 1.0

1.21: Set Backup

1.21.1: 1.0

1.22: Set Block Storage Size

1.22.1: 1.0

1.23: Set Log Export Config

1.23.1: 1.0

1.24: Set Maintenance

1.24.1: 1.0

1.25: Set Parameter Values

1.25.1: 1.0

1.26: Set Security Group Rules

1.26.1: 1.0

1.27: Set Server Type

1.27.1: 1.0

1.28: Show Cluster

1.28.1: 1.0

1.29: Show Request

1.29.1: 1.0

1.30: Start Cluster

1.30.1: 1.0

1.31: Stop Cluster

1.31.1: 1.0

1.32: Switchover Cluster

1.32.1: 1.0

1.33: Synchronize Cluster State

1.33.1: 1.0

1.34: Synchronize Parameter Values

1.34.1: 1.0

1.35: Terminate Cluster

1.35.1: 1.0

1.36: Unregister Log Export Config

1.36.1: 1.0

1.37: Unset Backup

1.37.1: 1.0

1.38: Unset Maintenance

1.38.1: 1.0

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Microsoft SQL Server(DBaaS) service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Status	Not Before

CLI Version History

1.0

Initial CLI release for Microsoft SQL Server(DBaaS)

Changes

[New] sqlserver add block storages - command has been added.
[New] sqlserver add secondary - command has been added.
[New] sqlserver create cluster - command has been added.
[New] sqlserver create restore - command has been added.
[New] sqlserver delete cluster - command has been added.
[New] sqlserver export log - command has been added.
[New] sqlserver list backup histories - command has been added.
[New] sqlserver list clusters - command has been added.
[New] sqlserver list engine version properties - command has been added.
[New] sqlserver list engine versions - command has been added.
[New] sqlserver list log export configs - command has been added.
[New] sqlserver list parameter groups - command has been added.
[New] sqlserver list parameter values - command has been added.
[New] sqlserver list parameters - command has been added.
[New] sqlserver list server types - command has been added.
[New] sqlserver register log export config - command has been added.
[New] sqlserver remove backup histories - command has been added.
[New] sqlserver restart cluster - command has been added.
[New] sqlserver set audit log - command has been added.
[New] sqlserver set backup - command has been added.
[New] sqlserver set block storage size - command has been added.
[New] sqlserver set databases - command has been added.
[New] sqlserver set log export config - command has been added.
[New] sqlserver set maintenance - command has been added.
[New] sqlserver set parameter values - command has been added.
[New] sqlserver set security group rules - command has been added.
[New] sqlserver set server type - command has been added.
[New] sqlserver show cluster - command has been added.
[New] sqlserver show request - command has been added.
[New] sqlserver start cluster - command has been added.
[New] sqlserver stop cluster - command has been added.
[New] sqlserver switchover cluster - command has been added.
[New] sqlserver sync cluster state - command has been added.
[New] sqlserver sync parameter values - command has been added.
[New] sqlserver unregister log export config - command has been added.
[New] sqlserver unset backup - command has been added.
[New] sqlserver unset maintenance - command has been added.

1 - CLIs

1.1 - Add Block Storages

1.1.1 - 1.0

scp-cli sqlserver block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
instance_group_id required	string	Instance group ID	-
size_gb required	integer	Size in GB	`104`
role_type required	string	Role type	`OS`
volume_type optional	string	Volume type	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.2 - Add Secondary

1.2.1 - 1.0

scp-cli sqlserver secondary add
--cluster_id <value>
--name <value>
--license <value>
[--service_ip_address <value>]

Description

Add Secondary.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
name required	string	Secondary Name	-
license required	string	license	-
service_ip_address optional	string	User subnet IP address	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.3 - Add/Remove Databases

1.3.1 - 1.0

scp-cli sqlserver database set
--cluster_id <value>
[--add_databases <value>]
[--del_databases <value>]

Description

Add/Remove Databases.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
add_databases optional	array	Databases	`'{"database_name": "", "drive_letter": "E"}'`
del_databases optional	array	Databases	`'{"database_name": "", "drive_letter": "E"}'`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.4 - Create Cluster

1.4.1 - 1.0

scp-cli sqlserver cluster create
--archive_frequency_minute <value>
--license <value>
--databases <value>
--database_user_password <value>
--database_user_name <value>
--database_service_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_collation <value>]
[--database_name <value>]
[--database_port <value>]
[--full_backup_day_of_week <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
archive_frequency_minute required	string	Backup starting time (minute)	-
license required	string	license	-
databases required	array	Databases	`'{"database_name": "", "drive_letter": "E"}'`
database_user_password required	string	Database user password	-
database_user_name required	string	Database User Name	-
database_service_name required	string	Database Service Name	-
timezone required	string	Timezone	`Asia/Seoul`
subnet_id required	string	Subnet ID	`1ddd7f1e4a8a43ed8b82d70cade0b321`
name required	string	Cluster name	`mycluster`
instance_name_prefix required	string	Instance name prefix	-
instance_groups required	array	Instance groups list	`'{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "", "server_type_name": ""}'`
dbaas_engine_version_id required	string	DBaaS engine version ID	`c1b856dd12754c0ba2614a39d0ed3ad1`
allowable_ip_addresses optional	array	Allowed IP addresses list	-
ha_enabled optional	boolean	HA availability	-
nat_enabled optional	boolean	NAT availability	-
tags optional	array	tag	`'{"key": "", "value": ""}'`
vip_public_ip_id optional	string	(VIP) Public IP ID	-
virtual_ip_address optional	string	Virtual IP address	-
audit_enabled optional	boolean	Audit usage state	-
database_collation optional	string		-
database_name optional	****		-
database_port optional	integer	Database service port	-
full_backup_day_of_week optional	string	Full backup day of week	-
retention_period_day optional	string	Backup retention period (day)	`7`
starting_time_hour optional	string	Backup starting time (hour)	`2`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.5 - Create Restore Cluster

1.5.1 - 1.0

scp-cli sqlserver restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Restore Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
server_type_name required	string	Server type name	-
name required	string	Cluster name	`mycluster`
instance_name_prefix required	string	Instance name prefix	`myprefix`
allowable_ip_addresses optional	array	Allowed IP addresses list	-
backup_history_number optional	string	Backup id	`202501010000`
backup_recovery_time optional	string	Backup Recovery Time	-
block_storage_groups optional	array	Block storage groups list	`'{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}'`
tags optional	array	tag	`'{"key": "", "value": ""}'`
period_hour optional	string	Period in hours	`5`
starting_day_of_week optional	string	Starting day of week	`MON`
starting_time optional	string	Starting time	`0000`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.6 - Export Log

1.6.1 - 1.0

scp-cli sqlserver log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.7 - List Backup Histories

1.7.1 - 1.0

scp-cli sqlserver backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
limit optional	integer	Number of backup lists	-
page optional	integer	Backup list page	-

Responses

Name	Description	Example
backup_end_at	Backup end time
backup_history_number	Backup id
backup_size_gb	Backup amount(GB)
backup_start_at	Backup start time
backup_state	Backup state
backup_state_detail	Backup detail state
software_version	Software version

1.8 - List Clusters

1.8.1 - 1.0

scp-cli sqlserver cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]

Description

List Clusters.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Cluster name	-
service_state optional	string	Service state	-
database_name optional	string	Database Name	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
database_name	Database Name
ha_enabled	HA availability
instance_count	Instance Count
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
role_type	Role type
service_state	Service state

1.9 - List Engine Version Properties

1.9.1 - 1.0

scp-cli sqlserver engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
dbaas_engine_version_id required	string	DBaaS engine version ID	-

Responses

Name	Description	Example
name	DBaas engine property name
value	DBaas engine property value

1.10 - List Engine Versions

1.10.1 - 1.0

scp-cli sqlserver engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
id optional	string	DBaaS engine version ID	-
product_image_type optional	****	Product image type	-
eos_included optional	boolean	EoS included	-

Responses

Name	Description	Example
id	ID
end_of_service	End of Service
major_version	Software major version
name	DBaaS engine version name
os_type	OS type
os_version	OS version
product_image_type	Product type
software_version	Software version

1.11 - List Log Export Configs

1.11.1 - 1.0

scp-cli sqlserver log export configs list
--cluster_id <value>
[--type <value>]

Description

List Log Export Configs.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
type optional	****	Log type	`alert`

Responses

Name	Description	Example
bucket_name	Bucket name	examplebucket
delete_on_export	Delete on export	True
is_bucket_deleted	Bucket deleted	False
is_registered	Log type registration state	True
log_label	Log label	DB Alert Log
log_type	Log type	alert
schedule_day_of_month	Schedule day of month	28
schedule_day_of_week	Schedule day of week	MON
schedule_frequency_type	Schedule frequency type	DAY
schedule_hour	Schedule hour	12

1.12 - List Parameter Groups

1.12.1 - 1.0

scp-cli sqlserver parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
major_version optional	string	Software major version	-
product_image_type optional	string	Product image type	-
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Parameter group ID
major_version	Software major version
name	Parameter group name
product_image_type	Product image type
product_type	Product type

1.13 - List Parameter Values

1.13.1 - 1.0

scp-cli sqlserver parameter value list
--cluster_id <value>

Description

List Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
id	Parameter id
allows_value	Parameter allows value
applied_value	Parameter applied value
apply_type	Parameter apply type
data_type	Parameter data type
default_value	Parameter default value
description	Parameter description
is_modifiable	Parameter is_modifiable
name	Parameter name
software_type	Parameter software type

1.14 - List Parameters

1.14.1 - 1.0

scp-cli sqlserver parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
dbaas_parameter_group_id required	string	Parameter group ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Parameter id
dbaas_parameter_group_id	Parameter id
default_value	Parameter default value
description	Parameter description
name	Parameter name
software_type	Parameter software type

1.15 - List Server Types

1.15.1 - 1.0

scp-cli sqlserver engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
name optional	string	Server type name	-
product_image_type optional	string	Product image type	-

Responses

Name	Description	Example
cpu_core	Server type cpu core
description	Server type description
memory_gb	Server type memory
name	Server type name
product_image_type	Product image type
product_type	Product type
purpose	Server type purpose
type	Server type class

1.16 - Patch Minor Version

1.16.1 - 1.0

scp-cli sqlserver minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
software_version required	string	software_version	-
backup_before_upgrade required	boolean	backup_before_upgrade	-

1.17 - Register Log Export Config

1.17.1 - 1.0

scp-cli sqlserver log export config register
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--log_type <value>
--delete_on_export <value>
--bucket_name <value>
--access_key <value>

Description

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
secret_key required	string	Secret key	`secretkey`
schedule_hour required	string	Schedule hour	`12`
schedule_frequency_type required	string	Schedule frequency type	`DAY`
schedule_day_of_week required	****	Schedule day of week	`MON`
schedule_day_of_month required	string	Schedule day of month	`28`
log_type required	string	Log type	`alert`
delete_on_export required	boolean	Delete on export	`True`
bucket_name required	string	Bucket name	`examplebucket`
access_key required	string	Access key	`13952a8851244213f2de8d95069bf161`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.18 - Remove Backup Histories

1.18.1 - 1.0

scp-cli sqlserver backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
backup_history_number required	array	Backup id	-

1.19 - Restart Cluster

1.19.1 - 1.0

scp-cli sqlserver cluster restart
--cluster_id <value>

Description

Restart Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.20 - Set Audit Log

1.20.1 - 1.0

scp-cli sqlserver audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
use_audit_log required	boolean	use_audit_log	-

1.21 - Set Backup

1.21.1 - 1.0

scp-cli sqlserver backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
[--full_backup_day_of_week <value>]

Description

Set Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
starting_time_hour required	string	Backup starting time (hour)	-
retention_period_day required	string	Backup retention period (day)	-
archive_frequency_minute required	string	Backup starting time (minute)	-
full_backup_day_of_week optional	string	Full backup day of week	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.22 - Set Block Storage Size

1.22.1 - 1.0

scp-cli sqlserver block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
block_storage_group_id required	string	Block storage group ID	`afc33891202643ba8ba1a5298a1affff`
size_gb required	integer	Size in GB	`16`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.23 - Set Log Export Config

1.23.1 - 1.0

scp-cli sqlserver log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>

Description

Set Log Export Config.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
secret_key required	string	Secret key	`secretkey`
schedule_hour required	string	Schedule hour	`12`
schedule_frequency_type required	string	Schedule frequency type	`DAY`
schedule_day_of_week required	****	Schedule day of week	`MON`
schedule_day_of_month required	string	Schedule day of month	`28`
delete_on_export required	boolean	Delete on export	`True`
access_key required	string	Access key	`13952a8851244213f2de8d95069bf161`

1.24 - Set Maintenance

1.24.1 - 1.0

scp-cli sqlserver maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
term_hour required	string	term_hour	-
start_time required	string	start_time	-
start_minute required	string	start_minute	-
start_day_of_week required	string	start_day_of_week	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.25 - Set Parameter Values

1.25.1 - 1.0

scp-cli sqlserver parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
parameters required	array	Parameter request list	`'{"id": "", "new_value": "", "old_value": ""}'`

1.26 - Set Security Group Rules

1.26.1 - 1.0

scp-cli sqlserver security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`
add_ip_addresses optional	array	Allowed IP addresses list	-
del_ip_addresses optional	array	Allowed IP addresses list	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.27 - Set Server Type

1.27.1 - 1.0

scp-cli sqlserver server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
instance_group_id required	string	Instance group ID	-
server_type_name required	string	Server type name	-

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.28 - Show Cluster

1.28.1 - 1.0

scp-cli sqlserver cluster show
--cluster_id <value>

Description

Show Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID
allowable_ip_addresses	Allowed IP addresses list	[]
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
dbaas_engine	DBaaS engine
dbaas_engine_version_name	DBaaS engine version name
ha_enabled	HA availability
init_config_option		{}
instance_count	Instance Count
instance_groups		[]
maintenance_option	Maintenance option	{}
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Cluster name
nat_enabled	NAT availability
product_image_type	Product image type
product_type	Product type
role_type	Role type	{}
service_state	Service state
software_version	Software version
subnet_id	Subnet ID
timezone	Timezone
vip_public_ip_address	(VIP) Public IP Address
vip_public_ip_id	(VIP) Public IP ID
virtual_ip_address	Virtual IP address

1.29 - Show Request

1.29.1 - 1.0

scp-cli sqlserver request show
--request_id <value>

Description

Show Request.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
request_id required	string	Request ID	-

Responses

Name	Description	Example
request_id	Request ID
state	Request state

1.30 - Start Cluster

1.30.1 - 1.0

scp-cli sqlserver cluster start
--cluster_id <value>

Description

Start Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.31 - Stop Cluster

1.31.1 - 1.0

scp-cli sqlserver cluster stop
--cluster_id <value>

Description

Stop Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.32 - Switchover Cluster

1.32.1 - 1.0

scp-cli sqlserver cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.33 - Synchronize Cluster State

1.33.1 - 1.0

scp-cli sqlserver cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.34 - Synchronize Parameter Values

1.34.1 - 1.0

scp-cli sqlserver parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

Responses

Name	Description	Example
request_id	Request ID	req-4f668846-8a3d-49f1-8111-451ebccf445c
resource	Resource

1.35 - Terminate Cluster

1.35.1 - 1.0

scp-cli sqlserver cluster delete
--cluster_id <value>

Description

Terminate Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

1.36 - Unregister Log Export Config

1.36.1 - 1.0

scp-cli sqlserver log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
log_type required	****	Log type	`alert`
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

1.37 - Unset Backup

1.37.1 - 1.0

scp-cli sqlserver backup unset
--cluster_id <value>

Description

Unset Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`

1.38 - Unset Maintenance

1.38.1 - 1.0

scp-cli sqlserver maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Name	Type	Description	Example
cluster_id required	string	Cluster ID	`109a585ae67b4e8482fdafc8a4a5be74`