Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 CacheStore(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
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>]
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| 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 | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
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>]
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| 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 | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
| 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 |
scpcli cachestore cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| 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 | - |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
scpcli cachestore command list
--cluster_id <value>
List Commands.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| Name | Description | Example |
|---|---|---|
| id | ||
| applied_value | ||
| description | ||
| modifiable | ||
| name |
scpcli cachestore engine version property list
--dbaas_engine_version_id <value>
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
scpcli cachestore engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
| 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 |
scpcli cachestore parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
List Parameter Groups.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| 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 |
| 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 |
scpcli cachestore parameter value list
--cluster_id <value>
List Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| 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 |
scpcli cachestore parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
List Parameters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| 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 |
| 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 |
scpcli cachestore engine server type list
[--name <value>]
[--product_image_type <value>]
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
| 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 |
scpcli cachestore backup history remove
--cluster_id <value>
--backup_history_number <value>
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
scpcli cachestore cluster restart
--cluster_id <value>
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| 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) | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore block storage size set
--block_storage_group_id <value>
--size_gb <value>
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| 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 | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore parameter value set
--cluster_id <value>
--parameters <value>
Set Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
scpcli cachestore security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| 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 | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore server type set
--instance_group_id <value>
--server_type_name <value>
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore cluster show
--cluster_id <value>
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| Name | Description | Example |
|---|---|---|
| backup_option | Backup setting option | |
| database_port | ||
| sentinel_port |
scpcli cachestore request show
--request_id <value>
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
scpcli cachestore cluster start
--cluster_id <value>
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore cluster stop
--cluster_id <value>
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore cluster switchover
--cluster_id <value>
--switch_host_name <value>
Switchover Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| switch_host_name required | string | Switch over target | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore cluster state sync
--cluster_id <value>
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore command sync
--cluster_id <value>
Synchronize Commands.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore parameter value sync
--cluster_id <value>
Synchronize Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
scpcli cachestore cluster delete
--cluster_id <value>
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
scpcli cachestore backup unset
--cluster_id <value>
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
scpcli cachestore maintenance unset
--cluster_id <value>
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
scpcli cachestore command set
--cluster_id <value>
--commands <value>
Update Commands.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| commands required | array | Apply command information | '{"id": "", "name": "", "new_value": ""}' |