This is the multi-page printable view of this section. Click here to print.
Database
- 1: CacheStore(DBaaS)
- 1.1: CLIs
- 1.1.1: Create Cluster
- 1.1.1.1: 1.0
- 1.1.2: Create Restore Cluster
- 1.1.2.1: 1.0
- 1.1.3: List Backup Histories
- 1.1.3.1: 1.0
- 1.1.4: List Clusters
- 1.1.4.1: 1.0
- 1.1.5: List Commands
- 1.1.5.1: 1.0
- 1.1.6: List Engine Version Properties
- 1.1.6.1: 1.0
- 1.1.7: List Engine Versions
- 1.1.7.1: 1.0
- 1.1.8: List Parameter Groups
- 1.1.8.1: 1.0
- 1.1.9: List Parameter Values
- 1.1.9.1: 1.0
- 1.1.10: List Parameters
- 1.1.10.1: 1.0
- 1.1.11: List Server Types
- 1.1.11.1: 1.0
- 1.1.12: Patch Minor Version
- 1.1.12.1: 1.0
- 1.1.13: Remove Backup Histories
- 1.1.13.1: 1.0
- 1.1.14: Restart Cluster
- 1.1.14.1: 1.0
- 1.1.15: Set Backup
- 1.1.15.1: 1.0
- 1.1.16: Set Block Storage Size
- 1.1.16.1: 1.0
- 1.1.17: Set Maintenance
- 1.1.17.1: 1.0
- 1.1.18: Set Parameter Values
- 1.1.18.1: 1.0
- 1.1.19: Set Security Group Rules
- 1.1.19.1: 1.0
- 1.1.20: Set Server Type
- 1.1.20.1: 1.0
- 1.1.21: Show Cluster
- 1.1.21.1: 1.0
- 1.1.22: Show Request
- 1.1.22.1: 1.0
- 1.1.23: Start Cluster
- 1.1.23.1: 1.0
- 1.1.24: Stop Cluster
- 1.1.24.1: 1.0
- 1.1.25: Switchover Cluster
- 1.1.25.1: 1.0
- 1.1.26: Synchronize Cluster State
- 1.1.26.1: 1.0
- 1.1.27: Synchronize Commands
- 1.1.27.1: 1.0
- 1.1.28: Synchronize Parameter Values
- 1.1.28.1: 1.0
- 1.1.29: Terminate Cluster
- 1.1.29.1: 1.0
- 1.1.30: Unset Backup
- 1.1.30.1: 1.0
- 1.1.31: Unset Maintenance
- 1.1.31.1: 1.0
- 1.1.32: Update Commands
- 1.1.32.1: 1.0
- 2: EPAS(DBaaS)
- 2.1: CLIs
- 2.1.1: Add Block Storages
- 2.1.2: Create Cluster
- 2.1.3: Create Other region Replica
- 2.1.4: Create Replica
- 2.1.5: Create Restore Cluster
- 2.1.6: Delete Archive Log
- 2.1.7: Export Log
- 2.1.8: List Backup Histories
- 2.1.9: List Clusters
- 2.1.10: List Engine Version Properties
- 2.1.11: List Engine Versions
- 2.1.12: List Log Export Configs
- 2.1.13: List Parameter Groups
- 2.1.14: List Parameter Values
- 2.1.15: List Parameters
- 2.1.16: List Replicas
- 2.1.17: List Server Types
- 2.1.18: Patch Minor Version
- 2.1.19: Promote Replica Cluster
- 2.1.20: Register Log Export Config
- 2.1.21: Remove Backup Histories
- 2.1.22: Reset Replica
- 2.1.23: Restart Cluster
- 2.1.24: Set Archive Config
- 2.1.25: Set Audit Log
- 2.1.26: Set Backup
- 2.1.27: Set Block Storage Size
- 2.1.28: Set Log Export Config
- 2.1.29: Set Maintenance
- 2.1.30: Set Parameter Values
- 2.1.31: Set Security Group Rules
- 2.1.32: Set Server Type
- 2.1.33: Show Archive Config
- 2.1.34: Show Cluster
- 2.1.35: Show Request
- 2.1.36: Start Cluster
- 2.1.37: Stop Cluster
- 2.1.38: Switchover Cluster
- 2.1.39: Synchronize Archive Config
- 2.1.40: Synchronize Cluster State
- 2.1.41: Synchronize Parameter Values
- 2.1.42: Synchronize Replica State
- 2.1.43: Terminate Cluster
- 2.1.44: Unregister Log Export Config
- 2.1.45: Unset Backup
- 2.1.46: Unset Maintenance
- 2.1.47: Upgrade Kernel
- 3: MariaDB(DBaaS)
- 3.1: CLIs
- 3.1.1: Add Block Storages
- 3.1.2: Create Cluster
- 3.1.3: Create Other region Replica
- 3.1.4: Create Replica
- 3.1.5: Create Restore Cluster
- 3.1.6: Export Log
- 3.1.7: List Backup Histories
- 3.1.8: List Clusters
- 3.1.9: List Engine Version Properties
- 3.1.10: List Engine Versions
- 3.1.11: List Log Export Configs
- 3.1.12: List Parameter Groups
- 3.1.13: List Parameter Values
- 3.1.14: List Parameters
- 3.1.15: List Replicas
- 3.1.16: List Server Types
- 3.1.17: Patch Minor Version
- 3.1.18: Promote Replica Cluster
- 3.1.19: Register Log Export Config
- 3.1.20: Remove Backup Histories
- 3.1.21: Reset Replica
- 3.1.22: Restart Cluster
- 3.1.23: Set Archive Config
- 3.1.24: Set Audit Log
- 3.1.25: Set Backup
- 3.1.26: Set Block Storage Size
- 3.1.27: Set Log Export Config
- 3.1.28: Set Maintenance
- 3.1.29: Set Parameter Values
- 3.1.30: Set Security Group Rules
- 3.1.31: Set Server Type
- 3.1.32: Show Archive Config
- 3.1.33: Show Cluster
- 3.1.34: Show Request
- 3.1.35: Start Cluster
- 3.1.36: Stop Cluster
- 3.1.37: Switchover Cluster
- 3.1.38: Synchronize Archive Config
- 3.1.39: Synchronize Cluster State
- 3.1.40: Synchronize Parameter Values
- 3.1.41: Synchronize Replica State
- 3.1.42: Terminate Cluster
- 3.1.43: Unregister Log Export Config
- 3.1.44: Unset Backup
- 3.1.45: Unset Maintenance
- 3.1.46: Upgrade Kernel
- 4: Microsoft SQL Server(DBaaS)
- 4.1: CLIs
- 4.1.1: Add Block Storages
- 4.1.1.1: 1.0
- 4.1.2: Add Secondary
- 4.1.2.1: 1.0
- 4.1.3: Add/Remove Databases
- 4.1.3.1: 1.0
- 4.1.4: Create Cluster
- 4.1.4.1: 1.0
- 4.1.5: Create Restore Cluster
- 4.1.5.1: 1.0
- 4.1.6: Export Log
- 4.1.6.1: 1.0
- 4.1.7: List Backup Histories
- 4.1.7.1: 1.0
- 4.1.8: List Clusters
- 4.1.8.1: 1.0
- 4.1.9: List Engine Version Properties
- 4.1.9.1: 1.0
- 4.1.10: List Engine Versions
- 4.1.10.1: 1.0
- 4.1.11: List Log Export Configs
- 4.1.11.1: 1.0
- 4.1.12: List Parameter Groups
- 4.1.12.1: 1.0
- 4.1.13: List Parameter Values
- 4.1.13.1: 1.0
- 4.1.14: List Parameters
- 4.1.14.1: 1.0
- 4.1.15: List Server Types
- 4.1.15.1: 1.0
- 4.1.16: Patch Minor Version
- 4.1.16.1: 1.0
- 4.1.17: Register Log Export Config
- 4.1.17.1: 1.0
- 4.1.18: Remove Backup Histories
- 4.1.18.1: 1.0
- 4.1.19: Restart Cluster
- 4.1.19.1: 1.0
- 4.1.20: Set Audit Log
- 4.1.20.1: 1.0
- 4.1.21: Set Backup
- 4.1.21.1: 1.0
- 4.1.22: Set Block Storage Size
- 4.1.22.1: 1.0
- 4.1.23: Set Log Export Config
- 4.1.23.1: 1.0
- 4.1.24: Set Maintenance
- 4.1.24.1: 1.0
- 4.1.25: Set Parameter Values
- 4.1.25.1: 1.0
- 4.1.26: Set Security Group Rules
- 4.1.26.1: 1.0
- 4.1.27: Set Server Type
- 4.1.27.1: 1.0
- 4.1.28: Show Cluster
- 4.1.28.1: 1.0
- 4.1.29: Show Request
- 4.1.29.1: 1.0
- 4.1.30: Start Cluster
- 4.1.30.1: 1.0
- 4.1.31: Stop Cluster
- 4.1.31.1: 1.0
- 4.1.32: Switchover Cluster
- 4.1.32.1: 1.0
- 4.1.33: Synchronize Cluster State
- 4.1.33.1: 1.0
- 4.1.34: Synchronize Parameter Values
- 4.1.34.1: 1.0
- 4.1.35: Terminate Cluster
- 4.1.35.1: 1.0
- 4.1.36: Unregister Log Export Config
- 4.1.36.1: 1.0
- 4.1.37: Unset Backup
- 4.1.37.1: 1.0
- 4.1.38: Unset Maintenance
- 4.1.38.1: 1.0
- 5: MySQL(DBaaS)
- 5.1: CLIs
- 5.1.1: Add Block Storages
- 5.1.2: Create Cluster
- 5.1.3: Create Other region Replica
- 5.1.4: Create Replica
- 5.1.5: Create Restore Cluster
- 5.1.6: Export Log
- 5.1.7: List Backup Histories
- 5.1.8: List Clusters
- 5.1.9: List Engine Version Properties
- 5.1.10: List Engine Versions
- 5.1.11: List Log Export Configs
- 5.1.12: List Parameter Groups
- 5.1.13: List Parameter Values
- 5.1.14: List Parameters
- 5.1.15: List Replicas
- 5.1.16: List Server Types
- 5.1.17: Patch Minor Version
- 5.1.18: Promote Replica Cluster
- 5.1.19: Register Log Export Config
- 5.1.20: Remove Backup Histories
- 5.1.21: Reset Replica
- 5.1.22: Restart Cluster
- 5.1.23: Set Archive Config
- 5.1.24: Set Backup
- 5.1.25: Set Block Storage Size
- 5.1.26: Set Log Export Config
- 5.1.27: Set Maintenance
- 5.1.28: Set Parameter Values
- 5.1.29: Set Security Group Rules
- 5.1.30: Set Server Type
- 5.1.31: Show Archive Config
- 5.1.32: Show Cluster
- 5.1.33: Show Request
- 5.1.34: Start Cluster
- 5.1.35: Stop Cluster
- 5.1.36: Switchover Cluster
- 5.1.37: Synchronize Archive Config
- 5.1.38: Synchronize Cluster State
- 5.1.39: Synchronize Parameter Values
- 5.1.40: Synchronize Replica State
- 5.1.41: Terminate Cluster
- 5.1.42: Unregister Log Export Config
- 5.1.43: Unset Backup
- 5.1.44: Unset Maintenance
- 5.1.45: Upgrade Kernel
- 6: PostgreSQL(DBaaS)
- 6.1: CLIs
- 6.1.1: Add Block Storages
- 6.1.2: Create Cluster
- 6.1.3: Create Other region Replica
- 6.1.4: Create Replica
- 6.1.5: Create Restore Cluster
- 6.1.6: Delete Archive Log
- 6.1.7: Export Log
- 6.1.8: List Backup Histories
- 6.1.9: List Clusters
- 6.1.10: List Engine Version Properties
- 6.1.11: List Engine Versions
- 6.1.12: List Log Export Configs
- 6.1.13: List Parameter Groups
- 6.1.14: List Parameter Values
- 6.1.15: List Parameters
- 6.1.16: List Replicas
- 6.1.17: List Server Types
- 6.1.18: Patch Minor Version
- 6.1.19: Promote Replica Cluster
- 6.1.20: Register Log Export Config
- 6.1.21: Remove Backup Histories
- 6.1.22: Reset Replica
- 6.1.23: Restart Cluster
- 6.1.24: Set Archive Config
- 6.1.25: Set Audit Log
- 6.1.26: Set Backup
- 6.1.27: Set Block Storage Size
- 6.1.28: Set Log Export Config
- 6.1.29: Set Maintenance
- 6.1.30: Set Parameter Values
- 6.1.31: Set Security Group Rules
- 6.1.32: Set Server Type
- 6.1.33: Show Archive Config
- 6.1.34: Show Cluster
- 6.1.35: Show Request
- 6.1.36: Start Cluster
- 6.1.37: Stop Cluster
- 6.1.38: Switchover Cluster
- 6.1.39: Synchronize Archive Config
- 6.1.40: Synchronize Cluster State
- 6.1.41: Synchronize Parameter Values
- 6.1.42: Synchronize Replica State
- 6.1.43: Terminate Cluster
- 6.1.44: Unregister Log Export Config
- 6.1.45: Unset Backup
- 6.1.46: Unset Maintenance
- 6.1.47: Upgrade Kernel
1 - CacheStore(DBaaS)
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 CacheStore(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 |
|---|---|---|
| 1.0 | CURRENT | - |
1.1 - CLIs
1.1.1 - Create Cluster
1.1.1.1 - 1.0
scpcli cachestore cluster create
--database_user_password <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>]
[--replica_count <value>]
[--tags <value>]
[--database_port <value>]
[--sentinel_port <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 |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | '{"block_storage_groups": [{"role_type": "", "size_gb": "", "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' | |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| replica_count optional | integer | Replica count | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| database_port optional | integer | Database service port | - |
| sentinel_port optional | integer | Sentinel port | - |
| 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 | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
1.1.2 - Create Restore Cluster
1.1.2.1 - 1.0
scpcli cachestore 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 | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
1.1.3 - List Backup Histories
1.1.3.1 - 1.0
scpcli cachestore 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 | - |
| 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.1.4 - List Clusters
1.1.4.1 - 1.0
scpcli cachestore cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <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 | - |
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 |
| 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.1.5 - List Commands
1.1.5.1 - 1.0
scpcli cachestore command list
--cluster_id <value>
Description
List Commands.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ||
| applied_value | ||
| description | ||
| modifiable | ||
| name |
1.1.6 - List Engine Version Properties
1.1.6.1 - 1.0
scpcli cachestore 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.1.7 - List Engine Versions
1.1.7.1 - 1.0
scpcli cachestore 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.1.8 - List Parameter Groups
1.1.8.1 - 1.0
scpcli cachestore 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.1.9 - List Parameter Values
1.1.9.1 - 1.0
scpcli cachestore 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 | - |
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.1.10 - List Parameters
1.1.10.1 - 1.0
scpcli cachestore 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.1.11 - List Server Types
1.1.11.1 - 1.0
scpcli cachestore 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.1.12 - Patch Minor Version
1.1.12.1 - 1.0
scpcli cachestore minor version patch
--cluster_id <value>
--software_version <value>
--dbaas_engine <value>
Description
Patch Minor Version.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| dbaas_engine required | string | dbaas_engine | - |
1.1.13 - Remove Backup Histories
1.1.13.1 - 1.0
scpcli cachestore 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 | - |
| backup_history_number required | array | Backup id | - |
1.1.14 - Restart Cluster
1.1.14.1 - 1.0
scpcli cachestore 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 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
1.1.15 - Set Backup
1.1.15.1 - 1.0
scpcli cachestore backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
Description
Set Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
1.1.16 - Set Block Storage Size
1.1.16.1 - 1.0
scpcli cachestore 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.1.17 - Set Maintenance
1.1.17.1 - 1.0
scpcli cachestore 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 | DB cluster id | - |
| 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.1.18 - Set Parameter Values
1.1.18.1 - 1.0
scpcli cachestore 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 | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
1.1.19 - Set Security Group Rules
1.1.19.1 - 1.0
scpcli cachestore 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 | - |
| 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.1.20 - Set Server Type
1.1.20.1 - 1.0
scpcli cachestore 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.1.21 - Show Cluster
1.1.21.1 - 1.0
scpcli cachestore 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 | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_option | Backup setting option | |
| database_port | ||
| sentinel_port |
1.1.22 - Show Request
1.1.22.1 - 1.0
scpcli cachestore 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.1.23 - Start Cluster
1.1.23.1 - 1.0
scpcli cachestore 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 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
1.1.24 - Stop Cluster
1.1.24.1 - 1.0
scpcli cachestore 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 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
1.1.25 - Switchover Cluster
1.1.25.1 - 1.0
scpcli cachestore cluster switchover
--cluster_id <value>
--switch_host_name <value>
Description
Switchover Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| switch_host_name required | string | Switch over target | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
1.1.26 - Synchronize Cluster State
1.1.26.1 - 1.0
scpcli cachestore 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 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
1.1.27 - Synchronize Commands
1.1.27.1 - 1.0
scpcli cachestore command sync
--cluster_id <value>
Description
Synchronize Commands.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
1.1.28 - Synchronize Parameter Values
1.1.28.1 - 1.0
scpcli cachestore 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 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
1.1.29 - Terminate Cluster
1.1.29.1 - 1.0
scpcli cachestore 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 | - |
1.1.30 - Unset Backup
1.1.30.1 - 1.0
scpcli cachestore 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 | - |
1.1.31 - Unset Maintenance
1.1.31.1 - 1.0
scpcli cachestore 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 | DB cluster id | - |
1.1.32 - Update Commands
1.1.32.1 - 1.0
scpcli cachestore command set
--cluster_id <value>
--commands <value>
Description
Update Commands.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| commands required | array | Apply command information | '{"id": "", "name": "", "new_value": ""}' |
2 - EPAS(DBaaS)
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 EPAS(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 |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20260531 |
2.1 - CLIs
2.1.1 - Add Block Storages
2.1.1.1 - 1.1
scpcli epas 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.1 | - |
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 | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.1.2 - 1.0
scpcli epas block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.2 - Create Cluster
2.1.2.1 - 1.1
scpcli epas cluster create
--database_user_password <value>
--database_user_name <value>
--database_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>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_encoding <value>]
[--database_locale <value>]
[--database_port <value>]
[--archive_frequency_minute <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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| 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_encoding optional | string | Database encoding | - |
| database_locale optional | string | Database locale information | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| 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 | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.2.2 - 1.0
scpcli epas cluster create
--database_user_password <value>
--database_user_name <value>
--database_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>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_encoding <value>]
[--database_locale <value>]
[--database_port <value>]
[--archive_frequency_minute <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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| 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_encoding optional | string | Database encoding | - |
| database_locale optional | string | Database locale information | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| 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 | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.3 - Create Other region Replica
2.1.3.1 - 1.1
scpcli epas replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Other region Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| subnet_id required | string | Subnet ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| region required | string | Replica region | - |
| nat_enabled required | boolean | NAT availability | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.3.2 - 1.0
scpcli epas replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Other region Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| subnet_id required | string | Subnet ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| region required | string | Replica region | - |
| nat_enabled required | boolean | NAT availability | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.4 - Create Replica
2.1.4.1 - 1.1
scpcli epas replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.4.2 - 1.0
scpcli epas replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.5 - Create Restore Cluster
2.1.5.1 - 1.1
scpcli epas 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.5.2 - 1.0
scpcli epas 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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.6 - Delete Archive Log
2.1.6.1 - 1.1
scpcli epas archive log delete
--cluster_id <value>
[--type <value>]
Description
Delete Archive Log.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | string | Archive log type | ALL |
2.1.6.2 - 1.0
scpcli epas archive log delete
--cluster_id <value>
[--type <value>]
Description
Delete Archive Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | string | Archive log type | ALL |
2.1.7 - Export Log
2.1.7.1 - 1.1
scpcli epas log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.7.2 - 1.0
scpcli epas log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.8 - List Backup Histories
2.1.8.1 - 1.1
scpcli epas backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
2.1.8.2 - 1.0
scpcli epas backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
2.1.9 - List Clusters
2.1.9.1 - 1.1
scpcli epas 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.1 | - |
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 |
2.1.9.2 - 1.0
scpcli epas cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]
Description
List Clusters.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.10 - List Engine Version Properties
2.1.10.1 - 1.1
scpcli epas engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.10.2 - 1.0
scpcli epas engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.11 - List Engine Versions
2.1.11.1 - 1.1
scpcli epas engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.11.2 - 1.0
scpcli epas engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.12 - List Log Export Configs
2.1.12.1 - 1.1
scpcli epas log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.12.2 - 1.0
scpcli epas log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.13 - List Parameter Groups
2.1.13.1 - 1.1
scpcli epas parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.13.2 - 1.0
scpcli epas parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.14 - List Parameter Values
2.1.14.1 - 1.1
scpcli epas parameter value list
--cluster_id <value>
Description
List Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
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 |
2.1.14.2 - 1.0
scpcli epas parameter value list
--cluster_id <value>
Description
List Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
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 |
2.1.15 - List Parameters
2.1.15.1 - 1.1
scpcli epas parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.15.2 - 1.0
scpcli epas parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.16 - List Replicas
2.1.16.1 - 1.1
scpcli epas replica list
--cluster_id <value>
Description
List Replicas.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
2.1.16.2 - 1.0
scpcli epas replica list
--cluster_id <value>
Description
List Replicas.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
2.1.17 - List Server Types
2.1.17.1 - 1.1
scpcli epas engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.17.2 - 1.0
scpcli epas engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.18 - Patch Minor Version
2.1.18.1 - 1.1
scpcli epas minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
2.1.18.2 - 1.0
scpcli epas minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
2.1.19 - Promote Replica Cluster
2.1.19.1 - 1.1
scpcli epas replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.19.2 - 1.0
scpcli epas replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.20 - Register Log Export Config
2.1.20.1 - 1.1
scpcli epas 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
Register Log Export Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.20.2 - 1.0
scpcli epas 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
Register Log Export Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.21 - Remove Backup Histories
2.1.21.1 - 1.1
scpcli epas backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
2.1.21.2 - 1.0
scpcli epas backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
2.1.22 - Reset Replica
2.1.22.1 - 1.1
scpcli epas replica reset
--replica_cluster_id <value>
Description
Reset Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.22.2 - 1.0
scpcli epas replica reset
--replica_cluster_id <value>
Description
Reset Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.23 - Restart Cluster
2.1.23.1 - 1.1
scpcli epas cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.23.2 - 1.0
scpcli epas cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.24 - Set Archive Config
2.1.24.1 - 1.1
scpcli epas archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
2.1.24.2 - 1.0
scpcli epas archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
2.1.25 - Set Audit Log
2.1.25.1 - 1.1
scpcli epas audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| use_audit_log required | boolean | use_audit_log | - |
2.1.25.2 - 1.0
scpcli epas audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| use_audit_log required | boolean | use_audit_log | - |
2.1.26 - Set Backup
2.1.26.1 - 1.1
scpcli epas backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.26.2 - 1.0
scpcli epas backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.27 - Set Block Storage Size
2.1.27.1 - 1.1
scpcli epas block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.27.2 - 1.0
scpcli epas block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.28 - Set Log Export Config
2.1.28.1 - 1.1
scpcli epas 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.1 | - |
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 |
2.1.28.2 - 1.0
scpcli epas 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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.29 - Set Maintenance
2.1.29.1 - 1.1
scpcli epas 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| 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 |
2.1.29.2 - 1.0
scpcli epas maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| 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 |
2.1.30 - Set Parameter Values
2.1.30.1 - 1.1
scpcli epas parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
2.1.30.2 - 1.0
scpcli epas parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
2.1.31 - Set Security Group Rules
2.1.31.1 - 1.1
scpcli epas 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
2.1.31.2 - 1.0
scpcli epas security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
2.1.32 - Set Server Type
2.1.32.1 - 1.1
scpcli epas server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.32.2 - 1.0
scpcli epas server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.33 - Show Archive Config
2.1.33.1 - 1.1
scpcli epas archive config show
--cluster_id <value>
Description
Show Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
2.1.33.2 - 1.0
scpcli epas archive config show
--cluster_id <value>
Description
Show Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
2.1.34 - Show Cluster
2.1.34.1 - 1.1
scpcli epas cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
2.1.34.2 - 1.0
scpcli epas cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
2.1.35 - Show Request
2.1.35.1 - 1.1
scpcli epas request show
--request_id <value>
Description
Show Request.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
2.1.35.2 - 1.0
scpcli epas request show
--request_id <value>
Description
Show Request.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
2.1.36 - Start Cluster
2.1.36.1 - 1.1
scpcli epas cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.36.2 - 1.0
scpcli epas cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.37 - Stop Cluster
2.1.37.1 - 1.1
scpcli epas cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.37.2 - 1.0
scpcli epas cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.38 - Switchover Cluster
2.1.38.1 - 1.1
scpcli epas cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.38.2 - 1.0
scpcli epas cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.39 - Synchronize Archive Config
2.1.39.1 - 1.1
scpcli epas archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
2.1.39.2 - 1.0
scpcli epas archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
2.1.40 - Synchronize Cluster State
2.1.40.1 - 1.1
scpcli epas cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.40.2 - 1.0
scpcli epas cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.41 - Synchronize Parameter Values
2.1.41.1 - 1.1
scpcli epas parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.41.2 - 1.0
scpcli epas parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.42 - Synchronize Replica State
2.1.42.1 - 1.1
scpcli epas replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.42.2 - 1.0
scpcli epas replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2.1.43 - Terminate Cluster
2.1.43.1 - 1.1
scpcli epas cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
2.1.43.2 - 1.0
scpcli epas cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
2.1.44 - Unregister Log Export Config
2.1.44.1 - 1.1
scpcli epas log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
2.1.44.2 - 1.0
scpcli epas log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
2.1.45 - Unset Backup
2.1.45.1 - 1.1
scpcli epas backup unset
--cluster_id <value>
Description
Unset Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
2.1.45.2 - 1.0
scpcli epas backup unset
--cluster_id <value>
Description
Unset Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
2.1.46 - Unset Maintenance
2.1.46.1 - 1.1
scpcli epas maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
2.1.46.2 - 1.0
scpcli epas maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
2.1.47 - Upgrade Kernel
2.1.47.1 - 1.1
scpcli epas kernel upgrade
--cluster_id <value>
Description
Upgrade Kernel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
2.1.47.2 - 1.0
scpcli epas kernel upgrade
--cluster_id <value>
Description
Upgrade Kernel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
3 - MariaDB(DBaaS)
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 MariaDB(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 |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20260531 |
3.1 - CLIs
3.1.1 - Add Block Storages
3.1.1.1 - 1.1
scpcli mariadb 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.1 | - |
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 | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.1.2 - 1.0
scpcli mariadb block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.2 - Create Cluster
3.1.2.1 - 1.1
scpcli mariadb cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--service_watch_log_collection <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>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_character_set <value>]
[--database_port <value>]
[--archive_frequency_minute <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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| service_watch_log_collection required | boolean | ServiceWatch log collection | True |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| 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_character_set optional | string | Database encoding | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| 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 | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.2.2 - 1.0
scpcli mariadb cluster create
--database_user_password <value>
--database_user_name <value>
--database_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>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_character_set <value>]
[--database_port <value>]
[--archive_frequency_minute <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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| 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_character_set optional | string | Database encoding | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| 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 | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.3 - Create Other region Replica
3.1.3.1 - 1.1
scpcli mariadb replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Other region Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| subnet_id required | string | Subnet ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| region required | string | Replica region | - |
| nat_enabled required | boolean | NAT availability | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.3.2 - 1.0
scpcli mariadb replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Other region Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| subnet_id required | string | Subnet ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| region required | string | Replica region | - |
| nat_enabled required | boolean | NAT availability | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.4 - Create Replica
3.1.4.1 - 1.1
scpcli mariadb replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.4.2 - 1.0
scpcli mariadb replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.5 - Create Restore Cluster
3.1.5.1 - 1.1
scpcli mariadb 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.5.2 - 1.0
scpcli mariadb 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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.6 - Export Log
3.1.6.1 - 1.1
scpcli mariadb log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.6.2 - 1.0
scpcli mariadb log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.7 - List Backup Histories
3.1.7.1 - 1.1
scpcli mariadb backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
3.1.7.2 - 1.0
scpcli mariadb backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
3.1.8 - List Clusters
3.1.8.1 - 1.1
scpcli mariadb 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.1 | - |
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 |
3.1.8.2 - 1.0
scpcli mariadb cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]
Description
List Clusters.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.9 - List Engine Version Properties
3.1.9.1 - 1.1
scpcli mariadb engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.9.2 - 1.0
scpcli mariadb engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.10 - List Engine Versions
3.1.10.1 - 1.1
scpcli mariadb engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.10.2 - 1.0
scpcli mariadb engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.11 - List Log Export Configs
3.1.11.1 - 1.1
scpcli mariadb log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.11.2 - 1.0
scpcli mariadb log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.12 - List Parameter Groups
3.1.12.1 - 1.1
scpcli mariadb parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.12.2 - 1.0
scpcli mariadb parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.13 - List Parameter Values
3.1.13.1 - 1.1
scpcli mariadb parameter value list
--cluster_id <value>
Description
List Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
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 |
3.1.13.2 - 1.0
scpcli mariadb parameter value list
--cluster_id <value>
Description
List Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
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 |
3.1.14 - List Parameters
3.1.14.1 - 1.1
scpcli mariadb parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.14.2 - 1.0
scpcli mariadb parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.15 - List Replicas
3.1.15.1 - 1.1
scpcli mariadb replica list
--cluster_id <value>
Description
List Replicas.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
3.1.15.2 - 1.0
scpcli mariadb replica list
--cluster_id <value>
Description
List Replicas.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
3.1.16 - List Server Types
3.1.16.1 - 1.1
scpcli mariadb engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.16.2 - 1.0
scpcli mariadb engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.17 - Patch Minor Version
3.1.17.1 - 1.1
scpcli mariadb minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
3.1.17.2 - 1.0
scpcli mariadb minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
3.1.18 - Promote Replica Cluster
3.1.18.1 - 1.1
scpcli mariadb replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.18.2 - 1.0
scpcli mariadb replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.19 - Register Log Export Config
3.1.19.1 - 1.1
scpcli mariadb 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
Register Log Export Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.19.2 - 1.0
scpcli mariadb 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
Register Log Export Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.20 - Remove Backup Histories
3.1.20.1 - 1.1
scpcli mariadb backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
3.1.20.2 - 1.0
scpcli mariadb backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
3.1.21 - Reset Replica
3.1.21.1 - 1.1
scpcli mariadb replica reset
--replica_cluster_id <value>
Description
Reset Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.21.2 - 1.0
scpcli mariadb replica reset
--replica_cluster_id <value>
Description
Reset Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.22 - Restart Cluster
3.1.22.1 - 1.1
scpcli mariadb cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.22.2 - 1.0
scpcli mariadb cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.23 - Set Archive Config
3.1.23.1 - 1.1
scpcli mariadb archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
3.1.23.2 - 1.0
scpcli mariadb archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
3.1.24 - Set Audit Log
3.1.24.1 - 1.1
scpcli mariadb audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| use_audit_log required | boolean | use_audit_log | - |
3.1.24.2 - 1.0
scpcli mariadb audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| use_audit_log required | boolean | use_audit_log | - |
3.1.25 - Set Backup
3.1.25.1 - 1.1
scpcli mariadb backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.25.2 - 1.0
scpcli mariadb backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.26 - Set Block Storage Size
3.1.26.1 - 1.1
scpcli mariadb block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.26.2 - 1.0
scpcli mariadb block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.27 - Set Log Export Config
3.1.27.1 - 1.1
scpcli mariadb 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.1 | - |
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 |
3.1.27.2 - 1.0
scpcli mariadb 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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.28 - Set Maintenance
3.1.28.1 - 1.1
scpcli mariadb 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| 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 |
3.1.28.2 - 1.0
scpcli mariadb maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| 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 |
3.1.29 - Set Parameter Values
3.1.29.1 - 1.1
scpcli mariadb parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
3.1.29.2 - 1.0
scpcli mariadb parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
3.1.30 - Set Security Group Rules
3.1.30.1 - 1.1
scpcli mariadb 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
3.1.30.2 - 1.0
scpcli mariadb security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
3.1.31 - Set Server Type
3.1.31.1 - 1.1
scpcli mariadb server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.31.2 - 1.0
scpcli mariadb server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.32 - Show Archive Config
3.1.32.1 - 1.1
scpcli mariadb archive config show
--cluster_id <value>
Description
Show Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
3.1.32.2 - 1.0
scpcli mariadb archive config show
--cluster_id <value>
Description
Show Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
3.1.33 - Show Cluster
3.1.33.1 - 1.1
scpcli mariadb cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| audit_enabled | Audit usage state | |
| backup_option | Backup setting option | |
| database_character_set | Database encoding | |
| database_name | Database Name | |
| database_port | Database service port | |
| database_user_name | Database User Name | |
| origin_region | Origin Region |
3.1.33.2 - 1.0
scpcli mariadb cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| audit_enabled | Audit usage state | |
| backup_option | Backup setting option | |
| database_character_set | Database encoding | |
| database_name | Database Name | |
| database_port | Database service port | |
| database_user_name | Database User Name | |
| origin_region | Origin Region |
3.1.34 - Show Request
3.1.34.1 - 1.1
scpcli mariadb request show
--request_id <value>
Description
Show Request.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
3.1.34.2 - 1.0
scpcli mariadb request show
--request_id <value>
Description
Show Request.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
3.1.35 - Start Cluster
3.1.35.1 - 1.1
scpcli mariadb cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.35.2 - 1.0
scpcli mariadb cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.36 - Stop Cluster
3.1.36.1 - 1.1
scpcli mariadb cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.36.2 - 1.0
scpcli mariadb cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.37 - Switchover Cluster
3.1.37.1 - 1.1
scpcli mariadb cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.37.2 - 1.0
scpcli mariadb cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.38 - Synchronize Archive Config
3.1.38.1 - 1.1
scpcli mariadb archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
3.1.38.2 - 1.0
scpcli mariadb archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
3.1.39 - Synchronize Cluster State
3.1.39.1 - 1.1
scpcli mariadb cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.39.2 - 1.0
scpcli mariadb cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.40 - Synchronize Parameter Values
3.1.40.1 - 1.1
scpcli mariadb parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.40.2 - 1.0
scpcli mariadb parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.41 - Synchronize Replica State
3.1.41.1 - 1.1
scpcli mariadb replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.41.2 - 1.0
scpcli mariadb replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
3.1.42 - Terminate Cluster
3.1.42.1 - 1.1
scpcli mariadb cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
3.1.42.2 - 1.0
scpcli mariadb cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
3.1.43 - Unregister Log Export Config
3.1.43.1 - 1.1
scpcli mariadb log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
3.1.43.2 - 1.0
scpcli mariadb log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
3.1.44 - Unset Backup
3.1.44.1 - 1.1
scpcli mariadb backup unset
--cluster_id <value>
Description
Unset Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
3.1.44.2 - 1.0
scpcli mariadb backup unset
--cluster_id <value>
Description
Unset Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
3.1.45 - Unset Maintenance
3.1.45.1 - 1.1
scpcli mariadb maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
3.1.45.2 - 1.0
scpcli mariadb maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
3.1.46 - Upgrade Kernel
3.1.46.1 - 1.1
scpcli mariadb kernel upgrade
--cluster_id <value>
Description
Upgrade Kernel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
3.1.46.2 - 1.0
scpcli mariadb kernel upgrade
--cluster_id <value>
Description
Upgrade Kernel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
4 - Microsoft SQL Server(DBaaS)
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 |
|---|
4.1 - CLIs
4.1.1 - Add Block Storages
4.1.1.1 - 1.0
scpcli 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 | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
4.1.2 - Add Secondary
4.1.2.1 - 1.0
scpcli 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 |
4.1.3 - Add/Remove Databases
4.1.3.1 - 1.0
scpcli 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 |
4.1.4 - Create Cluster
4.1.4.1 - 1.0
scpcli 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 | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| 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 | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
4.1.5 - Create Restore Cluster
4.1.5.1 - 1.0
scpcli 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 | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
4.1.6 - Export Log
4.1.6.1 - 1.0
scpcli 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 |
4.1.7 - List Backup Histories
4.1.7.1 - 1.0
scpcli 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 |
4.1.8 - List Clusters
4.1.8.1 - 1.0
scpcli 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 |
4.1.9 - List Engine Version Properties
4.1.9.1 - 1.0
scpcli 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 |
4.1.10 - List Engine Versions
4.1.10.1 - 1.0
scpcli 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 |
4.1.11 - List Log Export Configs
4.1.11.1 - 1.0
scpcli 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 |
4.1.12 - List Parameter Groups
4.1.12.1 - 1.0
scpcli 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 |
4.1.13 - List Parameter Values
4.1.13.1 - 1.0
scpcli 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 |
4.1.14 - List Parameters
4.1.14.1 - 1.0
scpcli 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 |
4.1.15 - List Server Types
4.1.15.1 - 1.0
scpcli 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 |
4.1.16 - Patch Minor Version
4.1.16.1 - 1.0
scpcli 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 | - |
4.1.17 - Register Log Export Config
4.1.17.1 - 1.0
scpcli 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
Register Log Export Config.
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 |
4.1.18 - Remove Backup Histories
4.1.18.1 - 1.0
scpcli 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 | - |
4.1.19 - Restart Cluster
4.1.19.1 - 1.0
scpcli 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 |
4.1.20 - Set Audit Log
4.1.20.1 - 1.0
scpcli 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 | - |
4.1.21 - Set Backup
4.1.21.1 - 1.0
scpcli 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 |
4.1.22 - Set Block Storage Size
4.1.22.1 - 1.0
scpcli 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 |
4.1.23 - Set Log Export Config
4.1.23.1 - 1.0
scpcli 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 |
4.1.24 - Set Maintenance
4.1.24.1 - 1.0
scpcli 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 |
4.1.25 - Set Parameter Values
4.1.25.1 - 1.0
scpcli 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": ""}' |
4.1.26 - Set Security Group Rules
4.1.26.1 - 1.0
scpcli 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 |
4.1.27 - Set Server Type
4.1.27.1 - 1.0
scpcli 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 |
4.1.28 - Show Cluster
4.1.28.1 - 1.0
scpcli 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 |
|---|---|---|
| audit_enabled | Audit usage state | |
| backup_option | Backup setting option | |
| database_collation | ||
| database_port | Database service port | |
| database_service_name | Database Service Name | |
| database_user_name | Database User Name | |
| databases | Databases |
4.1.29 - Show Request
4.1.29.1 - 1.0
scpcli 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 |
4.1.30 - Start Cluster
4.1.30.1 - 1.0
scpcli 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 |
4.1.31 - Stop Cluster
4.1.31.1 - 1.0
scpcli 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 |
4.1.32 - Switchover Cluster
4.1.32.1 - 1.0
scpcli 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 |
4.1.33 - Synchronize Cluster State
4.1.33.1 - 1.0
scpcli 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 |
4.1.34 - Synchronize Parameter Values
4.1.34.1 - 1.0
scpcli 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 |
4.1.35 - Terminate Cluster
4.1.35.1 - 1.0
scpcli 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 |
4.1.36 - Unregister Log Export Config
4.1.36.1 - 1.0
scpcli 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 |
4.1.37 - Unset Backup
4.1.37.1 - 1.0
scpcli 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 |
4.1.38 - Unset Maintenance
4.1.38.1 - 1.0
scpcli 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 |
5 - MySQL(DBaaS)
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 MySQL(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 |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20260531 |
5.1 - CLIs
5.1.1 - Add Block Storages
5.1.1.1 - 1.1
scpcli mysql 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.1 | - |
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 | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.1.2 - 1.0
scpcli mysql block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.2 - Create Cluster
5.1.2.1 - 1.1
scpcli mysql cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--service_watch_log_collection <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>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_case_sensitive <value>]
[--database_character_set <value>]
[--database_port <value>]
[--archive_frequency_minute <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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| service_watch_log_collection required | boolean | ServiceWatch log collection | True |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| 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 | **** | - | |
| database_case_sensitive optional | boolean | Database case sensitivity | - |
| database_character_set optional | string | Database encoding | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| 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 | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.2.2 - 1.0
scpcli mysql cluster create
--database_user_password <value>
--database_user_name <value>
--database_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>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_case_sensitive <value>]
[--database_character_set <value>]
[--database_port <value>]
[--archive_frequency_minute <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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| 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 | **** | - | |
| database_case_sensitive optional | boolean | Database case sensitivity | - |
| database_character_set optional | string | Database encoding | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| 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 | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.3 - Create Other region Replica
5.1.3.1 - 1.1
scpcli mysql replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Other region Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| subnet_id required | string | Subnet ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| region required | string | Replica region | - |
| nat_enabled required | boolean | NAT availability | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.3.2 - 1.0
scpcli mysql replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Other region Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| subnet_id required | string | Subnet ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| region required | string | Replica region | - |
| nat_enabled required | boolean | NAT availability | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.4 - Create Replica
5.1.4.1 - 1.1
scpcli mysql replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.4.2 - 1.0
scpcli mysql replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.5 - Create Restore Cluster
5.1.5.1 - 1.1
scpcli mysql 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.5.2 - 1.0
scpcli mysql 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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.6 - Export Log
5.1.6.1 - 1.1
scpcli mysql log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.6.2 - 1.0
scpcli mysql log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.7 - List Backup Histories
5.1.7.1 - 1.1
scpcli mysql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
5.1.7.2 - 1.0
scpcli mysql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
5.1.8 - List Clusters
5.1.8.1 - 1.1
scpcli mysql 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.1 | - |
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 |
5.1.8.2 - 1.0
scpcli mysql cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]
Description
List Clusters.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.9 - List Engine Version Properties
5.1.9.1 - 1.1
scpcli mysql engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.9.2 - 1.0
scpcli mysql engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.10 - List Engine Versions
5.1.10.1 - 1.1
scpcli mysql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.10.2 - 1.0
scpcli mysql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.11 - List Log Export Configs
5.1.11.1 - 1.1
scpcli mysql log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.11.2 - 1.0
scpcli mysql log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.12 - List Parameter Groups
5.1.12.1 - 1.1
scpcli mysql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.12.2 - 1.0
scpcli mysql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.13 - List Parameter Values
5.1.13.1 - 1.1
scpcli mysql parameter value list
--cluster_id <value>
Description
List Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
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 |
5.1.13.2 - 1.0
scpcli mysql parameter value list
--cluster_id <value>
Description
List Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
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 |
5.1.14 - List Parameters
5.1.14.1 - 1.1
scpcli mysql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.14.2 - 1.0
scpcli mysql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.15 - List Replicas
5.1.15.1 - 1.1
scpcli mysql replica list
--cluster_id <value>
Description
List Replicas.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
5.1.15.2 - 1.0
scpcli mysql replica list
--cluster_id <value>
Description
List Replicas.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
5.1.16 - List Server Types
5.1.16.1 - 1.1
scpcli mysql engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.16.2 - 1.0
scpcli mysql engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.17 - Patch Minor Version
5.1.17.1 - 1.1
scpcli mysql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
5.1.17.2 - 1.0
scpcli mysql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
5.1.18 - Promote Replica Cluster
5.1.18.1 - 1.1
scpcli mysql replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.18.2 - 1.0
scpcli mysql replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.19 - Register Log Export Config
5.1.19.1 - 1.1
scpcli mysql 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
Register Log Export Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.19.2 - 1.0
scpcli mysql 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
Register Log Export Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.20 - Remove Backup Histories
5.1.20.1 - 1.1
scpcli mysql backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
5.1.20.2 - 1.0
scpcli mysql backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
5.1.21 - Reset Replica
5.1.21.1 - 1.1
scpcli mysql replica reset
--replica_cluster_id <value>
Description
Reset Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.21.2 - 1.0
scpcli mysql replica reset
--replica_cluster_id <value>
Description
Reset Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.22 - Restart Cluster
5.1.22.1 - 1.1
scpcli mysql cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.22.2 - 1.0
scpcli mysql cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.23 - Set Archive Config
5.1.23.1 - 1.1
scpcli mysql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
5.1.23.2 - 1.0
scpcli mysql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
5.1.24 - Set Backup
5.1.24.1 - 1.1
scpcli mysql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.24.2 - 1.0
scpcli mysql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.25 - Set Block Storage Size
5.1.25.1 - 1.1
scpcli mysql block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.25.2 - 1.0
scpcli mysql block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.26 - Set Log Export Config
5.1.26.1 - 1.1
scpcli mysql 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.1 | - |
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 |
5.1.26.2 - 1.0
scpcli mysql 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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.27 - Set Maintenance
5.1.27.1 - 1.1
scpcli mysql 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| 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 |
5.1.27.2 - 1.0
scpcli mysql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| 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 |
5.1.28 - Set Parameter Values
5.1.28.1 - 1.1
scpcli mysql parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
5.1.28.2 - 1.0
scpcli mysql parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
5.1.29 - Set Security Group Rules
5.1.29.1 - 1.1
scpcli mysql 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
5.1.29.2 - 1.0
scpcli mysql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
5.1.30 - Set Server Type
5.1.30.1 - 1.1
scpcli mysql server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.30.2 - 1.0
scpcli mysql server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.31 - Show Archive Config
5.1.31.1 - 1.1
scpcli mysql archive config show
--cluster_id <value>
Description
Show Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
5.1.31.2 - 1.0
scpcli mysql archive config show
--cluster_id <value>
Description
Show Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
5.1.32 - Show Cluster
5.1.32.1 - 1.1
scpcli mysql cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_option | Backup setting option | |
| database_character_set | Database encoding | |
| database_name | Database Name | |
| database_port | Database service port | |
| database_user_name | Database User Name | |
| origin_region | Origin Region |
5.1.32.2 - 1.0
scpcli mysql cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_option | Backup setting option | |
| database_character_set | Database encoding | |
| database_name | Database Name | |
| database_port | Database service port | |
| database_user_name | Database User Name | |
| origin_region | Origin Region |
5.1.33 - Show Request
5.1.33.1 - 1.1
scpcli mysql request show
--request_id <value>
Description
Show Request.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
5.1.33.2 - 1.0
scpcli mysql request show
--request_id <value>
Description
Show Request.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
5.1.34 - Start Cluster
5.1.34.1 - 1.1
scpcli mysql cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.34.2 - 1.0
scpcli mysql cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.35 - Stop Cluster
5.1.35.1 - 1.1
scpcli mysql cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.35.2 - 1.0
scpcli mysql cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.36 - Switchover Cluster
5.1.36.1 - 1.1
scpcli mysql cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.36.2 - 1.0
scpcli mysql cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.37 - Synchronize Archive Config
5.1.37.1 - 1.1
scpcli mysql archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
5.1.37.2 - 1.0
scpcli mysql archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
5.1.38 - Synchronize Cluster State
5.1.38.1 - 1.1
scpcli mysql cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.38.2 - 1.0
scpcli mysql cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.39 - Synchronize Parameter Values
5.1.39.1 - 1.1
scpcli mysql parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.39.2 - 1.0
scpcli mysql parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.40 - Synchronize Replica State
5.1.40.1 - 1.1
scpcli mysql replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.40.2 - 1.0
scpcli mysql replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
5.1.41 - Terminate Cluster
5.1.41.1 - 1.1
scpcli mysql cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
5.1.41.2 - 1.0
scpcli mysql cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
5.1.42 - Unregister Log Export Config
5.1.42.1 - 1.1
scpcli mysql log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
5.1.42.2 - 1.0
scpcli mysql log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
5.1.43 - Unset Backup
5.1.43.1 - 1.1
scpcli mysql backup unset
--cluster_id <value>
Description
Unset Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
5.1.43.2 - 1.0
scpcli mysql backup unset
--cluster_id <value>
Description
Unset Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
5.1.44 - Unset Maintenance
5.1.44.1 - 1.1
scpcli mysql maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
5.1.44.2 - 1.0
scpcli mysql maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
5.1.45 - Upgrade Kernel
5.1.45.1 - 1.1
scpcli mysql kernel upgrade
--cluster_id <value>
Description
Upgrade Kernel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
5.1.45.2 - 1.0
scpcli mysql kernel upgrade
--cluster_id <value>
Description
Upgrade Kernel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6 - PostgreSQL(DBaaS)
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 PostgreSQL(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 |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20260531 |
6.1 - CLIs
6.1.1 - Add Block Storages
6.1.1.1 - 1.1
scpcli postgresql 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.1 | - |
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 | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.2 - 1.0
scpcli postgresql block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.2 - Create Cluster
6.1.2.1 - 1.1
scpcli postgresql cluster create
--database_user_password <value>
--database_user_name <value>
--database_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>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_encoding <value>]
[--database_locale <value>]
[--database_port <value>]
[--archive_frequency_minute <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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| 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_encoding optional | string | Database encoding | - |
| database_locale optional | string | Database locale information | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| 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 | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.2.2 - 1.0
scpcli postgresql cluster create
--database_user_password <value>
--database_user_name <value>
--database_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>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_encoding <value>]
[--database_locale <value>]
[--database_port <value>]
[--archive_frequency_minute <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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| 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_encoding optional | string | Database encoding | - |
| database_locale optional | string | Database locale information | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| 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 | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.3 - Create Other region Replica
6.1.3.1 - 1.1
scpcli postgresql replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Other region Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| subnet_id required | string | Subnet ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| region required | string | Replica region | - |
| nat_enabled required | boolean | NAT availability | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.3.2 - 1.0
scpcli postgresql replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Other region Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| subnet_id required | string | Subnet ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| region required | string | Replica region | - |
| nat_enabled required | boolean | NAT availability | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.4 - Create Replica
6.1.4.1 - 1.1
scpcli postgresql replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.4.2 - 1.0
scpcli postgresql replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.5 - Create Restore Cluster
6.1.5.1 - 1.1
scpcli postgresql 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.5.2 - 1.0
scpcli postgresql 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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.6 - Delete Archive Log
6.1.6.1 - 1.1
scpcli postgresql archive log delete
--cluster_id <value>
[--type <value>]
Description
Delete Archive Log.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | string | Archive log type | ALL |
6.1.6.2 - 1.0
scpcli postgresql archive log delete
--cluster_id <value>
[--type <value>]
Description
Delete Archive Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | string | Archive log type | ALL |
6.1.7 - Export Log
6.1.7.1 - 1.1
scpcli postgresql log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.7.2 - 1.0
scpcli postgresql log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.8 - List Backup Histories
6.1.8.1 - 1.1
scpcli postgresql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
6.1.8.2 - 1.0
scpcli postgresql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
6.1.9 - List Clusters
6.1.9.1 - 1.1
scpcli postgresql 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.1 | - |
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 |
6.1.9.2 - 1.0
scpcli postgresql cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]
Description
List Clusters.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.10 - List Engine Version Properties
6.1.10.1 - 1.1
scpcli postgresql engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.10.2 - 1.0
scpcli postgresql engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.11 - List Engine Versions
6.1.11.1 - 1.1
scpcli postgresql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.11.2 - 1.0
scpcli postgresql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.12 - List Log Export Configs
6.1.12.1 - 1.1
scpcli postgresql log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.12.2 - 1.0
scpcli postgresql log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.13 - List Parameter Groups
6.1.13.1 - 1.1
scpcli postgresql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.13.2 - 1.0
scpcli postgresql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.14 - List Parameter Values
6.1.14.1 - 1.1
scpcli postgresql parameter value list
--cluster_id <value>
Description
List Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
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 |
6.1.14.2 - 1.0
scpcli postgresql parameter value list
--cluster_id <value>
Description
List Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
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 |
6.1.15 - List Parameters
6.1.15.1 - 1.1
scpcli postgresql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.15.2 - 1.0
scpcli postgresql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.16 - List Replicas
6.1.16.1 - 1.1
scpcli postgresql replica list
--cluster_id <value>
Description
List Replicas.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
6.1.16.2 - 1.0
scpcli postgresql replica list
--cluster_id <value>
Description
List Replicas.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
6.1.17 - List Server Types
6.1.17.1 - 1.1
scpcli postgresql engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.17.2 - 1.0
scpcli postgresql engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.18 - Patch Minor Version
6.1.18.1 - 1.1
scpcli postgresql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
6.1.18.2 - 1.0
scpcli postgresql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
6.1.19 - Promote Replica Cluster
6.1.19.1 - 1.1
scpcli postgresql replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.19.2 - 1.0
scpcli postgresql replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.20 - Register Log Export Config
6.1.20.1 - 1.1
scpcli postgresql 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
Register Log Export Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.20.2 - 1.0
scpcli postgresql 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
Register Log Export Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.21 - Remove Backup Histories
6.1.21.1 - 1.1
scpcli postgresql backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
6.1.21.2 - 1.0
scpcli postgresql backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
6.1.22 - Reset Replica
6.1.22.1 - 1.1
scpcli postgresql replica reset
--replica_cluster_id <value>
Description
Reset Replica.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.22.2 - 1.0
scpcli postgresql replica reset
--replica_cluster_id <value>
Description
Reset Replica.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.23 - Restart Cluster
6.1.23.1 - 1.1
scpcli postgresql cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.23.2 - 1.0
scpcli postgresql cluster restart
--cluster_id <value>
Description
Restart Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.24 - Set Archive Config
6.1.24.1 - 1.1
scpcli postgresql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
6.1.24.2 - 1.0
scpcli postgresql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
6.1.25 - Set Audit Log
6.1.25.1 - 1.1
scpcli postgresql audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| use_audit_log required | boolean | use_audit_log | - |
6.1.25.2 - 1.0
scpcli postgresql audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| use_audit_log required | boolean | use_audit_log | - |
6.1.26 - Set Backup
6.1.26.1 - 1.1
scpcli postgresql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.26.2 - 1.0
scpcli postgresql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.27 - Set Block Storage Size
6.1.27.1 - 1.1
scpcli postgresql block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.27.2 - 1.0
scpcli postgresql block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.28 - Set Log Export Config
6.1.28.1 - 1.1
scpcli postgresql 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.1 | - |
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 |
6.1.28.2 - 1.0
scpcli postgresql 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 (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.29 - Set Maintenance
6.1.29.1 - 1.1
scpcli postgresql 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| 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 |
6.1.29.2 - 1.0
scpcli postgresql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| 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 |
6.1.30 - Set Parameter Values
6.1.30.1 - 1.1
scpcli postgresql parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
6.1.30.2 - 1.0
scpcli postgresql parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
6.1.31 - Set Security Group Rules
6.1.31.1 - 1.1
scpcli postgresql 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.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
6.1.31.2 - 1.0
scpcli postgresql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
6.1.32 - Set Server Type
6.1.32.1 - 1.1
scpcli postgresql server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.32.2 - 1.0
scpcli postgresql server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.33 - Show Archive Config
6.1.33.1 - 1.1
scpcli postgresql archive config show
--cluster_id <value>
Description
Show Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
6.1.33.2 - 1.0
scpcli postgresql archive config show
--cluster_id <value>
Description
Show Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
6.1.34 - Show Cluster
6.1.34.1 - 1.1
scpcli postgresql cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
6.1.34.2 - 1.0
scpcli postgresql cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
6.1.35 - Show Request
6.1.35.1 - 1.1
scpcli postgresql request show
--request_id <value>
Description
Show Request.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
6.1.35.2 - 1.0
scpcli postgresql request show
--request_id <value>
Description
Show Request.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
6.1.36 - Start Cluster
6.1.36.1 - 1.1
scpcli postgresql cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.36.2 - 1.0
scpcli postgresql cluster start
--cluster_id <value>
Description
Start Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.37 - Stop Cluster
6.1.37.1 - 1.1
scpcli postgresql cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.37.2 - 1.0
scpcli postgresql cluster stop
--cluster_id <value>
Description
Stop Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.38 - Switchover Cluster
6.1.38.1 - 1.1
scpcli postgresql cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.38.2 - 1.0
scpcli postgresql cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.39 - Synchronize Archive Config
6.1.39.1 - 1.1
scpcli postgresql archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 |
6.1.39.2 - 1.0
scpcli postgresql archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
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 |
6.1.40 - Synchronize Cluster State
6.1.40.1 - 1.1
scpcli postgresql cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.40.2 - 1.0
scpcli postgresql cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.41 - Synchronize Parameter Values
6.1.41.1 - 1.1
scpcli postgresql parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.41.2 - 1.0
scpcli postgresql parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.42 - Synchronize Replica State
6.1.42.1 - 1.1
scpcli postgresql replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.42.2 - 1.0
scpcli postgresql replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.43 - Terminate Cluster
6.1.43.1 - 1.1
scpcli postgresql cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.1.43.2 - 1.0
scpcli postgresql cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.1.44 - Unregister Log Export Config
6.1.44.1 - 1.1
scpcli postgresql log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
6.1.44.2 - 1.0
scpcli postgresql log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
6.1.45 - Unset Backup
6.1.45.1 - 1.1
scpcli postgresql backup unset
--cluster_id <value>
Description
Unset Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.1.45.2 - 1.0
scpcli postgresql backup unset
--cluster_id <value>
Description
Unset Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.1.46 - Unset Maintenance
6.1.46.1 - 1.1
scpcli postgresql maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
6.1.46.2 - 1.0
scpcli postgresql maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
6.1.47 - Upgrade Kernel
6.1.47.1 - 1.1
scpcli postgresql kernel upgrade
--cluster_id <value>
Description
Upgrade Kernel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.1.47.2 - 1.0
scpcli postgresql kernel upgrade
--cluster_id <value>
Description
Upgrade Kernel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |