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 |
CLI Version History
1.1
CLI version 1.1 release for EPAS(DBaaS)
Changes
- [Changed]
epas show cluster - command has been changed.- Response model has been changed to
EpasClusterDetailResponseV1Dot1. - The following fields are added to the response:
- [New]
epas create other region replica - command has been added. - [New]
epas patch minor version - command has been added. - [New]
epas upgrade kernel - command has been added.
1.0
Initial CLI release for EPAS(DBaaS)
Changes
- [New]
epas add block storages - command has been added. - [New]
epas create cluster - command has been added. - [New]
epas create replica - command has been added. - [New]
epas create restore - command has been added. - [New]
epas delete archive log - command has been added. - [New]
epas delete cluster - command has been added. - [New]
epas export log - command has been added. - [New]
epas list backup histories - command has been added. - [New]
epas list clusters - command has been added. - [New]
epas list engine version properties - command has been added. - [New]
epas list engine versions - command has been added. - [New]
epas list log export configs - command has been added. - [New]
epas list parameter groups - command has been added. - [New]
epas list parameter values - command has been added. - [New]
epas list parameters - command has been added. - [New]
epas list replicas - command has been added. - [New]
epas list server types - command has been added. - [New]
epas promote replica cluster - command has been added. - [New]
epas register log export config - command has been added. - [New]
epas remove backup histories - command has been added. - [New]
epas reset replica - command has been added. - [New]
epas restart cluster - command has been added. - [New]
epas set archive config - command has been added. - [New]
epas set audit log - command has been added. - [New]
epas set backup - command has been added. - [New]
epas set block storage size - command has been added. - [New]
epas set log export config - command has been added. - [New]
epas set maintenance - command has been added. - [New]
epas set parameter values - command has been added. - [New]
epas set security group rules - command has been added. - [New]
epas set server type - command has been added. - [New]
epas show archive config - command has been added. - [New]
epas show cluster - command has been added. - [New]
epas show request - command has been added. - [New]
epas start cluster - command has been added. - [New]
epas stop cluster - command has been added. - [New]
epas switchover cluster - command has been added. - [New]
epas sync archive config - command has been added. - [New]
epas sync cluster state - command has been added. - [New]
epas sync parameter values - command has been added. - [New]
epas sync replica state - command has been added. - [New]
epas unregister log export config - command has been added. - [New]
epas unset backup - command has been added. - [New]
epas unset maintenance - command has been added.
1 - CLIs
1.1 - Add Block Storages
1.1.1 - 1.1
scp-cli epas block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
instance_group_id required | string | Instance group ID | - |
size_gb required | integer | Size in GB | 104 |
role_type required | string | Role type | OS |
volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.1.2 - 1.0
scp-cli 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 | OS |
volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.2 - Create Cluster
1.2.1 - 1.1
scp-cli 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)
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 | Asia/Seoul |
subnet_id required | string | Subnet ID | 1ddd7f1e4a8a43ed8b82d70cade0b321 |
name required | string | Cluster name | mycluster |
instance_name_prefix required | string | Instance name prefix | myprefix |
instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}' |
dbaas_engine_version_id required | string | DBaaS engine version ID | c1b856dd12754c0ba2614a39d0ed3ad1 |
allowable_ip_addresses optional | array | Allowed IP addresses list | - |
ha_enabled optional | boolean | HA availability | - |
nat_enabled optional | boolean | NAT availability | - |
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 | 5 |
starting_day_of_week optional | string | Starting day of week | MON |
starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.2.2 - 1.0
scp-cli 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 | Asia/Seoul |
subnet_id required | string | Subnet ID | 1ddd7f1e4a8a43ed8b82d70cade0b321 |
name required | string | Cluster name | mycluster |
instance_name_prefix required | string | Instance name prefix | myprefix |
instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "ACTIVE", "server_type_name": ""}' |
dbaas_engine_version_id required | string | DBaaS engine version ID | c1b856dd12754c0ba2614a39d0ed3ad1 |
allowable_ip_addresses optional | array | Allowed IP addresses list | - |
ha_enabled optional | boolean | HA availability | - |
nat_enabled optional | boolean | NAT availability | - |
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 | 5 |
starting_day_of_week optional | string | Starting day of week | MON |
starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.3 - Create Other region Replica
1.3.1 - 1.1
scp-cli 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)
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": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "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 | 5 |
starting_day_of_week optional | string | Starting day of week | MON |
starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.3.2 - 1.0
scp-cli 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": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "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 | 5 |
starting_day_of_week optional | string | Starting day of week | MON |
starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.4 - Create Replica
1.4.1 - 1.1
scp-cli 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)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | - |
replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "role_type": "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 | 5 |
starting_day_of_week optional | string | Starting day of week | MON |
starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.4.2 - 1.0
scp-cli 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": "OS", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": "192.168.10.10/32"}], "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 | 5 |
starting_day_of_week optional | string | Starting day of week | MON |
starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.5 - Create Restore Cluster
1.5.1 - 1.1
scp-cli 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)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | - |
server_type_name required | string | Server type name | - |
name required | string | Cluster name | mycluster |
instance_name_prefix required | string | Instance name prefix | myprefix |
allowable_ip_addresses optional | array | Allowed IP addresses list | - |
backup_history_number optional | string | Backup id | 202501010000 |
backup_recovery_time optional | string | Backup Recovery Time | - |
block_storage_groups optional | array | Block storage groups list | '{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}' |
tags optional | array | tag | '{"key": "", "value": ""}' |
period_hour optional | string | Period in hours | 5 |
starting_day_of_week optional | string | Starting day of week | MON |
starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.5.2 - 1.0
scp-cli 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 | mycluster |
instance_name_prefix required | string | Instance name prefix | myprefix |
allowable_ip_addresses optional | array | Allowed IP addresses list | - |
backup_history_number optional | string | Backup id | 202501010000 |
backup_recovery_time optional | string | Backup Recovery Time | - |
block_storage_groups optional | array | Block storage groups list | '{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}' |
tags optional | array | tag | '{"key": "", "value": ""}' |
period_hour optional | string | Period in hours | 5 |
starting_day_of_week optional | string | Starting day of week | MON |
starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.6 - Delete Archive Log
1.6.1 - 1.1
scp-cli epas archive log delete
--cluster_id <value>
[--type <value>]
Description
Delete Archive Log.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
type optional | string | Archive log type | ALL |
1.6.2 - 1.0
scp-cli 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 |
1.7 - Export Log
1.7.1 - 1.1
scp-cli epas log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
log_type required | **** | Log type | alert |
cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.7.2 - 1.0
scp-cli 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 | |
1.8 - List Backup Histories
1.8.1 - 1.1
scp-cli epas backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
State
ACTIVE (CURRENT)
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.8.2 - 1.0
scp-cli 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 | |
1.9 - List Clusters
1.9.1 - 1.1
scp-cli epas cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]
Description
List Clusters.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
name optional | string | Cluster name | - |
service_state optional | string | Service state | - |
database_name optional | string | Database Name | - |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| database_name | Database Name | |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state | |
1.9.2 - 1.0
scp-cli 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 | |
1.10 - List Engine Version Properties
1.10.1 - 1.1
scp-cli epas engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|
| name | DBaas engine property name | |
| value | DBaas engine property value | |
1.10.2 - 1.0
scp-cli 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 | |
1.11 - List Engine Versions
1.11.1 - 1.1
scp-cli epas engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
id optional | string | DBaaS engine version ID | - |
product_image_type optional | **** | Product image type | - |
eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version | |
1.11.2 - 1.0
scp-cli 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 | |
1.12 - List Log Export Configs
1.12.1 - 1.1
scp-cli epas log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
type optional | **** | Log type | alert |
Responses
| Name | Description | Example |
|---|
| bucket_name | Bucket name | examplebucket |
| delete_on_export | Delete on export | True |
| is_bucket_deleted | Bucket deleted | False |
| is_registered | Log type registration state | True |
| log_label | Log label | DB Alert Log |
| log_type | Log type | alert |
| schedule_day_of_month | Schedule day of month | 28 |
| schedule_day_of_week | Schedule day of week | MON |
| schedule_frequency_type | Schedule frequency type | DAY |
| schedule_hour | Schedule hour | 12 |
1.12.2 - 1.0
scp-cli 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 |
1.13 - List Parameter Groups
1.13.1 - 1.1
scp-cli epas parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
major_version optional | string | Software major version | - |
product_image_type optional | string | Product image type | - |
sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type | |
1.13.2 - 1.0
scp-cli 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 | |
1.14 - List Parameter Values
1.14.1 - 1.1
scp-cli epas parameter value list
--cluster_id <value>
Description
List Parameter Values.
State
ACTIVE (CURRENT)
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.14.2 - 1.0
scp-cli 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 | |
1.15 - List Parameters
1.15.1 - 1.1
scp-cli epas parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
dbaas_parameter_group_id required | string | Parameter group ID | - |
size optional | integer | size | 20 |
page optional | integer | page | 0 |
sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type | |
1.15.2 - 1.0
scp-cli 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 | |
1.16 - List Replicas
1.16.1 - 1.1
scp-cli epas replica list
--cluster_id <value>
Description
List Replicas.
State
ACTIVE (CURRENT)
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 | |
1.16.2 - 1.0
scp-cli 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 | |
1.17 - List Server Types
1.17.1 - 1.1
scp-cli epas engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
State
ACTIVE (CURRENT)
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.17.2 - 1.0
scp-cli 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 | |
1.18 - Patch Minor Version
1.18.1 - 1.1
scp-cli epas minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
State
ACTIVE (CURRENT)
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 | - |
1.18.2 - 1.0
scp-cli 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 | - |
1.19 - Promote Replica Cluster
1.19.1 - 1.1
scp-cli epas replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
State
ACTIVE (CURRENT)
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.19.2 - 1.0
scp-cli 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 | |
1.20 - Register Log Export Config
1.20.1 - 1.1
scp-cli 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)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
secret_key required | string | Secret key | secretkey |
schedule_hour required | string | Schedule hour | 12 |
schedule_frequency_type required | string | Schedule frequency type | DAY |
schedule_day_of_week required | **** | Schedule day of week | MON |
schedule_day_of_month required | string | Schedule day of month | 28 |
log_type required | string | Log type | alert |
delete_on_export required | boolean | Delete on export | True |
bucket_name required | string | Bucket name | examplebucket |
access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.20.2 - 1.0
scp-cli 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 | |
1.21 - Remove Backup Histories
1.21.1 - 1.1
scp-cli epas backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | - |
backup_history_number required | array | Backup id | - |
1.21.2 - 1.0
scp-cli 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 | - |
1.22 - Reset Replica
1.22.1 - 1.1
scp-cli epas replica reset
--replica_cluster_id <value>
Description
Reset Replica.
State
ACTIVE (CURRENT)
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 | |
1.22.2 - 1.0
scp-cli 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 | |
1.23 - Restart Cluster
1.23.1 - 1.1
scp-cli epas cluster restart
--cluster_id <value>
Description
Restart Cluster.
State
ACTIVE (CURRENT)
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.23.2 - 1.0
scp-cli 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 | |
1.24 - Set Archive Config
1.24.1 - 1.1
scp-cli epas archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
State
ACTIVE (CURRENT)
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) | - |
1.24.2 - 1.0
scp-cli 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) | - |
1.25 - Set Audit Log
1.25.1 - 1.1
scp-cli epas audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | - |
use_audit_log required | boolean | use_audit_log | - |
1.25.2 - 1.0
scp-cli 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 | - |
1.26 - Set Backup
1.26.1 - 1.1
scp-cli epas backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
State
ACTIVE (CURRENT)
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 | |
1.26.2 - 1.0
scp-cli 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 | |
1.27 - Set Block Storage Size
1.27.1 - 1.1
scp-cli epas block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
State
ACTIVE (CURRENT)
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.27.2 - 1.0
scp-cli 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 | |
1.28 - Set Log Export Config
1.28.1 - 1.1
scp-cli 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)
Parameters
| Name | Type | Description | Example |
|---|
log_type required | **** | Log type | alert |
cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
secret_key required | string | Secret key | secretkey |
schedule_hour required | string | Schedule hour | 12 |
schedule_frequency_type required | string | Schedule frequency type | DAY |
schedule_day_of_week required | **** | Schedule day of week | MON |
schedule_day_of_month required | string | Schedule day of month | 28 |
delete_on_export required | boolean | Delete on export | True |
access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
1.28.2 - 1.0
scp-cli 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 |
1.29 - Set Maintenance
1.29.1 - 1.1
scp-cli 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)
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.29.2 - 1.0
scp-cli 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 | |
1.30 - Set Parameter Values
1.30.1 - 1.1
scp-cli epas parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | - |
parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
1.30.2 - 1.0
scp-cli 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": ""}' |
1.31 - Set Security Group Rules
1.31.1 - 1.1
scp-cli epas security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
State
ACTIVE (CURRENT)
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.31.2 - 1.0
scp-cli 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 | |
1.32 - Set Server Type
1.32.1 - 1.1
scp-cli epas server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
State
ACTIVE (CURRENT)
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.32.2 - 1.0
scp-cli 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 | |
1.33 - Show Archive Config
1.33.1 - 1.1
scp-cli epas archive config show
--cluster_id <value>
Description
Show Archive Config.
State
ACTIVE (CURRENT)
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) | |
1.33.2 - 1.0
scp-cli 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) | |
1.34 - Show Cluster
1.34.1 - 1.1
scp-cli epas cluster show
--cluster_id <value>
Description
Show Cluster.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| allowable_ip_addresses | Allowed IP addresses list | [] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| dbaas_engine | DBaaS engine | |
| dbaas_engine_version_name | DBaaS engine version name | |
| ha_enabled | HA availability | |
| init_config_option | DB initial configuration option | |
| instance_count | Instance Count | |
| instance_groups | Instance groups list | [] |
| is_kernel_patchable | Whether the kernel can be patched | |
| maintenance_option | Maintenance option | {} |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| origin_cluster_id | Origin cluster ID | |
| product_image_type | Product image type | |
| product_type | Product type | |
| replicas | Replicas list | [] |
| role_type | Role type | {} |
| service_state | Service state | |
| software_version | Software version | |
| subnet_id | Subnet ID | |
| timezone | Timezone | |
| vip_public_ip_address | (VIP) Public IP Address | |
| vip_public_ip_id | (VIP) Public IP ID | |
| virtual_ip_address | Virtual IP address | |
1.34.2 - 1.0
scp-cli 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 | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| allowable_ip_addresses | Allowed IP addresses list | [] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| dbaas_engine | DBaaS engine | |
| dbaas_engine_version_name | DBaaS engine version name | |
| ha_enabled | HA availability | |
| init_config_option | DB initial configuration option | |
| instance_count | Instance Count | |
| instance_groups | Instance groups list | [] |
| maintenance_option | Maintenance option | {} |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| origin_cluster_id | Origin cluster ID | |
| product_image_type | Product image type | |
| product_type | Product type | |
| replicas | Replicas list | [] |
| role_type | Role type | {} |
| service_state | Service state | |
| software_version | Software version | |
| subnet_id | Subnet ID | |
| timezone | Timezone | |
| vip_public_ip_address | (VIP) Public IP Address | |
| vip_public_ip_id | (VIP) Public IP ID | |
| virtual_ip_address | Virtual IP address | |
1.35 - Show Request
1.35.1 - 1.1
scp-cli epas request show
--request_id <value>
Description
Show Request.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | |
| state | Request state | |
1.35.2 - 1.0
scp-cli 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 | |
1.36 - Start Cluster
1.36.1 - 1.1
scp-cli epas cluster start
--cluster_id <value>
Description
Start Cluster.
State
ACTIVE (CURRENT)
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.36.2 - 1.0
scp-cli 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 | |
1.37 - Stop Cluster
1.37.1 - 1.1
scp-cli epas cluster stop
--cluster_id <value>
Description
Stop Cluster.
State
ACTIVE (CURRENT)
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.37.2 - 1.0
scp-cli 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 | |
1.38 - Switchover Cluster
1.38.1 - 1.1
scp-cli epas cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
State
ACTIVE (CURRENT)
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.38.2 - 1.0
scp-cli 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 | |
1.39 - Synchronize Archive Config
1.39.1 - 1.1
scp-cli epas archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource | |
1.39.2 - 1.0
scp-cli 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 | |
1.40 - Synchronize Cluster State
1.40.1 - 1.1
scp-cli epas cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
State
ACTIVE (CURRENT)
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.40.2 - 1.0
scp-cli 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 | |
1.41 - Synchronize Parameter Values
1.41.1 - 1.1
scp-cli epas parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
State
ACTIVE (CURRENT)
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.41.2 - 1.0
scp-cli 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 | |
1.42 - Synchronize Replica State
1.42.1 - 1.1
scp-cli epas replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
State
ACTIVE (CURRENT)
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 | |
1.42.2 - 1.0
scp-cli 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 | |
1.43 - Terminate Cluster
1.43.1 - 1.1
scp-cli epas cluster delete
--cluster_id <value>
Description
Terminate Cluster.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | - |
1.43.2 - 1.0
scp-cli 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 | - |
1.44 - Unregister Log Export Config
1.44.1 - 1.1
scp-cli epas log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
log_type required | **** | Log type | alert |
cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
1.44.2 - 1.0
scp-cli 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 |
1.45 - Unset Backup
1.45.1 - 1.1
scp-cli epas backup unset
--cluster_id <value>
Description
Unset Backup.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | - |
1.45.2 - 1.0
scp-cli 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 | - |
1.46 - Unset Maintenance
1.46.1 - 1.1
scp-cli epas maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | DB cluster id | - |
1.46.2 - 1.0
scp-cli 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 | - |
1.47 - Upgrade Kernel
1.47.1 - 1.1
scp-cli epas kernel upgrade
--cluster_id <value>
Description
Upgrade Kernel.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
cluster_id required | string | Cluster ID | - |
1.47.2 - 1.0
scp-cli 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 | - |