CLI Reference

1 - Common

Overview


삼성 클라우드 플랫폼에서 제공하는 인프라/솔루션 상품을 이용할 수있도록 지원하는 명령줄 인터페이스(Command Line Interface, CLI)를 제공하고 있습니다.

본 가이드에서는 삼성 클라우드 플랫폼 Open API에 대한 간략한 설명 및 CLI 호출하는 방법을 제공합니다.

CLI에 따라 파라미터 값을 입력하고 등록, 수정, 삭제 , 조회 할 수 있습니다.

설치


CLI는 아래에서 다운로드 합니다.

windows

windows CLI Download

linux

linux CLI Download

다운 받은 파일에 실행권한을 부여 합니다.

chmod +x scp-cli

사전 필요 사항


인증키 발급

삼성 클라우드 플랫폼의 CLI 기능을 사용하시려면 인증키를 발급받아야 합니다.

인증키 발급은 삼성 클라우드 플랫폼 콘솔의 왼쪽 상단 [My 메뉴] > [My Info] > [인증키 관리] 에서 확인 할 수 있습니다.

인증키는 Access Key와 Access Secret Key의 한 쌍으로 구성되어 있습니다. 인증키는 API 인증 토큰을 발급할 때 사용됩니다.

  1. Samsung Cloud Platform Console에 로그인을 하세요.
  2. My 메뉴 > My Info > 인증키 관리 메뉴로 이동하여, 인증키 생성 버튼을 클릭하세요.
  3. 기간과 사용 용도를 작성하고, 확인 버튼을 클릭하여 인증키를 생성하세요.
  4. 인증키 목록에서 발급받은 Access KeyAccess Secret Key를 확인하세요.
    • Access Secret Key는 인증키 상세 페이지에서 확인할 수 있습니다.

임시 보안 자격 증명 (Optional)


임시 보안 자격 증명은 사용자가 정해진 시간 동안만 유효한 인증 정보를 통해 시스템에 접근할 수 있도록 하는 기능입니다. 이 자격 증명은 일반적으로 다음과 같은 목적을 위해 사용됩니다:

  • 보안 강화: 장기 자격 증명(예: API 키, 비밀번호) 유출 시의 피해를 줄이기 위해
  • 권한 위임: 외부 사용자나 시스템에 제한된 권한을 임시로 부여 가능
  • 자동 만료: 자격 증명이 일정 시간 후 자동으로 만료되므로 관리가 간편

구성 요소

임시 자격 증명은 일반적으로 다음 정보를 포함합니다:

  1. Access Key : 인증을 위한 식별자
  2. Secret Key : 암호화된 인증 서명 생성에 사용
  3. Session Token: 세션 식별 및 유효성 검사를 위한 토큰

임시 보안 자격 증명 생성하기

삼성 클라우드 플랫폼의 임시 보안 자격 증명 기능을 사용하시려면 역할을 생성하여야 합니다.

역할 생성은 삼성 클라우드 플랫폼 콘솔의 [My 메뉴] > [My Info] > [역할] 에서 확인 할 수 있습니다.

  • 수행 주체

    • 역할을 생성할시 해당 역할을 맡을 수 있는 수행 주체를 설정해 주어야 합니다.
    • 수행 주체는 역할을 맡을 수 있는 계정, 사용자 SRN, 자격 증명 공급자 등으로 지정합니다
  • 정책

    • 역할을 맡은 사람이 어떤 행동을 할 수 있는지 정의하는 정책을 설정해주어야 합니다.
    • 정책은 최소 권한 원칙(Principle of Least Privilege)을 준수하여 필요한 권한만 부여합니다
  1. Samsung Cloud Platform Console에 로그인을 하세요.
  2. My 메뉴 > My Info > 역할 메뉴로 이동하여, 역할 생성 버튼을 클릭하세요.
  3. 역할명을 작성하고 최대 세션 지속 시간을 선택하여 역할 수임의 유효시간을 설정하세요.
  4. 수행 주체 항목에서 구분 버튼을 눌러 수행 주체를 설정할 수 있으며, 추가 버튼을 눌러 여러 수행 주체 설정이 가능합니다
  5. 정책의 목록에서 원하는 정책을 확인한 후 왼쪽의 체크박스을 누르면 정책의 설정이 가능합니다
  6. 완료 버튼을 눌러 역할의 생성을 확인합니다

이후엔 역할자의 토큰을 생성해주어야 합니다. 이는 assume-role api를 수행하여야 하며, 결과 값으로는 Access key, Secret key, Session token을 받게 됩니다

assume-role 사용법 문서 : assume-role 사용법

실행 환경 설정 관리


CLI의 실행 환경 설정은 config 파일로 정의하여 수행합니다. 해당 파일은 PC 내, 해당위치에 파일 형태로 작성 되어야 합니다.

windows

C:\Users\{사용자명}\.scp\cli-config.json

linux

~/.scp/cli-config.json

설정 파일의 포멧은 JSON 포멧을 지원하며, 아래와 같이 설정합니다.

{
        "auth_url": "https://iam.s.samsungsdscloud.com/v1/endpoints",
        "access_key": "my-access-key",
        "access_secret_key": "my-access-secret-key",
        "default_scp_region": "kr-west1",
        (Optional) "session_token": "session_token"
}

설정 항목 확인

key설명예시
auth_url인증 urlhttps://iam.s.samsungsdscloud.com/v1/endpoints
access_key발급받은 access keymy-access-key
access_secret_key발급받은 access secret keymy-access-secret-key
default_scp_region기본 region 이름kr-west1
(Optional) session_token임시 보안 자격 증명의 세션 토큰session_token

auth_url 예시

Environmentenv valueExample Service URL
for Samsungshttps://iam.s.samsungsdscloud.com/v1/endpoints
for Sovereignghttps://iam.g.samsungsdscloud.com/v1/endpoints
for Enterpriseehttps://iam.e.samsungsdscloud.com/v1/endpoints

CLI 명령어


명령어 도움말

CLI 명령어 형식은 아래와 같습니다.

scp-cli [서비스] [리소스] [actcion] [--option and parameters]
// e.g. ( 예제의 입출력 결과는 예시를 위한 것이며 실제와 다를 수 있습니다. )
> scp-cli iam user create --user-name TestUser

사용 가능한 명령어는 –help를 통해 확인할 수 있습니다.

scp-cli iam policy create --help

usage: scp-cli iam policy create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width]
                                   [--print-empty] --Version [VERSION] --Statement [STATEMENT ...] --policy_name [POLICY_NAME]
                                   [--default_version_id [DEFAULT_VERSION_ID]] [--description [DESCRIPTION]] [--policy_category [POLICY_CATEGORY]]
                                   [--policy_type [POLICY_TYPE]] [--service_type [SERVICE_TYPE]] [--tags [TAGS ...]] [--policy_id [POLICY_ID]]
                                   [--policy_version_id [POLICY_VERSION_ID]] [--policy_version_name [POLICY_VERSION_NAME]]

Create a policy

options:
  -h, --help            show this help message and exit
  --Version [VERSION]
                        [Required] Policy Version.
  --Statement [STATEMENT ...]
                        [Required] Statement.
  --policy_name [POLICY_NAME]
                        [Required] Policy Name.
  --default_version_id [DEFAULT_VERSION_ID]
                        [Optional] Default Version Id.
  --description [DESCRIPTION]
                        [Optional] Description.
  --policy_category [POLICY_CATEGORY]
                        [Optional] Policy Category.
  --policy_type [POLICY_TYPE]
                        [Optional] Policy Type.
  --service_type [SERVICE_TYPE]
                        [Optional] Service Type.
  --tags [TAGS ...]
                        [Optional] Policy Tag.
  --policy_id [POLICY_ID]
                        [Optional] Policy ID.
  --policy_version_id [POLICY_VERSION_ID]
                        [Optional] Policy Version Id.
  --policy_version_name [POLICY_VERSION_NAME]
                        [Optional] Policy Version Name.

옵션 설명에 “[Required]” 표시는 필수 옵션 항목이며, “[Optional]” 표시는 선택 옵션 항목입니다.

API 버저닝


CLI는 Micro version 형태의 API 버전을 지원하며 명령어를 통해 각 상품의 api 버전을 확인 할 수 있습니다.

기본적으로, 현재 상품이 지원하는 최신 버전이 호출 되며, CLI 버전에 따라 호출 가능한 기본버전이 따라 응답 출력이 다를 수 있습니다.

–{상품명}–api-version 인자를 통해, 고정된 버전의 CLI를 사용할 수 있습니다.

  • 해당 인자는 global option 인자로 대화형 모드 사용 시, 진입시 설정이 필요합니다.

API 버전확인 CLI Command 호출예시

scp-cli versions show [--region-name <region_name>] [--service <service>] [--status <status>] [--timeout <timeout>]

API 버전 CLI 예시

+-------------+----------------------------+---------+-----------+---------------------------------------------------------+------------+
| Region Name | Service Name               | Version | Status    | Endpoint                                                | Not Before |
+-------------+----------------------------+---------+-----------+---------------------------------------------------------+------------+
| kr-west1    | data-flow                  | 1.0     | CURRENT   | https://data-flow.kr-west1.e.samsungsdscloud.com        |    None    |
| kr-west1    | data-ops                   | 1.0     | CURRENT   | https://data-ops.kr-west1.e.samsungsdscloud.com         |    None    |
| kr-west2    | scp-aimlops-platform       | 1.0     | CURRENT   | https://aimlops-platform.kr-west2.e.samsungsdscloud.com |    None    |
| kr-west1    | scp-aimlops-platform       | 1.0     | CURRENT   | https://aimlops-platform.kr-west1.e.samsungsdscloud.com |    None    |
| kr-west1    | scp-apigateway             | 1.1     | CURRENT   | https://apigateway.kr-west1.e.samsungsdscloud.com       |    None    |

API 버전 Status 목록

STATUSDescription
CURRENT현재 사용 권장되는 최신버전 (최신 1개만 유지)
SUPPORTED신규 기능의 추가는 없고 bug fix만 되는 버전
PLANNED미리 다음 버전 정보를 주기 위한 단계 API 호출 불가, 문서로만 제공
DEPRECATEDAPI 버전의 남은 Not Before 기간이 90일 이하인 단계

대화형 모드


대화형 모드로 CLI를 실행하여, 사용 할 수 있습니다.

scp-cli <global 인자>

global 인자의 설정이 필요한 경우, 실행시 입력하여 설정 후 진입합니다.

global 인자 : CLI를 수행할 때 사용되는 명령어의 인자 외 제공 되는 인자. (ex. debug, microversion 등)

global 인자 사용 예시

scp-cli --iam-api-version 1.3 --vpc-api-version 1.3

실행 후 아래와 같은 프롬프트가 나타나며, 명령을 직접 입력하여 실행할 수 있습니다.

(scp-cli)

대화형 모드 사용 예시

(scp-cli) iam policy list

종료 하려면 Ctrl + D 를 통해 대화형 모드를 종료합니다.

2 - Compute

2.1 - Bare Metal Server

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Bare Metal Server 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

2.1.1 - CLIs

2.1.1.1 - Assign Baremetal Private NAT IP

2.1.1.1.1 - 1.1

scpcli baremetal private-nat-ip create
--baremetal_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Bare Metal Server Private NAT IP 연결 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
private_nat_ip_id
required
stringPrivate NAT IP ID03cd065d8acc4e47b11a11dc1411323e
private_nat_id
required
stringPrivate NAT IDa4fd0216cd32442a82733bbb8be0e82b

Responses

NameDescriptionExample
nat_idNAT IDa4fd0216cd32442a82733bbb8be0e82b
nat_ipNAT IP192.170.2.10
nat_ip_idNAT IP ID20c507a036c447cdb3b19468d8ea62ac
stateStatic NAT 상태ACTIVE
static_nat_idStatic NAT IDa1b97ae4695b40b0866e86a19cb191d3

2.1.1.2 - Assign Baremetal Public NAT IP

2.1.1.2.1 - 1.1

scpcli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>

Description

Bare Metal Server NAT IP 연결 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
public_ip_address_id
required
stringPublic NAT ID20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
baremetal_idBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.2.2 - 1.0

scpcli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>

Description

Bare Metal Server NAT IP 연결 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
public_ip_address_id
required
stringPublic NAT ID20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
baremetal_idBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.3 - Attach Baremetal Local Subnet

2.1.1.3.1 - 1.1

scpcli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]

Description

Bare Metal Server 로컬 서브넷 연결 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_id
required
string로컬 Subnet IDab313c43291e4b678f4bacffe10768ae
local_subnet_ip
optional
string로컬 Subnet IP192.168.0.1

2.1.1.3.2 - 1.0

scpcli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]

Description

Bare Metal Server 로컬 서브넷 연결 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_id
required
string로컬 Subnet IDab313c43291e4b678f4bacffe10768ae
local_subnet_ip
optional
string로컬 Subnet IP192.168.0.1

2.1.1.4 - Create Baremetals

2.1.1.4.1 - 1.1

scpcli baremetal baremetal create
--vpc_id <value>
--subnet_id <value>
--server_details <value>
--region_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
[--init_script <value>]
[--lock_enabled <value>]
[--placement_group_name <value>]
[--tags <value>]
[--use_placement_group <value>]

Description

Bare Metal Server 생성 요청 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca
subnet_id
required
stringSubnet IDab313c43291e4b678f4bacffe10768ae
server_details
required
array서버별 세부 설정'{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "ip_address": "192.168.0.1", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "server_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg", "use_hyper_threading": true}'
region_id
required
string리전 IDkr-west1
os_user_password
required
stringOS 유저 패스워드password
os_user_id
required
stringOS 유저 IDuser001
image_id
required
string이미지 IDIMAGE-7XFMaJpLsapKvskFMjCtmm
init_script
optional
stringInit scriptinit script
lock_enabled
optional
booleanLock 사용 여부True
placement_group_name
optional
stringPlacement Group 이름pgtest
tags
optional
array태그'{"key": "key", "value": "value"}'
use_placement_group
optional
booleanplacement group 사용 여부False

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id자원 ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.4.2 - 1.0

scpcli baremetal baremetal create
--vpc_id <value>
--subnet_id <value>
--server_details <value>
--region_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
[--init_script <value>]
[--lock_enabled <value>]
[--placement_group_name <value>]
[--tags <value>]
[--use_placement_group <value>]

Description

Bare Metal Server 생성 요청 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca
subnet_id
required
stringSubnet IDab313c43291e4b678f4bacffe10768ae
server_details
required
array서버별 세부 설정'{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "ip_address": "192.168.0.1", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "server_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg", "use_hyper_threading": true}'
region_id
required
string리전 IDkr-west1
os_user_password
required
stringOS 유저 패스워드password
os_user_id
required
stringOS 유저 IDuser001
image_id
required
string이미지 IDIMAGE-7XFMaJpLsapKvskFMjCtmm
init_script
optional
stringInit scriptinit script
lock_enabled
optional
booleanLock 사용 여부True
placement_group_name
optional
stringPlacement Group 이름pgtest
tags
optional
array태그'{"key": "key", "value": "value"}'
use_placement_group
optional
booleanplacement group 사용 여부False

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id자원 ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.5 - Delete Baremetal Private NAT IP

2.1.1.5.1 - 1.1

scpcli baremetal private-nat-ip delete
--baremetal_id <value>

Description

Bare Metal Server Private NAT IP 해지 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.6 - Delete Baremetal Public NAT IP

2.1.1.6.1 - 1.1

scpcli baremetal nat-ip delete
--baremetal_id <value>

Description

Bare Metal Server NAT IP 해지 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.6.2 - 1.0

scpcli baremetal nat-ip delete
--baremetal_id <value>

Description

Bare Metal Server NAT IP 해지 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.7 - Delete Baremetals

2.1.1.7.1 - 1.1

scpcli baremetal baremetal delete
--baremetal_id_list <value>

Description

Bare Metal Server 해지 요청 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id_list
required
arrayBare Metal Server ID 리스트20c507a036c447cdb3b19468d8ea62ac

2.1.1.7.2 - 1.0

scpcli baremetal baremetal delete
--baremetal_id_list <value>

Description

Bare Metal Server 해지 요청 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id_list
required
arrayBare Metal Server ID 리스트20c507a036c447cdb3b19468d8ea62ac

2.1.1.8 - Detach Baremetal Local Subnet

2.1.1.8.1 - 1.1

scpcli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>

Description

Bare Metal Server 로컬 서브넷 해지 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_ip
required
string로컬 Subnet IP192.168.0.1
local_subnet_id
required
string로컬 Subnet IDab313c43291e4b678f4bacffe10768ae

2.1.1.8.2 - 1.0

scpcli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>

Description

Bare Metal Server 로컬 서브넷 해지 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_ip
required
string로컬 Subnet IP192.168.0.1
local_subnet_id
required
string로컬 Subnet IDab313c43291e4b678f4bacffe10768ae

2.1.1.9 - List Baremetal Images

2.1.1.9.1 - 1.1

scpcli baremetal image list
--region_id <value>

Description

Bare Metal Server 이미지 조회 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
region_id
required
string리전 IDkr-west1

Responses

NameDescriptionExample
id이미지 IDIMAGE-7XFMaJpLsapKvskFMjCtmm
created_at생성 시간2024-07-11 08:56:59
name이미지명RHEL 8.8 for BM
os_distroOS typeRHEL
scp_image_type이미지 타입STANDARD
scp_os_versionOS 버전8.7

2.1.1.9.2 - 1.0

scpcli baremetal image list
--region_id <value>

Description

Bare Metal Server 이미지 조회 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
region_id
required
string리전 IDkr-west1

Responses

NameDescriptionExample
id이미지 IDIMAGE-7XFMaJpLsapKvskFMjCtmm
created_at생성 시간2024-07-11 08:56:59
name이미지명RHEL 8.8 for BM
os_distroOS typeRHEL
scp_image_type이미지 타입STANDARD
scp_os_versionOS 버전8.7

2.1.1.10 - List Baremetal Products

2.1.1.10.1 - 1.1

scpcli baremetal product list
[--image_id <value>]

Description

Bare Metal Server Scale type 조회 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
optional
string이미지 IDIMAGE-7XFMaJpLsapKvskFMjCtmm

Responses

NameDescriptionExample
idIDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
compute_class_type_nameCompute class type 이름StandardMetal-2
compute_class_type_valueCompute class type values2_metal
cpu_nameCPU 이름cpu 16 vCore
cpu_unitCPU unitvCPU
cpu_valueCPU value64
created_at생성 시간2024-05-17T00:23:17Z
description설명vCPU 16 │ Memory 128G │ Disk 480G
disk_unitDisk unitGB
disk_valueDisk value480
memory_nameMemroy 이름server memory 128GB
memory_unitMemory unitGB
memory_valueMemory value128
modified_at수정 시간2024-05-17T00:23:17Z
name이름s2v16m128_metal
name_with_generation세대s2v16m128_metal
os_disk_gbOS Disk 값480
stateStateAVAILABLE
type유형SCALE

2.1.1.10.2 - 1.0

scpcli baremetal product list
[--image_id <value>]

Description

Bare Metal Server Scale type 조회 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
image_id
optional
string이미지 IDIMAGE-7XFMaJpLsapKvskFMjCtmm

Responses

NameDescriptionExample
idIDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
attri_nameAttribute 이름attri name
attri_valueAttribute valueattri value
compute_class_type_nameCompute class type 이름StandardMetal-2
compute_class_type_unitCompute class type unitcompute_class_type_unit
compute_class_type_valueCompute class type values2_metal
cpu_generationCPU generationcpu generation
cpu_nameCPU 이름cpu 16 vCore
cpu_unitCPU unitvCPU
cpu_valueCPU value64
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명vCPU 16 │ Memory 128G │ Disk 480G
disk_nameDisk명disk_name
disk_unitDisk unitGB
disk_valueDisk value480
infiniband_nameInfiniBand 이름infiniband_name
infiniband_unitInfiniBand unitinfiniband_unit
infiniband_valueInfiniband valueinfiniband_value
memory_nameMemroy 이름server memory 128GB
memory_unitMemory unitGB
memory_valueMemory value128
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name이름s2v16m128_metal
name_with_generation세대s2v16m128_metal
socket_nameSocket 이름socket_name
socket_unitSocket unitsocket_unit
socket_valueSocket valuesocket_value
stateStateAVAILABLE
type유형SCALE

2.1.1.11 - List Baremetals

2.1.1.11.1 - 1.1

scpcli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]

Description

Bare Metal Server 목록 조회 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
server_name
optional
stringBare Metal Server 이름bmserver-001
state
optional
stringBare Metal Server 상태RUNNING
ip
optional
stringBare Metal Server IP 주소192.168.0.1
vpc_id
optional
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
image_id이미지 IDIMAGE-7XFMaJpLsapKvskFMjCtmm
image_version이미지 버전RHEL 8.7 for BM
lock_enabledLock 사용 여부True
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
network_idSubnet IDab313c43291e4b678f4bacffe10768ae
os_typeOS typeWINDOWS
placement_group_namePlacement Group 이름pgtest
policy_ip정책 IP192.168.0.1
product_type_idBare Metal Server 스케일 IDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
region_id리전 IDkr-west1
server_nameBare Metal Server 이름bmserver-001
server_typeBare Metal Server 스케일 타입s1v8m32_metal
stateBare Metal Server 상태RUNNING
vpc_idVPC IDe58348b1bc9148e5af86500fd4ef99ca

2.1.1.11.2 - 1.0

scpcli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]

Description

Bare Metal Server 목록 조회 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
server_name
optional
stringBare Metal Server 이름bmserver-001
state
optional
stringBare Metal Server 상태RUNNING
ip
optional
stringBare Metal Server IP 주소192.168.0.1
vpc_id
optional
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca

Responses

NameDescriptionExample
idBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자ef716e80-1fac-4faa-892d-0132fc7f5583
hyper_threading_useHyper threading 사용 여부True
image_id이미지 IDIMAGE-7XFMaJpLsapKvskFMjCtmm
image_version이미지 버전RHEL 8.7 for BM
init_scriptInit scriptinit script
local_subnet_infoLocal Subnet 정보
lock_enabledLock 사용 여부True
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자ef716e80-1fac-4faa-892d-0132fc7f5583
network_idSubnet IDab313c43291e4b678f4bacffe10768ae
os_typeOS typeWINDOWS
placement_group_namePlacement Group 이름pgtest
policy_ip정책 IP192.168.0.1
policy_natPublic NAT IP192.168.0.1
policy_use_natPublic NAT 사용 여부True
product_type_idBare Metal Server 스케일 IDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
public_nat_statusPublic NAT 상태ACTIVE
region_id리전 IDkr-west1
root_account루트 계정rootaccount
server_nameBare Metal Server 이름bmserver-001
server_typeBare Metal Server 스케일 타입s1v8m32_metal
stateBare Metal Server 상태RUNNING
time_zone타임존Asia/Seoul
use_local_subnet로컬 서브넷 사용 여부True
vpc_idVPC IDe58348b1bc9148e5af86500fd4ef99ca

2.1.1.12 - Lock Baremetal

2.1.1.12.1 - 1.1

scpcli baremetal baremetal lock
--baremetal_id <value>

Description

Bare Metal Server Lock 활성화 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.12.2 - 1.0

scpcli baremetal baremetal lock
--baremetal_id <value>

Description

Bare Metal Server Lock 활성화 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.13 - Show Baremetal

2.1.1.13.1 - 1.1

scpcli baremetal baremetal show
--baremetal_id <value>

Description

Bare Metal Server 상세 조회 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
interface_nameInterface명ens8f1,bond_serv.2
local_subnet_id로컬 Subnet IDab313c43291e4b678f4bacffe10768ae
policy_local_subnet_ip로컬 Subnet IP192.168.0.1
stateLocal subnet IP의 상태CREATING
vlan_idVlan ID500
vni_role_nameVNI Role NamemgmtJ4dzQBo

2.1.1.13.2 - 1.0

scpcli baremetal baremetal show
--baremetal_id <value>

Description

Bare Metal Server 상세 조회 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
interface_nameInterface명ens8f1,bond_serv.2
local_subnet_id로컬 Subnet IDab313c43291e4b678f4bacffe10768ae
policy_local_subnet_ip로컬 Subnet IP192.168.0.1
stateLocal subnet IP의 상태CREATING
vlan_idVlan ID500
vni_role_nameVNI Role NamemgmtJ4dzQBo

2.1.1.14 - Start Baremetals

2.1.1.14.1 - 1.1

scpcli baremetal baremetal start
--bare_metal_server_ids <value>

Description

Bare Metal Server 시작(부팅) 요청 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bare_metal_server_ids
required
arrayBare Metal Server ID 리스트20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id자원 ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.14.2 - 1.0

scpcli baremetal baremetal start
--bare_metal_server_ids <value>

Description

Bare Metal Server 시작(부팅) 요청 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bare_metal_server_ids
required
arrayBare Metal Server ID 리스트20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id자원 ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.15 - Stop Baremetals

2.1.1.15.1 - 1.1

scpcli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Bare Metal Server 중지 요청 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bare_metal_server_ids
required
arrayBare Metal Server ID 리스트20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id자원 ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.15.2 - 1.0

scpcli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Bare Metal Server 중지 요청 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bare_metal_server_ids
required
arrayBare Metal Server ID 리스트20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id자원 ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.16 - Unlock Baremetal

2.1.1.16.1 - 1.1

scpcli baremetal baremetal unlock
--baremetal_id <value>

Description

Bare Metal Server Lock 해지 기능

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2.1.1.16.2 - 1.0

scpcli baremetal baremetal unlock
--baremetal_id <value>

Description

Bare Metal Server Lock 해지 기능

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2.2 - Cloud Functions

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Cloud Function 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1DEPRECATED20260430
1.2CURRENT-

2.2.1 - CLIs

2.2.1.1 - Approve PrivateLink Endpoint

2.2.1.1.1 - 1.2

scpcli scf privatelink-endpoint approve
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

PrivateLink Endpoint 승인

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
string타입APPROVE

2.2.1.2 - Check Function Name Duplication

2.2.1.2.1 - 1.2

scpcli scf cloud-function duplication show
--name <value>

Description

Cloud Function 이름 중복 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
name
required
string이름sample-function-name

Responses

NameDescriptionExample
result결과True

2.2.1.2.2 - 1.1

scpcli scf cloud-function duplication show
--name <value>

Description

Cloud Function 이름 중복 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
name
required
string이름sample-function-name

Responses

NameDescriptionExample
result결과True

2.2.1.2.3 - 1.0

scpcli scf cloud-function duplication show
--name <value>

Description

Cloud Function 이름 중복 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
string이름sample-function-name

Responses

NameDescriptionExample
result결과True

2.2.1.3 - Connect PrivateLink Endpoint

2.2.1.3.1 - 1.2

scpcli scf privatelink-endpoint connect
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

PrivateLink Endpoint 연결

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
string타입RECONNECT

2.2.1.4 - Create Cloud Function

2.2.1.4.1 - 1.2

scpcli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

Cloud Function 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
runtime
required
string런타임Node.js:20
name
required
string이름sample-function-name
content
required
string코드 내용sample
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
message설명Description
state함수 상태READY

2.2.1.4.2 - 1.1

scpcli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

Cloud Function 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
runtime
required
string런타임Node.js:20
name
required
string이름sample-function-name
content
required
string코드 내용sample
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
message설명Description
state함수 상태READY

2.2.1.4.3 - 1.0

scpcli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]

Description

Cloud Function 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
runtime
required
string런타임Node.js:20
name
required
string이름sample-function-name
content
required
string코드 내용sample
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
message설명Description
state함수 상태READY

2.2.1.5 - Create Cloud Function Apigateway Trigger

2.2.1.5.1 - 1.2

scpcli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

Cloud Function 트리거 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway 스테이지 이름sample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.5.2 - 1.1

scpcli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

Cloud Function 트리거 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway 스테이지 이름sample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.5.3 - 1.0

scpcli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>

Description

Cloud Function 트리거 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway 스테이지 이름sample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.6 - Create Cloud Function Cronjob Trigger

2.2.1.6.1 - 1.2

scpcli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

Cloud Function 트리거 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
timezone
required
string타임존Asia/Tokyo
schedule
required
string스케쥴* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.6.2 - 1.1

scpcli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

Cloud Function 트리거 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
timezone
required
string타임존Asia/Tokyo
schedule
required
string스케쥴* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.6.3 - 1.0

scpcli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

Cloud Function 트리거 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
timezone
required
string타임존Asia/Tokyo
schedule
required
string스케쥴* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.7 - Create PrivateLink Endpoint

2.2.1.7.1 - 1.2

scpcli scf privatelink-endpoint create
--cloud_function_id <value>
--service_id <value>
--alias <value>

Description

PrivateLink Endpoint 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
service_id
required
stringService Id8c9f6c1c928a45b4bbd1e4da5531d656
alias
required
stringAliassample

Responses

NameDescriptionExample
endpointEndpoint

2.2.1.8 - Delete Cloud Function

2.2.1.8.1 - 1.2

scpcli scf cloud-function delete
--cloud_function_id <value>

Description

Cloud Function 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.2.1.8.2 - 1.1

scpcli scf cloud-function delete
--cloud_function_id <value>

Description

Cloud Function 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.2.1.8.3 - 1.0

scpcli scf cloud-function delete
--cloud_function_id <value>

Description

Cloud Function 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.2.1.9 - Delete Cloud Function Trigger

2.2.1.9.1 - 1.2

scpcli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

Cloud Function 트리거 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
trigger_id
required
integer트리거 ID1
trigger_type
required
string트리거 타입apigateway
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.2.1.9.2 - 1.1

scpcli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

Cloud Function 트리거 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
trigger_id
required
integer트리거 ID1
trigger_type
required
string트리거 타입apigateway
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.2.1.9.3 - 1.0

scpcli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>

Description

Cloud Function 트리거 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
trigger_id
required
integer트리거 ID1
trigger_type
required
string트리거 타입apigateway
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.2.1.10 - Delete PrivateLink Endpoint

2.2.1.10.1 - 1.2

scpcli scf privatelink-endpoint delete
--endpoint_id <value>
--cloud_function_id <value>

Description

PrivateLink Endpoint 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.2.1.11 - List Cloud Function Triggers

2.2.1.11.1 - 1.2

scpcli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

Cloud Function 트리거 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
string트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
string트리거 타입apigateway

Responses

NameDescriptionExample
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.11.2 - 1.1

scpcli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

Cloud Function 트리거 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
string트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
string트리거 타입apigateway

Responses

NameDescriptionExample
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.11.3 - 1.0

scpcli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]

Description

Cloud Function 트리거 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
string트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
string트리거 타입apigateway

Responses

NameDescriptionExample
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.12 - List Cloud Functions

2.2.1.12.1 - 1.2

scpcli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

Cloud Function 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
string이름sample-function-name
state
optional
array함수 상태R
runtime
optional
array런타임N

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_id어카운트 ID617b3d0e90c24a5fa1f65a3824861354
created_at생성 시간2025-05-22T06:21:17.580522
function_url함수 URLhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions 이름sample
runtime런타임Node.js:20
state함수 상태READY
user_id사용자 ID617b3d0e90c24a5fa1f65a3824861354

2.2.1.12.2 - 1.1

scpcli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

Cloud Function 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
string이름sample-function-name
state
optional
array함수 상태R
runtime
optional
array런타임N

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_id어카운트 ID617b3d0e90c24a5fa1f65a3824861354
created_at생성 시간2025-05-22T06:21:17.580522
function_url함수 URLhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions 이름sample
runtime런타임Node.js:20
state함수 상태READY
user_id사용자 ID617b3d0e90c24a5fa1f65a3824861354

2.2.1.12.3 - 1.0

scpcli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]

Description

Cloud Function 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
string이름sample-function-name
state
optional
array함수 상태R
runtime
optional
array런타임N

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_id어카운트 ID617b3d0e90c24a5fa1f65a3824861354
created_at생성 시간2025-05-22T06:21:17.580522
function_url함수 URLhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions 이름sample
runtime런타임Node.js:20
state함수 상태READY
user_id사용자 ID617b3d0e90c24a5fa1f65a3824861354

2.2.1.13 - List Runtimes

2.2.1.13.1 - 1.2

scpcli scf cloud-function runtime list

Description

Runtime 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Responses

NameDescriptionExample
base_image_seq기본 이미지 번호3
name이름sample
version버전1.0.0

2.2.1.13.2 - 1.1

scpcli scf cloud-function runtime list

Description

Runtime 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Responses

NameDescriptionExample
base_image_seq기본 이미지 번호3
name이름sample
version버전1.0.0

2.2.1.13.3 - 1.0

scpcli scf cloud-function runtime list

Description

Runtime 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Responses

NameDescriptionExample
base_image_seq기본 이미지 번호3
name이름sample
version버전1.0.0

2.2.1.14 - List Sample Codes

2.2.1.14.1 - 1.2

scpcli scf cloud-function sample-codes show

Description

Sample 코드 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Responses

NameDescriptionExample
content코드 내용sample
default기본값False
description설명sample
name이름sample
runtime런타임Node.js:20
seq번호3
version버전sample

2.2.1.14.2 - 1.1

scpcli scf cloud-function sample-codes show

Description

Sample 코드 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Responses

NameDescriptionExample
content코드 내용sample
default기본값False
description설명sample
name이름sample
runtime런타임Node.js:20
seq번호3
version버전sample

2.2.1.14.3 - 1.0

scpcli scf cloud-function sample-codes show

Description

Sample 코드 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Responses

NameDescriptionExample
content코드 내용sample
default기본값False
description설명sample
name이름sample
runtime런타임Node.js:20
seq번호3
version버전sample

2.2.1.15 - Request PrivateLink Endpoint

2.2.1.15.1 - 1.2

scpcli scf privatelink-endpoint request
--endpoint_id <value>
--cloud_function_id <value>
--type <value>

Description

PrivateLink Endpoint 요청

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
string타입CANCEL

2.2.1.16 - Show Cloud Function

2.2.1.16.1 - 1.2

scpcli scf cloud-function show
--cloud_function_id <value>

Description

Cloud Function 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_id어카운트 ID617b3d0e90c24a5fa1f65a3824861354
function_url함수 URLhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions 이름sample
runtime런타임Node.js:20
state함수 상태READY
user_id사용자 ID617b3d0e90c24a5fa1f65a3824861354

2.2.1.16.2 - 1.1

scpcli scf cloud-function show
--cloud_function_id <value>

Description

Cloud Function 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_id어카운트 ID617b3d0e90c24a5fa1f65a3824861354
function_url함수 URLhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions 이름sample
runtime런타임Node.js:20
state함수 상태READY
user_id사용자 ID617b3d0e90c24a5fa1f65a3824861354

2.2.1.16.3 - 1.0

scpcli scf cloud-function show
--cloud_function_id <value>

Description

Cloud Function 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_id어카운트 ID617b3d0e90c24a5fa1f65a3824861354
function_url함수 URLhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions 이름sample
runtime런타임Node.js:20
state함수 상태READY
user_id사용자 ID617b3d0e90c24a5fa1f65a3824861354

2.2.1.17 - Show Cloud Function Code

2.2.1.17.1 - 1.2

scpcli scf cloud-function code show
--cloud_function_id <value>

Description

Cloud Function 코드 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_name클래스명com.example.Handler
code_text코드 내용ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_type코드 유형text
file_name파일명sample
file_transfer_status파일 전송 상태sample
file_upload_at파일 업로드 시간2025-05-17 00:23:17
method_name메소드명handleRequest
runtime런타임Node.js:20

2.2.1.17.2 - 1.1

scpcli scf cloud-function code show
--cloud_function_id <value>

Description

Cloud Function 코드 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_name클래스명com.example.Handler
code_text코드 내용ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_type코드 유형text
file_name파일명sample
file_transfer_status파일 전송 상태sample
file_upload_at파일 업로드 시간2025-05-17 00:23:17
method_name메소드명handleRequest
runtime런타임Node.js:20

2.2.1.17.3 - 1.0

scpcli scf cloud-function code show
--cloud_function_id <value>

Description

Cloud Function 코드 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_name클래스명com.example.Handler
code_text코드 내용ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_type코드 유형text
file_name파일명sample
file_transfer_status파일 전송 상태sample
file_upload_at파일 업로드 시간2025-05-17 00:23:17
method_name메소드명handleRequest
runtime런타임Node.js:20

2.2.1.18 - Show Cloud Function Configuration

2.2.1.18.1 - 1.2

scpcli scf cloud-function configuration show
--cloud_function_id <value>

Description

Cloud Function 구성 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
endpoint_aliasAliassample
endpoint_idEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
service_idService Id8c9f6c1c928a45b4bbd1e4da5531d656
state상태Active

2.2.1.18.2 - 1.1

scpcli scf cloud-function configuration show
--cloud_function_id <value>

Description

Cloud Function 구성 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
keysample
valuesample

2.2.1.18.3 - 1.0

scpcli scf cloud-function configuration show
--cloud_function_id <value>

Description

Cloud Function 구성 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
keysample
valuesample

2.2.1.19 - Show Cloud Function Logs

2.2.1.19.1 - 1.2

scpcli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

Cloud Function Log 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integer시간3
start
optional
string시작 일자20250517
end
optional
string종료 일자20250517

Responses

NameDescriptionExample
log로그[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST
time시간2025-05-17 00:23:17

2.2.1.19.2 - 1.1

scpcli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

Cloud Function Log 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integer시간3
start
optional
string시작 일자20250517
end
optional
string종료 일자20250517

Responses

NameDescriptionExample
log로그[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST
time시간2025-05-17 00:23:17

2.2.1.19.3 - 1.0

scpcli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

Cloud Function Log 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integer시간3
start
optional
string시작 일자20250517
end
optional
string종료 일자20250517

Responses

NameDescriptionExample
log로그[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST
time시간2025-05-17 00:23:17

2.2.1.20 - Show Cloud Function Metrics

2.2.1.20.1 - 1.2

scpcli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

Cloud Function Metric 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integer시간3
start
optional
string시작 일자20250517
end
optional
string종료 일자20250517

Responses

NameDescriptionExample
metric_dataMetric 데이터1.0033444816053512
time시간16:37

2.2.1.20.2 - 1.1

scpcli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

Cloud Function Metric 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integer시간3
start
optional
string시작 일자20250517
end
optional
string종료 일자20250517

Responses

NameDescriptionExample
metric_dataMetric 데이터1.0033444816053512
time시간16:37

2.2.1.20.3 - 1.0

scpcli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]

Description

Cloud Function Metric 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integer시간3
start
optional
string시작 일자20250517
end
optional
string종료 일자20250517

Responses

NameDescriptionExample
metric_dataMetric 데이터1.0033444816053512
time시간16:37

2.2.1.21 - Show Cloud Function Trigger

2.2.1.21.1 - 1.2

scpcli scf cloud-function trigger show
--trigger_id <value>

Description

Cloud Function 트리거 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
trigger_id
required
integer트리거 ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sid트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.21.2 - 1.1

scpcli scf cloud-function trigger show
--trigger_id <value>

Description

Cloud Function 트리거 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
trigger_id
required
integer트리거 ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sid트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.21.3 - 1.0

scpcli scf cloud-function trigger show
--trigger_id <value>

Description

Cloud Function 트리거 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
trigger_id
required
integer트리거 ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
schedule스케쥴* * * * 0
timezone타임존Asia/Tokyo
trigger_id트리거 ID1
trigger_name트리거 타입8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sid트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_id트리거 타겟 어카운트 ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srn트리거 타겟 SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuid트리거 타겟 UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type트리거 타입apigateway

2.2.1.22 - Update Cloud Function Code

2.2.1.22.1 - 1.2

scpcli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

Cloud Function 코드 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
string코드 내용print("Hello World")

2.2.1.22.2 - 1.1

scpcli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

Cloud Function 코드 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
string코드 내용print("Hello World")

2.2.1.22.3 - 1.0

scpcli scf cloud-function code set
--cloud_function_id <value>
--content <value>

Description

Cloud Function 코드 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
string코드 내용print("Hello World")

2.2.1.23 - Update Cloud Function Code File

2.2.1.23.1 - 1.2

scpcli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]

Description

Cloud Function 코드 파일 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
method_name
required
string메소드명handleRequest
class_name
required
string클래스명com.example.Handler
obs_url
optional
stringObject Storage URLhttps://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar

2.2.1.23.2 - 1.1

scpcli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]

Description

Cloud Function 코드 파일 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
method_name
required
string메소드명handleRequest
class_name
required
string클래스명com.example.Handler
obs_url
optional
stringObject Storage URLhttps://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar

2.2.1.24 - Update Cloud Function Config

2.2.1.24.1 - 1.2

scpcli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

Cloud Function 일반 구성 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integer제한 시간100
min_scale
required
integer최소 작업 수1
memory
required
integer메모리256
max_scale
required
integer최대 작업 수5

2.2.1.24.2 - 1.1

scpcli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

Cloud Function 일반 구성 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integer제한 시간100
min_scale
required
integer최소 작업 수1
memory
required
integer메모리256
max_scale
required
integer최대 작업 수5

2.2.1.24.3 - 1.0

scpcli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>

Description

Cloud Function 일반 구성 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integer제한 시간100
min_scale
required
integer최소 작업 수1
memory
required
integer메모리256
max_scale
required
integer최대 작업 수5

2.2.1.25 - Update Cloud Function Cronjob Trigger

2.2.1.25.1 - 1.2

scpcli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

Cloud Function 트리거 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
trigger_id
required
integer트리거 ID1
timezone
required
string타임존Asia/Tokyo
schedule
required
string스케쥴* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.2.1.25.2 - 1.1

scpcli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

Cloud Function 트리거 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
trigger_id
required
integer트리거 ID1
timezone
required
string타임존Asia/Tokyo
schedule
required
string스케쥴* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.2.1.25.3 - 1.0

scpcli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>

Description

Cloud Function 트리거 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
trigger_id
required
integer트리거 ID1
timezone
required
string타임존Asia/Tokyo
schedule
required
string스케쥴* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

2.2.1.26 - Update Cloud Function Url

2.2.1.26.1 - 1.2

scpcli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

Cloud Function 함수 URL 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL 사용True
public_ip_acl_enabled
required
booleanPublic IP 접근 제어 사용True
allow_ips
optional
array허용 IP-
auth_type
optional
string인증 유형NONE

2.2.1.26.2 - 1.1

scpcli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

Cloud Function 함수 URL 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL 사용True
public_ip_acl_enabled
required
booleanPublic IP 접근 제어 사용True
allow_ips
optional
array허용 IP-
auth_type
optional
string인증 유형NONE

2.2.1.26.3 - 1.0

scpcli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]

Description

Cloud Function 함수 URL 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL 사용True
public_ip_acl_enabled
required
booleanPublic IP 접근 제어 사용True
allow_ips
optional
array허용 IP-
auth_type
optional
string인증 유형NONE

2.2.1.27 - Update Cloud Function Variables

2.2.1.27.1 - 1.2

scpcli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

Cloud Function 환경 변수 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
array환경 변수'{"key": "sample", "value": "sample"}'

2.2.1.27.2 - 1.1

scpcli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

Cloud Function 환경 변수 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
array환경 변수'{"key": "sample", "value": "sample"}'

2.2.1.27.3 - 1.0

scpcli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>

Description

Cloud Function 환경 변수 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
array환경 변수'{"key": "sample", "value": "sample"}'

2.2.1.28 - Update PrivateLink Service

2.2.1.28.1 - 1.2

scpcli scf privatelink-service set
--cloud_function_id <value>
--privatelink_service_enabled <value>

Description

PrivateLink Service 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
privatelink_service_enabled
required
booleanPrivateLink Service 활성화True

2.3 - Virtual Server

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Virtual Server 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

2.3.1 - CLIs

2.3.1.1 - Accept a volume transfer

2.3.1.1.1 - 1.1

scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>

Description

Accept a volume transfer.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
transfer_id
required
stringTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_key
required
stringAuth keyf5972fdb456897eb

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
name볼륨명volume01
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.1.2 - 1.0

scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>

Description

Accept a volume transfer.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
transfer_id
required
stringTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_key
required
stringAuth keyf5972fdb456897eb

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
name볼륨명volume01
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.2 - Attach Virtual Server Security Group

2.3.1.2.1 - 1.0

scpcli virtualserver server add security group
--server_id <value>
--security_group_id <value>

Description

서버에 Security Group을 추가한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
security_group_id
required
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f

Responses

NameDescriptionExample

2.3.1.3 - Attach Volume to Virtual Server

2.3.1.3.1 - 1.1

scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]

Description

볼륨을 서버에 연결한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
delete_on_termination
optional
boolean해지 시 삭제False

Responses

NameDescriptionExample
delete_on_termination해지 시 삭제False
deviceDevice name/dev/vda
server_id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.3.2 - 1.0

scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]

Description

볼륨을 서버에 연결한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
delete_on_termination
optional
boolean해지 시 삭제False

Responses

NameDescriptionExample
delete_on_termination해지 시 삭제False
deviceDevice name/dev/vda
server_id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.4 - Create a snapshot

2.3.1.4.1 - 1.1

scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]

Description

Create a snapshot.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
name
required
string스냅샷명snapshot-1
description
optional
string설명description
force
optional
booleanForceTrue
metadata
optional
****Snapshot metadata-

Responses

NameDescriptionExample
id스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at생성일시2025-07-22T09:00:00Z
description설명description
metadataSnapshot metadata
name스냅샷명snapshot-1
size볼륨 크기104
status볼륨 상태available
updated_at수정일시2025-07-26T12:00:00Z
user_id사용자 ID570907805e5447be84b618450ef52o0t
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.4.2 - 1.0

scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]

Description

Create a snapshot.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
name
required
string스냅샷명snapshot-1
description
optional
string설명description
force
optional
booleanForceTrue
metadata
optional
****Snapshot metadata-

Responses

NameDescriptionExample
id스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at생성일시2025-07-22T09:00:00Z
description설명description
metadataSnapshot metadata
name스냅샷명snapshot-1
size볼륨 크기104
status볼륨 상태available
updated_at수정일시2025-07-26T12:00:00Z
user_id사용자 ID570907805e5447be84b618450ef52o0t
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.5 - Create a volume transfer

2.3.1.5.1 - 1.1

scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]

Description

Create a volume transfer.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
string볼륨명volume01

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_keyAuth keyf5972fdb456897eb
created_at생성일시
name볼륨명volume01
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.5.2 - 1.0

scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]

Description

Create a volume transfer.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
string볼륨명volume01

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_keyAuth keyf5972fdb456897eb
created_at생성일시
name볼륨명volume01
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.6 - Create Auto-Scaling Group

2.3.1.6.1 - 1.1

scpcli virtualserver auto scaling group create
--subnet_ids <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Auto-Scaling Group을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
subnet_ids
required
arraySubnet ID 목록-
server_name_prefix
required
string서버 이름 접두사server-name-prefix
name
required
stringAuto-Scaling Group 이름auto-scaling-group-name
min_server_count
required
integer최소 서버 수1
max_server_count
required
integer최대 서버 수2
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
desired_server_count_editable
required
boolean목표 서버 수 수정 가능 여부True
desired_server_count
required
integer목표 서버 수1
drain_enabled
optional
booleanDrain 사용 여부True
drain_timeout
optional
integerDrain timeout 값300
lb_server_groups
optional
arrayLB 서버 그룹 목록'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'
notifications
optional
arrayNotifications'{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}'
scaling_policies
optional
arrayScaling policy list'{"comparison_operator": "ge", "cooldown_seconds": 300, "evaluation_minutes": 1, "metric_method": "AVG", "metric_type": "CPU", "name": "policy-name", "scale_method": "AMOUNT", "scale_type": "SCALE_OUT", "scale_value": 10, "threshold": 60}'
security_group_ids
optional
arraySecurity Group ID 목록[
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idLB 서버 그룹 IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB 서버 그룹 포트8080

2.3.1.6.2 - 1.0

scpcli virtualserver auto scaling group create
--subnet_ids <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Auto-Scaling Group을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
subnet_ids
required
arraySubnet ID 목록-
server_name_prefix
required
string서버 이름 접두사server-name-prefix
name
required
stringAuto-Scaling Group 이름auto-scaling-group-name
min_server_count
required
integer최소 서버 수1
max_server_count
required
integer최대 서버 수2
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
desired_server_count_editable
required
boolean목표 서버 수 수정 가능 여부True
desired_server_count
required
integer목표 서버 수1
drain_enabled
optional
booleanDrain 사용 여부True
drain_timeout
optional
integerDrain timeout 값300
lb_server_groups
optional
arrayLB 서버 그룹 목록'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'
notifications
optional
arrayNotifications'{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}'
scaling_policies
optional
arrayScaling policy list'{"comparison_operator": "ge", "cooldown_seconds": 300, "evaluation_minutes": 1, "metric_method": "AVG", "metric_type": "CPU", "name": "policy-name", "scale_method": "AMOUNT", "scale_type": "SCALE_OUT", "scale_value": 10, "threshold": 60}'
security_group_ids
optional
arraySecurity Group ID 목록[
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idLB 서버 그룹 IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB 서버 그룹 포트8080

2.3.1.7 - Create Auto-Scaling Group Notification

2.3.1.7.1 - 1.1

scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>

Description

Auto-Scaling Group 알림을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
required
array사용자 ID 목록570907805e5447be84b618450ef52o0t
notification_events
required
arrayAuto-Scaling Group 알림 이벤트 목록SCALE_OUT

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group 알림 이벤트 목록[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group 알림 상태ACTIVE
user_id사용자 ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

2.3.1.7.2 - 1.0

scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>

Description

Auto-Scaling Group 알림을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
required
array사용자 ID 목록570907805e5447be84b618450ef52o0t
notification_events
required
arrayAuto-Scaling Group 알림 이벤트 목록SCALE_OUT

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group 알림 이벤트 목록[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group 알림 상태ACTIVE
user_id사용자 ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

2.3.1.8 - Create Auto-Scaling Group Policy

2.3.1.8.1 - 1.1

scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>

Description

Auto-Scaling Group 정책을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
threshold
required
integer임계값60
scale_value
required
integer스켕일 값10
scale_type
required
string스케일 유형SCALE_OUT
scale_method
required
string스케일 방법AMOUNT
name
required
string정책 이름policy-name
metric_type
required
string메트릭 유형CPU
metric_method
required
string메트릭 방법AVG
evaluation_minutes
required
integer평가 시간(분 단위)1
cooldown_seconds
required
integer쿨다운 시간(초 단위)300
comparison_operator
required
string비교 연산자ge

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator비교 연산자ge
cooldown_seconds쿨다운 시간(초 단위)300
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes평가 시간(분 단위)1
metric_method메트릭 방법AVG
metric_type메트릭 유형CPU
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name정책 이름policy-name
scale_method스케일 방법AMOUNT
scale_type스케일 유형SCALE_OUT
scale_value스켕일 값10
state정책 상태ACTIVE
threshold임계값60
threshold_unit임계값 단위%

2.3.1.8.2 - 1.0

scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>

Description

Auto-Scaling Group 정책을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
threshold
required
integer임계값60
scale_value
required
integer스켕일 값10
scale_type
required
string스케일 유형SCALE_OUT
scale_method
required
string스케일 방법AMOUNT
name
required
string정책 이름policy-name
metric_type
required
string메트릭 유형CPU
metric_method
required
string메트릭 방법AVG
evaluation_minutes
required
integer평가 시간(분 단위)1
cooldown_seconds
required
integer쿨다운 시간(초 단위)300
comparison_operator
required
string비교 연산자ge

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator비교 연산자ge
cooldown_seconds쿨다운 시간(초 단위)300
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes평가 시간(분 단위)1
metric_method메트릭 방법AVG
metric_type메트릭 유형CPU
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name정책 이름policy-name
scale_method스케일 방법AMOUNT
scale_type스케일 유형SCALE_OUT
scale_value스켕일 값10
state정책 상태ACTIVE
threshold임계값60
threshold_unit임계값 단위%

2.3.1.9 - Create Auto-Scaling Group Schedule

2.3.1.9.1 - 1.1

scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]

Description

Auto-Scaling Group 스케줄을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
timezone
required
string시간대Asia/Seoul
start_date
required
string시작 날짜2024-01-01
name
required
string스케쥴 이름schedulename
minute
required
integer0
hour
required
integer시간9
frequency
required
string빈도WEEKLY
day_of_month
optional
string-1,1
day_of_week
optional
string요일SU,SA
description
optional
string설명description
desired_server_count
optional
integer목표 서버 수1
end_date
optional
string종료 날짜2025-01-01
max_server_count
optional
integer최대 서버 수2
min_server_count
optional
integer최소 서버 수1
state
optional
string스케쥴 상태ACTIVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
day_of_month-1,1
day_of_week요일SU,SA
description설명description
desired_server_count목표 서버 수1
end_date종료 날짜2025-01-01
frequency빈도WEEKLY
hour시간9
max_server_count최대 서버 수2
min_server_count최소 서버 수1
minute0
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name스케쥴 이름schedulename
start_date시작 날짜2024-01-01
state스케쥴 상태ACTIVE
timezone시간대Asia/Seoul

2.3.1.9.2 - 1.0

scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]

Description

Auto-Scaling Group 스케줄을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
timezone
required
string시간대Asia/Seoul
start_date
required
string시작 날짜2024-01-01
name
required
string스케쥴 이름schedulename
minute
required
integer0
hour
required
integer시간9
frequency
required
string빈도WEEKLY
day_of_month
optional
string-1,1
day_of_week
optional
string요일SU,SA
description
optional
string설명description
desired_server_count
optional
integer목표 서버 수1
end_date
optional
string종료 날짜2025-01-01
max_server_count
optional
integer최대 서버 수2
min_server_count
optional
integer최소 서버 수1
state
optional
string스케쥴 상태ACTIVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
day_of_month-1,1
day_of_week요일SU,SA
description설명description
desired_server_count목표 서버 수1
end_date종료 날짜2025-01-01
frequency빈도WEEKLY
hour시간9
max_server_count최대 서버 수2
min_server_count최소 서버 수1
minute0
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name스케쥴 이름schedulename
start_date시작 날짜2024-01-01
state스케쥴 상태ACTIVE
timezone시간대Asia/Seoul

2.3.1.10 - Create Image

2.3.1.10.1 - 1.1

scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]

Description

이미지를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
url
required
stringObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
os_distro
required
stringOS 배포판alma
name
required
string이미지 이름imagename
container_format
optional
string컨테이너 형식bare
disk_format
optional
string디스크 형식qcow2
min_disk
optional
integer최소 디스크100
min_ram
optional
integer최소 RAM0
protected
optional
boolean보호False
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
visibility
optional
string가시성private

Responses

NameDescriptionExample
id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
checksum체크섬7538e0fcb56e0e272cfd89eb384d6613
container_format컨테이너 형식bare
created_at생성일시2025-07-22T09:00:00Z
disk_format디스크 형식qcow2
file파일/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk최소 디스크100
min_ram최소 RAM0
name이미지 이름imagename
os_distroOS 배포판alma
os_hash_algoOS 해시 알고리즘sha512
os_hash_valueOS 해시 값c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS 숨김 여부False
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_name소유 account 이름AccountName
owner_user_name소유자 이름user@samsung.com
protected보호False
root_device_name루트 디바이스 이름/dev/vda
scp_image_type이미지 타입custom
scp_k8s_versionK8S 버전v1.28.7
scp_original_image_type원본 이미지 타입standard
scp_os_build_versionOS 빌드 버전20250101
scp_os_versionOS 버전8.8
size크기2429747200
status상태active
updated_at수정일시2025-07-26T12:00:00Z
url이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size가상 크기17179869184
visibility가시성private
volumes볼륨[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

2.3.1.10.2 - 1.0

scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]

Description

이미지를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
url
required
stringObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
os_distro
required
stringOS 배포판alma
name
required
string이미지 이름imagename
container_format
optional
string컨테이너 형식bare
disk_format
optional
string디스크 형식qcow2
min_disk
optional
integer최소 디스크100
min_ram
optional
integer최소 RAM0
protected
optional
boolean보호False
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
visibility
optional
string가시성private

Responses

NameDescriptionExample
id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
checksum체크섬7538e0fcb56e0e272cfd89eb384d6613
container_format컨테이너 형식bare
created_at생성일시2025-07-22T09:00:00Z
disk_format디스크 형식qcow2
file파일/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk최소 디스크100
min_ram최소 RAM0
name이미지 이름imagename
os_distroOS 배포판alma
os_hash_algoOS 해시 알고리즘sha512
os_hash_valueOS 해시 값c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS 숨김 여부False
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_name소유 account 이름AccountName
owner_user_name소유자 이름user@samsung.com
protected보호False
root_device_name루트 디바이스 이름/dev/vda
scp_image_type이미지 타입custom
scp_k8s_versionK8S 버전v1.28.7
scp_original_image_type원본 이미지 타입standard
scp_os_build_versionOS 빌드 버전20250101
scp_os_versionOS 버전8.8
size크기2429747200
status상태active
updated_at수정일시2025-07-26T12:00:00Z
url이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size가상 크기17179869184
visibility가시성private
volumes볼륨[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

2.3.1.11 - Create Image member

2.3.1.11.1 - 1.1

scpcli virtualserver image add member
--image_id <value>
--member_id <value>

Description

이미지 멤버를 추가한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
member_id
required
string멤버 IDa8f10467abfc4b87b64614ab36eb9ae4

Responses

NameDescriptionExample
created_at생성일시2025-07-22T09:00:00Z
image_id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
member_id멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
status멤버 상태pending
updated_at수정일시2025-07-26T12:00:00Z

2.3.1.11.2 - 1.0

scpcli virtualserver image add member
--image_id <value>
--member_id <value>

Description

이미지 멤버를 추가한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
member_id
required
string멤버 IDa8f10467abfc4b87b64614ab36eb9ae4

Responses

NameDescriptionExample
created_at생성일시2025-07-22T09:00:00Z
image_id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
member_id멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
status멤버 상태pending
updated_at수정일시2025-07-26T12:00:00Z

2.3.1.12 - Create Keypair

2.3.1.12.1 - 1.1

scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]

Description

키페어를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
string키페어 이름keypairname
public_key
optional
stringPublic Keypublickey
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name키페어 이름keypairname
private_key비밀 키privatekey
public_keyPublic Keypublickey
type키페어 유형ssh

2.3.1.12.2 - 1.0

scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]

Description

키페어를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
string키페어 이름keypairname
public_key
optional
stringPublic Keypublickey
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name키페어 이름keypairname
private_key비밀 키privatekey
public_keyPublic Keypublickey
type키페어 유형ssh

2.3.1.13 - Create Launch Configuration

2.3.1.13.1 - 1.1

scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

Launch Configuration을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_type_id
required
string서버 타입 IDs1v1m2
name
required
stringLaunch Configuration 이름launch-configuration-name
keypair_name
required
string키페어 이름keypairname
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
string사용자 데이터IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
array볼륨'{"boot_index": 0, "size": 104, "type": "SSD"}'

Responses

NameDescriptionExample
boot_index부팅 장치를 시도하는 순서0
size볼륨 크기104
type볼륨 타입SSD

2.3.1.13.2 - 1.0

scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

Launch Configuration을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_type_id
required
string서버 타입 IDs1v1m2
name
required
stringLaunch Configuration 이름launch-configuration-name
keypair_name
required
string키페어 이름keypairname
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
string사용자 데이터IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
array볼륨'{"boot_index": 0, "size": 104, "type": "SSD"}'

Responses

NameDescriptionExample
boot_index부팅 장치를 시도하는 순서0
size볼륨 크기104
type볼륨 타입SSD

2.3.1.14 - Create Server Group

2.3.1.14.1 - 1.1

scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]

Description

서버 그룹을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
policy
required
string서버 그룹 정책anti-affinity
name
required
string서버 그룹 명server-group
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
id서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
members서버 그룹 멤버[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name서버 그룹 명server-group
partition_size파티션 사이즈3
policy서버 그룹 정책anti-affinity
user_id사용자 ID570907805e5447be84b618450ef52o0t

2.3.1.14.2 - 1.0

scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]

Description

서버 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
policy
required
string서버 그룹 정책anti-affinity
name
required
string서버 그룹 명server-group
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
id서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
members서버 그룹 멤버[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name서버 그룹 명server-group
partition_size파티션 사이즈3
policy서버 그룹 정책anti-affinity
user_id사용자 ID570907805e5447be84b618450ef52o0t

2.3.1.15 - Create Server Interface

2.3.1.15.1 - 1.1

scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]

Description

서버 인터페이스를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ips
optional
arrayFixed Ip list'{"ip_address": "192.169.3.2"}'
port_id
optional
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
subnet_id
optional
string서브넷 ID78b2ee3f074145c580ab6abac4821f97

Responses

NameDescriptionExample
ip_addressIP 주소192.169.3.2

2.3.1.15.2 - 1.0

scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]

Description

서버 인터페이스를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ips
optional
arrayFixed Ip list'{"ip_address": "192.169.3.2"}'
port_id
optional
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
subnet_id
optional
string서브넷 ID78b2ee3f074145c580ab6abac4821f97

Responses

NameDescriptionExample
ip_addressIP 주소192.169.3.2

2.3.1.16 - Create Server Interface Nat

2.3.1.16.1 - 1.1

scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>

Description

Create Server Interface Nat.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
publicip_id
required
string공개 IP ID615fa9cd5cff486c9de679b3ce63e601

Responses

NameDescriptionExample

2.3.1.16.2 - 1.0

scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>

Description

Create Server Interface Nat.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
publicip_id
required
string공개 IP ID615fa9cd5cff486c9de679b3ce63e601

Responses

NameDescriptionExample

2.3.1.17 - Create Server Interface Private Nat

2.3.1.17.1 - 1.1

scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Create Server Interface Private Nat.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_nat_ip_id
required
string비공개 NAT IP ID1f0cb5390c40483592ddc5a282f53496
private_nat_id
required
stringPrivate NAT ID3a6c1dc6b1b24e02a444d672c2798a1c

Responses

NameDescriptionExample

2.3.1.17.2 - 1.0

scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Create Server Interface Private Nat.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_nat_ip_id
required
string비공개 NAT IP ID1f0cb5390c40483592ddc5a282f53496
private_nat_id
required
stringPrivate NAT ID3a6c1dc6b1b24e02a444d672c2798a1c

Responses

NameDescriptionExample

2.3.1.18 - Create Server Volume

2.3.1.18.1 - 1.1

scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]

Description

서버 볼륨을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
string볼륨 ID-
delete_on_termination
optional
boolean해지 시 삭제False
device
optional
stringDevice name/dev/vda

Responses

NameDescriptionExample
id볼륨 연결 ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination해지 시 삭제False
deviceDevice name/dev/vda
server_id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.18.2 - 1.0

scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]

Description

서버 볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
string볼륨 ID-
delete_on_termination
optional
boolean해지 시 삭제False
device
optional
stringDevice name/dev/vda

Responses

NameDescriptionExample
id볼륨 연결 ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination해지 시 삭제False
deviceDevice name/dev/vda
server_id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.19 - Create Sharing Image

2.3.1.19.1 - 1.1

scpcli virtualserver sharing image create
--image_id <value>

Description

공유용 이미지를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample

2.3.1.19.2 - 1.0

scpcli virtualserver sharing image create
--image_id <value>

Description

공유용 이미지를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample

2.3.1.20 - Create Virtual Server

2.3.1.20.1 - 1.1

scpcli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

서버를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_type_id
required
string서버 타입 IDs1v1m2
networks
required
array네트워크 목록'{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}'
name
required
string서버 이름servername
keypair_name
required
string키페어 이름keypairname
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
lock
optional
boolean잠김 여부False
max_count
optional
integer최대 생성 개수2
metadata
optional
object메타 데이터-
partition_number
optional
integer파티션 넘버1
product_category
optional
****상품군compute
product_offering
optional
****상품virtual_server
security_groups
optional
arraySecurity Group 목록[
server_group_id
optional
string서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
string사용자 데이터IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
array볼륨'{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}'

Responses

NameDescriptionExample
id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.20.2 - 1.0

scpcli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]

Description

서버를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_type_id
required
string서버 타입 IDs1v1m2
networks
required
array네트워크 목록'{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}'
name
required
string서버 이름servername
keypair_name
required
string키페어 이름keypairname
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
lock
optional
boolean잠김 여부False
max_count
optional
integer최대 생성 개수2
metadata
optional
object메타 데이터-
partition_number
optional
integer파티션 넘버1
product_category
optional
****상품군compute
product_offering
optional
****상품virtual_server
security_groups
optional
arraySecurity Group 목록[
server_group_id
optional
string서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
string사용자 데이터IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
array볼륨'{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}'

Responses

NameDescriptionExample
id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.21 - Create Virtual Server Custom Image

2.3.1.21.1 - 1.1

scpcli virtualserver server image create
--server_id <value>
--image_name <value>

Description

서버 커스텀 이미지를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
image_name
required
string이미지 이름imagename

Responses

NameDescriptionExample
image_id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

2.3.1.21.2 - 1.0

scpcli virtualserver server image create
--server_id <value>
--image_name <value>

Description

서버 커스텀 이미지를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
image_name
required
string이미지 이름imagename

Responses

NameDescriptionExample
image_id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

2.3.1.22 - Create Virtual Server Dump

2.3.1.22.1 - 1.1

scpcli virtualserver server dump create
--server_id <value>

Description

서버 Dump를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.22.2 - 1.0

scpcli virtualserver server dump create
--server_id <value>

Description

서버 Dump를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.23 - Create Volume

2.3.1.23.1 - 1.1

scpcli virtualserver volume create
--size <value>
--name <value>
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]

Description

볼륨 생성을 요청한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
required
integer볼륨 크기104
name
required
string볼륨명volume01
snapshot_id
optional
string스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
volume_type
optional
string볼륨 타입SSD

Responses

NameDescriptionExample
id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_atThe time when the volume was attached to the server.
deviceDevice name/dev/vda

2.3.1.23.2 - 1.0

scpcli virtualserver volume create
--size <value>
--name <value>
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]

Description

볼륨 생성을 요청한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
required
integer볼륨 크기104
name
required
string볼륨명volume01
snapshot_id
optional
string스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
volume_type
optional
string볼륨 타입SSD

Responses

NameDescriptionExample
id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_atThe time when the volume was attached to the server.
deviceDevice name/dev/vda

2.3.1.24 - Delete a snapshot

2.3.1.24.1 - 1.1

scpcli virtualserver volume snapshot delete
--snapshot_id <value>

Description

Delete a snapshot.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

2.3.1.24.2 - 1.0

scpcli virtualserver volume snapshot delete
--snapshot_id <value>

Description

Delete a snapshot.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

2.3.1.25 - Delete a volume transfer

2.3.1.25.1 - 1.1

scpcli virtualserver volume transfer delete
--transfer_id <value>

Description

Delete a volume transfer.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
transfer_id
required
stringTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a

2.3.1.25.2 - 1.0

scpcli virtualserver volume transfer delete
--transfer_id <value>

Description

Delete a volume transfer.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
transfer_id
required
stringTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a

2.3.1.26 - Delete Auto-Scaling Group

2.3.1.26.1 - 1.1

scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>

Description

Auto-Scaling Group을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

2.3.1.26.2 - 1.0

scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>

Description

Auto-Scaling Group을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

2.3.1.27 - Delete Auto-Scaling Group Notification

2.3.1.27.1 - 1.1

scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group 알림을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
notification_id
required
string알림 IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

2.3.1.27.2 - 1.0

scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group 알림을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
notification_id
required
string알림 IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

2.3.1.28 - Delete Auto-Scaling Group Policy

2.3.1.28.1 - 1.1

scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group 정책을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
policy_id
required
string정책 ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

2.3.1.28.2 - 1.0

scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group 정책을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
policy_id
required
string정책 ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

2.3.1.29 - Delete Auto-Scaling Group Schedule

2.3.1.29.1 - 1.1

scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group 스케줄을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
schedule_id
required
string스케줄 ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

2.3.1.29.2 - 1.0

scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
schedule_id
required
string스케줄 ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

2.3.1.30 - Delete Image

2.3.1.30.1 - 1.1

scpcli virtualserver image delete
--image_id <value>

Description

이미지를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

2.3.1.30.2 - 1.0

scpcli virtualserver image delete
--image_id <value>

Description

이미지를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

2.3.1.31 - Delete Image member

2.3.1.31.1 - 1.1

scpcli virtualserver image remove member
--member_id <value>
--image_id <value>

Description

이미지 멤버를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
member_id
required
string멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

2.3.1.31.2 - 1.0

scpcli virtualserver image remove member
--member_id <value>
--image_id <value>

Description

이미지 멤버를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
member_id
required
string멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

2.3.1.32 - Delete Keypair

2.3.1.32.1 - 1.1

scpcli virtualserver keypair delete
--keypair_name <value>

Description

키페어를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
keypair_name
required
string키페어 이름keypairname

2.3.1.32.2 - 1.0

scpcli virtualserver keypair delete
--keypair_name <value>

Description

키페어를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
keypair_name
required
string키페어 이름keypairname

2.3.1.33 - Delete Launch Configuration

2.3.1.33.1 - 1.1

scpcli virtualserver launch configuration delete
--launch_configuration_id <value>

Description

Launch Configuration을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

2.3.1.33.2 - 1.0

scpcli virtualserver launch configuration delete
--launch_configuration_id <value>

Description

Launch Configuration을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

2.3.1.34 - Delete Server Group

2.3.1.34.1 - 1.1

scpcli virtualserver server group delete
--server_group_id <value>

Description

서버 그룹을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_group_id
required
string서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19

2.3.1.34.2 - 1.0

scpcli virtualserver server group delete
--server_group_id <value>

Description

서버 그룹을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_group_id
required
string서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19

2.3.1.35 - Delete Server Interface

2.3.1.35.1 - 1.1

scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>

Description

서버 인터페이스를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.35.2 - 1.0

scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>

Description

서버 인터페이스를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.36 - Delete Server Interface Nat

2.3.1.36.1 - 1.1

scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

서버 인터페이스 NAT를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.36.2 - 1.0

scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

서버 인터페이스 NAT를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.37 - Delete Server Interface Private Nat

2.3.1.37.1 - 1.1

scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

서버 인터페이스 Private NAT를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.37.2 - 1.0

scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>

Description

서버 인터페이스 Private NAT를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.38 - Delete Server Volume

2.3.1.38.1 - 1.1

scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>

Description

서버 볼륨을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.38.2 - 1.0

scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>

Description

서버 볼륨을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.39 - Delete Virtual Server

2.3.1.39.1 - 1.1

scpcli virtualserver server delete
--server_id <value>

Description

서버를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.39.2 - 1.0

scpcli virtualserver server delete
--server_id <value>

Description

서버를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.40 - Delete Volume

2.3.1.40.1 - 1.1

scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]

Description

볼륨 삭제를 요청한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
cascade
optional
boolean스냅샷 삭제 여부True

2.3.1.40.2 - 1.0

scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]

Description

볼륨 삭제를 요청한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
cascade
optional
boolean스냅샷 삭제 여부True

2.3.1.41 - Detach Virtual Server Security Group

2.3.1.41.1 - 1.0

scpcli virtualserver server remove security group
--security_group_id <value>
--server_id <value>

Description

서버에서 Security Group을 해제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.42 - Detach Volume from Virtual Server

2.3.1.42.1 - 1.1

scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>

Description

볼륨을 서버에서 연결 해제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.42.2 - 1.0

scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>

Description

볼륨을 서버에서 연결 해제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.43 - Extend Volume

2.3.1.43.1 - 1.1

scpcli virtualserver volume resize
--volume_id <value>
--size <value>

Description

볼륨 용량을 증설 요청한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
size
required
integer볼륨 크기104

2.3.1.43.2 - 1.0

scpcli virtualserver volume resize
--volume_id <value>
--size <value>

Description

볼륨 용량을 증설 요청한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
size
required
integer볼륨 크기104

2.3.1.44 - Get region's maximum partition size.

2.3.1.44.1 - 1.1

scpcli virtualserver server group maximum partition size

Description

해당 리전의 최대 파티션 사이즈를 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
partition_size

2.3.1.44.2 - 1.0

scpcli virtualserver server group maximum partition size

Description

해당 리전의 최대 파티션 사이즈를 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Responses

NameDescriptionExample
partition_size

2.3.1.45 - Import Image

2.3.1.45.1 - 1.1

scpcli virtualserver image import
--image_id <value>
--url <value>

Description

이미지 파일을 추가한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
url
required
stringObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2

Responses

NameDescriptionExample

2.3.1.45.2 - 1.0

scpcli virtualserver image import
--image_id <value>
--url <value>

Description

이미지 파일을 추가한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
url
required
stringObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2

Responses

NameDescriptionExample

2.3.1.46 - List Auto-Scaling Group LB Server Groups

2.3.1.46.1 - 1.1

scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

Auto-Scaling Group LB 서버 그룹 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
offset
optional
integer목록에서 시작할 지점의 인덱스0
limit
optional
integer페이지 항목 개수20
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 서버 그룹 이름lb-server-group-name
portLB 서버 그룹 포트8080

2.3.1.46.2 - 1.0

scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

Auto-Scaling Group LB 서버 그룹 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
offset
optional
integer목록에서 시작할 지점의 인덱스0
limit
optional
integer페이지 항목 개수20
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 서버 그룹 이름lb-server-group-name
portLB 서버 그룹 포트8080

2.3.1.47 - List Auto-Scaling Group Notifications

2.3.1.47.1 - 1.1

scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

Auto-Scaling Group 알림 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
optional
array사용자 ID 목록570907805e5447be84b618450ef52o0t
notification_state
optional
stringAuto-Scaling Group 알림 상태ACTIVE
notification_event
optional
stringAuto-Scaling Group 알림 이벤트SCALE_OUT
offset
optional
integer목록에서 시작할 지점의 인덱스0
limit
optional
integer페이지 항목 개수20
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group 알림 이벤트 목록[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group 알림 상태ACTIVE
user_id사용자 ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

2.3.1.47.2 - 1.0

scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

Auto-Scaling Group 알림 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
optional
array사용자 ID 목록570907805e5447be84b618450ef52o0t
notification_state
optional
stringAuto-Scaling Group 알림 상태ACTIVE
notification_event
optional
stringAuto-Scaling Group 알림 이벤트SCALE_OUT
offset
optional
integer목록에서 시작할 지점의 인덱스0
limit
optional
integer페이지 항목 개수20
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group 알림 이벤트 목록[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group 알림 상태ACTIVE
user_id사용자 ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

2.3.1.48 - List Auto-Scaling Group Policies

2.3.1.48.1 - 1.1

scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

Auto-Scaling Group 정책 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
name
optional
string정책 이름policy-name
metric_method
optional
****메트릭 방법AVG
metric_type
optional
string메트릭 유형CPU
scale_type
optional
****스케일 유형SCALE_OUT
offset
optional
integer목록에서 시작할 지점의 인덱스0
limit
optional
integer페이지 항목 개수20
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator비교 연산자ge
cooldown_seconds쿨다운 시간(초 단위)300
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes평가 시간(분 단위)1
metric_method메트릭 방법AVG
metric_type메트릭 유형CPU
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name정책 이름policy-name
scale_method스케일 방법AMOUNT
scale_type스케일 유형SCALE_OUT
scale_value스켕일 값10
state정책 상태ACTIVE
threshold임계값60
threshold_unit임계값 단위%

2.3.1.48.2 - 1.0

scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]

Description

Auto-Scaling Group 정책 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
name
optional
string정책 이름policy-name
metric_method
optional
****메트릭 방법AVG
metric_type
optional
string메트릭 유형CPU
scale_type
optional
****스케일 유형SCALE_OUT
offset
optional
integer목록에서 시작할 지점의 인덱스0
limit
optional
integer페이지 항목 개수20
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator비교 연산자ge
cooldown_seconds쿨다운 시간(초 단위)300
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes평가 시간(분 단위)1
metric_method메트릭 방법AVG
metric_type메트릭 유형CPU
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name정책 이름policy-name
scale_method스케일 방법AMOUNT
scale_type스케일 유형SCALE_OUT
scale_value스켕일 값10
state정책 상태ACTIVE
threshold임계값60
threshold_unit임계값 단위%

2.3.1.49 - List Auto-Scaling Group Schedules

2.3.1.49.1 - 1.1

scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]

Description

Auto-Scaling Group 스케줄 목록을 조회한다..

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
frequency
optional
****빈도WEEKLY

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
day_of_month-1,1
day_of_week요일SU,SA
description설명description
desired_server_count목표 서버 수1
end_date종료 날짜2025-01-01
frequency빈도WEEKLY
hour시간9
max_server_count최대 서버 수2
min_server_count최소 서버 수1
minute0
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name스케쥴 이름schedulename
start_date시작 날짜2024-01-01
state스케쥴 상태ACTIVE
timezone시간대Asia/Seoul

2.3.1.49.2 - 1.0

scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]

Description

Auto-Scaling Group 스케줄 목록을 조회한다..

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
frequency
optional
****빈도WEEKLY

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
day_of_month-1,1
day_of_week요일SU,SA
description설명description
desired_server_count목표 서버 수1
end_date종료 날짜2025-01-01
frequency빈도WEEKLY
hour시간9
max_server_count최대 서버 수2
min_server_count최소 서버 수1
minute0
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name스케쥴 이름schedulename
start_date시작 날짜2024-01-01
state스케쥴 상태ACTIVE
timezone시간대Asia/Seoul

2.3.1.50 - List Auto-Scaling Group Virtual Servers

2.3.1.50.1 - 1.1

scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]

Description

Auto-Scaling Group Virtual Server 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
limit
optional
integer페이지 항목 개수20
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
addresses주소 목록
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_at생성일시
created_by생성자 ID97e6b22c9a4143789ca522df7457a32f
disk_config디스크 컨피그MANUAL
image_id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceMarketplace 여부False
keypair_name키페어 이름keypairname
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
lb_linked_stateLoad Balancer 연결 상태ATTACHED
locked잠김 여부False
metadata메타 데이터
modified_at수정일시
name서버 이름servername
partition_number파티션 넘버1
planned_compute_os_typePlanned Compute OS 유형windows
product_category상품군compute
product_offering상품virtual_server
security_groupsSecurity Group 목록
server_group_id서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19
server_type서버 타입
state서버 상태ACTIVE
volumes볼륨
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

2.3.1.50.2 - 1.0

scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]

Description

Auto-Scaling Group Virtual Server 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
limit
optional
integer페이지 항목 개수20
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
addresses주소 목록
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_at생성일시
created_by생성자 ID97e6b22c9a4143789ca522df7457a32f
disk_config디스크 컨피그MANUAL
image_id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceMarketplace 여부False
keypair_name키페어 이름keypairname
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
lb_linked_stateLoad Balancer 연결 상태ATTACHED
locked잠김 여부False
metadata메타 데이터
modified_at수정일시
name서버 이름servername
partition_number파티션 넘버1
planned_compute_os_typePlanned Compute OS 유형windows
product_category상품군compute
product_offering상품virtual_server
security_groupsSecurity Group 목록
server_group_id서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19
server_type서버 타입
state서버 상태ACTIVE
volumes볼륨
vpc_idVPC IDcc976b621087484ea5fd527f4b78708b

2.3.1.51 - List Auto-Scaling Groups

2.3.1.51.1 - 1.1

scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

Description

Auto-Scaling Group 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
optional
stringAuto-Scaling Group 이름auto-scaling-group-name
state
optional
stringAuto-Scaling Group 상태IN_SERVICE
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_name
optional
stringLaunch Configuration 이름launch-configuration-name
lb_server_group_id
optional
stringLB 서버 그룹 IDd06e87d3-ca9a-461b-8e88-077a542a7335
security_group_id
optional
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f
subnet_id
optional
string서브넷 ID78b2ee3f074145c580ab6abac4821f97
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
created_by
optional
string생성자 ID97e6b22c9a4143789ca522df7457a32f
offset
optional
integer목록에서 시작할 지점의 인덱스0
limit
optional
integer페이지 항목 개수20
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
created_at생성 시간
--long 옵션 사용 필요
2024-05-17T00:23:17Z
created_by생성자
--long 옵션 사용 필요
90dddfc2b1e04edba54ba2b41539a9ac
desired_server_count목표 서버 수1
desired_server_count_editable목표 서버 수 수정 가능 여부
--long 옵션 사용 필요
True
drain_enabledDrain 사용 여부
--long 옵션 사용 필요
True
drain_timeoutDrain timeout 값
--long 옵션 사용 필요
300
launch_configuration_idLaunch Configuration ID
--long 옵션 사용 필요
b5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration 이름launch-configuration-name
lb_server_groupsLB 서버 그룹 목록
--long 옵션 사용 필요
max_server_count최대 서버 수2
min_server_count최소 서버 수1
modified_at수정 시간
--long 옵션 사용 필요
2024-05-17T00:23:17Z
modified_by수정자
--long 옵션 사용 필요
90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group 이름auto-scaling-group-name
security_group_idsSecurity Group ID 목록
--long 옵션 사용 필요
[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefix서버 이름 접두사
--long 옵션 사용 필요
server-name-prefix
stateAuto-Scaling Group 상태IN_SERVICE
subnet_idsSubnet ID 목록
--long 옵션 사용 필요
vpc_idVPC ID
--long 옵션 사용 필요
cc976b621087484ea5fd527f4b78708b

2.3.1.51.2 - 1.0

scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

Description

Auto-Scaling Group 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
stringAuto-Scaling Group 이름auto-scaling-group-name
state
optional
stringAuto-Scaling Group 상태IN_SERVICE
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_name
optional
stringLaunch Configuration 이름launch-configuration-name
lb_server_group_id
optional
stringLB 서버 그룹 IDd06e87d3-ca9a-461b-8e88-077a542a7335
security_group_id
optional
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f
subnet_id
optional
string서브넷 ID78b2ee3f074145c580ab6abac4821f97
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
created_by
optional
string생성자 ID97e6b22c9a4143789ca522df7457a32f
offset
optional
integer목록에서 시작할 지점의 인덱스0
limit
optional
integer페이지 항목 개수20
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
created_at생성 시간
--long 옵션 사용 필요
2024-05-17T00:23:17Z
created_by생성자
--long 옵션 사용 필요
90dddfc2b1e04edba54ba2b41539a9ac
desired_server_count목표 서버 수1
desired_server_count_editable목표 서버 수 수정 가능 여부
--long 옵션 사용 필요
True
drain_enabledDrain 사용 여부
--long 옵션 사용 필요
True
drain_timeoutDrain timeout 값
--long 옵션 사용 필요
300
launch_configuration_idLaunch Configuration ID
--long 옵션 사용 필요
b5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration 이름launch-configuration-name
lb_server_groupsLB 서버 그룹 목록
--long 옵션 사용 필요
max_server_count최대 서버 수2
min_server_count최소 서버 수1
modified_at수정 시간
--long 옵션 사용 필요
2024-05-17T00:23:17Z
modified_by수정자
--long 옵션 사용 필요
90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group 이름auto-scaling-group-name
security_group_idsSecurity Group ID 목록
--long 옵션 사용 필요
[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefix서버 이름 접두사
--long 옵션 사용 필요
server-name-prefix
stateAuto-Scaling Group 상태IN_SERVICE
subnet_idsSubnet ID 목록
--long 옵션 사용 필요
vpc_idVPC ID
--long 옵션 사용 필요
cc976b621087484ea5fd527f4b78708b

2.3.1.52 - List Default Configs

2.3.1.52.1 - 1.1

scpcli virtualserver default config list
[--name <value>]
[--category <value>]

Description

기본 설정 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
optional
string이름key
category
optional
string분류AUTO_SCALING_GROUP

Responses

NameDescriptionExample
configs설정 값(‘key’: ‘value’}
countcount20

2.3.1.52.2 - 1.0

scpcli virtualserver default config list
[--name <value>]
[--category <value>]

Description

기본 설정 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
string이름key
category
optional
string분류AUTO_SCALING_GROUP

Responses

NameDescriptionExample
configs설정 값(‘key’: ‘value’}
countcount20

2.3.1.53 - List Image members

2.3.1.53.1 - 1.1

scpcli virtualserver image member list
--image_id <value>

Description

이미지 멤버 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_at생성일시2025-07-22T09:00:00Z
image_id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
member_id멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
status멤버 상태pending
updated_at수정일시2025-07-26T12:00:00Z

2.3.1.53.2 - 1.0

scpcli virtualserver image member list
--image_id <value>

Description

이미지 멤버 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_at생성일시2025-07-22T09:00:00Z
image_id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
member_id멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
status멤버 상태pending
updated_at수정일시2025-07-26T12:00:00Z

2.3.1.54 - List Images

2.3.1.54.1 - 1.1

scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]

Description

이미지 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지 항목 개수20
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
scp_image_type
optional
string이미지 타입custom
scp_original_image_type
optional
string원본 이미지 타입standard
name
optional
string이미지 이름imagename
os_distro
optional
stringOS 배포판alma
status
optional
string상태active
visibility
optional
****가시성private
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
checksum체크섬
--long 옵션 사용 필요
7538e0fcb56e0e272cfd89eb384d6613
container_format컨테이너 형식
--long 옵션 사용 필요
bare
created_at생성일시2025-07-22T09:00:00Z
disk_format디스크 형식
--long 옵션 사용 필요
qcow2
file파일
--long 옵션 사용 필요
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk최소 디스크
--long 옵션 사용 필요
100
min_ram최소 RAM
--long 옵션 사용 필요
0
name이미지 이름imagename
os_distroOS 배포판alma
os_hash_algoOS 해시 알고리즘
--long 옵션 사용 필요
sha512
os_hash_valueOS 해시 값
--long 옵션 사용 필요
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS 숨김 여부
--long 옵션 사용 필요
False
ownerOwner account ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name소유 account 이름
--long 옵션 사용 필요
AccountName
owner_user_name소유자 이름
--long 옵션 사용 필요
user@samsung.com
protected보호
--long 옵션 사용 필요
False
root_device_name루트 디바이스 이름
--long 옵션 사용 필요
/dev/vda
scp_image_type이미지 타입
--long 옵션 사용 필요
custom
scp_k8s_versionK8S 버전
--long 옵션 사용 필요
v1.28.7
scp_original_image_type원본 이미지 타입
--long 옵션 사용 필요
standard
scp_os_build_versionOS 빌드 버전
--long 옵션 사용 필요
20250101
scp_os_versionOS 버전
--long 옵션 사용 필요
8.8
size크기
--long 옵션 사용 필요
2429747200
status상태
--long 옵션 사용 필요
active
updated_at수정일시
--long 옵션 사용 필요
2025-07-26T12:00:00Z
url이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용)
--long 옵션 사용 필요
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size가상 크기
--long 옵션 사용 필요
17179869184
visibility가시성private
volumes볼륨
--long 옵션 사용 필요
[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

2.3.1.54.2 - 1.0

scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]

Description

이미지 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지 항목 개수20
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
scp_image_type
optional
string이미지 타입custom
scp_original_image_type
optional
string원본 이미지 타입standard
name
optional
string이미지 이름imagename
os_distro
optional
stringOS 배포판alma
status
optional
string상태active
visibility
optional
****가시성private
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
checksum체크섬
--long 옵션 사용 필요
7538e0fcb56e0e272cfd89eb384d6613
container_format컨테이너 형식
--long 옵션 사용 필요
bare
created_at생성일시2025-07-22T09:00:00Z
disk_format디스크 형식
--long 옵션 사용 필요
qcow2
file파일
--long 옵션 사용 필요
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk최소 디스크
--long 옵션 사용 필요
100
min_ram최소 RAM
--long 옵션 사용 필요
0
name이미지 이름imagename
os_distroOS 배포판alma
os_hash_algoOS 해시 알고리즘
--long 옵션 사용 필요
sha512
os_hash_valueOS 해시 값
--long 옵션 사용 필요
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS 숨김 여부
--long 옵션 사용 필요
False
ownerOwner account ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name소유 account 이름
--long 옵션 사용 필요
AccountName
owner_user_name소유자 이름
--long 옵션 사용 필요
user@samsung.com
protected보호
--long 옵션 사용 필요
False
root_device_name루트 디바이스 이름
--long 옵션 사용 필요
/dev/vda
scp_image_type이미지 타입
--long 옵션 사용 필요
custom
scp_k8s_versionK8S 버전
--long 옵션 사용 필요
v1.28.7
scp_original_image_type원본 이미지 타입
--long 옵션 사용 필요
standard
scp_os_build_versionOS 빌드 버전
--long 옵션 사용 필요
20250101
scp_os_versionOS 버전
--long 옵션 사용 필요
8.8
size크기
--long 옵션 사용 필요
2429747200
status상태
--long 옵션 사용 필요
active
updated_at수정일시
--long 옵션 사용 필요
2025-07-26T12:00:00Z
url이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용)
--long 옵션 사용 필요
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size가상 크기
--long 옵션 사용 필요
17179869184
visibility가시성private
volumes볼륨
--long 옵션 사용 필요
[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

2.3.1.55 - List Keypairs

2.3.1.55.1 - 1.1

scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]

Description

키페어 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지 항목 개수20
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name키페어 이름keypairname
public_keyPublic Key
--long 옵션 사용 필요
publickey
type키페어 유형ssh

2.3.1.55.2 - 1.0

scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]

Description

키페어 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지 항목 개수20
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name키페어 이름keypairname
public_keyPublic Key
--long 옵션 사용 필요
publickey
type키페어 유형ssh

2.3.1.56 - List Launch Configurations

2.3.1.56.1 - 1.1

scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

Description

Launch Configuration 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
optional
stringLaunch Configuration 이름launch-configuration-name
image_id
optional
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
offset
optional
integer목록에서 시작할 지점의 인덱스-
limit
optional
integer페이지 항목 개수-
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countLaunch Configuration에 연결된 Auto-Scaling Group 수1
boot_disk_size기본 볼륨 크기
--long 옵션 사용 필요
104
created_at생성 시간
--long 옵션 사용 필요
2024-05-17T00:23:17Z
created_by생성자
--long 옵션 사용 필요
90dddfc2b1e04edba54ba2b41539a9ac
extra_disk_size추가 볼륨 크기
--long 옵션 사용 필요
104
image_id이미지 ID
--long 옵션 사용 필요
70a599e0-31e7-49b7-b260-868f441e862b
image_name이미지 이름imagename
keypair_name키페어 이름
--long 옵션 사용 필요
keypairname
modified_at수정 시간
--long 옵션 사용 필요
2024-05-17T00:23:17Z
modified_by수정자
--long 옵션 사용 필요
90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration 이름launch-configuration-name
public_keyPublic Key
--long 옵션 사용 필요
publickey
server_type_id서버 타입 IDs1v1m2
stateLaunch Configuration 상태
--long 옵션 사용 필요
ACTIVE
user_data사용자 데이터
--long 옵션 사용 필요
IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes볼륨

2.3.1.56.2 - 1.0

scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]

Description

Launch Configuration 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
stringLaunch Configuration 이름launch-configuration-name
image_id
optional
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
offset
optional
integer목록에서 시작할 지점의 인덱스-
limit
optional
integer페이지 항목 개수-
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countLaunch Configuration에 연결된 Auto-Scaling Group 수1
boot_disk_size기본 볼륨 크기
--long 옵션 사용 필요
104
created_at생성 시간
--long 옵션 사용 필요
2024-05-17T00:23:17Z
created_by생성자
--long 옵션 사용 필요
90dddfc2b1e04edba54ba2b41539a9ac
extra_disk_size추가 볼륨 크기
--long 옵션 사용 필요
104
image_id이미지 ID
--long 옵션 사용 필요
70a599e0-31e7-49b7-b260-868f441e862b
image_name이미지 이름imagename
keypair_name키페어 이름
--long 옵션 사용 필요
keypairname
modified_at수정 시간
--long 옵션 사용 필요
2024-05-17T00:23:17Z
modified_by수정자
--long 옵션 사용 필요
90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration 이름launch-configuration-name
public_keyPublic Key
--long 옵션 사용 필요
publickey
server_type_id서버 타입 IDs1v1m2
stateLaunch Configuration 상태
--long 옵션 사용 필요
ACTIVE
user_data사용자 데이터
--long 옵션 사용 필요
IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes볼륨

2.3.1.57 - List pending Images

2.3.1.57.1 - 1.1

scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]

Description

공유 대기 중인 이미지 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
scp_image_type
optional
string이미지 타입custom
scp_original_image_type
optional
string원본 이미지 타입standard

Responses

NameDescriptionExample
id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
checksum체크섬
--long 옵션 사용 필요
7538e0fcb56e0e272cfd89eb384d6613
container_format컨테이너 형식
--long 옵션 사용 필요
bare
created_at생성일시2025-07-22T09:00:00Z
disk_format디스크 형식
--long 옵션 사용 필요
qcow2
file파일
--long 옵션 사용 필요
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk최소 디스크
--long 옵션 사용 필요
100
min_ram최소 RAM
--long 옵션 사용 필요
0
name이미지 이름imagename
os_distroOS 배포판alma
os_hash_algoOS 해시 알고리즘
--long 옵션 사용 필요
sha512
os_hash_valueOS 해시 값
--long 옵션 사용 필요
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS 숨김 여부
--long 옵션 사용 필요
False
ownerOwner account ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name소유 account 이름
--long 옵션 사용 필요
AccountName
owner_user_name소유자 이름
--long 옵션 사용 필요
user@samsung.com
protected보호
--long 옵션 사용 필요
False
root_device_name루트 디바이스 이름
--long 옵션 사용 필요
/dev/vda
scp_image_type이미지 타입
--long 옵션 사용 필요
custom
scp_k8s_versionK8S 버전
--long 옵션 사용 필요
v1.28.7
scp_original_image_type원본 이미지 타입
--long 옵션 사용 필요
standard
scp_os_build_versionOS 빌드 버전
--long 옵션 사용 필요
20250101
scp_os_versionOS 버전
--long 옵션 사용 필요
8.8
size크기
--long 옵션 사용 필요
2429747200
status상태
--long 옵션 사용 필요
active
updated_at수정일시
--long 옵션 사용 필요
2025-07-26T12:00:00Z
url이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용)
--long 옵션 사용 필요
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size가상 크기
--long 옵션 사용 필요
17179869184
visibility가시성private
volumes볼륨
--long 옵션 사용 필요
[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

2.3.1.57.2 - 1.0

scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]

Description

공유 대기 중인 이미지 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
scp_image_type
optional
string이미지 타입custom
scp_original_image_type
optional
string원본 이미지 타입standard

Responses

NameDescriptionExample
id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
checksum체크섬
--long 옵션 사용 필요
7538e0fcb56e0e272cfd89eb384d6613
container_format컨테이너 형식
--long 옵션 사용 필요
bare
created_at생성일시2025-07-22T09:00:00Z
disk_format디스크 형식
--long 옵션 사용 필요
qcow2
file파일
--long 옵션 사용 필요
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk최소 디스크
--long 옵션 사용 필요
100
min_ram최소 RAM
--long 옵션 사용 필요
0
name이미지 이름imagename
os_distroOS 배포판alma
os_hash_algoOS 해시 알고리즘
--long 옵션 사용 필요
sha512
os_hash_valueOS 해시 값
--long 옵션 사용 필요
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS 숨김 여부
--long 옵션 사용 필요
False
ownerOwner account ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_name소유 account 이름
--long 옵션 사용 필요
AccountName
owner_user_name소유자 이름
--long 옵션 사용 필요
user@samsung.com
protected보호
--long 옵션 사용 필요
False
root_device_name루트 디바이스 이름
--long 옵션 사용 필요
/dev/vda
scp_image_type이미지 타입
--long 옵션 사용 필요
custom
scp_k8s_versionK8S 버전
--long 옵션 사용 필요
v1.28.7
scp_original_image_type원본 이미지 타입
--long 옵션 사용 필요
standard
scp_os_build_versionOS 빌드 버전
--long 옵션 사용 필요
20250101
scp_os_versionOS 버전
--long 옵션 사용 필요
8.8
size크기
--long 옵션 사용 필요
2429747200
status상태
--long 옵션 사용 필요
active
updated_at수정일시
--long 옵션 사용 필요
2025-07-26T12:00:00Z
url이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용)
--long 옵션 사용 필요
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size가상 크기
--long 옵션 사용 필요
17179869184
visibility가시성private
volumes볼륨
--long 옵션 사용 필요
[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

2.3.1.58 - List Server Groups

2.3.1.58.1 - 1.1

scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]

Description

서버 그룹 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지 항목 개수20
offset
optional
integer목록에서 시작할 지점의 인덱스0

Responses

NameDescriptionExample
id서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_id계정 ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
members서버 그룹 멤버
--long 옵션 사용 필요
[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name서버 그룹 명server-group
partition_size파티션 사이즈
--long 옵션 사용 필요
3
policy서버 그룹 정책anti-affinity
user_id사용자 ID
--long 옵션 사용 필요
570907805e5447be84b618450ef52o0t

2.3.1.58.2 - 1.0

scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]

Description

서버 그룹 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지 항목 개수20
offset
optional
integer목록에서 시작할 지점의 인덱스0

Responses

NameDescriptionExample
id서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_id계정 ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
members서버 그룹 멤버
--long 옵션 사용 필요
[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name서버 그룹 명server-group
partition_size파티션 사이즈
--long 옵션 사용 필요
3
policy서버 그룹 정책anti-affinity
user_id사용자 ID
--long 옵션 사용 필요
570907805e5447be84b618450ef52o0t

2.3.1.59 - List Server Interfaces

2.3.1.59.1 - 1.1

scpcli virtualserver server interface list
--server_id <value>

Description

서버 인터페이스 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed Ip list
mac_addrMAC 주소fa:16:3e:c0:71:2b
port_id포트 IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_id서브넷 ID183c6c30df0c4fcbb16422aa2d64aa21

2.3.1.59.2 - 1.0

scpcli virtualserver server interface list
--server_id <value>

Description

서버 인터페이스 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed Ip list
mac_addrMAC 주소fa:16:3e:c0:71:2b
port_id포트 IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_id서브넷 ID183c6c30df0c4fcbb16422aa2d64aa21

2.3.1.60 - List Server Ips

2.3.1.60.1 - 1.1

scpcli virtualserver server ip list
--server_id <value>

Description

서버 IP 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP 주소 목록
subnet_name서브넷 이름subnetname

2.3.1.60.2 - 1.0

scpcli virtualserver server ip list
--server_id <value>

Description

서버 IP 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP 주소 목록
subnet_name서브넷 이름subnetname

2.3.1.61 - List Server Types

2.3.1.61.1 - 1.1

scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]

Description

서버 타입 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지 항목 개수20
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
min_disk
optional
integer최소 디스크 크기0
min_ram
optional
integer최소 램 크기2048
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
id서버 타입 IDs1v1m2
description설명description
disk루트 디스크 크기100
ephemeral임시 디스크 크기0
extra_specs추가 스펙
name서버 타입 이름s1v1m2
ramRAM 크기2
swap전용 스왑 디스크 크기0
vcpusCPU 수1

2.3.1.61.2 - 1.0

scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]

Description

서버 타입 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지 항목 개수20
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
min_disk
optional
integer최소 디스크 크기0
min_ram
optional
integer최소 램 크기2048
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
id서버 타입 IDs1v1m2
description설명description
disk루트 디스크 크기100
ephemeral임시 디스크 크기0
extra_specs추가 스펙
name서버 타입 이름s1v1m2
ramRAM 크기2
swap전용 스왑 디스크 크기0
vcpusCPU 수1

2.3.1.62 - List Server Volumes

2.3.1.62.1 - 1.1

scpcli virtualserver server volume list
--server_id <value>

Description

서버 볼륨 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
id볼륨 연결 ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination해지 시 삭제False
deviceDevice name/dev/vda
server_id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.62.2 - 1.0

scpcli virtualserver server volume list
--server_id <value>

Description

서버 볼륨 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
id볼륨 연결 ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination해지 시 삭제False
deviceDevice name/dev/vda
server_id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.63 - List snapshots and details

2.3.1.63.1 - 1.1

scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]

Description

List snapshots and details.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
optional
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
limit
optional
integer페이지 항목 개수20
offset
optional
integer목록에서 시작할 지점의 인덱스0
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
with_count
optional
boolean총 개수 여부True
name
optional
string스냅샷명snapshot-1

Responses

NameDescriptionExample
id스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at생성일시2025-07-22T09:00:00Z
description설명description
metadataSnapshot metadata
name스냅샷명snapshot-1
size볼륨 크기104
status볼륨 상태available
updated_at수정일시2025-07-26T12:00:00Z
user_id사용자 ID570907805e5447be84b618450ef52o0t
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.63.2 - 1.0

scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]

Description

List snapshots and details.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
optional
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
limit
optional
integer페이지 항목 개수20
offset
optional
integer목록에서 시작할 지점의 인덱스0
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
with_count
optional
boolean총 개수 여부True
name
optional
string스냅샷명snapshot-1

Responses

NameDescriptionExample
id스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at생성일시2025-07-22T09:00:00Z
description설명description
metadataSnapshot metadata
name스냅샷명snapshot-1
size볼륨 크기104
status볼륨 상태available
updated_at수정일시2025-07-26T12:00:00Z
user_id사용자 ID570907805e5447be84b618450ef52o0t
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.64 - List Virtual Server Security Group

2.3.1.64.1 - 1.1

scpcli virtualserver server security group list
--server_id <value>

Description

서버 Security Group 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idSecurity Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idServer Group owner’s account ID6f70656e737461636b20342065766572
descriptionSecurity group descriptionSecurity group description
nameSecurity Group 이름securitygroup
rulesSecurity group rules

2.3.1.64.2 - 1.0

scpcli virtualserver server security group list
--server_id <value>

Description

서버 Security Group 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idSecurity Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idServer Group owner’s account ID6f70656e737461636b20342065766572
descriptionSecurity group descriptionSecurity group description
nameSecurity Group 이름securitygroup
rulesSecurity group rules

2.3.1.65 - List Virtual Servers

2.3.1.65.1 - 1.1

scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]

Description

서버 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
optional
string서버 이름servername
ip
optional
stringIP 주소192.169.3.2
state
optional
string서버 상태ACTIVE
product_category
optional
****상품군compute
product_offering
optional
array상품'v'
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
server_type_id
optional
string서버 타입 IDs1v1m2
limit
optional
integer페이지 항목 개수20
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc
auto_scaling_group_id
optional
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_id계정 ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
addresses주소 목록
auto_scaling_group_idAuto-Scaling Group ID
--long 옵션 사용 필요
52613bd852b04b39adcb15a8364d856d
created_at생성일시
--long 옵션 사용 필요
created_by생성자 ID
--long 옵션 사용 필요
97e6b22c9a4143789ca522df7457a32f
disk_config디스크 컨피그
--long 옵션 사용 필요
MANUAL
image_id이미지 ID
--long 옵션 사용 필요
70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceMarketplace 여부
--long 옵션 사용 필요
False
keypair_name키페어 이름
--long 옵션 사용 필요
keypairname
launch_configuration_idLaunch Configuration ID
--long 옵션 사용 필요
b5aea5a675fc4f6b9e0fcd1288354c5f
locked잠김 여부
--long 옵션 사용 필요
False
metadata메타 데이터
--long 옵션 사용 필요
modified_at수정일시
--long 옵션 사용 필요
name서버 이름servername
partition_number파티션 넘버
--long 옵션 사용 필요
1
planned_compute_os_typePlanned Compute OS 유형
--long 옵션 사용 필요
windows
product_category상품군
--long 옵션 사용 필요
compute
product_offering상품
--long 옵션 사용 필요
virtual_server
security_groupsSecurity Group 목록
--long 옵션 사용 필요
server_group_id서버 그룹 ID
--long 옵션 사용 필요
616fb98f-46ca-475e-917e-2563e5a8cd19
server_type서버 타입
state서버 상태ACTIVE
volumes볼륨
--long 옵션 사용 필요
vpc_idVPC ID
--long 옵션 사용 필요
cc976b621087484ea5fd527f4b78708b

2.3.1.65.2 - 1.0

scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]

Description

서버 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
string서버 이름servername
ip
optional
stringIP 주소192.169.3.2
state
optional
string서버 상태ACTIVE
product_category
optional
****상품군compute
product_offering
optional
array상품'v'
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
server_type_id
optional
string서버 타입 IDs1v1m2
limit
optional
integer페이지 항목 개수20
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc
auto_scaling_group_id
optional
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_id계정 ID
--long 옵션 사용 필요
a8f10467abfc4b87b64614ab36eb9ae4
addresses주소 목록
auto_scaling_group_idAuto-Scaling Group ID
--long 옵션 사용 필요
52613bd852b04b39adcb15a8364d856d
created_at생성일시
--long 옵션 사용 필요
created_by생성자 ID
--long 옵션 사용 필요
97e6b22c9a4143789ca522df7457a32f
disk_config디스크 컨피그
--long 옵션 사용 필요
MANUAL
image_id이미지 ID
--long 옵션 사용 필요
70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceMarketplace 여부
--long 옵션 사용 필요
False
keypair_name키페어 이름
--long 옵션 사용 필요
keypairname
launch_configuration_idLaunch Configuration ID
--long 옵션 사용 필요
b5aea5a675fc4f6b9e0fcd1288354c5f
locked잠김 여부
--long 옵션 사용 필요
False
metadata메타 데이터
--long 옵션 사용 필요
modified_at수정일시
--long 옵션 사용 필요
name서버 이름servername
partition_number파티션 넘버
--long 옵션 사용 필요
1
planned_compute_os_typePlanned Compute OS 유형
--long 옵션 사용 필요
windows
product_category상품군
--long 옵션 사용 필요
compute
product_offering상품
--long 옵션 사용 필요
virtual_server
security_groupsSecurity Group 목록
--long 옵션 사용 필요
server_group_id서버 그룹 ID
--long 옵션 사용 필요
616fb98f-46ca-475e-917e-2563e5a8cd19
server_type서버 타입
state서버 상태ACTIVE
volumes볼륨
--long 옵션 사용 필요
vpc_idVPC ID
--long 옵션 사용 필요
cc976b621087484ea5fd527f4b78708b

2.3.1.66 - List volume transfers

2.3.1.66.1 - 1.1

scpcli virtualserver volume transfer list

Description

List volume transfers.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
name볼륨명volume01
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.66.2 - 1.0

scpcli virtualserver volume transfer list

Description

List volume transfers.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
name볼륨명volume01
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.67 - List volume types and details

2.3.1.67.1 - 1.1

scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]

Description

볼륨 유형 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지 항목 개수20
offset
optional
integer목록에서 시작할 지점의 인덱스0
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
id볼륨 유형 IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specs추가 스펙
name볼륨 유형명SSD

2.3.1.67.2 - 1.0

scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]

Description

볼륨 유형 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지 항목 개수20
offset
optional
integer목록에서 시작할 지점의 인덱스0
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc

Responses

NameDescriptionExample
id볼륨 유형 IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specs추가 스펙
name볼륨 유형명SSD

2.3.1.68 - List volumes and details

2.3.1.68.1 - 1.1

scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]

Description

볼륨 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
boolean총 개수 여부True
limit
optional
integer페이지 항목 개수20
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc
offset
optional
integer목록에서 시작할 지점의 인덱스0
name
optional
string볼륨명volume01
state
optional
string볼륨 상태available
bootable
optional
boolean부트 디스크 여부False

Responses

NameDescriptionExample
id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
bootable부트 디스크 여부False
created_at생성일시
encrypted암호화 여부
--long 옵션 사용 필요
True
modified_at수정일시
--long 옵션 사용 필요
2025-07-26T12:00:00Z
multiattach다중 연결
--long 옵션 사용 필요
False
name볼륨명volume01
serversAttached servers
--long 옵션 사용 필요
size볼륨 크기104
snapshot_id스냅샷 ID
--long 옵션 사용 필요
cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
state볼륨 상태available
user_id사용자 ID
--long 옵션 사용 필요
570907805e5447be84b618450ef52o0t
volume_image_metadata볼륨 이미지 메타데이터
--long 옵션 사용 필요
volume_type볼륨 타입SSD
volume_type_id볼륨 유형 ID
--long 옵션 사용 필요
c643ac35-3aec-43e6-b97a-3d6f666c5207

2.3.1.68.2 - 1.0

scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]

Description

볼륨 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
boolean총 개수 여부True
limit
optional
integer페이지 항목 개수20
marker
optional
string이전 요청에서 마지막으로 반환된 항목 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
string쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정created_at:desc
offset
optional
integer목록에서 시작할 지점의 인덱스0
name
optional
string볼륨명volume01
state
optional
string볼륨 상태available
bootable
optional
boolean부트 디스크 여부False

Responses

NameDescriptionExample
id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
bootable부트 디스크 여부False
created_at생성일시
encrypted암호화 여부
--long 옵션 사용 필요
True
modified_at수정일시
--long 옵션 사용 필요
2025-07-26T12:00:00Z
multiattach다중 연결
--long 옵션 사용 필요
False
name볼륨명volume01
serversAttached servers
--long 옵션 사용 필요
size볼륨 크기104
snapshot_id스냅샷 ID
--long 옵션 사용 필요
cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
state볼륨 상태available
user_id사용자 ID
--long 옵션 사용 필요
570907805e5447be84b618450ef52o0t
volume_image_metadata볼륨 이미지 메타데이터
--long 옵션 사용 필요
volume_type볼륨 타입SSD
volume_type_id볼륨 유형 ID
--long 옵션 사용 필요
c643ac35-3aec-43e6-b97a-3d6f666c5207

2.3.1.69 - Lock Virtual Server

2.3.1.69.1 - 1.1

scpcli virtualserver server lock
--server_id <value>

Description

서버에 Lock을 건다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.69.2 - 1.0

scpcli virtualserver server lock
--server_id <value>

Description

서버에 Lock을 건다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.70 - Reboot Virtual Server

2.3.1.70.1 - 1.1

scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]

Description

서버를 재시작한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
reboot_type
optional
****재시작 유형SOFT

Responses

NameDescriptionExample

2.3.1.70.2 - 1.0

scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]

Description

서버를 재시작한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
reboot_type
optional
****재시작 유형SOFT

Responses

NameDescriptionExample

2.3.1.71 - Rebuild Virtual Server

2.3.1.71.1 - 1.1

scpcli virtualserver server rebuild
--server_id <value>

Description

서버를 재빌드한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.71.2 - 1.0

scpcli virtualserver server rebuild
--server_id <value>

Description

서버를 재빌드한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.72 - Revert Volume to snapshot

2.3.1.72.1 - 1.1

scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>

Description

Revert Volume to snapshot.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
snapshot_id
required
string스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample

2.3.1.72.2 - 1.0

scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>

Description

Revert Volume to snapshot.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
snapshot_id
required
string스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample

2.3.1.73 - Show a snapshot’s details

2.3.1.73.1 - 1.1

scpcli virtualserver volume snapshot show
--snapshot_id <value>

Description

Show a snapshot’s details.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample
id스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at생성일시2025-07-22T09:00:00Z
description설명description
metadataSnapshot metadata
name스냅샷명snapshot-1
size볼륨 크기104
status볼륨 상태available
updated_at수정일시2025-07-26T12:00:00Z
user_id사용자 ID570907805e5447be84b618450ef52o0t
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.73.2 - 1.0

scpcli virtualserver volume snapshot show
--snapshot_id <value>

Description

Show a snapshot’s details.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample
id스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_at생성일시2025-07-22T09:00:00Z
description설명description
metadataSnapshot metadata
name스냅샷명snapshot-1
size볼륨 크기104
status볼륨 상태available
updated_at수정일시2025-07-26T12:00:00Z
user_id사용자 ID570907805e5447be84b618450ef52o0t
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.74 - Show Auto-Scaling Group

2.3.1.74.1 - 1.1

scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>

Description

Auto-Scaling Group을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idLB 서버 그룹 IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB 서버 그룹 포트8080

2.3.1.74.2 - 1.0

scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>

Description

Auto-Scaling Group을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idLB 서버 그룹 IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB 서버 그룹 포트8080

2.3.1.75 - Show Auto-Scaling Group Notification

2.3.1.75.1 - 1.1

scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group 알림을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
notification_id
required
string알림 IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group 알림 이벤트 목록[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group 알림 상태ACTIVE
user_id사용자 ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

2.3.1.75.2 - 1.0

scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group 알림을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
notification_id
required
string알림 IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group 알림 이벤트 목록[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group 알림 상태ACTIVE
user_id사용자 ID570907805e5447be84b618450ef52o0t
user_nameUser namescpuser

2.3.1.76 - Show Auto-Scaling Group Policy

2.3.1.76.1 - 1.1

scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group 정책을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
policy_id
required
string정책 ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator비교 연산자ge
cooldown_seconds쿨다운 시간(초 단위)300
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes평가 시간(분 단위)1
metric_method메트릭 방법AVG
metric_type메트릭 유형CPU
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name정책 이름policy-name
scale_method스케일 방법AMOUNT
scale_type스케일 유형SCALE_OUT
scale_value스켕일 값10
state정책 상태ACTIVE
threshold임계값60
threshold_unit임계값 단위%

2.3.1.76.2 - 1.0

scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group 정책을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
policy_id
required
string정책 ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator비교 연산자ge
cooldown_seconds쿨다운 시간(초 단위)300
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutes평가 시간(분 단위)1
metric_method메트릭 방법AVG
metric_type메트릭 유형CPU
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name정책 이름policy-name
scale_method스케일 방법AMOUNT
scale_type스케일 유형SCALE_OUT
scale_value스켕일 값10
state정책 상태ACTIVE
threshold임계값60
threshold_unit임계값 단위%

2.3.1.77 - Show Auto-Scaling Group Schedule

2.3.1.77.1 - 1.1

scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
schedule_id
required
string스케줄 ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
day_of_month-1,1
day_of_week요일SU,SA
description설명description
desired_server_count목표 서버 수1
end_date종료 날짜2025-01-01
frequency빈도WEEKLY
hour시간9
max_server_count최대 서버 수2
min_server_count최소 서버 수1
minute0
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name스케쥴 이름schedulename
start_date시작 날짜2024-01-01
state스케쥴 상태ACTIVE
timezone시간대Asia/Seoul

2.3.1.77.2 - 1.0

scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>

Description

Auto-Scaling Group을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
schedule_id
required
string스케줄 ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
day_of_month-1,1
day_of_week요일SU,SA
description설명description
desired_server_count목표 서버 수1
end_date종료 날짜2025-01-01
frequency빈도WEEKLY
hour시간9
max_server_count최대 서버 수2
min_server_count최소 서버 수1
minute0
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name스케쥴 이름schedulename
start_date시작 날짜2024-01-01
state스케쥴 상태ACTIVE
timezone시간대Asia/Seoul

2.3.1.78 - Show default Volume type’s details

2.3.1.78.1 - 1.1

scpcli virtualserver volume type default show

Description

기본 볼륨 유형을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
id볼륨 유형 IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specs추가 스펙
name볼륨 유형명SSD

2.3.1.78.2 - 1.0

scpcli virtualserver volume type default show

Description

기본 볼륨 유형을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Responses

NameDescriptionExample
id볼륨 유형 IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specs추가 스펙
name볼륨 유형명SSD

2.3.1.79 - Show Image

2.3.1.79.1 - 1.1

scpcli virtualserver image show
--image_id <value>

Description

이미지를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
checksum체크섬7538e0fcb56e0e272cfd89eb384d6613
container_format컨테이너 형식bare
created_at생성일시2025-07-22T09:00:00Z
disk_format디스크 형식qcow2
file파일/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk최소 디스크100
min_ram최소 RAM0
name이미지 이름imagename
os_distroOS 배포판alma
os_hash_algoOS 해시 알고리즘sha512
os_hash_valueOS 해시 값c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS 숨김 여부False
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_name소유 account 이름AccountName
owner_user_name소유자 이름user@samsung.com
protected보호False
root_device_name루트 디바이스 이름/dev/vda
scp_image_type이미지 타입custom
scp_k8s_versionK8S 버전v1.28.7
scp_original_image_type원본 이미지 타입standard
scp_os_build_versionOS 빌드 버전20250101
scp_os_versionOS 버전8.8
size크기2429747200
status상태active
updated_at수정일시2025-07-26T12:00:00Z
url이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size가상 크기17179869184
visibility가시성private
volumes볼륨[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

2.3.1.79.2 - 1.0

scpcli virtualserver image show
--image_id <value>

Description

이미지를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
checksum체크섬7538e0fcb56e0e272cfd89eb384d6613
container_format컨테이너 형식bare
created_at생성일시2025-07-22T09:00:00Z
disk_format디스크 형식qcow2
file파일/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_disk최소 디스크100
min_ram최소 RAM0
name이미지 이름imagename
os_distroOS 배포판alma
os_hash_algoOS 해시 알고리즘sha512
os_hash_valueOS 해시 값c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS 숨김 여부False
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_name소유 account 이름AccountName
owner_user_name소유자 이름user@samsung.com
protected보호False
root_device_name루트 디바이스 이름/dev/vda
scp_image_type이미지 타입custom
scp_k8s_versionK8S 버전v1.28.7
scp_original_image_type원본 이미지 타입standard
scp_os_build_versionOS 빌드 버전20250101
scp_os_versionOS 버전8.8
size크기2429747200
status상태active
updated_at수정일시2025-07-26T12:00:00Z
url이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_size가상 크기17179869184
visibility가시성private
volumes볼륨[{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}]

2.3.1.80 - Show Image member

2.3.1.80.1 - 1.1

scpcli virtualserver image member show
--member_id <value>
--image_id <value>

Description

이미지 멤버를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
member_id
required
string멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_at생성일시2025-07-22T09:00:00Z
image_id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
member_id멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
status멤버 상태pending
updated_at수정일시2025-07-26T12:00:00Z

2.3.1.80.2 - 1.0

scpcli virtualserver image member show
--member_id <value>
--image_id <value>

Description

이미지 멤버를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
member_id
required
string멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_at생성일시2025-07-22T09:00:00Z
image_id이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
member_id멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
status멤버 상태pending
updated_at수정일시2025-07-26T12:00:00Z

2.3.1.81 - Show Keypair

2.3.1.81.1 - 1.1

scpcli virtualserver keypair show
--keypair_name <value>

Description

키페어를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
keypair_name
required
string키페어 이름keypairname

Responses

NameDescriptionExample
id키페어 ID1
created_at생성일시2025-07-22T09:00:00Z
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name키페어 이름keypairname
public_keyPublic Keypublickey
type키페어 유형ssh
user_id사용자 ID570907805e5447be84b618450ef52o0t

2.3.1.81.2 - 1.0

scpcli virtualserver keypair show
--keypair_name <value>

Description

키페어를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
keypair_name
required
string키페어 이름keypairname

Responses

NameDescriptionExample
id키페어 ID1
created_at생성일시2025-07-22T09:00:00Z
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
name키페어 이름keypairname
public_keyPublic Keypublickey
type키페어 유형ssh
user_id사용자 ID570907805e5447be84b618450ef52o0t

2.3.1.82 - Show Launch Configuration

2.3.1.82.1 - 1.1

scpcli virtualserver launch configuration show
--launch_configuration_id <value>

Description

Launch Configuration을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

Responses

NameDescriptionExample
boot_index부팅 장치를 시도하는 순서0
size볼륨 크기104
type볼륨 타입SSD

2.3.1.82.2 - 1.0

scpcli virtualserver launch configuration show
--launch_configuration_id <value>

Description

Launch Configuration을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

Responses

NameDescriptionExample
boot_index부팅 장치를 시도하는 순서0
size볼륨 크기104
type볼륨 타입SSD

2.3.1.83 - Show Server Group

2.3.1.83.1 - 1.1

scpcli virtualserver server group show
--server_group_id <value>

Description

서버 그룹을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_group_id
required
string서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19

Responses

NameDescriptionExample
id서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
members서버 그룹 멤버[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name서버 그룹 명server-group
partition_size파티션 사이즈3
policy서버 그룹 정책anti-affinity
user_id사용자 ID570907805e5447be84b618450ef52o0t

2.3.1.83.2 - 1.0

scpcli virtualserver server group show
--server_group_id <value>

Description

서버 그룹을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_group_id
required
string서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19

Responses

NameDescriptionExample
id서버 그룹 ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_id계정 IDa8f10467abfc4b87b64614ab36eb9ae4
members서버 그룹 멤버[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
name서버 그룹 명server-group
partition_size파티션 사이즈3
policy서버 그룹 정책anti-affinity
user_id사용자 ID570907805e5447be84b618450ef52o0t

2.3.1.84 - Show Server Interface

2.3.1.84.1 - 1.1

scpcli virtualserver server interface show
--port_id <value>
--server_id <value>

Description

서버 인터페이스를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed Ip list
mac_addrMAC 주소fa:16:3e:c0:71:2b
port_id포트 IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_id서브넷 ID183c6c30df0c4fcbb16422aa2d64aa21

2.3.1.84.2 - 1.0

scpcli virtualserver server interface show
--port_id <value>
--server_id <value>

Description

서버 인터페이스를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed Ip list
mac_addrMAC 주소fa:16:3e:c0:71:2b
port_id포트 IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_id서브넷 ID183c6c30df0c4fcbb16422aa2d64aa21

2.3.1.85 - Show Server Ip

2.3.1.85.1 - 1.1

scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>

Description

서버 IP를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
string서브넷 ID78b2ee3f074145c580ab6abac4821f97
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressIP 주소192.169.3.2
versionIP 주소 버전4

2.3.1.85.2 - 1.0

scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>

Description

서버 IP를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
string서브넷 ID78b2ee3f074145c580ab6abac4821f97
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressIP 주소192.169.3.2
versionIP 주소 버전4

2.3.1.86 - Show Server Quota Set

2.3.1.86.1 - 1.1

scpcli virtualserver quota set show

Description

서버 쿼터 셋을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
id쿼터 셋 IDfc7283354c6143a58629b59f4c3e16b2
cores코어 한도
instances인스턴스 한도
keypairs키페어 한도
metadata_items메타 데이터 항목 한도
ram램 한도
server_group_members서버 그룹 멤버 한도
server_groups서버 그룹 한도

2.3.1.86.2 - 1.0

scpcli virtualserver quota set show

Description

서버 쿼터 셋을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Responses

NameDescriptionExample
id쿼터 셋 IDfc7283354c6143a58629b59f4c3e16b2
cores코어 한도
instances인스턴스 한도
keypairs키페어 한도
metadata_items메타 데이터 항목 한도
ram램 한도
server_group_members서버 그룹 멤버 한도
server_groups서버 그룹 한도

2.3.1.87 - Show Server Type

2.3.1.87.1 - 1.1

scpcli virtualserver server type show
--server_type_id <value>

Description

서버 타입을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_type_id
required
string서버 타입 IDs1v1m2

Responses

NameDescriptionExample
id서버 타입 IDs1v1m2
description설명description
disk루트 디스크 크기100
ephemeral임시 디스크 크기0
extra_specs추가 스펙
name서버 타입 이름s1v1m2
ramRAM 크기2
swap전용 스왑 디스크 크기0
vcpusCPU 수1

2.3.1.87.2 - 1.0

scpcli virtualserver server type show
--server_type_id <value>

Description

서버 타입을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_type_id
required
string서버 타입 IDs1v1m2

Responses

NameDescriptionExample
id서버 타입 IDs1v1m2
description설명description
disk루트 디스크 크기100
ephemeral임시 디스크 크기0
extra_specs추가 스펙
name서버 타입 이름s1v1m2
ramRAM 크기2
swap전용 스왑 디스크 크기0
vcpusCPU 수1

2.3.1.88 - Show Server Volume

2.3.1.88.1 - 1.1

scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>

Description

서버 볼륨을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
id볼륨 연결 ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination해지 시 삭제False
deviceDevice name/dev/vda
server_id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.88.2 - 1.0

scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>

Description

서버 볼륨을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
id볼륨 연결 ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_termination해지 시 삭제False
deviceDevice name/dev/vda
server_id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.89 - Show Virtual Server

2.3.1.89.1 - 1.1

scpcli virtualserver server show
--server_id <value>

Description

서버를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP 주소 목록
subnet_name서브넷 이름subnetname

2.3.1.89.2 - 1.0

scpcli virtualserver server show
--server_id <value>

Description

서버를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP 주소 목록
subnet_name서브넷 이름subnetname

2.3.1.90 - Show Virtual Server Console Log

2.3.1.90.1 - 1.1

scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]

Description

서버 콘솔 로그를 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
line_size
optional
integerNumber of log lines to get1

Responses

NameDescriptionExample
outputServer console log outputFAKE CONSOLE OUTPUT

2.3.1.90.2 - 1.0

scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]

Description

서버 콘솔 로그를 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
line_size
optional
integerNumber of log lines to get1

Responses

NameDescriptionExample
outputServer console log outputFAKE CONSOLE OUTPUT

2.3.1.91 - Show Virtual Server Password

2.3.1.91.1 - 1.1

scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]

Description

서버 비밀번호를 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_key
optional
string비밀 키privatekey

Responses

NameDescriptionExample
passwordServer passwordpassword

2.3.1.91.2 - 1.0

scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]

Description

서버 비밀번호를 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_key
optional
string비밀 키privatekey

Responses

NameDescriptionExample
passwordServer passwordpassword

2.3.1.92 - Show Volume Quota Set

2.3.1.92.1 - 1.1

scpcli virtualserver volume quota set show

Description

볼륨 쿼터 셋을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
id쿼터 셋 IDfc7283354c6143a58629b59f4c3e16b2
per_volume_size볼륨 별 크기 한도
snapshotsSnapshot Quota
usages사용량 한도
volumesVolume Quota

2.3.1.92.2 - 1.0

scpcli virtualserver volume quota set show

Description

볼륨 쿼터 셋을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Responses

NameDescriptionExample
id쿼터 셋 IDfc7283354c6143a58629b59f4c3e16b2
per_volume_size볼륨 별 크기 한도
snapshotsSnapshot Quota
usages사용량 한도
volumesVolume Quota

2.3.1.93 - Show volume transfer detail

2.3.1.93.1 - 1.1

scpcli virtualserver volume transfer show
--transfer_id <value>

Description

Show volume transfer detail.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
transfer_id
required
stringTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
created_at생성일시
name볼륨명volume01
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.93.2 - 1.0

scpcli virtualserver volume transfer show
--transfer_id <value>

Description

Show volume transfer detail.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
transfer_id
required
stringTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
created_at생성일시
name볼륨명volume01
volume_id볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.94 - Show Volume type’s details

2.3.1.94.1 - 1.1

scpcli virtualserver volume type show
--volume_type_id <value>

Description

볼륨 유형을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_type_id
required
string볼륨 유형 IDc643ac35-3aec-43e6-b97a-3d6f666c5207

Responses

NameDescriptionExample
id볼륨 유형 IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specs추가 스펙
name볼륨 유형명SSD

2.3.1.94.2 - 1.0

scpcli virtualserver volume type show
--volume_type_id <value>

Description

볼륨 유형을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_type_id
required
string볼륨 유형 IDc643ac35-3aec-43e6-b97a-3d6f666c5207

Responses

NameDescriptionExample
id볼륨 유형 IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specs추가 스펙
name볼륨 유형명SSD

2.3.1.95 - Show Volume's details

2.3.1.95.1 - 1.1

scpcli virtualserver volume show
--volume_id <value>

Description

볼륨을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

Responses

NameDescriptionExample
id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_atThe time when the volume was attached to the server.
deviceDevice name/dev/vda

2.3.1.95.2 - 1.0

scpcli virtualserver volume show
--volume_id <value>

Description

볼륨을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a

Responses

NameDescriptionExample
id서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
attached_atThe time when the volume was attached to the server.
deviceDevice name/dev/vda

2.3.1.96 - Start Virtual Server

2.3.1.96.1 - 1.1

scpcli virtualserver server start
--server_id <value>

Description

서버를 시작한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.96.2 - 1.0

scpcli virtualserver server start
--server_id <value>

Description

서버를 시작한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.97 - Stop Virtual Server

2.3.1.97.1 - 1.1

scpcli virtualserver server stop
--server_id <value>

Description

서버를 중지한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.97.2 - 1.0

scpcli virtualserver server stop
--server_id <value>

Description

서버를 중지한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.98 - Unlock Virtual Server

2.3.1.98.1 - 1.1

scpcli virtualserver server unlock
--server_id <value>

Description

서버 Lock을 푼다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.98.2 - 1.0

scpcli virtualserver server unlock
--server_id <value>

Description

서버 Lock을 푼다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.99 - Update a snapshot

2.3.1.99.1 - 1.1

scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]

Description

Update a snapshot.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
name
required
string스냅샷명snapshot-1
description
optional
string설명description

2.3.1.99.2 - 1.0

scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]

Description

Update a snapshot.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
name
required
string스냅샷명snapshot-1
description
optional
string설명description

2.3.1.100 - Update Auto-Scaling Group

2.3.1.100.1 - 1.1

scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]

Description

Auto-Scaling Group을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count_editable
optional
boolean목표 서버 수 수정 가능 여부True
drain_enabled
optional
booleanDrain 사용 여부True
drain_timeout
optional
integerDrain timeout 값300
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
security_group_ids
optional
arraySecurity Group ID 목록[

2.3.1.100.2 - 1.0

scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]

Description

Auto-Scaling Group을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count_editable
optional
boolean목표 서버 수 수정 가능 여부True
drain_enabled
optional
booleanDrain 사용 여부True
drain_timeout
optional
integerDrain timeout 값300
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
security_group_ids
optional
arraySecurity Group ID 목록[

2.3.1.101 - Update Auto-Scaling Group LB Server Groups

2.3.1.101.1 - 1.1

scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>

Description

Auto-Scaling Group LB 서버 그룹을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
lb_server_groups
required
arrayLB 서버 그룹 목록'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'

2.3.1.101.2 - 1.0

scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>

Description

Auto-Scaling Group LB 서버 그룹을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
lb_server_groups
required
arrayLB 서버 그룹 목록'{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}'

2.3.1.102 - Update Auto-Scaling Group Notification

2.3.1.102.1 - 1.1

scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]

Description

Auto-Scaling Group 알림을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
notification_id
required
string알림 IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
notification_events
optional
arrayAuto-Scaling Group 알림 이벤트 목록SCALE_OUT
notification_state
optional
stringAuto-Scaling Group 알림 상태ACTIVE

2.3.1.102.2 - 1.0

scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]

Description

Auto-Scaling Group 알림을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
notification_id
required
string알림 IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
notification_events
optional
arrayAuto-Scaling Group 알림 이벤트 목록SCALE_OUT
notification_state
optional
stringAuto-Scaling Group 알림 상태ACTIVE

2.3.1.103 - Update Auto-Scaling Group Policy

2.3.1.103.1 - 1.1

scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--name <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]

Description

Auto-Scaling Group 정책을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
policy_id
required
string정책 ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator
optional
string비교 연산자ge
cooldown_seconds
optional
integer쿨다운 시간(초 단위)300
evaluation_minutes
optional
integer평가 시간(분 단위)1
metric_method
optional
string메트릭 방법AVG
metric_type
optional
string메트릭 유형CPU
name
optional
string정책 이름policy-name
scale_method
optional
string스케일 방법AMOUNT
scale_type
optional
string스케일 유형SCALE_OUT
scale_value
optional
integer스켕일 값10
state
optional
string정책 상태ACTIVE
threshold
optional
integer임계값60

2.3.1.103.2 - 1.0

scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--name <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]

Description

Auto-Scaling Group 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
policy_id
required
string정책 ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator
optional
string비교 연산자ge
cooldown_seconds
optional
integer쿨다운 시간(초 단위)300
evaluation_minutes
optional
integer평가 시간(분 단위)1
metric_method
optional
string메트릭 방법AVG
metric_type
optional
string메트릭 유형CPU
name
optional
string정책 이름policy-name
scale_method
optional
string스케일 방법AMOUNT
scale_type
optional
string스케일 유형SCALE_OUT
scale_value
optional
integer스켕일 값10
state
optional
string정책 상태ACTIVE
threshold
optional
integer임계값60

2.3.1.104 - Update Auto-Scaling Group Schedule

2.3.1.104.1 - 1.1

scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]

Description

Auto-Scaling Group 스케줄을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
schedule_id
required
string스케줄 ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
day_of_month
optional
string-1,1
day_of_week
optional
string요일SU,SA
description
optional
string설명description
desired_server_count
optional
integer목표 서버 수1
end_date
optional
string종료 날짜2025-01-01
frequency
optional
****빈도WEEKLY
hour
optional
integer시간9
max_server_count
optional
integer최대 서버 수2
min_server_count
optional
integer최소 서버 수1
minute
optional
integer0
name
optional
string스케쥴 이름schedulename
start_date
optional
string시작 날짜2024-01-01
state
optional
string스케쥴 상태ACTIVE
timezone
optional
string시간대Asia/Seoul

2.3.1.104.2 - 1.0

scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]

Description

Auto-Scaling Group 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
schedule_id
required
string스케줄 ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
day_of_month
optional
string-1,1
day_of_week
optional
string요일SU,SA
description
optional
string설명description
desired_server_count
optional
integer목표 서버 수1
end_date
optional
string종료 날짜2025-01-01
frequency
optional
****빈도WEEKLY
hour
optional
integer시간9
max_server_count
optional
integer최대 서버 수2
min_server_count
optional
integer최소 서버 수1
minute
optional
integer0
name
optional
string스케쥴 이름schedulename
start_date
optional
string시작 날짜2024-01-01
state
optional
string스케쥴 상태ACTIVE
timezone
optional
string시간대Asia/Seoul

2.3.1.105 - Update Auto-Scaling Group server count

2.3.1.105.1 - 1.1

scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]

Description

Auto-Scaling Group 서버 수를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count
optional
integer목표 서버 수1
max_server_count
optional
integer최대 서버 수2
min_server_count
optional
integer최소 서버 수1

2.3.1.105.2 - 1.0

scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]

Description

Auto-Scaling Group 서버 수를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count
optional
integer목표 서버 수1
max_server_count
optional
integer최대 서버 수2
min_server_count
optional
integer최소 서버 수1

2.3.1.106 - Update Image

2.3.1.106.1 - 1.1

scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]

Description

이미지를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
min_disk
optional
integer최소 디스크100
min_ram
optional
integer최소 RAM0
protected
optional
boolean보호False
visibility
optional
string가시성private

2.3.1.106.2 - 1.0

scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]

Description

이미지를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
min_disk
optional
integer최소 디스크100
min_ram
optional
integer최소 RAM0
protected
optional
boolean보호False
visibility
optional
string가시성private

2.3.1.107 - Update Image member

2.3.1.107.1 - 1.1

scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

Description

이미지 멤버를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
member_id
required
string멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
status
required
string멤버 상태pending

2.3.1.107.2 - 1.0

scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

Description

이미지 멤버를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
member_id
required
string멤버 IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
string이미지 ID70a599e0-31e7-49b7-b260-868f441e862b
status
required
string멤버 상태pending

2.3.1.108 - Update Server Interface

2.3.1.108.1 - 1.1

scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]

Description

서버 인터페이스를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ip_address
optional
stringIP 주소192.169.3.2
subnet_id
optional
string서브넷 ID-

2.3.1.108.2 - 1.0

scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]

Description

서버 인터페이스를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
string포트 ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ip_address
optional
stringIP 주소192.169.3.2
subnet_id
optional
string서브넷 ID-

2.3.1.109 - Update Server Volume

2.3.1.109.1 - 1.1

scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]

Description

서버 볼륨을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
delete_on_termination
optional
boolean해지 시 삭제False

2.3.1.109.2 - 1.0

scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]

Description

서버 볼륨을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
delete_on_termination
optional
boolean해지 시 삭제False

2.3.1.110 - Update Virtual Server

2.3.1.110.1 - 1.1

scpcli virtualserver server set
--server_id <value>
--name <value>

Description

서버를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
name
required
string서버 이름servername

2.3.1.110.2 - 1.0

scpcli virtualserver server set
--server_id <value>
--name <value>

Description

서버를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
name
required
string서버 이름servername

2.3.1.111 - Update Virtual Server type

2.3.1.111.1 - 1.1

scpcli virtualserver server type set
--server_id <value>
--server_type <value>

Description

서버 타입을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
server_type
required
string서버 타입s1v1m2

Responses

NameDescriptionExample

2.3.1.111.2 - 1.0

scpcli virtualserver server type set
--server_id <value>
--server_type <value>

Description

서버 타입을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
string서버 ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
server_type
required
string서버 타입s1v1m2

Responses

NameDescriptionExample

2.3.1.112 - Update Volume

2.3.1.112.1 - 1.1

scpcli virtualserver volume set
--volume_id <value>
[--name <value>]

Description

볼륨을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
string볼륨명volume01

2.3.1.112.2 - 1.0

scpcli virtualserver volume set
--volume_id <value>
[--name <value>]

Description

볼륨을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
string볼륨명volume01

3 - Storage

3.1 - Archive Storage

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Archive Storage 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

3.1.1 - CLIs

3.1.1.1 - CancelArchiving

3.1.1.1.1 - 1.1

scpcli archivestorage archiving history cancel
--bucket_id <value>
--id <value>

Description

아카이빙을 취소한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디3d036efe-f576-48b0-8375-6d3704a95b63
id
required
string아카이빙 이력 아이디EXE-8f35b491-a060-453b-b825-e78440ca46de

3.1.1.1.2 - 1.0

scpcli archivestorage archiving history cancel
--bucket_id <value>
--id <value>

Description

아카이빙을 취소한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디3d036efe-f576-48b0-8375-6d3704a95b63
id
required
string아카이빙 이력 아이디EXE-8f35b491-a060-453b-b825-e78440ca46de

3.1.1.2 - CancelRecovery

3.1.1.2.1 - 1.1

scpcli archivestorage recovery history cancel
--bucket_id <value>
--id <value>

Description

복구를 취소한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
id
required
string복구 이력 아이디EXE-9df439a5-9e6d-46a4-806e-1e9991520763

3.1.1.2.2 - 1.0

scpcli archivestorage recovery history cancel
--bucket_id <value>
--id <value>

Description

복구를 취소한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
id
required
string복구 이력 아이디EXE-9df439a5-9e6d-46a4-806e-1e9991520763

3.1.1.3 - CreateArchivingPolicy

3.1.1.3.1 - 1.1

scpcli archivestorage archiving policy create
--bucket_id <value>
--object_path <value>
--object_lifecycle <value>
--archiving_source_bucket_name <value>

Description

아카이빙 정책을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_path
required
string오브젝트 경로/
object_lifecycle
required
stringObject Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값1
archiving_source_bucket_name
required
string아카이빙 소스 버킷 이름obs-bucket-name

Responses

NameDescriptionExample
id아카이빙 정책 아이디SCH-XXXXXXX
bucket_id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source아카이빙 소스
object_lifecycleObject Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값1
state아카이빙 정책 상태ACTIVE

3.1.1.3.2 - 1.0

scpcli archivestorage archiving policy create
--bucket_id <value>
--object_path <value>
--object_lifecycle <value>
--archiving_source_bucket_name <value>

Description

아카이빙 정책을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_path
required
string오브젝트 경로/
object_lifecycle
required
stringObject Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값1
archiving_source_bucket_name
required
string아카이빙 소스 버킷 이름obs-bucket-name

Responses

NameDescriptionExample
id아카이빙 정책 아이디SCH-XXXXXXX
bucket_id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source아카이빙 소스
object_lifecycleObject Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값1
state아카이빙 정책 상태ACTIVE

3.1.1.4 - CreateBucket

3.1.1.4.1 - 1.1

scpcli archivestorage bucket create
--name <value>
[--tags <value>]

Description

버킷을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
string버킷 이름astest
tags
optional
array태그 목록'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

3.1.1.4.2 - 1.0

scpcli archivestorage bucket create
--name <value>
[--tags <value>]

Description

버킷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
string버킷 이름astest
tags
optional
array태그 목록'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

3.1.1.5 - DeleteBucket

3.1.1.5.1 - 1.1

scpcli archivestorage bucket delete
--bucket_id <value>

Description

버킷을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

3.1.1.5.2 - 1.0

scpcli archivestorage bucket delete
--bucket_id <value>

Description

버킷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

3.1.1.6 - DeleteBucketObjects

3.1.1.6.1 - 1.1

scpcli archivestorage bucket object delete
--bucket_id <value>
--paths <value>

Description

버킷 오브젝트를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
paths
required
array오브젝트 경로 목록test/

3.1.1.6.2 - 1.0

scpcli archivestorage bucket object delete
--bucket_id <value>
--paths <value>

Description

버킷 오브젝트를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
paths
required
array오브젝트 경로 목록test/

3.1.1.7 - DeleteBucketObjectVersions

3.1.1.7.1 - 1.1

scpcli archivestorage bucket object version delete
--bucket_id <value>
--versions <value>
--path <value>

Description

버킷 오브젝트 버전을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
versions
required
array오브젝트 버전 목록Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
path
required
string오브젝트 경로hello/my_file.txt

3.1.1.8 - ListArchivingHistories

3.1.1.8.1 - 1.1

scpcli archivestorage archiving history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]

Description

아카이빙 이력 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
start_at_to
required
string시작일까지2025-04-30T23:59:59+09:00
start_at_from
required
string시작일부터2025-04-01T00:00:00+09:00
bucket_id
required
string버킷 아이디3d036efe-f576-48b0-8375-6d3704a95b63
state
optional
string상태SUCCESS
limit
optional
integer조회 개수20
offset
optional
integer오프셋0

Responses

NameDescriptionExample
id아카이빙 이력 아이디EXE-8f35b491-a060-453b-b825-e78440ca46de
archiving_id아카이빙 아이디SCH-02d48456-0f35-47e2-8056-b00e09366cac
state상태SUCCESS
archiving_policy_id아카이빙 정책 아이디SCH-02d48456-0f35-47e2-8056-b00e09366cac
start_at시작 일시2025-04-01T00:00:00+09:00
end_at종료 일시2025-04-30T23:59:59+09:00

3.1.1.8.2 - 1.0

scpcli archivestorage archiving history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]

Description

아카이빙 이력 목록을 검색한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
start_at_to
required
string시작일까지2025-04-30T23:59:59+09:00
start_at_from
required
string시작일부터2025-04-01T00:00:00+09:00
bucket_id
required
string버킷 아이디3d036efe-f576-48b0-8375-6d3704a95b63
state
optional
string상태SUCCESS
limit
optional
integer조회 개수20
offset
optional
integer오프셋0

Responses

NameDescriptionExample
id아카이빙 이력 아이디EXE-8f35b491-a060-453b-b825-e78440ca46de
archiving_id아카이빙 아이디SCH-02d48456-0f35-47e2-8056-b00e09366cac
state상태SUCCESS
archiving_policy_id아카이빙 정책 아이디SCH-02d48456-0f35-47e2-8056-b00e09366cac
start_at시작 일시2025-04-01T00:00:00+09:00
end_at종료 일시2025-04-30T23:59:59+09:00

3.1.1.9 - ListArchivingPolicies

3.1.1.9.1 - 1.1

scpcli archivestorage archiving policy list
--bucket_id <value>

Description

아카이빙 정책 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
id아카이빙 정책 아이디SCH-XXXXXXX
object_lifecycleObject Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값1
object_path오브젝트 경로/
state아카이빙 정책 상태ACTIVE

3.1.1.9.2 - 1.0

scpcli archivestorage archiving policy list
--bucket_id <value>

Description

아카이빙 정책 목록을 검색한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
id아카이빙 정책 아이디SCH-XXXXXXX
object_lifecycleObject Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값1
object_path오브젝트 경로/
state아카이빙 정책 상태ACTIVE

3.1.1.10 - ListBucketObjects

3.1.1.10.1 - 1.1

scpcli archivestorage bucket object list
--bucket_id <value>
[--marker <value>]
[--object_path <value>]
[--object_name <value>]
[--object_type <value>]
[--limit <value>]

Description

버킷 오브젝트 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
marker
optional
string마커TODO.txt
object_path
optional
string오브젝트 경로/
object_name
optional
string오브젝트 이름hello/TODO.txt
object_type
optional
string오브젝트 타입FILE
limit
optional
integer조회 개수20

Responses

NameDescriptionExample
object_name오브젝트 이름hello/TODO.txt
object_type오브젝트 타입FILE
object_size오브젝트 크기3581
modified_at수정일2025-04-09T05:54:46.244000+00:00

3.1.1.10.2 - 1.0

scpcli archivestorage bucket object list
--bucket_id <value>
[--marker <value>]
[--object_path <value>]
[--object_name <value>]
[--object_type <value>]
[--limit <value>]

Description

버킷 오브젝트 목록을 검색한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
marker
optional
string마커TODO.txt
object_path
optional
string오브젝트 경로/
object_name
optional
string오브젝트 이름hello/TODO.txt
object_type
optional
string오브젝트 타입FILE
limit
optional
integer조회 개수20

Responses

NameDescriptionExample
object_name오브젝트 이름hello/TODO.txt
object_type오브젝트 타입FILE
object_size오브젝트 크기3581
modified_at수정일2025-04-09T05:54:46.244000+00:00

3.1.1.11 - ListBucketObjectVersions

3.1.1.11.1 - 1.1

scpcli archivestorage bucket object version list
--bucket_id <value>
--object_path <value>
[--offset <value>]
[--limit <value>]

Description

버킷 오브젝트 버전 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_path
required
string오브젝트 경로hello/my_file.txt
offset
optional
integer오프셋0
limit
optional
integer조회 개수20

Responses

NameDescriptionExample
object_path오브젝트 경로hello/my_file.txt
object_version_id오브젝트 버전 아이디Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
latest오브젝트의 최신버전True
modified_at수정일2025-04-09T05:54:46.244000+00:00
etagETag4f6094f1e0619a6504efcb5e69e63bec
size크기20

3.1.1.12 - ListBuckets

3.1.1.12.1 - 1.1

scpcli archivestorage bucket list
[--name <value>]
[--limit <value>]

Description

버킷 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
optional
string버킷 이름astest
limit
optional
integer조회 개수20

Responses

NameDescriptionExample
id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name버킷 이름astest

3.1.1.12.2 - 1.0

scpcli archivestorage bucket list
[--name <value>]
[--limit <value>]

Description

버킷 목록을 검색한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
string버킷 이름astest
limit
optional
integer조회 개수20

Responses

NameDescriptionExample
id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name버킷 이름astest

3.1.1.13 - ListRecoveryHistories

3.1.1.13.1 - 1.1

scpcli archivestorage recovery history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]

Description

복구 이력 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
start_at_to
required
string시작일까지2025-04-30T23:59:59+09:00
start_at_from
required
string시작일부터2025-04-01T00:00:00+09:00
bucket_id
required
string버킷 아이디7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
state
optional
string상태SUCCESS
limit
optional
integer조회 개수20
offset
optional
integer오프셋0

Responses

NameDescriptionExample
id복구 이력 아이디EXE-9df439a5-9e6d-46a4-806e-1e9991520763
recovery_id복구 아이디ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5
state상태SUCCESS
recovery_target_bucket_name복구 대상 버킷 이름test-obs-bucket
start_at시작 일시2025-04-01T00:00:00+09:00
end_at종료 일시2025-04-30T23:59:59+09:00

3.1.1.13.2 - 1.0

scpcli archivestorage recovery history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]

Description

복구 이력 목록을 검색한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
start_at_to
required
string시작일까지2025-04-30T23:59:59+09:00
start_at_from
required
string시작일부터2025-04-01T00:00:00+09:00
bucket_id
required
string버킷 아이디7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
state
optional
string상태SUCCESS
limit
optional
integer조회 개수20
offset
optional
integer오프셋0

Responses

NameDescriptionExample
id복구 이력 아이디EXE-9df439a5-9e6d-46a4-806e-1e9991520763
recovery_id복구 아이디ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5
state상태SUCCESS
recovery_target_bucket_name복구 대상 버킷 이름test-obs-bucket
start_at시작 일시2025-04-01T00:00:00+09:00
end_at종료 일시2025-04-30T23:59:59+09:00

3.1.1.14 - RecoverObjects

3.1.1.14.1 - 1.1

scpcli archivestorage bucket object recover
--bucket_id <value>
--overwrite <value>
--recovery_infos <value>
--recovery_target_bucket_name <value>

Description

오브젝트를 오브젝트 스토리지에 복구한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
overwrite
required
boolean덮어쓰기True
recovery_infos
required
array오브젝트 복구 정보 목록'{"source_object_path": "/", "object_type": "FILE"}'
recovery_target_bucket_name
required
string복구 대상 버킷 이름obs-bucket-name

3.1.1.14.2 - 1.0

scpcli archivestorage bucket object recover
--bucket_id <value>
--overwrite <value>
--recovery_infos <value>
--recovery_target_bucket_name <value>

Description

오브젝트를 오브젝트 스토리지에 복구한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
overwrite
required
boolean덮어쓰기True
recovery_infos
required
array오브젝트 복구 정보 목록'{"source_object_path": "/", "object_type": "FILE"}'
recovery_target_bucket_name
required
string복구 대상 버킷 이름obs-bucket-name

3.1.1.15 - RecoverObjectVersions

3.1.1.15.1 - 1.1

scpcli archivestorage bucket object recover versions
--bucket_id <value>
--overwrite <value>
--source_object_version <value>
--source_object_path <value>
--recovery_target_bucket_name <value>

Description

오브젝트 버전을 오브젝트 스토리지에 복구한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
overwrite
required
boolean덮어쓰기True
source_object_version
required
string복구 소스 오브젝트 버전Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
source_object_path
required
string복구 소스 오브젝트 경로/
recovery_target_bucket_name
required
string복구 대상 버킷 이름obs-bucket-name

3.1.1.16 - SetArchivingPolicy

3.1.1.16.1 - 1.1

scpcli archivestorage archiving policy set
--archiving_policy_id <value>
--bucket_id <value>
--object_lifecycle <value>

Description

아카이빙 정책을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
string아카이빙 정책 아이디SCH-XXXXXXX
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_lifecycle
required
stringObject Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값1

3.1.1.16.2 - 1.0

scpcli archivestorage archiving policy set
--archiving_policy_id <value>
--bucket_id <value>
--object_lifecycle <value>

Description

아카이빙 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
string아카이빙 정책 아이디SCH-XXXXXXX
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_lifecycle
required
stringObject Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값1

3.1.1.17 - SetArchivingPolicyState

3.1.1.17.1 - 1.1

scpcli archivestorage archiving policy state set
--archiving_policy_id <value>
--bucket_id <value>
--state <value>

Description

아카이빙 정책 상태를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
string아카이빙 정책 아이디SCH-XXXXXXX
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
state
required
string아카이빙 정책 상태ACTIVE

3.1.1.18 - SetBucketEncryption

3.1.1.18.1 - 1.1

scpcli archivestorage bucket encryption set
--bucket_id <value>
--enabled <value>

Description

버킷 암호화 정보를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled
required
boolean암호화 여부True

3.1.1.18.2 - 1.0

scpcli archivestorage bucket encryption set
--bucket_id <value>
--enabled <value>

Description

버킷 암호화 정보를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled
required
boolean암호화 여부True

3.1.1.19 - SetBucketVersioning

3.1.1.19.1 - 1.1

scpcli archivestorage bucket versioning set
--bucket_id <value>
--enabled <value>

Description

버킷 버저닝을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled
required
boolean버저닝 여부True

3.1.1.20 - ShowArchivingHistory

3.1.1.20.1 - 1.1

scpcli archivestorage archiving history show
--bucket_id <value>
--id <value>

Description

아카이빙 이력을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디3d036efe-f576-48b0-8375-6d3704a95b63
id
required
string아카이빙 이력 아이디EXE-8f35b491-a060-453b-b825-e78440ca46de

Responses

NameDescriptionExample
source_object_path소스 오브젝트 경로example_source_object_path/
usage사용량1024
total_object_count총 오브젝트 개수100
archiving_object_count아카이빙 오브젝트 개수50
archiving_rate아카이빙 진행률100

3.1.1.20.2 - 1.0

scpcli archivestorage archiving history show
--bucket_id <value>
--id <value>

Description

아카이빙 이력을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디3d036efe-f576-48b0-8375-6d3704a95b63
id
required
string아카이빙 이력 아이디EXE-8f35b491-a060-453b-b825-e78440ca46de

Responses

NameDescriptionExample
source_object_path소스 오브젝트 경로example_source_object_path/
usage사용량1024
total_object_count총 오브젝트 개수100
archiving_object_count아카이빙 오브젝트 개수50
archiving_rate아카이빙 진행률100

3.1.1.21 - ShowArchivingPolicy

3.1.1.21.1 - 1.1

scpcli archivestorage archiving policy show
--archiving_policy_id <value>
--bucket_id <value>

Description

아카이빙 정책을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
string아카이빙 정책 아이디SCH-XXXXXXX
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
id아카이빙 정책 아이디SCH-XXXXXXX
bucket_id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source아카이빙 소스
object_lifecycleObject Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값1
state아카이빙 정책 상태ACTIVE

3.1.1.21.2 - 1.0

scpcli archivestorage archiving policy show
--archiving_policy_id <value>
--bucket_id <value>

Description

아카이빙 정책을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
string아카이빙 정책 아이디SCH-XXXXXXX
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
id아카이빙 정책 아이디SCH-XXXXXXX
bucket_id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source아카이빙 소스
object_lifecycleObject Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값1
state아카이빙 정책 상태ACTIVE

3.1.1.22 - ShowBucket

3.1.1.22.1 - 1.1

scpcli archivestorage bucket show
--bucket_id <value>

Description

버킷을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name버킷 이름astest
state버킷 상태ACTIVE
usage버킷 사용량10
archiving_source_bucket_name아카이빙 소스 버킷 이름obstest

3.1.1.22.2 - 1.0

scpcli archivestorage bucket show
--bucket_id <value>

Description

버킷을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name버킷 이름astest
state버킷 상태ACTIVE
usage버킷 사용량10
archiving_source_bucket_name아카이빙 소스 버킷 이름obstest

3.1.1.23 - ShowBucketEncryption

3.1.1.23.1 - 1.1

scpcli archivestorage bucket encryption show
--bucket_id <value>

Description

버킷 암호화 정보를 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled암호화 여부True

3.1.1.23.2 - 1.0

scpcli archivestorage bucket encryption show
--bucket_id <value>

Description

버킷 암호화 정보를 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled암호화 여부True

3.1.1.24 - ShowBucketVersioning

3.1.1.24.1 - 1.1

scpcli archivestorage bucket versioning show
--bucket_id <value>

Description

버킷 버저닝 정보를 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
id버킷 아이디138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled암호화 여부True

3.1.1.25 - ShowRecoveryHistory

3.1.1.25.1 - 1.1

scpcli archivestorage recovery history show
--bucket_id <value>
--id <value>

Description

복구 이력을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
id
required
string복구 이력 아이디EXE-9df439a5-9e6d-46a4-806e-1e9991520763

Responses

NameDescriptionExample
source_object_path소스 오브젝트 경로example_source_object_path/
usage사용량1024
total_object_count총 오브젝트 개수100
recovery_object_count복구 오브젝트 개수50
recovery_rate복구 진행률50

3.1.1.25.2 - 1.0

scpcli archivestorage recovery history show
--bucket_id <value>
--id <value>

Description

복구 이력을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
string버킷 아이디7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
id
required
string복구 이력 아이디EXE-9df439a5-9e6d-46a4-806e-1e9991520763

Responses

NameDescriptionExample
source_object_path소스 오브젝트 경로example_source_object_path/
usage사용량1024
total_object_count총 오브젝트 개수100
recovery_object_count복구 오브젝트 개수50
recovery_rate복구 진행률50

3.2 - Backup

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Backup 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20260331
1.1CURRENT-

3.2.1 - CLIs

3.2.1.1 - Check Backup Master Connection State

3.2.1.1.1 - 1.1

scpcli backup backup agent connection state check
--backup_agent_id <value>

Description

백업 마스터 연결 상태 확인

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.1.2 - 1.0

scpcli backup backup agent connection state check
--backup_agent_id <value>

Description

백업 마스터 연결 상태 확인

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.2 - Check Backup Name Duplicate

3.2.1.2.1 - 1.1

scpcli backup backup name duplicate check
--backup_name <value>

Description

Backup명을 중복 체크한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_name
required
stringBackup명backup-001

Responses

NameDescriptionExample
result결과True

3.2.1.2.2 - 1.0

scpcli backup backup name duplicate check
--backup_name <value>

Description

Backup명을 중복 체크한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_name
required
stringBackup명backup-001

Responses

NameDescriptionExample
result결과True

3.2.1.3 - Check Backup Restore Server Name Duplicate

3.2.1.3.1 - 1.1

scpcli backup backup restore server name duplicate check
--restore_server_name <value>

Description

복구 서버명을 중복 체크한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
restore_server_name
required
string복구 서버명restoretest1

Responses

NameDescriptionExample
result결과True

3.2.1.3.2 - 1.0

scpcli backup backup restore server name duplicate check
--restore_server_name <value>

Description

복구 서버명을 중복 체크한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
restore_server_name
required
string복구 서버명restoretest1

Responses

NameDescriptionExample
result결과True

3.2.1.4 - Check Filesystem Path Duplication

3.2.1.4.1 - 1.1

scpcli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Filesystem 경로 중복 체크

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_path
required
string백업 대상 파일 시스템 경로/aaa

Responses

NameDescriptionExample
result결과True

3.2.1.4.2 - 1.0

scpcli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Filesystem 경로 중복 체크

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_path
required
string백업 대상 파일 시스템 경로/aaa

Responses

NameDescriptionExample
result결과True

3.2.1.5 - Create Backup

3.2.1.5.1 - 1.1

scpcli backup backup create
--server_uuid <value>
--server_category <value>
--schedules <value>
--policy_type <value>
--policy_category <value>
--name <value>
[--dr_enabled <value>]
[--encrypt_enabled <value>]
[--filesystem_paths <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]

Description

Backup을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
server_category
required
string대상 서버 카테고리```VIRTUAL_SERVER
schedules
required
array스케줄 목록'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'
policy_type
required
stringBackup 정책 유형VM_IMAGE
policy_category
required
stringBackup 정책 카테고리AGENTLESS
name
required
stringBackup명backup-001
dr_enabled
optional
booleanDR 사용 여부-
encrypt_enabled
optional
boolean암호화 사용 여부True
filesystem_paths
optional
array백업 대상 파일 시스템 경로/aaa
region
optional
string위치kr-west1
retention_period
optional
stringBackup 보관 기간WEEK_2
server_guid
optional
stringBackup 서버 GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.5.2 - 1.0

scpcli backup backup create
--server_uuid <value>
--server_category <value>
--schedules <value>
--policy_type <value>
--policy_category <value>
--name <value>
[--encrypt_enabled <value>]
[--filesystem_paths <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]

Description

Backup을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
server_category
required
string대상 서버 카테고리```VIRTUAL_SERVER
schedules
required
array스케줄 목록'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'
policy_type
required
stringBackup 정책 유형VM_IMAGE
policy_category
required
stringBackup 정책 카테고리AGENTLESS
name
required
stringBackup명backup-001
encrypt_enabled
optional
boolean암호화 사용 여부True
filesystem_paths
optional
array백업 대상 파일 시스템 경로/aaa
region
optional
string위치kr-west1
retention_period
optional
stringBackup 보관 기간WEEK_2
server_guid
optional
stringBackup 서버 GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.6 - Create Backup Agent

3.2.1.6.1 - 1.1

scpcli backup backup agent create
--server_uuid <value>
[--tags <value>]

Description

Backup Agent을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup Agent 대상 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.6.2 - 1.0

scpcli backup backup agent create
--server_uuid <value>
[--tags <value>]

Description

Backup Agent을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup Agent 대상 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.7 - Delete Backup

3.2.1.7.1 - 1.1

scpcli backup backup delete
--backup_id <value>

Description

Backup을 해지한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

3.2.1.7.2 - 1.0

scpcli backup backup delete
--backup_id <value>

Description

Backup을 해지한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

3.2.1.8 - Delete Backup Agent

3.2.1.8.1 - 1.1

scpcli backup backup agent delete
--backup_agent_id <value>

Description

Backup Agent를 해지한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

3.2.1.8.2 - 1.0

scpcli backup backup agent delete
--backup_agent_id <value>

Description

Backup Agent를 해지한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

3.2.1.9 - Delete Backup Restore Target

3.2.1.9.1 - 1.1

scpcli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

복구 대상을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_ids
required
array복구 대상 목록ca1a8e76-af49-40ea-93f8-a5989ffe138b

3.2.1.9.2 - 1.0

scpcli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

복구 대상을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_ids
required
array복구 대상 목록ca1a8e76-af49-40ea-93f8-a5989ffe138b

3.2.1.10 - List Agent Backup Restore Target Servers

3.2.1.10.1 - 1.1

scpcli backup agent backup restore target server list
--backup_id <value>
[--server_name <value>]
[--page <value>]
[--size <value>]

Description

복구 대상 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_name
optional
stringBackup 서버명server-001
page
optional
integer페이지0
size
optional
integer항목 수20

Responses

NameDescriptionExample
server_nameBackup 서버명server-001
server_os_version서버의 OS Type 과 버전UBUNTU 22.04
server_uuidBackup 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

3.2.1.10.2 - 1.0

scpcli backup agent backup restore target server list
--backup_id <value>
[--server_name <value>]
[--page <value>]
[--size <value>]

Description

복구 대상 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_name
optional
stringBackup 서버명server-001
page
optional
integer페이지0
size
optional
integer항목 수20

Responses

NameDescriptionExample
server_nameBackup 서버명server-001
server_os_version서버의 OS Type 과 버전UBUNTU 22.04
server_uuidBackup 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

3.2.1.11 - List Backup Agents

3.2.1.11.1 - 1.1

scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]

Description

Backup 대상 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup Agent명agent_abcd12
server_backup_agent_ip
optional
string대상 서버 Backup Agent IP11.22.33.44
server_name
optional
stringBackup Agent 대상 서버명server-001

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_countBackup 정책 수3
connection_stateBackup Agent 연결 상태SUCCESS
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent명agent_abcd12
server_backup_agent_ip대상 서버 Backup Agent IP11.22.33.44
server_nameBackup 서버명server-001
stateBackup Agent 상태AVAILABLE

3.2.1.11.2 - 1.0

scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]

Description

Backup 대상 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup Agent명agent_abcd12
server_backup_agent_ip
optional
string대상 서버 Backup Agent IP11.22.33.44
server_name
optional
stringBackup Agent 대상 서버명server-001

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_countBackup 정책 수3
connection_stateBackup Agent 연결 상태SUCCESS
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent명agent_abcd12
server_backup_agent_ip대상 서버 Backup Agent IP11.22.33.44
server_nameBackup 서버명server-001
stateBackup Agent 상태AVAILABLE

3.2.1.12 - List Backup Histories

3.2.1.12.1 - 1.1

scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Backup 이력을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
string시작 일시2024-09-30T15:00:00Z
backup_end_time
optional
string검색 종료 일시2024-10-31T14:59:59Z
backup_job_state
optional
****Backup 이력 상태SUCCESS
page
optional
integer페이지0
size
optional
integer항목 수20
sort
optional
string정렬 조건backup_start_time:desc

Responses

NameDescriptionExample
backup_end_time검색 종료 일시2024-10-31T14:59:59Z
backup_job_guidBackup job GUID3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_stateBackup 이력 상태SUCCESS
backup_start_time시작 일시2024-09-30T15:00:00Z
schedule_id스케줄 IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name스케줄명INCREMENTAL_DAILY_15:00:00-chg4By

3.2.1.12.2 - 1.0

scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Backup 이력을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
string시작 일시2024-09-30T15:00:00Z
backup_end_time
optional
string검색 종료 일시2024-10-31T14:59:59Z
backup_job_state
optional
****Backup 이력 상태SUCCESS
page
optional
integer페이지0
size
optional
integer항목 수20
sort
optional
string정렬 조건backup_start_time:desc

Responses

NameDescriptionExample
backup_end_time검색 종료 일시2024-10-31T14:59:59Z
backup_job_guidBackup job GUID3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_stateBackup 이력 상태SUCCESS
backup_start_time시작 일시2024-09-30T15:00:00Z
schedule_id스케줄 IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name스케줄명INCREMENTAL_DAILY_15:00:00-chg4By

3.2.1.13 - List Backup Region Relationship

3.2.1.13.1 - 1.1

scpcli backup backup region relationship list
[--from_region <value>]
[--from_availability_zone <value>]
[--to_region <value>]
[--to_availability_zone <value>]
[--backup_master_type <value>]

Description

List Backup Region Relationship.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
from_region
optional
string위치kr-west1
from_availability_zone
optional
stringAvailability Zone명kr-west1
to_region
optional
string위치kr-west1
to_availability_zone
optional
stringAvailability Zone명kr-west1
backup_master_type
optional
****Backup Master 유형AGENTLESS

Responses

NameDescriptionExample
from_availability_zoneAvailability Zone명kr-west1
from_region위치kr-west1
to_availability_zoneAvailability Zone명kr-west1
to_region위치kr-west1

3.2.1.13.2 - 1.0

scpcli backup backup region relationship list
[--from_region <value>]
[--from_availability_zone <value>]
[--to_region <value>]
[--to_availability_zone <value>]

Description

List Backup Region Relationship.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
from_region
optional
string위치kr-west1
from_availability_zone
optional
stringAvailability Zone명kr-west1
to_region
optional
string위치kr-west1
to_availability_zone
optional
stringAvailability Zone명kr-west1

Responses

NameDescriptionExample
from_availability_zoneAvailability Zone명kr-west1
from_region위치kr-west1
to_availability_zoneAvailability Zone명kr-west1
to_region위치kr-west1

3.2.1.14 - List Backup Restore Histories

3.2.1.14.1 - 1.1

scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]

Description

복구 이력을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
page
optional
integer페이지0
size
optional
integer항목 수20
sort
optional
string정렬 조건backup_start_time:desc
restore_state
optional
****복구 상태COMPLETED
start_time
optional
string시작 일시2024-09-30T15:00:00Z
end_time
optional
string검색 종료 일시2024-10-31T14:59:59Z

Responses

NameDescriptionExample
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_timeBackup 일시2024-10-28T05:38:48
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
restore_end_time복구 완료 일시2024-10-28T05:52:47
restore_server_id복구 서버 ID26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_name복구 서버명restoretest1
restore_start_time복구 시작 일시2024-10-28T05:52:47
restore_state복구 상태COMPLETED
schedule_name스케줄명INCREMENTAL_DAILY_15:00:00-chg4By

3.2.1.14.2 - 1.0

scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]

Description

복구 이력을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
page
optional
integer페이지0
size
optional
integer항목 수20
sort
optional
string정렬 조건backup_start_time:desc
restore_state
optional
****복구 상태COMPLETED
start_time
optional
string시작 일시2024-09-30T15:00:00Z
end_time
optional
string검색 종료 일시2024-10-31T14:59:59Z

Responses

NameDescriptionExample
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_timeBackup 일시2024-10-28T05:38:48
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
restore_end_time복구 완료 일시2024-10-28T05:52:47
restore_server_id복구 서버 ID26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_name복구 서버명restoretest1
restore_start_time복구 시작 일시2024-10-28T05:52:47
restore_state복구 상태COMPLETED
schedule_name스케줄명INCREMENTAL_DAILY_15:00:00-chg4By

3.2.1.15 - List Backup Restore Subnets

3.2.1.15.1 - 1.1

scpcli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]

Description

원본 서버와 다른 위치에 복구하기 위해 서브넷 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
region
required
string서버를 복구할 리전kr-west1
vpc_id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
stringSubnet 상태ACTIVE

Responses

NameDescriptionExample
id서브넷 ID023c57b14f11483689338d085e061492
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
cidrSubnet Cidr192.167.1.0/24
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP192.167.1.1
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet명subnetName
stateSubnet 상태ACTIVE
typeSubnet 유형GENERAL
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC명vpcName

3.2.1.15.2 - 1.0

scpcli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]

Description

원본 서버와 다른 위치에 복구하기 위해 서브넷 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
region
required
string서버를 복구할 리전kr-west1
vpc_id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
stringSubnet 상태ACTIVE

Responses

NameDescriptionExample
id서브넷 ID023c57b14f11483689338d085e061492
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
cidrSubnet Cidr192.167.1.0/24
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP192.167.1.1
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet명subnetName
stateSubnet 상태ACTIVE
typeSubnet 유형GENERAL
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC명vpcName

3.2.1.16 - List Backup Restore Targets

3.2.1.16.1 - 1.1

scpcli backup backup restore target list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

복구 대상 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
string시작 일시2024-09-30T15:00:00Z
backup_end_time
optional
string검색 종료 일시2024-10-31T14:59:59Z
page
optional
integer페이지0
size
optional
integer항목 수20
sort
optional
string정렬 조건backup_start_time:desc

Responses

NameDescriptionExample
backup_start_time시작 일시2024-09-30T15:00:00Z
is_restore_available해당 백업 Image로 복구 가능 여부true
restore_target_id복구 대상 목록ca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_periodBackup 보관 기간WEEK_2
schedule_id스케줄 IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name스케줄명INCREMENTAL_DAILY_15:00:00-chg4By
usage_gb백업 용량(GB)123.4

3.2.1.16.2 - 1.0

scpcli backup backup restore target list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

복구 대상 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
string시작 일시2024-09-30T15:00:00Z
backup_end_time
optional
string검색 종료 일시2024-10-31T14:59:59Z
page
optional
integer페이지0
size
optional
integer항목 수20
sort
optional
string정렬 조건backup_start_time:desc

Responses

NameDescriptionExample
backup_start_time시작 일시2024-09-30T15:00:00Z
is_restore_available해당 백업 Image로 복구 가능 여부true
restore_target_id복구 대상 목록ca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_periodBackup 보관 기간WEEK_2
schedule_id스케줄 IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name스케줄명INCREMENTAL_DAILY_15:00:00-chg4By
usage_gb백업 용량(GB)123.4

3.2.1.17 - List Backup Schedules

3.2.1.17.1 - 1.1

scpcli backup backup schedule list
--backup_id <value>

Description

스케줄 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
frequency스케줄 주기 유형DAILY
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name스케줄명INCREMENTAL_DAILY_15:00:00-chg4By
start_day스케줄 시작 요일MON
start_time스케줄 시작 시간14:00:00
start_week스케줄 시작 주WEEK_1
stateBackup 스케줄 상태AVAILABLE
type스케줄 유형FULL

3.2.1.17.2 - 1.0

scpcli backup backup schedule list
--backup_id <value>

Description

스케줄 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
frequency스케줄 주기 유형DAILY
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name스케줄명INCREMENTAL_DAILY_15:00:00-chg4By
start_day스케줄 시작 요일MON
start_time스케줄 시작 시간14:00:00
start_week스케줄 시작 주WEEK_1
stateBackup 스케줄 상태AVAILABLE
type스케줄 유형FULL

3.2.1.18 - List Backup Targets

3.2.1.18.1 - 1.1

scpcli backup backup target list
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]

Description

Backup 대상 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_category
required
****대상 서버 카테고리```VIRTUAL_SERVER
server_name
optional
stringBackup 서버명server-001
region
optional
string위치kr-west1
page
optional
integer페이지0
size
optional
integer항목 수20

Responses

NameDescriptionExample
server_guidBackup 서버 GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_nameBackup 서버명server-001
server_os_version서버의 OS Type 과 버전UBUNTU 22.04
server_type백업 서버 타입s1v1m2
server_uuidBackup 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

3.2.1.18.2 - 1.0

scpcli backup backup target list
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]

Description

Backup 대상 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
server_category
required
****대상 서버 카테고리```VIRTUAL_SERVER
server_name
optional
stringBackup 서버명server-001
region
optional
string위치kr-west1
page
optional
integer페이지0
size
optional
integer항목 수20

Responses

NameDescriptionExample
server_guidBackup 서버 GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_nameBackup 서버명server-001
server_os_version서버의 OS Type 과 버전UBUNTU 22.04
server_type백업 서버 타입s1v1m2
server_uuidBackup 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

3.2.1.19 - List Backups

3.2.1.19.1 - 1.1

scpcli backup backup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_name <value>]

Description

Backup 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup명backup-001
server_name
optional
stringBackup 서버명server-001

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameBackup명backup-001
policy_typeBackup 정책 유형VM_IMAGE
retention_periodBackup 보관 기간WEEK_2
role_type백업 역할 유형ORIGINAL
server_nameBackup 서버명server-001
stateBackup 상태AVAILABLE

3.2.1.19.2 - 1.0

scpcli backup backup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_name <value>]

Description

Backup 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup명backup-001
server_name
optional
stringBackup 서버명server-001

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameBackup명backup-001
policy_typeBackup 정책 유형VM_IMAGE
retention_periodBackup 보관 기간WEEK_2
role_type백업 역할 유형ORIGINAL
server_nameBackup 서버명server-001
stateBackup 상태AVAILABLE

3.2.1.20 - List Targets of Backup Agent

3.2.1.20.1 - 1.1

scpcli backup backup agent target list
--server_category <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]

Description

Backup Agent 대상 서버 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
server_category
required
string대상 서버 카테고리BAREMETAL_SERVER
size
optional
integersize20
page
optional
integerpage0
sort
optional
string정렬 조건-
server_name
optional
stringBackup 서버명server-001

Responses

NameDescriptionExample
server_backup_agent_ip대상 서버 Backup Agent IP11.22.33.44
server_nameBackup Agent 대상 서버명server-001
server_stateBackup 서버 상태RUNNING
server_uuidBackup Agent 대상 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

3.2.1.20.2 - 1.0

scpcli backup backup agent target list
--server_category <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]

Description

Backup Agent 대상 서버 목록

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
server_category
required
string대상 서버 카테고리BAREMETAL_SERVER
size
optional
integersize20
page
optional
integerpage0
sort
optional
string정렬 조건-
server_name
optional
stringBackup 서버명server-001

Responses

NameDescriptionExample
server_backup_agent_ip대상 서버 Backup Agent IP11.22.33.44
server_nameBackup Agent 대상 서버명server-001
server_stateBackup 서버 상태RUNNING
server_uuidBackup Agent 대상 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

3.2.1.21 - Manual Backup

3.2.1.21.1 - 1.1

scpcli backup backup manual backup create
--backup_id <value>

Description

즉시 Backup을 수행한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.21.2 - 1.0

scpcli backup backup manual backup create
--backup_id <value>

Description

즉시 Backup을 수행한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.22 - Restore Agent Backup

3.2.1.22.1 - 1.1

scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]

Description

백업을 복구한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_id
required
string복구 대상 목록ca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_uuid
required
string복구 서버 ID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_paths
required
array백업 대상 파일 시스템 경로'{"destination": "/data", "source": "/data"}'
overwrite
optional
boolean덮어쓰기True

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.22.2 - 1.0

scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]

Description

백업을 복구한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_id
required
string복구 대상 목록ca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_uuid
required
string복구 서버 ID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_paths
required
array백업 대상 파일 시스템 경로'{"destination": "/data", "source": "/data"}'
overwrite
optional
boolean덮어쓰기True

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.23 - Restore Backup

3.2.1.23.1 - 1.1

scpcli backup backup restore
--backup_id <value>
--server_type_id <value>
--restore_target_id <value>
--restore_server_name <value>
[--networks <value>]
[--restore_region <value>]
[--security_groups <value>]

Description

백업을 복구한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_type_id
required
string서버 유형 IDs1v1m2
restore_target_id
required
string복구 대상 목록ca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_name
required
string복구 서버명restoretest1
networks
optional
array복구용 네트워크 정보'{"subnet_id": "023c57b14f11483689338d085e061492"}'
restore_region
optional
string서버를 복구할 리전kr-west1
security_groups
optional
arraySecurity Group ID 목록023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.23.2 - 1.0

scpcli backup backup restore
--backup_id <value>
--server_type_id <value>
--restore_target_id <value>
--restore_server_name <value>
[--networks <value>]
[--restore_region <value>]
[--security_groups <value>]

Description

백업을 복구한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_type_id
required
string서버 유형 IDs1v1m2
restore_target_id
required
string복구 대상 목록ca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_name
required
string복구 서버명restoretest1
networks
optional
array복구용 네트워크 정보'{"subnet_id": "023c57b14f11483689338d085e061492"}'
restore_region
optional
string서버를 복구할 리전kr-west1
security_groups
optional
arraySecurity Group ID 목록023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
request_id요청 ID
resource자원

3.2.1.24 - Set Backup Schedule

3.2.1.24.1 - 1.1

scpcli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

스케줄 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
schedules
required
arrayBackup 스케줄 목록'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'

3.2.1.24.2 - 1.0

scpcli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

스케줄 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
schedules
required
arrayBackup 스케줄 목록'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'

3.2.1.25 - Set Filesystem Path

3.2.1.25.1 - 1.1

scpcli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>

Description

파일 시스템 경로 설정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_filesystem_paths
required
array백업 대상 파일 시스템 경로/aaa

3.2.1.25.2 - 1.0

scpcli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>

Description

파일 시스템 경로 설정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_filesystem_paths
required
array백업 대상 파일 시스템 경로/aaa

3.2.1.26 - Show Backup

3.2.1.26.1 - 1.1

scpcli backup backup show
--backup_id <value>

Description

Backup을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_idBackup Agent IDBACKUP_AGENT-abcd
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
dr_enabledDR 사용 여부
dr_regionDR Regionkr-west1
encrypt_enabled암호화 사용 여부False
filesystem_paths백업 대상 파일 시스템 경로[’/aaa’, ‘/bbb’]
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameBackup명backup-001
origin_backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
policy_categoryBackup 정책 카테고리AGENTLESS
policy_typeBackup 정책 유형VM_IMAGE
region위치kr-west1
replica_backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_periodBackup 보관 기간WEEK_2
role_type백업 역할 유형ORIGINAL
server_category대상 서버 카테고리VIRTUAL_SERVER
server_nameBackup 서버명server-001
server_os_type서버 OS TypeWINDOWS
server_region위치kr-west1
server_uuidBackup 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup 상태AVAILABLE

3.2.1.26.2 - 1.0

scpcli backup backup show
--backup_id <value>

Description

Backup을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_idBackup Agent IDBACKUP_AGENT-abcd
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
encrypt_enabled암호화 사용 여부False
filesystem_paths백업 대상 파일 시스템 경로[’/aaa’, ‘/bbb’]
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameBackup명backup-001
policy_categoryBackup 정책 카테고리AGENTLESS
policy_typeBackup 정책 유형VM_IMAGE
region위치kr-west1
retention_periodBackup 보관 기간WEEK_2
role_type백업 역할 유형ORIGINAL
server_category대상 서버 카테고리VIRTUAL_SERVER
server_nameBackup 서버명server-001
server_os_type서버 OS TypeWINDOWS
server_region위치kr-west1
server_uuidBackup 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup 상태AVAILABLE

3.2.1.27 - Show Backup Agent

3.2.1.27.1 - 1.1

scpcli backup backup agent show
--backup_agent_id <value>

Description

Backup Agent를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_master_ipBackup Master IP33.44.55.66
backup_master_nameBackup Master명backupmastertest
backup_policy_countBackup 정책 수3
connection_check_timeBackup Agent 연결 확인 시간2024-11-11T09:13:48Z
connection_stateBackup Agent 연결 상태SUCCESS
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
install_file_path설치 파일 경로http://linux-agent
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent명agent_abcd12
server_backup_agent_ip대상 서버 Backup Agent IP11.22.33.44
server_category대상 서버 카테고리VIRTUAL_SERVER
server_gateway_ip서버 Gateway IP22.33.44.55
server_nameBackup Agent 대상 서버명server-001
server_os_type서버 OS TypeWINDOWS
server_uuidBackup Agent 대상 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup Agent 상태AVAILABLE

3.2.1.27.2 - 1.0

scpcli backup backup agent show
--backup_agent_id <value>

Description

Backup Agent를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_master_ipBackup Master IP33.44.55.66
backup_master_nameBackup Master명backupmastertest
backup_policy_countBackup 정책 수3
connection_check_timeBackup Agent 연결 확인 시간2024-11-11T09:13:48Z
connection_stateBackup Agent 연결 상태SUCCESS
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
install_file_path설치 파일 경로http://linux-agent
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent명agent_abcd12
server_backup_agent_ip대상 서버 Backup Agent IP11.22.33.44
server_category대상 서버 카테고리VIRTUAL_SERVER
server_gateway_ip서버 Gateway IP22.33.44.55
server_nameBackup Agent 대상 서버명server-001
server_os_type서버 OS TypeWINDOWS
server_uuidBackup Agent 대상 서버 UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup Agent 상태AVAILABLE

3.2.1.28 - Show Backup Agent Install File Path

3.2.1.28.1 - 1.1

scpcli backup backup agent install file path show
--os_type <value>

Description

Backup Agent 설치 파일 경로 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
os_type
required
stringOS 유형-

Responses

NameDescriptionExample
install_file_path설치 파일 경로http://linux-agent

3.2.1.28.2 - 1.0

scpcli backup backup agent install file path show
--os_type <value>

Description

Backup Agent 설치 파일 경로 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
os_type
required
stringOS 유형-

Responses

NameDescriptionExample
install_file_path설치 파일 경로http://linux-agent

3.2.1.29 - Update Replication Use

3.2.1.29.1 - 1.1

scpcli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

복제 사용 여부를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
dr_enabled
required
booleanDR 사용 여부False

3.2.1.29.2 - 1.0

scpcli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

복제 사용 여부를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
dr_enabled
required
booleanDR 사용 여부False

3.2.1.30 - Update Retention Period

3.2.1.30.1 - 1.1

scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

보관 기간을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_period
required
stringBackup 보관 기간WEEK_2

3.2.1.30.2 - 1.0

scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

보관 기간을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_period
required
stringBackup 보관 기간WEEK_2

3.3 - Block Storage(BM)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Block Storage(BM) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1DEPRECATED20260331
1.2CURRENT-

3.3.1 - CLIs

3.3.1.1 - Add Volume Group Member on Volume Group

3.3.1.1.1 - 1.2

scpcli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>

Description

볼륨 그룹에 볼륨 그룹 멤버를 추가한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.3.1.1.2 - 1.1

scpcli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>

Description

볼륨 그룹에 볼륨 그룹 멤버를 추가한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.3.1.1.3 - 1.0

scpcli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>

Description

볼륨 그룹에 볼륨 그룹 멤버를 추가한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.3.1.2 - Attach Volume

3.3.1.2.1 - 1.2

scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

서버에 볼륨을 연결한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
attachments
required
array서버 id, 유형 목록'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
object_idObject id83c3c73d457345e3829ee6d5557c0016
object_typeObject 유형

3.3.1.2.2 - 1.1

scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

서버에 볼륨을 연결한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
attachments
required
array서버 id, 유형 목록'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
result볼륨 상세 정보

3.3.1.2.3 - 1.0

scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

서버에 볼륨을 연결한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
attachments
required
array서버 id, 유형 목록'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
result볼륨 상세 정보

3.3.1.3 - Create Volume

3.3.1.3.1 - 1.2

scpcli baremetal-blockstorage volume create
--throughput <value>
--iops <value>
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]

Description

볼륨을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
throughput
required
integerEnter the value between at least 125MB/s and up to 1,000MB/s.125
iops
required
integerEnter the value between at least 3,000 IOPS and up to 16,000 IOPS.3000
size_gb
required
integerVolume capacity(GB)10
name
required
string볼륨명bs-01
disk_type
required
string디스크 유형-
attachments
required
array서버 id, 유형 목록'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
array태그'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.3.2 - 1.1

scpcli baremetal-blockstorage volume create
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]

Description

볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
size_gb
required
integerVolume capacity(GB)10
name
required
string볼륨명bs-01
disk_type
required
string디스크 유형-
attachments
required
array서버 id, 유형 목록'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
array태그'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.3.3 - 1.0

scpcli baremetal-blockstorage volume create
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]

Description

볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size_gb
required
integerVolume capacity(GB)10
name
required
string볼륨명bs-01
disk_type
required
string디스크 유형-
attachments
required
array서버 id, 유형 목록'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
array태그'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.4 - Create Volume Group

3.3.1.4.1 - 1.2

scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]

Description

볼륨 그룹을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
string볼륨 그룹명vg-01
tags
optional
array태그'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.4.2 - 1.1

scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]

Description

볼륨 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
string볼륨 그룹명vg-01
tags
optional
array태그'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.4.3 - 1.0

scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]

Description

볼륨 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
string볼륨 그룹명vg-01
tags
optional
array태그'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.5 - Create Volume Group Recovery

3.3.1.5.1 - 1.2

scpcli baremetal-blockstorage volume-group recovery create
--volume_group_id <value>
--snapshot_id <value>
--block_storage_name_prefix <value>

Description

복구본 볼륨 그룹을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
block_storage_name_prefix
required
stringBlock Storage명 접두사prefix-

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.5.2 - 1.1

scpcli baremetal-blockstorage volume-group recovery create
--volume_group_id <value>
--snapshot_id <value>
--block_storage_name_prefix <value>

Description

복구본 볼륨 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
block_storage_name_prefix
required
stringBlock Storage명 접두사prefix-

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.6 - Create Volume Group Replication

3.3.1.6.1 - 1.2

scpcli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>

Description

복제본 볼륨 그룹을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
replication_volume_name_prefix
required
string복제본 볼륨명 접두사dr
region
required
string리전kr-west1
name
required
string복제본 볼륨 그룹명replica-vg-01
cycle
required
string복제 주기-

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.6.2 - 1.1

scpcli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>

Description

복제본 볼륨 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
replication_volume_name_prefix
required
string복제본 볼륨명 접두사dr
region
required
string리전kr-west1
name
required
string복제본 볼륨 그룹명replica-vg-01
cycle
required
string복제 주기-

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.6.3 - 1.0

scpcli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>

Description

복제본 볼륨 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
replication_volume_name_prefix
required
string복제본 볼륨명 접두사dr
region
required
string리전kr-west1
name
required
string복제본 볼륨 그룹명replica-vg-01
cycle
required
string복제 주기-

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.7 - Create Volume Group Snapshot

3.3.1.7.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

볼륨 그룹 스냅샷을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_id계정 id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_id볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.7.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

볼륨 그룹 스냅샷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_id계정 id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_id볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.7.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

볼륨 그룹 스냅샷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_id계정 id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_id볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.8 - Create Volume Group Snapshot Schedule

3.3.1.8.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 그룹 스냅샷 스케줄을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_week요일
frequency주기 DAILYWEEKLY
hour시간18
volume_group_id볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.8.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 그룹 스냅샷 스케줄을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_week요일
frequency주기 DAILYWEEKLY
hour시간18
volume_group_id볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.8.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 그룹 스냅샷 스케줄을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_week요일
frequency주기 DAILYWEEKLY
hour시간18
volume_group_id볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.9 - Create Volume Recovery

3.3.1.9.1 - 1.2

scpcli baremetal-blockstorage volume recovery create
--volume_id <value>
--snapshot_id <value>
--name <value>

Description

복구본 볼륨을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
name
required
string복구 볼륨명recovery-volume

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.9.2 - 1.1

scpcli baremetal-blockstorage volume recovery create
--volume_id <value>
--snapshot_id <value>
--name <value>

Description

복구본 볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
name
required
string복구 볼륨명recovery-volume

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.10 - Create Volume Replication

3.3.1.10.1 - 1.2

scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>

Description

복제본 볼륨을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
region
required
string리전kr-west1
name
required
string복제본 볼륨 목록replica-bs-01
cycle
required
string복제 주기-

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.10.2 - 1.1

scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>

Description

복제본 볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
region
required
string리전kr-west1
name
required
string복제본 볼륨 목록replica-bs-01
cycle
required
string복제 주기-

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.10.3 - 1.0

scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>

Description

복제본 볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
region
required
string리전kr-west1
name
required
string복제본 볼륨 목록replica-bs-01
cycle
required
string복제 주기-

Responses

NameDescriptionExample
request_id요청 idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_id자원 id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.11 - Create Volume Snapshot

3.3.1.11.1 - 1.2

scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

볼륨 스냅샷을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_id계정 id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_id볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.11.2 - 1.1

scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

볼륨 스냅샷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_id계정 id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_id볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.11.3 - 1.0

scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

볼륨 스냅샷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_id계정 id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_id볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.12 - Create Volume Snapshot Rate

3.3.1.12.1 - 1.2

scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>

Description

볼륨 스냅샷 용량을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integer스냅샷 용량100

Responses

NameDescriptionExample
is_snapshot_activated스냅샷 활성화 여부True
snapshot_rate스냅샷 용량100
volume_id볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.12.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>

Description

볼륨 스냅샷 용량을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integer스냅샷 용량100

Responses

NameDescriptionExample
is_snapshot_activated스냅샷 활성화 여부True
snapshot_rate스냅샷 용량100
volume_id볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.12.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>

Description

볼륨 스냅샷 용량을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integer스냅샷 용량100

Responses

NameDescriptionExample
is_snapshot_activated스냅샷 활성화 여부True
snapshot_rate스냅샷 용량100
volume_id볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.13 - Create Volume Snapshot Schedule

3.3.1.13.1 - 1.2

scpcli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 스냅샷 스케줄을 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_week요일
frequency주기 DAILYWEEKLY
hour시간18
volume_id볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.13.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 스냅샷 스케줄을 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_week요일
frequency주기 DAILYWEEKLY
hour시간18
volume_id볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.13.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 스냅샷 스케줄을 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_week요일
frequency주기 DAILYWEEKLY
hour시간18
volume_id볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.14 - Delete Volume

3.3.1.14.1 - 1.2

scpcli baremetal-blockstorage volume delete
--volume_id <value>

Description

볼륨을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.14.2 - 1.1

scpcli baremetal-blockstorage volume delete
--volume_id <value>

Description

볼륨을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.14.3 - 1.0

scpcli baremetal-blockstorage volume delete
--volume_id <value>

Description

볼륨을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.15 - Delete Volume Group Replication

3.3.1.15.1 - 1.2

scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

복제본 볼륨 그룹을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.15.2 - 1.1

scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

복제본 볼륨 그룹을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.15.3 - 1.0

scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

복제본 볼륨 그룹을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.16 - Delete Volume Group Snapshot

3.3.1.16.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>

Description

볼륩 그룹 스냅샷을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.16.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>

Description

볼륩 그룹 스냅샷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.16.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>

Description

볼륩 그룹 스냅샷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.17 - Delete Volume Group Snapshot Schedule

3.3.1.17.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>

Description

볼륨 그룹 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.17.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>

Description

볼륨 그룹 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.17.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>

Description

볼륨 그룹 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.18 - Delete Volume Replication

3.3.1.18.1 - 1.2

scpcli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

복제본 볼륨을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.18.2 - 1.1

scpcli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

복제본 볼륨을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.18.3 - 1.0

scpcli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

복제본 볼륨을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.19 - Delete Volume Snapshot

3.3.1.19.1 - 1.2

scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

볼륨 스냅샷을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.19.2 - 1.1

scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

볼륨 스냅샷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.19.3 - 1.0

scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

볼륨 스냅샷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.20 - Delete Volume Snapshot Rate

3.3.1.20.1 - 1.2

scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

볼륨 스냅샷 용량을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.20.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

볼륨 스냅샷 용량을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.20.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

볼륨 스냅샷 용량을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.21 - Delete Volume Snapshot Schedule

3.3.1.21.1 - 1.2

scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

볼륨 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.21.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

볼륨 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.21.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

볼륨 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.22 - Detach Volume

3.3.1.22.1 - 1.2

scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

서버에 연결된 볼륨을 분리한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
attachments
required
array연결해지 object id 목록-

3.3.1.22.2 - 1.1

scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

서버에 연결된 볼륨을 분리한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
attachments
required
array연결해지 object id 목록-

3.3.1.22.3 - 1.0

scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

서버에 연결된 볼륨을 분리한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
attachments
required
array연결해지 object id 목록-

3.3.1.23 - List Volume Group Snapshots

3.3.1.23.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

볼륨 그룹 스냅샷의 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dt생성일시2024-08-01T07:07:23.315Z
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932

3.3.1.23.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

볼륨 그룹 스냅샷의 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dt생성일시2024-08-01T07:07:23.315Z
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932

3.3.1.23.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

볼륨 그룹 스냅샷의 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dt생성일시2024-08-01T07:07:23.315Z
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932

3.3.1.24 - List Volume Groups

3.3.1.24.1 - 1.2

scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]

Description

볼륨 그룹 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지에 표시될 번호20
offset
optional
integerOffset0
sort
optional
string정렬column1:asc,column2:desc
name
optional
string볼륨 그룹명vg-01

Responses

NameDescriptionExample
id볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
account_id계정 id36827d9b643f46c2ae6bb7e63d633bfe
created_at생성일시2024-08-01T07:06:23.315Z
created_by생성자samsung-cloud-platform1@samsung.com
modified_at수정일시2024-08-01T07:06:25.315Z
modified_by수정자samsung-cloud-platform2@samsung.com
name볼륨 그룹명vg-01
num_of_block_storages볼륨 수2
purpose볼륨 그룹 구분ORG
state현재 상태

3.3.1.24.2 - 1.1

scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]

Description

볼륨 그룹 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지에 표시될 번호20
offset
optional
integerOffset0
sort
optional
string정렬column1:asc,column2:desc
name
optional
string볼륨 그룹명vg-01

Responses

NameDescriptionExample
id볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
account_id계정 id36827d9b643f46c2ae6bb7e63d633bfe
created_at생성일시2024-08-01T07:06:23.315Z
created_by생성자samsung-cloud-platform1@samsung.com
modified_at수정일시2024-08-01T07:06:25.315Z
modified_by수정자samsung-cloud-platform2@samsung.com
name볼륨 그룹명vg-01
num_of_block_storages볼륨 수2
purpose볼륨 그룹 구분ORG
state현재 상태

3.3.1.24.3 - 1.0

scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]

Description

볼륨 그룹 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지에 표시될 번호20
offset
optional
integerOffset0
sort
optional
string정렬column1:asc,column2:desc
name
optional
string볼륨 그룹명vg-01

Responses

NameDescriptionExample
id볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
account_id계정 id36827d9b643f46c2ae6bb7e63d633bfe
created_at생성일시2024-08-01T07:06:23.315Z
created_by생성자samsung-cloud-platform1@samsung.com
modified_at수정일시2024-08-01T07:06:25.315Z
modified_by수정자samsung-cloud-platform2@samsung.com
name볼륨 그룹명vg-01
num_of_block_storages볼륨 수2
purpose볼륨 그룹 구분ORG
state현재 상태

3.3.1.25 - List Volume Snapshots

3.3.1.25.1 - 1.2

scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

볼륨 스냅샷 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dt생성일시2024-08-01T07:07:23.315Z
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mb스냅샷 크기(MB)0

3.3.1.25.2 - 1.1

scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

볼륨 스냅샷 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dt생성일시2024-08-01T07:07:23.315Z
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mb스냅샷 크기(MB)0

3.3.1.25.3 - 1.0

scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

볼륨 스냅샷 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dt생성일시2024-08-01T07:07:23.315Z
snapshot_id스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_name스냅샷 이름vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mb스냅샷 크기(MB)0

3.3.1.26 - List Volumes

3.3.1.26.1 - 1.2

scpcli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

볼륨 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지에 표시될 번호20
offset
optional
integerOffset0
sort
optional
string정렬column1:asc,column2:desc
name
optional
string볼륨명bs-01
object_name
optional
string연결 서버명baremetal-server-name
volume_group_name
optional
string볼륨 그룹명vg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachments연결 서버[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}]
created_at생성일시
created_by생성자samsung-cloud-platform1@samsung.com
disk_type디스크 유형
has_relation관계 존재 여부False
is_in_volume_group볼륨 그룹 소속 여부False
is_snapshot_activated스냅샷 활성화 여부True
iscsi_target_ipsiscsi ip 목록{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_at수정일시
modified_by수정자samsung-cloud-platform2@samsung.com
name볼륨명bs-01
purpose볼륨 구분
size_gb볼륨 용량(GB)10
state현재 상태
volume_group볼륨 그룹

3.3.1.26.2 - 1.1

scpcli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

볼륨 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지에 표시될 번호20
offset
optional
integerOffset0
sort
optional
string정렬column1:asc,column2:desc
name
optional
string볼륨명bs-01
object_name
optional
string연결 서버명baremetal-server-name
volume_group_name
optional
string볼륨 그룹명vg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachments연결 서버[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}]
created_at생성일시
created_by생성자samsung-cloud-platform1@samsung.com
disk_type디스크 유형
has_relation관계 존재 여부False
is_in_volume_group볼륨 그룹 소속 여부False
is_snapshot_activated스냅샷 활성화 여부True
iscsi_target_ipsiscsi ip 목록{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_at수정일시
modified_by수정자samsung-cloud-platform2@samsung.com
name볼륨명bs-01
purpose볼륨 구분
size_gb볼륨 용량(GB)10
state현재 상태
volume_group볼륨 그룹

3.3.1.26.3 - 1.0

scpcli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

볼륨 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integer페이지에 표시될 번호20
offset
optional
integerOffset0
sort
optional
string정렬column1:asc,column2:desc
name
optional
string볼륨명bs-01
object_name
optional
string연결 서버명baremetal-server-name
volume_group_name
optional
string볼륨 그룹명vg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachments연결 서버[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}]
created_at생성일시
created_by생성자samsung-cloud-platform1@samsung.com
disk_type디스크 유형
has_relation관계 존재 여부False
is_in_volume_group볼륨 그룹 소속 여부False
is_snapshot_activated스냅샷 활성화 여부True
iscsi_target_ipsiscsi ip 목록{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_at수정일시
modified_by수정자samsung-cloud-platform2@samsung.com
name볼륨명bs-01
purpose볼륨 구분
size_gb볼륨 용량(GB)10
state현재 상태
volume_group볼륨 그룹

3.3.1.27 - Remove Volume Group Member on Volume Group

3.3.1.27.1 - 1.2

scpcli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>

Description

볼륨 그룹에서 볼륨 그룹 멤버를 제거한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.3.1.27.2 - 1.1

scpcli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>

Description

볼륨 그룹에서 볼륨 그룹 멤버를 제거한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.3.1.27.3 - 1.0

scpcli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>

Description

볼륨 그룹에서 볼륨 그룹 멤버를 제거한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.3.1.28 - Restore Volume Group Snapshot

3.3.1.28.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>

Description

볼륨 그룹 스냅샷을 복원한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.28.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>

Description

볼륨 그룹 스냅샷을 복원한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.28.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>

Description

볼륨 그룹 스냅샷을 복원한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

3.3.1.29 - Restore Volume Snapshot

3.3.1.29.1 - 1.2

scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

스냅샷에서 볼륨을 복원한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.29.2 - 1.1

scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

스냅샷에서 볼륨을 복원한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.29.3 - 1.0

scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

스냅샷에서 볼륨을 복원한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

3.3.1.30 - Set Volume Group Replication Cycle

3.3.1.30.1 - 1.2

scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>

Description

볼륨 그룹 복제 주기를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
cycle
required
string복제 주기-

3.3.1.30.2 - 1.1

scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>

Description

볼륨 그룹 복제 주기를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
cycle
required
string복제 주기-

3.3.1.30.3 - 1.0

scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>

Description

볼륨 그룹 복제 주기를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
cycle
required
string복제 주기-

3.3.1.31 - Set Volume Group Replication Policy

3.3.1.31.1 - 1.2

scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>

Description

볼륨 그룹 복제 정책을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
policy
required
string정책-

3.3.1.31.2 - 1.1

scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>

Description

볼륨 그룹 복제 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
policy
required
string정책-

3.3.1.31.3 - 1.0

scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>

Description

볼륨 그룹 복제 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
policy
required
string정책-

3.3.1.32 - Set Volume Group Snapshot Schedule

3.3.1.32.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 그룹 스냅샷 스케줄을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.3.1.32.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 그룹 스냅샷 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.3.1.32.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 그룹 스냅샷 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.3.1.33 - Set Volume QoS

3.3.1.33.1 - 1.2

scpcli baremetal-blockstorage volume qos set
--volume_id <value>
[--iops <value>]
[--throughput <value>]

Description

볼륨 QoS를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
iops
optional
integerIOPS. If omitted, the existing value will be retained.3000
throughput
optional
integerThroughput. If omitted, the existing value will be retained.125

3.3.1.34 - Set Volume Replication Cycle

3.3.1.34.1 - 1.2

scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

복제본 볼륨 주기를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
cycle
required
string복제 주기5MIN

3.3.1.34.2 - 1.1

scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

복제본 볼륨 주기를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
cycle
required
string복제 주기5MIN

3.3.1.34.3 - 1.0

scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

복제본 볼륨 주기를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
cycle
required
string복제 주기5MIN

3.3.1.35 - Set Volume Replication Policy

3.3.1.35.1 - 1.2

scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

복제본 볼륨 정책을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
policy
required
string정책-

3.3.1.35.2 - 1.1

scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

복제본 볼륨 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
policy
required
string정책-

3.3.1.35.3 - 1.0

scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

복제본 볼륨 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
policy
required
string정책-

3.3.1.36 - Set Volume Snapshot Rate

3.3.1.36.1 - 1.2

scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>

Description

볼륨 스냅샷 용량을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integer스냅샷 용량100

3.3.1.36.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>

Description

볼륨 스냅샷 용량을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integer스냅샷 용량100

3.3.1.36.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>

Description

볼륨 스냅샷 용량을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integer스냅샷 용량100

3.3.1.37 - Set Volume Snapshot Schedule

3.3.1.37.1 - 1.2

scpcli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 스냅샷 스케줄을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.3.1.37.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 스냅샷 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.3.1.37.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

볼륨 스냅샷 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000
hour
required
integer시간18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.3.1.38 - Show Volume

3.3.1.38.1 - 1.2

scpcli baremetal-blockstorage volume show
--volume_id <value>

Description

볼륨을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
result볼륨 상세 정보

3.3.1.38.2 - 1.1

scpcli baremetal-blockstorage volume show
--volume_id <value>

Description

볼륨을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
result볼륨 상세 정보

3.3.1.38.3 - 1.0

scpcli baremetal-blockstorage volume show
--volume_id <value>

Description

볼륨을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
result볼륨 상세 정보

3.3.1.39 - Show Volume Group

3.3.1.39.1 - 1.2

scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

볼륨 그룹을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
result볼륨 그룹 상세 정보

3.3.1.39.2 - 1.1

scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

볼륨 그룹을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
result볼륨 그룹 상세 정보

3.3.1.39.3 - 1.0

scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

볼륨 그룹을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
result볼륨 그룹 상세 정보

3.3.1.40 - Show Volume Group Replication

3.3.1.40.1 - 1.2

scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

복제본 볼륨 그룹을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
result볼륨 그룹 복제 정보

3.3.1.40.2 - 1.1

scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

복제본 볼륨 그룹을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
result볼륨 그룹 복제 정보

3.3.1.40.3 - 1.0

scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

복제본 볼륨 그룹을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
string볼륨 그룹 idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
result볼륨 그룹 복제 정보

3.3.1.41 - Show Volume Replication

3.3.1.41.1 - 1.2

scpcli baremetal-blockstorage volume replication show
--volume_id <value>

Description

복제본 볼륨을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
result볼륨 복제 정보

3.3.1.41.2 - 1.1

scpcli baremetal-blockstorage volume replication show
--volume_id <value>

Description

복제본 볼륨을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
result볼륨 복제 정보

3.3.1.41.3 - 1.0

scpcli baremetal-blockstorage volume replication show
--volume_id <value>

Description

복제본 볼륨을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
result볼륨 복제 정보

3.4 - File Storage

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 File Storage 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

3.4.1 - CLIs

3.4.1.1 - CreateSnapshot

3.4.1.1.1 - 1.1

scpcli filestorage volume snapshot create
--volume_id <value>

Description

파일스토리지 스냅샷을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
id스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
name스냅샷 이름my_volume.2024-10-01_14215
state스냅샷 상태available
size스냅샷 크기100
created_at생성 시간2024-07-30T04:54:33.219373
volume_id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.1.2 - 1.0

scpcli filestorage volume snapshot create
--volume_id <value>

Description

파일스토리지 스냅샷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
id스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
name스냅샷 이름my_volume.2024-10-01_14215
state스냅샷 상태available
size스냅샷 크기100
created_at생성 시간2024-07-30T04:54:33.219373
volume_id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.2 - CreateSnapshotSchedule

3.4.1.2.1 - 1.1

scpcli filestorage volume snapshot schedule create
--hour <value>
--frequency <value>
--volume_id <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]

Description

파일스토리지 스냅샷 스케줄을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
hour
required
string스냅샷 스케줄 시간23
frequency
required
string스냅샷 주기WEEKLY
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
snapshot_retention_count
optional
integer보관 개수10
day_of_week
optional
string스냅샷 스케줄 설정 요일MON

Responses

NameDescriptionExample
frequency스냅샷 주기WEEKLY
day_of_week스냅샷 스케줄 설정 요일MON
hour스냅샷 스케줄 시간23

3.4.1.2.2 - 1.0

scpcli filestorage volume snapshot schedule create
--hour <value>
--frequency <value>
--volume_id <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]

Description

파일스토리지 스냅샷 스케줄을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
hour
required
string스냅샷 스케줄 시간23
frequency
required
string스냅샷 주기WEEKLY
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
snapshot_retention_count
optional
integer보관 개수10
day_of_week
optional
string스냅샷 스케줄 설정 요일MON

Responses

NameDescriptionExample
frequency스냅샷 주기WEEKLY
day_of_week스냅샷 스케줄 설정 요일MON
hour스냅샷 스케줄 시간23

3.4.1.3 - CreateVolume

3.4.1.3.1 - 1.1

scpcli filestorage volume create
--type_name <value>
--protocol <value>
--name <value>
[--snapshot_id <value>]
[--cifs_password <value>]
[--tags <value>]

Description

파일스토리지를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
type_name
required
string볼륨 유형 이름HDD
protocol
required
string프로토콜NFS
name
required
string볼륨 이름my_volume
snapshot_id
optional
string스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
cifs_password
optional
stringCIFS 비밀번호cifspwd0!!
tags
optional
array'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
protocol프로토콜NFS
snapshot_id스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
type_name볼륨 유형 이름HDD
volume_id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_name볼륨 이름my_volume

3.4.1.3.2 - 1.0

scpcli filestorage volume create
--type_name <value>
--protocol <value>
--name <value>
[--snapshot_id <value>]
[--cifs_password <value>]
[--tags <value>]

Description

파일스토리지를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
type_name
required
string볼륨 유형 이름HDD
protocol
required
string프로토콜NFS
name
required
string볼륨 이름my_volume
snapshot_id
optional
string스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
cifs_password
optional
stringCIFS 비밀번호cifspwd0!!
tags
optional
array'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
protocol프로토콜NFS
snapshot_id스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
type_name볼륨 유형 이름HDD
volume_id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_name볼륨 이름my_volume

3.4.1.4 - CreateVolumeReplication

3.4.1.4.1 - 1.1

scpcli filestorage volume replication create
--replication_type <value>
--volume_id <value>
--region <value>
--replication_frequency <value>
--name <value>
[--cifs_password <value>]
[--backup_retention_count <value>]

Description

파일스토리지 복제를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
replication_type
required
string복제 유형replication
volume_id
required
string원본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
region
required
string복제본 리전kr-west1
replication_frequency
required
string복제 주기5min
name
required
string복제본 볼륨 이름my_volume
cifs_password
optional
stringCIFS 비밀번호cifspwd0!!
backup_retention_count
optional
integer백업 보관 개수2

Responses

NameDescriptionExample
replication_id복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_status복제 상태creating
source_volume_id원본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region원본 리전kr-west1
protocol프로토콜NFS
replication_volume_id복제본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region복제본 리전kr-west1

3.4.1.4.2 - 1.0

scpcli filestorage volume replication create
--replication_type <value>
--volume_id <value>
--region <value>
--replication_frequency <value>
--name <value>
[--cifs_password <value>]
[--backup_retention_count <value>]

Description

파일스토리지 복제를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
replication_type
required
string복제 유형replication
volume_id
required
string원본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
region
required
string복제본 리전kr-west1
replication_frequency
required
string복제 주기5min
name
required
string복제본 볼륨 이름my_volume
cifs_password
optional
stringCIFS 비밀번호cifspwd0!!
backup_retention_count
optional
integer백업 보관 개수2

Responses

NameDescriptionExample
replication_id복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_status복제 상태creating
source_volume_id원본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region원본 리전kr-west1
protocol프로토콜NFS
replication_volume_id복제본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region복제본 리전kr-west1

3.4.1.5 - DeleteSnapshot

3.4.1.5.1 - 1.1

scpcli filestorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

파일스토리지 스냅샷을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.5.2 - 1.0

scpcli filestorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

파일스토리지 스냅샷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.6 - DeleteSnapshotSchedule

3.4.1.6.1 - 1.1

scpcli filestorage volume snapshot schedule delete
--snapshot_schedule_id <value>
--volume_id <value>

Description

파일스토리지 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
string스냅샷 스케줄 아이디d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.6.2 - 1.0

scpcli filestorage volume snapshot schedule delete
--snapshot_schedule_id <value>
--volume_id <value>

Description

파일스토리지 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
string스냅샷 스케줄 아이디d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.7 - DeleteVolume

3.4.1.7.1 - 1.1

scpcli filestorage volume delete
--volume_id <value>

Description

파일스토리지를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.7.2 - 1.0

scpcli filestorage volume delete
--volume_id <value>

Description

파일스토리지를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.8 - DeleteVolumeReplication

3.4.1.8.1 - 1.1

scpcli filestorage volume replication delete
--replication_id <value>
--volume_id <value>

Description

파일스토리지 복제를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
replication_id
required
string복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.8.2 - 1.0

scpcli filestorage volume replication delete
--replication_id <value>
--volume_id <value>

Description

파일스토리지 복제를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
replication_id
required
string복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.9 - ListAccessRules

3.4.1.9.1 - 1.1

scpcli filestorage volume access rule list
--volume_id <value>

Description

접근제어 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
access_rule_state접근제어 상태active
object_type오브젝트 유형VM
object_id오브젝트 아이디43fq3347-02q4-4aa8-ccf9-affe4917bb6f

3.4.1.9.2 - 1.0

scpcli filestorage volume access rule list
--volume_id <value>

Description

접근제어 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
access_rule_state접근제어 상태active
object_type오브젝트 유형VM
object_id오브젝트 아이디43fq3347-02q4-4aa8-ccf9-affe4917bb6f

3.4.1.10 - ListSnapshots

3.4.1.10.1 - 1.1

scpcli filestorage volume snapshot list
--volume_id <value>

Description

파일스토리지 스냅샷 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
id스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
name스냅샷 이름my_volume.2024-10-01_14215
state스냅샷 상태available
size스냅샷 크기100
created_at생성 시간2024-07-30T04:54:33.219373

3.4.1.10.2 - 1.0

scpcli filestorage volume snapshot list
--volume_id <value>

Description

파일스토리지 스냅샷 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
id스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
name스냅샷 이름my_volume.2024-10-01_14215
state스냅샷 상태available
size스냅샷 크기100
created_at생성 시간2024-07-30T04:54:33.219373

3.4.1.11 - ListSnapshotSchedule

3.4.1.11.1 - 1.1

scpcli filestorage volume snapshot schedule list
--volume_id <value>

Description

파일스토리지 스냅샷 스케줄 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
id스냅샷 스케줄 아이디d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
frequency스냅샷 주기WEEKLY
day_of_week스냅샷 스케줄 설정 요일MON
hour스냅샷 스케줄 시간23

3.4.1.11.2 - 1.0

scpcli filestorage volume snapshot schedule list
--volume_id <value>

Description

파일스토리지 스냅샷 스케줄 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
id스냅샷 스케줄 아이디d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
frequency스냅샷 주기WEEKLY
day_of_week스냅샷 스케줄 설정 요일MON
hour스냅샷 스케줄 시간23

3.4.1.12 - ListVolumeReplicationRegion

3.4.1.12.1 - 1.1

scpcli filestorage volume replication region list
--replication_type <value>
--source_region_name <value>
[--type_name <value>]

Description

파일스토리지 복제 리전 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
replication_type
required
string복제 유형replication
source_region_name
required
string리전kr-west1
type_name
optional
string볼륨 유형 이름HDD

Responses

NameDescriptionExample
regions복제 리전 목록[‘kr-west1’]

3.4.1.12.2 - 1.0

scpcli filestorage volume replication region list
--replication_type <value>
--source_region_name <value>
[--type_name <value>]

Description

파일스토리지 복제 리전 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
replication_type
required
string복제 유형replication
source_region_name
required
string리전kr-west1
type_name
optional
string볼륨 유형 이름HDD

Responses

NameDescriptionExample
regions복제 리전 목록[‘kr-west1’]

3.4.1.13 - ListVolumeReplications

3.4.1.13.1 - 1.1

scpcli filestorage volume replication list
--volume_id <value>

Description

파일스토리지 복제 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
replication_id복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequency복제 주기5min
source_volume_id원본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region원본 리전kr-west1
source_volume_access_level원본 접근 레벨ro
replication_volume_id복제본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region복제본 리전kr-west1
replication_volume_access_level복제본 접근 레벨ro
replication_type복제 유형replication

3.4.1.13.2 - 1.0

scpcli filestorage volume replication list
--volume_id <value>

Description

파일스토리지 복제 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
replication_id복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequency복제 주기5min
source_volume_id원본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region원본 리전kr-west1
source_volume_access_level원본 접근 레벨ro
replication_volume_id복제본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region복제본 리전kr-west1
replication_volume_access_level복제본 접근 레벨ro
replication_type복제 유형replication

3.4.1.14 - ListVolumes

3.4.1.14.1 - 1.1

scpcli filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--type_name <value>]
[--sort <value>]

Description

파일스토리지 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
offset
optional
integeroffset-
limit
optional
integerlimit-
name
optional
string볼륨 이름my_volume
type_name
optional
string볼륨 유형 이름HDD
sort
optional
string정렬-

Responses

NameDescriptionExample
id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
name볼륨 이름my_volume
protocol프로토콜NFS
state볼륨 상태available
account_idAccount 아이디rwww523320dfvwbbefefsdvwdadsfa24c
created_at생성 시간2024-07-30T04:54:33.219373
type_id볼륨 유형 아이디jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_name볼륨 유형 이름HDD
purpose볼륨 용도replication

3.4.1.14.2 - 1.0

scpcli filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--type_name <value>]
[--sort <value>]

Description

파일스토리지 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
offset
optional
integeroffset-
limit
optional
integerlimit-
name
optional
string볼륨 이름my_volume
type_name
optional
string볼륨 유형 이름HDD
sort
optional
string정렬-

Responses

NameDescriptionExample
id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
name볼륨 이름my_volume
protocol프로토콜NFS
state볼륨 상태available
account_idAccount 아이디rwww523320dfvwbbefefsdvwdadsfa24c
created_at생성 시간2024-07-30T04:54:33.219373
type_id볼륨 유형 아이디jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_name볼륨 유형 이름HDD
purpose볼륨 용도replication

3.4.1.15 - RestoreSnapshot

3.4.1.15.1 - 1.1

scpcli filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>

Description

파일스토리지 스냅샷을 복구한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.15.2 - 1.0

scpcli filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>

Description

파일스토리지 스냅샷을 복구한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.16 - SetAccessRule

3.4.1.16.1 - 1.1

scpcli filestorage volume access rule set
--volume_id <value>
--action <value>
--object_type <value>
--object_id <value>

Description

파일스토리지 접근제어를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
action
required
string접근제어 액션add
object_type
required
string오브젝트 유형VM
object_id
required
string오브젝트 아이디43fq3347-02q4-4aa8-ccf9-affe4917bb6f

3.4.1.16.2 - 1.0

scpcli filestorage volume access rule set
--volume_id <value>
--action <value>
--object_type <value>
--object_id <value>

Description

파일스토리지 접근제어를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
action
required
string접근제어 액션add
object_type
required
string오브젝트 유형VM
object_id
required
string오브젝트 아이디43fq3347-02q4-4aa8-ccf9-affe4917bb6f

3.4.1.17 - SetSnapshotSchedule

3.4.1.17.1 - 1.1

scpcli filestorage volume snapshot schedule set
--snapshot_schedule_id <value>
--volume_id <value>
--hour <value>
--frequency <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]

Description

파일스토리지 스냅샷 스케줄을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
string스냅샷 스케줄 아이디d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
hour
required
string스냅샷 스케줄 시간23
frequency
required
string스냅샷 주기WEEKLY
snapshot_retention_count
optional
integer보관 개수10
day_of_week
optional
string스냅샷 스케줄 설정 요일MON

3.4.1.17.2 - 1.0

scpcli filestorage volume snapshot schedule set
--snapshot_schedule_id <value>
--volume_id <value>
--hour <value>
--frequency <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]

Description

파일스토리지 스냅샷 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
string스냅샷 스케줄 아이디d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
hour
required
string스냅샷 스케줄 시간23
frequency
required
string스냅샷 주기WEEKLY
snapshot_retention_count
optional
integer보관 개수10
day_of_week
optional
string스냅샷 스케줄 설정 요일MON

3.4.1.18 - SetVolume

3.4.1.18.1 - 1.1

scpcli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>

Description

파일스토리지를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
file_unit_recovery_enabled
required
boolean볼륨 파일 단위 복구 사용 여부True

3.4.1.18.2 - 1.0

scpcli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>

Description

파일스토리지를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
file_unit_recovery_enabled
required
boolean볼륨 파일 단위 복구 사용 여부True

3.4.1.19 - SetVolumeReplication

3.4.1.19.1 - 1.1

scpcli filestorage volume replication set
--replication_id <value>
--volume_id <value>
--replication_update_type <value>
[--replication_policy <value>]
[--replication_frequency <value>]
[--backup_retention_count <value>]

Description

파일스토리지 복제를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
replication_id
required
string복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_update_type
required
string복제 수정 유형policy
replication_policy
optional
****복제 정책use
replication_frequency
optional
****복제 주기5min
backup_retention_count
optional
integer백업 보관 개수2

3.4.1.19.2 - 1.0

scpcli filestorage volume replication set
--replication_id <value>
--volume_id <value>
--replication_update_type <value>
[--replication_policy <value>]
[--replication_frequency <value>]
[--backup_retention_count <value>]

Description

파일스토리지 복제를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
replication_id
required
string복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_update_type
required
string복제 수정 유형policy
replication_policy
optional
****복제 정책use
replication_frequency
optional
****복제 주기5min
backup_retention_count
optional
integer백업 보관 개수2

3.4.1.20 - ShowVolume

3.4.1.20.1 - 1.1

scpcli filestorage volume show
--volume_id <value>

Description

파일스토리지를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
name볼륨 이름my_volume
protocol프로토콜NFS
state볼륨 상태available
account_idAccount 아이디rwww523320dfvwbbefefsdvwdadsfa24c
created_at생성 시간2024-07-30T04:54:33.219373
type_id볼륨 유형 아이디jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_name볼륨 유형 이름HDD
purpose볼륨 용도replication
path볼륨 마운트 경로xxx.xx.xxx:/xxxxxxxx
usage볼륨 사용량100000
encryption_enabled볼륨 암호화 사용 여부True
file_unit_recovery_enabled볼륨 파일 단위 복구 사용 여부True
cifs_idCIFS 아이디cifsid
endpoint_path볼륨 엔드포인트 경로xxx.xx.xxx.xxx

3.4.1.20.2 - 1.0

scpcli filestorage volume show
--volume_id <value>

Description

파일스토리지를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
name볼륨 이름my_volume
protocol프로토콜NFS
state볼륨 상태available
account_idAccount 아이디rwww523320dfvwbbefefsdvwdadsfa24c
created_at생성 시간2024-07-30T04:54:33.219373
type_id볼륨 유형 아이디jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_name볼륨 유형 이름HDD
purpose볼륨 용도replication
path볼륨 마운트 경로xxx.xx.xxx:/xxxxxxxx
usage볼륨 사용량100000
encryption_enabled볼륨 암호화 사용 여부True
file_unit_recovery_enabled볼륨 파일 단위 복구 사용 여부True
cifs_idCIFS 아이디cifsid
endpoint_path볼륨 엔드포인트 경로xxx.xx.xxx.xxx

3.4.1.21 - ShowVolumeReplication

3.4.1.21.1 - 1.1

scpcli filestorage volume replication show
--replication_id <value>
--volume_id <value>

Description

파일스토리지 복제를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
replication_id
required
string복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
replication_id복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequency복제 주기5min
source_volume_id원본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region원본 리전kr-west1
source_volume_access_level원본 접근 레벨ro
replication_volume_id복제본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region복제본 리전kr-west1
replication_volume_access_level복제본 접근 레벨ro
replication_type복제 유형replication
source_volume_name원본 볼륨 이름my_volume
replication_policy복제 정책use
replication_status복제 상태creating
replication_volume_name복제본 볼륨 이름my_volume
backup_retention_count백업 보관 개수2

3.4.1.21.2 - 1.0

scpcli filestorage volume replication show
--replication_id <value>
--volume_id <value>

Description

파일스토리지 복제를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
replication_id
required
string복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
replication_id복제 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequency복제 주기5min
source_volume_id원본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region원본 리전kr-west1
source_volume_access_level원본 접근 레벨ro
replication_volume_id복제본 볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region복제본 리전kr-west1
replication_volume_access_level복제본 접근 레벨ro
replication_type복제 유형replication
source_volume_name원본 볼륨 이름my_volume
replication_policy복제 정책use
replication_status복제 상태creating
replication_volume_name복제본 볼륨 이름my_volume
backup_retention_count백업 보관 개수2

3.5 - Parallel File Storage

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Parallel File Storage 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

3.5.1 - CLIs

3.5.1.1 - CreateSnapshot

3.5.1.1.1 - 1.0

scpcli parallel-filestorage snapshot create
--volume_id <value>

Description

병렬 파일스토리지 스냅샷을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
snapshot스냅샷

3.5.1.2 - CreateVolume

3.5.1.2.1 - 1.0

scpcli parallel-filestorage volume create
--capacity_tb <value>
--name <value>
[--tags <value>]

Description

병렬 파일스토리지를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
capacity_tb
required
integer볼륨 용량100
name
required
string볼륨 이름my_volume
tags
optional
array'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
name볼륨 이름my_volume
state볼륨 상태available
created_at생성 시간2024-07-30T04:54:33.219373
capacity_tb볼륨 용량100
account_id어카운트 아이디rwww523320dfvwbbefefsdvwdadsfa24c

3.5.1.3 - DeleteSnapshot

3.5.1.3.1 - 1.0

scpcli parallel-filestorage snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

병렬 파일스토리지 스냅샷을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
snapshot_id
required
string스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.5.1.4 - DeleteVolume

3.5.1.4.1 - 1.0

scpcli parallel-filestorage volume delete
--volume_id <value>

Description

병렬 파일스토리지를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

3.5.1.5 - ListAccessRule

3.5.1.5.1 - 1.0

scpcli parallel-filestorage access rule list
--volume_id <value>

Description

병렬 파일스토리지 접근제어 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
object_id오브젝트 아이디43fq3347-02q4-4aa8-ccf9-affe4917bb6f
object_type오브젝트 유형GPU_NODE
object_name오브젝트 이름objectname
object_state오브젝트 상태RUNNING
access_state접근제어 상태all
access_ip_list

3.5.1.6 - ListSnapshots

3.5.1.6.1 - 1.0

scpcli parallel-filestorage snapshot list
--volume_id <value>

Description

병렬 파일스토리지 스냅샷 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
id스냅샷 아이디40htrre5b-eww25-ff2b-a426-6afefas65a3b
name스냅샷 이름snapshot.2025-10-30_121212
size스냅샷 크기100
state스냅샷 상태available
created_at생성 시간2024-10-30T04:54:33.219373

3.5.1.7 - ListVolumes

3.5.1.7.1 - 1.0

scpcli parallel-filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--sort <value>]

Description

병렬 파일스토리지 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
offset
optional
integeroffset-
limit
optional
integerlimit-
name
optional
string볼륨 이름my_volume
sort
optional
string정렬-

Responses

NameDescriptionExample
id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
name볼륨 이름my_volume
state볼륨 상태available
created_at생성 시간2024-07-30T04:54:33.219373
capacity_tb볼륨 용량100
account_id어카운트 아이디rwww523320dfvwbbefefsdvwdadsfa24c

3.5.1.8 - SetAccessRule

3.5.1.8.1 - 1.0

scpcli parallel-filestorage access rule set
--volume_id <value>
--remove_access_rules <value>
--add_access_rules <value>

Description

병렬 파일스토리지 접근제어를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
remove_access_rules
required
array'{"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f", "object_type": "GPU_NODE"}'
add_access_rules
required
array'{"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f", "object_type": "GPU_NODE"}'

3.5.1.9 - SetVolumeCapacity

3.5.1.9.1 - 1.0

scpcli parallel-filestorage volume capacity set
--volume_id <value>
--capacity_tb <value>

Description

병렬 파일스토리지 용량을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
capacity_tb
required
integer볼륨 용량100

3.5.1.10 - ShowVolume

3.5.1.10.1 - 1.0

scpcli parallel-filestorage volume show
--volume_id <value>

Description

병렬 파일스토리지를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
string볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
id볼륨 아이디bfdbabf2-04d9-4e8b-a205-020f8e6da438
name볼륨 이름my_volume
state볼륨 상태available
created_at생성 시간2024-07-30T04:54:33.219373
capacity_tb볼륨 용량100
account_id어카운트 아이디rwww523320dfvwbbefefsdvwdadsfa24c
mount_path볼륨 마운트 경로xxx.xx.xxx:/xxxxxxxx

4 - Container

4.1 - Container Registry

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Container Registry 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0SUPPORTED20260630
1.1CURRENT-

4.1.1 - CLIs

4.1.1.1 - Check Registry Name Duplication

4.1.1.1.1 - 1.1

scpcli scr registry name-duplication show
--name <value>

Description

Registry명 중복 여부

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringRegistry명sample

Responses

NameDescriptionExample
result이름 중복 여부True

4.1.1.1.2 - 1.0

scpcli scr registry name-duplication show
--name <value>

Description

Registry명 중복 여부

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
name
required
stringRegistry명sample

Responses

NameDescriptionExample
result이름 중복 여부True

4.1.1.2 - Check Repository Name Duplication

4.1.1.2.1 - 1.1

scpcli scr repository name-duplication show
--name <value>
--registry_id <value>

Description

Registry명 중복 여부

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringRepository명sample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
result이름 중복 여부True

4.1.1.2.2 - 1.0

scpcli scr repository name-duplication show
--name <value>
--registry_id <value>

Description

Registry명 중복 여부

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
name
required
stringRepository명sample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
result이름 중복 여부True

4.1.1.3 - Check Tags Vulnerability

4.1.1.3.1 - 1.1

scpcli scr tags scan set
--tags_id <value>

Description

취약점 검사 수행

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

4.1.1.3.2 - 1.0

scpcli scr tags scan set
--tags_id <value>

Description

취약점 검사 수행

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

4.1.1.4 - Create Registry

4.1.1.4.1 - 1.1

scpcli scr registry create
--public_visible_enabled <value>
--public_acl_resources <value>
--private_acl_resources <value>
--private_acl_enabled <value>
--name <value>
[--public_acl_enabled <value>]
[--public_endpoint_enabled <value>]
[--tags <value>]

Description

Registry 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
public_visible_enabled
required
boolean가시성 Public 선택 여부True
public_acl_resources
required
arrayPublic 접근 허용 리소스 리스트'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_resources
required
arrayPrivate 접근 허용 리소스 리스트'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate 접근 제어 활성화True
name
required
stringRegistry명sample
public_acl_enabled
optional
booleanPublic 접근 제어 활성화True
public_endpoint_enabled
optional
booleanPublic Endpoint 활성화True
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
message설명Carpe diem.
stateRegistry 상태Running

4.1.1.4.2 - 1.0

scpcli scr registry create
--public_visible_enabled <value>
--public_acl_resources <value>
--private_acl_resources <value>
--private_acl_enabled <value>
--name <value>
[--public_acl_enabled <value>]
[--public_endpoint_enabled <value>]
[--tags <value>]

Description

Registry 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
public_visible_enabled
required
boolean가시성 Public 선택 여부True
public_acl_resources
required
arrayPublic 접근 허용 리소스 리스트'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_resources
required
arrayPrivate 접근 허용 리소스 리스트'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate 접근 제어 활성화True
name
required
stringRegistry명sample
public_acl_enabled
optional
booleanPublic 접근 제어 활성화True
public_endpoint_enabled
optional
booleanPublic Endpoint 활성화True
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
message설명Carpe diem.
stateRegistry 상태Running

4.1.1.5 - Create Repository

4.1.1.5.1 - 1.1

scpcli scr repository create
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
--locked <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_tag_expression <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>
--registry_id <value>
--name <value>
--description <value>
[--tags <value>]
[--critical_limit <value>]
[--high_limit <value>]

Description

Repository 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
severity_limit
required
string취약점 레벨High
secret_excepted
required
booleanSecret 제외 여부True
scan_policy_enabled
required
boolean스캔 제외 정책 여부True
language_excepted
required
booleanLanguage 제외 여부True
fixed_version_excepted
required
booleanFixed version 제외 여부True
auto_scan_enabled
required
boolean이미지 자동 스캔 여부True
vulnerable_image_pull_prevented
required
boolean취약점이 있는 이미지 Pull 제한 여부True
unscanned_image_pull_prevented
required
boolean스캔 되지 않은 이미지 Pull 제한 여부True
unmodified_excepted
required
boolean수정 버전이 없는 취약점 제외 여부True
locked
required
booleanLockedTrue
untagged_rule_enabled
required
booleanUntagged Image 자동 삭제 활성화True
untagged_rule_duration
required
integerUntagged Image 자동 삭제 기한90
outdated_rule_tag_expression
required
stringTagged rule tag expression*
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle 정책 활성화True
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
name
required
stringRepository명sample
description
required
string설명Carpe diem.
tags
optional
array태그 목록'{"key": "", "value": ""}'
critical_limit
optional
integerCritical 심각도20
high_limit
optional
integerHigh 심각도20

Responses

NameDescriptionExample
idRepository IDe5611ca6c1484df480668c5adce8b078
message설명Carpe diem.
stateRepository 상태Active

4.1.1.5.2 - 1.0

scpcli scr repository create
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
--locked <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>
--registry_id <value>
--name <value>
--description <value>
[--tags <value>]
[--critical_limit <value>]
[--high_limit <value>]

Description

Repository 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
severity_limit
required
string취약점 레벨High
secret_excepted
required
booleanSecret 제외 여부True
scan_policy_enabled
required
boolean스캔 제외 정책 여부True
language_excepted
required
booleanLanguage 제외 여부True
fixed_version_excepted
required
booleanFixed version 제외 여부True
auto_scan_enabled
required
boolean이미지 자동 스캔 여부True
vulnerable_image_pull_prevented
required
boolean취약점이 있는 이미지 Pull 제한 여부True
unscanned_image_pull_prevented
required
boolean스캔 되지 않은 이미지 Pull 제한 여부True
unmodified_excepted
required
boolean수정 버전이 없는 취약점 제외 여부True
locked
required
booleanLockedTrue
untagged_rule_enabled
required
booleanUntagged Image 자동 삭제 활성화True
untagged_rule_duration
required
integerUntagged Image 자동 삭제 기한90
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle 정책 활성화True
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
name
required
stringRepository명sample
description
required
string설명Carpe diem.
tags
optional
array태그 목록'{"key": "", "value": ""}'
critical_limit
optional
integerCritical 심각도20
high_limit
optional
integerHigh 심각도20

Responses

NameDescriptionExample
idRepository IDe5611ca6c1484df480668c5adce8b078
message설명Carpe diem.
stateRepository 상태Active

4.1.1.6 - Delete Image

4.1.1.6.1 - 1.1

scpcli scr image delete
--image_id <value>

Description

Image 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28

4.1.1.6.2 - 1.0

scpcli scr image delete
--image_id <value>

Description

Image 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28

4.1.1.7 - Delete Registry

4.1.1.7.1 - 1.1

scpcli scr registry delete
--registry_id <value>

Description

Registry 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

4.1.1.7.2 - 1.0

scpcli scr registry delete
--registry_id <value>

Description

Registry 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

4.1.1.8 - Delete Repository

4.1.1.8.1 - 1.1

scpcli scr repository delete
--repository_id <value>

Description

Repository 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

4.1.1.8.2 - 1.0

scpcli scr repository delete
--repository_id <value>

Description

Repository 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

4.1.1.9 - Delete Tags

4.1.1.9.1 - 1.1

scpcli scr tag delete
--tags_id <value>
--tag_names <value>

Description

Tags 복수 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
tag_names
required
array태그명[

4.1.1.9.2 - 1.0

scpcli scr tag delete
--tags_id <value>
--tag_names <value>

Description

Tags 복수 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
tag_names
required
array태그명[

4.1.1.10 - Delete Tagses

4.1.1.10.1 - 1.1

scpcli scr tags delete
--tags_ids <value>

Description

Tags 복수 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
tags_ids
required
array태그 ID 목록[

4.1.1.10.2 - 1.0

scpcli scr tags delete
--tags_ids <value>

Description

Tags 복수 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
tags_ids
required
array태그 ID 목록[

4.1.1.11 - Download Manifest

4.1.1.11.1 - 1.1

scpcli scr tags manifest show
--tags_id <value>

Description

매니페스트 파일 다운로드

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

Responses

NameDescriptionExample

4.1.1.11.2 - 1.0

scpcli scr tags manifest show
--tags_id <value>

Description

매니페스트 파일 다운로드

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

Responses

NameDescriptionExample

4.1.1.12 - List Connectable Resources

4.1.1.12.1 - 1.1

scpcli scr registry connectable-resource list

Description

get connectable domains

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
id자원 ID558496f6c49d43459e61e191fb3c08fe
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
nameRegistry명sample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
type자원 타입container-registry

4.1.1.12.2 - 1.0

scpcli scr registry connectable-resource list

Description

get connectable domains

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Responses

NameDescriptionExample
id자원 ID558496f6c49d43459e61e191fb3c08fe
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
nameRegistry명sample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
type자원 타입container-registry

4.1.1.13 - List Images

4.1.1.13.1 - 1.1

scpcli scr repository image list
--repository_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]

Description

Image 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
string이미지명sample

Responses

NameDescriptionExample
id이미지 ID5b5ed4f2881a440583536fc1a8c39a28
created_at생성일시2024-08-15T13:05:09.701645823+09:00
modified_at수정일시2024-08-16T16:06:09.701645823+09:00
name이미지명sample
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
pull_countPull 횟수20
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
state이미지 상태Active

4.1.1.13.2 - 1.0

scpcli scr repository image list
--repository_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]

Description

Image 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
string이미지명sample

Responses

NameDescriptionExample
id이미지 ID5b5ed4f2881a440583536fc1a8c39a28
created_at생성일시2024-08-15T13:05:09.701645823+09:00
modified_at수정일시2024-08-16T16:06:09.701645823+09:00
name이미지명sample
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817
pull_countPull 횟수20
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
state이미지 상태Active

4.1.1.14 - List Registries

4.1.1.14.1 - 1.1

scpcli scr registry list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]

Description

Registry 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRegistry명sample
state
optional
stringRegistry 상태Running

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_nameBucket명4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry명sample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_visible_enabled가시성 Public 선택 여부True
stateRegistry 상태Running

4.1.1.14.2 - 1.0

scpcli scr registry list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]

Description

Registry 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRegistry명sample
state
optional
stringRegistry 상태Running

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_nameBucket명4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry명sample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_visible_enabled가시성 Public 선택 여부True
stateRegistry 상태Running

4.1.1.15 - List Repositories

4.1.1.15.1 - 1.1

scpcli scr registry repository list
--registry_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]

Description

Repository 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRepository명sample

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameRepository명sample
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
stateRepository 상태Active

4.1.1.15.2 - 1.0

scpcli scr registry repository list
--registry_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]

Description

Repository 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRepository명sample

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameRepository명sample
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
stateRepository 상태Active

4.1.1.16 - List Tagses

4.1.1.16.1 - 1.1

scpcli scr image tags list
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]

Description

Tags 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
string참조 중인 tags 목록["sample"]

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
hash_digestHash digest
last_scanned_at마지막 스캔 일시2024-08-15T13:05:09.701645823+09:00
lock_policyLock 정책
modified_at수정일시2024-08-16T16:06:09.701645823+09:00
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
re_scan_needed취약점 점검 재시도 필요 여부True
reference_tags참조 중인 tags 목록[“sample”]
referenced_by참조 여부
scan_state스캔 상태Scanning state
scan_summary
size크기10
state태그 상태Active

4.1.1.16.2 - 1.0

scpcli scr image tags list
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]

Description

Tags 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
string참조 중인 tags 목록["sample"]

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
hash_digestHash digest
last_scanned_at마지막 스캔 일시2024-08-15T13:05:09.701645823+09:00
lock_policyLock 정책
modified_at수정일시2024-08-16T16:06:09.701645823+09:00
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
re_scan_needed취약점 점검 재시도 필요 여부True
reference_tags참조 중인 tags 목록[“sample”]
referenced_by참조 여부
scan_state스캔 상태Scanning state
scan_summary
size크기10
state태그 상태Active

4.1.1.17 - Run Image Lifecycle Policy Preview

4.1.1.17.1 - 1.1

scpcli scr image lifecycle-policy-preview run
--image_id <value>

Description

Lifecycle 정책 Preview 실행

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample

4.1.1.17.2 - 1.0

scpcli scr image lifecycle-policy-preview run
--image_id <value>

Description

Lifecycle 정책 Preview 실행

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample

4.1.1.18 - Show Image

4.1.1.18.1 - 1.1

scpcli scr image show
--image_id <value>

Description

Image 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Carpe diem.
lifecycle_policyLifecycle 정책
lock_policyLock 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name이미지명sample
pull_countPull 횟수100
pull_policyPull 정책
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
scan_policyScan 정책
state이미지 상태Active

4.1.1.18.2 - 1.0

scpcli scr image show
--image_id <value>

Description

Image 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Carpe diem.
lifecycle_policyLifecycle 정책
lock_policyLock 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name이미지명sample
pull_countPull 횟수100
pull_policyPull 정책
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
scan_policyScan 정책
state이미지 상태Active

4.1.1.19 - Show Image Lifecycle Policy Preview

4.1.1.19.1 - 1.1

scpcli scr image lifecycle-policy-preview show
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]

Description

Lifecycle 정책 Preview 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
string참조 중인 tags 목록["sample"]

Responses

NameDescriptionExample
created_at생성일시2024-08-15T13:05:09.701645823+09:00
hash_digestHash digest
reference_tags참조 중인 tags 목록[“sample”]
state태그 상태Active

4.1.1.19.2 - 1.0

scpcli scr image lifecycle-policy-preview show
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]

Description

Lifecycle 정책 Preview 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
string참조 중인 tags 목록["sample"]

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
hash_digestHash digest
last_scanned_at마지막 스캔 일시2024-08-15T13:05:09.701645823+09:00
lock_policyLock 정책
modified_at수정일시2024-08-16T16:06:09.701645823+09:00
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd
re_scan_needed취약점 점검 재시도 필요 여부True
reference_tags참조 중인 tags 목록[“sample”]
referenced_by참조 여부
scan_state스캔 상태Scanning state
scan_summary
size크기10
state태그 상태Active

4.1.1.20 - Show Registry

4.1.1.20.1 - 1.1

scpcli scr registry show
--registry_id <value>

Description

Registry 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_idBucket IDrpqtmqgec3174541bbf77eecf2cd3585
bucket_nameBucket명4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
bucket_usageBucket 사용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry명sample
private_acl_enabledPrivate 접근 제어 활성화True
private_acl_resourcesPrivate 접근 허용 리소스 리스트
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_acl_enabledPublic 접근 제어 활성화True
public_acl_resourcesPublic 접근 허용 리소스 리스트
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_endpoint_enabledPublic Endpoint 활성화True
public_visible_enabled가시성 Public 선택 여부True
stateRegistry 상태Running

4.1.1.20.2 - 1.0

scpcli scr registry show
--registry_id <value>

Description

Registry 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_idBucket IDrpqtmqgec3174541bbf77eecf2cd3585
bucket_nameBucket명4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
bucket_usageBucket 사용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry명sample
private_acl_enabledPrivate 접근 제어 활성화True
private_acl_resourcesPrivate 접근 허용 리소스 리스트
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_acl_enabledPublic 접근 제어 활성화True
public_acl_resourcesPublic 접근 허용 리소스 리스트
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_endpoint_enabledPublic Endpoint 활성화True
public_visible_enabled가시성 Public 선택 여부True
stateRegistry 상태Running

4.1.1.21 - Show Repository

4.1.1.21.1 - 1.1

scpcli scr repository show
--repository_id <value>

Description

Repository 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Carpe diem.
lifecycle_policyLifecycle 정책
lock_policyLock 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameRepository명sample
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
pull_policyPull 정책
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
scan_policyScan 정책
stateRepository 상태Active

4.1.1.21.2 - 1.0

scpcli scr repository show
--repository_id <value>

Description

Repository 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Carpe diem.
lifecycle_policyLifecycle 정책
lock_policyLock 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameRepository명sample
private_endpoint_urlPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
public_endpoint_urlPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo
pull_policyPull 정책
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
scan_policyScan 정책
stateRepository 상태Active

4.1.1.22 - Show Tags

4.1.1.22.1 - 1.1

scpcli scr tags show
--tags_id <value>

Description

Tags 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
created_at생성일시2024-08-15T13:05:09.701645823+09:00
hash_digestHash digest
image_id이미지 ID5b5ed4f2881a440583536fc1a8c39a28
lock_policyLock 정책
manifest매니페스트
manifest_media_typeManifest 미디어 타입
modified_at수정일시2024-08-16T16:06:09.701645823+09:00
reference_tags참조 중인 tags 목록[“sample”]
registry_id
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
state태그 상태Active

4.1.1.22.2 - 1.0

scpcli scr tags show
--tags_id <value>

Description

Tags 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
created_at생성일시2024-08-15T13:05:09.701645823+09:00
hash_digestHash digest
image_id이미지 ID5b5ed4f2881a440583536fc1a8c39a28
lock_policyLock 정책
manifest매니페스트
manifest_media_typeManifest 미디어 타입
modified_at수정일시2024-08-16T16:06:09.701645823+09:00
reference_tags참조 중인 tags 목록[“sample”]
registry_id
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
state태그 상태Active

4.1.1.23 - Show Tags Packages

4.1.1.23.1 - 1.1

scpcli scr tags package show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]

Description

Package 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS 이름 또는 언어 이름Java
package_name
optional
string패키지명com.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20

Responses

NameDescriptionExample
category카테고리Language
os_languageOS 이름 또는 언어 이름Java
package_name패키지명com.example.sample
scan_summary
typePipeline 유형os-pkg(binary)
versionOS 배포 버전0.7.2-r3

4.1.1.23.2 - 1.0

scpcli scr tags package show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]

Description

Package 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS 이름 또는 언어 이름Java
package_name
optional
string패키지명com.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20

Responses

NameDescriptionExample
category카테고리Language
os_languageOS 이름 또는 언어 이름Java
package_name패키지명com.example.sample
scan_summary
typePipeline 유형os-pkg(binary)
versionOS 배포 버전0.7.2-r3

4.1.1.24 - Show Tags Secrets

4.1.1.24.1 - 1.1

scpcli scr tags secret show
--tags_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--file_name <value>]

Description

Secret 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
file_name
optional
string시크릿 파일명/certs/sample-key1.key

Responses

NameDescriptionExample
category카테고리Language
file_name시크릿 파일명/certs/sample-key1.key
match시크릿 매치—–BEGIN SAMPLE KEY—–*********************…
rule_id시크릿 룰 IDprivate-key
severity심각도High
start_line시크릿 시작점1
target대상/certs/sample-key1.key
title시크릿 제목Asymmetric Private Key
vulnerability_class시크릿 취약점 클래스secret

4.1.1.24.2 - 1.0

scpcli scr tags secret show
--tags_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--file_name <value>]

Description

Secret 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
file_name
optional
string시크릿 파일명/certs/sample-key1.key

Responses

NameDescriptionExample
category카테고리Language
file_name시크릿 파일명/certs/sample-key1.key
match시크릿 매치—–BEGIN SAMPLE KEY—–*********************…
rule_id시크릿 룰 IDprivate-key
severity심각도High
start_line시크릿 시작점1
target대상/certs/sample-key1.key
title시크릿 제목Asymmetric Private Key
vulnerability_class시크릿 취약점 클래스secret

4.1.1.25 - Show Tags Vulnerabilities

4.1.1.25.1 - 1.1

scpcli scr tags vulnerability show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]
[--update_version_available <value>]
[--severity <value>]
[--category <value>]

Description

취약점 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS 이름 또는 언어 이름Java
package_name
optional
string패키지명com.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
update_version_available
optional
boolean수정 버전True
severity
optional
array심각도H
category
optional
string카테고리Language

Responses

NameDescriptionExample
attack_complexity공격 복잡성
attack_vector공격 벡터
availability가용성
confidentiality기밀성
integrity무결성
privileges_required필요한 권한
scope공격 범위
user_interaction사용자 참여 정도

4.1.1.25.2 - 1.0

scpcli scr tags vulnerability show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]
[--update_version_available <value>]
[--severity <value>]
[--category <value>]

Description

취약점 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS 이름 또는 언어 이름Java
package_name
optional
string패키지명com.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
update_version_available
optional
boolean수정 버전True
severity
optional
array심각도H
category
optional
string카테고리Language

Responses

NameDescriptionExample
attack_complexity공격 복잡성
attack_vector공격 벡터
availability가용성
confidentiality기밀성
integrity무결성
privileges_required필요한 권한
scope공격 범위
user_interaction사용자 참여 정도

4.1.1.26 - Update Image Description

4.1.1.26.1 - 1.1

scpcli scr image description set
--image_id <value>
--description <value>

Description

Image 설명 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
description
required
string설명Carpe diem.

4.1.1.26.2 - 1.0

scpcli scr image description set
--image_id <value>
--description <value>

Description

Image 설명 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
description
required
string설명Carpe diem.

4.1.1.27 - Update Image Lifecycle Policy

4.1.1.27.1 - 1.1

scpcli scr image lifecycle-policy set
--image_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_tag_expression <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>

Description

Lifecycle 정책 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
untagged_rule_enabled
required
booleanUntagged Image 자동 삭제 활성화True
untagged_rule_duration
required
integerUntagged Image 자동 삭제 기한90
outdated_rule_tag_expression
required
stringTagged rule tag expression*
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle 정책 활성화True

4.1.1.27.2 - 1.0

scpcli scr image lifecycle-policy set
--image_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>

Description

Lifecycle 정책 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
untagged_rule_enabled
required
booleanUntagged Image 자동 삭제 활성화True
untagged_rule_duration
required
integerUntagged Image 자동 삭제 기한90
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle 정책 활성화True

4.1.1.28 - Update Image Lock Policy

4.1.1.28.1 - 1.1

scpcli scr image lock-policy set
--image_id <value>
--locked <value>

Description

Lock 정책 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
locked
required
booleanLockedTrue

4.1.1.28.2 - 1.0

scpcli scr image lock-policy set
--image_id <value>
--locked <value>

Description

Lock 정책 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
locked
required
booleanLockedTrue

4.1.1.29 - Update Image Pull Policy

4.1.1.29.1 - 1.1

scpcli scr image pull-policy set
--image_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]

Description

Pull 정책 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
vulnerable_image_pull_prevented
required
boolean취약점이 있는 이미지 Pull 제한 여부True
unscanned_image_pull_prevented
required
boolean스캔 되지 않은 이미지 Pull 제한 여부True
unmodified_excepted
required
boolean수정 버전이 없는 취약점 제외 여부True
critical_limit
optional
integerCritical 심각도20
high_limit
optional
integerHigh 심각도20

4.1.1.29.2 - 1.0

scpcli scr image pull-policy set
--image_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]

Description

Pull 정책 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
vulnerable_image_pull_prevented
required
boolean취약점이 있는 이미지 Pull 제한 여부True
unscanned_image_pull_prevented
required
boolean스캔 되지 않은 이미지 Pull 제한 여부True
unmodified_excepted
required
boolean수정 버전이 없는 취약점 제외 여부True
critical_limit
optional
integerCritical 심각도20
high_limit
optional
integerHigh 심각도20

4.1.1.30 - Update Image Scan Policy

4.1.1.30.1 - 1.1

scpcli scr image scan-policy set
--image_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>

Description

Scan 정책 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
severity_limit
required
string취약점 레벨High
secret_excepted
required
booleanSecret 제외 여부True
scan_policy_enabled
required
boolean스캔 제외 정책 여부True
language_excepted
required
booleanLanguage 제외 여부True
fixed_version_excepted
required
booleanFixed version 제외 여부True
auto_scan_enabled
required
boolean이미지 자동 스캔 여부True

4.1.1.30.2 - 1.0

scpcli scr image scan-policy set
--image_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>

Description

Scan 정책 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
string이미지 ID5b5ed4f2881a440583536fc1a8c39a28
severity_limit
required
string취약점 레벨High
secret_excepted
required
booleanSecret 제외 여부True
scan_policy_enabled
required
boolean스캔 제외 정책 여부True
language_excepted
required
booleanLanguage 제외 여부True
fixed_version_excepted
required
booleanFixed version 제외 여부True
auto_scan_enabled
required
boolean이미지 자동 스캔 여부True

4.1.1.31 - Update Private Acl

4.1.1.31.1 - 1.1

scpcli scr registry private-acl set
--registry_id <value>
--private_acl_resources <value>
--private_acl_enabled <value>

Description

Private 접근 제어 설정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
private_acl_resources
required
arrayPrivate 접근 허용 리소스 리스트'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate 접근 제어 활성화True

4.1.1.31.2 - 1.0

scpcli scr registry private-acl set
--registry_id <value>
--private_acl_resources <value>
--private_acl_enabled <value>

Description

Private 접근 제어 설정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
private_acl_resources
required
arrayPrivate 접근 허용 리소스 리스트'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate 접근 제어 활성화True

4.1.1.32 - Update Public Acl

4.1.1.32.1 - 1.1

scpcli scr registry public-acl set
--registry_id <value>
--public_acl_resources <value>
--public_acl_enabled <value>

Description

Public 접근 제어 설정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_acl_resources
required
arrayPublic 접근 허용 리소스 리스트'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
public_acl_enabled
required
booleanPublic 접근 제어 활성화True

4.1.1.32.2 - 1.0

scpcli scr registry public-acl set
--registry_id <value>
--public_acl_resources <value>
--public_acl_enabled <value>

Description

Public 접근 제어 설정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_acl_resources
required
arrayPublic 접근 허용 리소스 리스트'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
public_acl_enabled
required
booleanPublic 접근 제어 활성화True

4.1.1.33 - Update Public Endpoint Enabled

4.1.1.33.1 - 1.1

scpcli scr registry public-endpoint-enabled set
--registry_id <value>
--public_endpoint_enabled <value>

Description

Public Endpoint 활성화

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_endpoint_enabled
required
booleanPublic Endpoint 활성화True

4.1.1.33.2 - 1.0

scpcli scr registry public-endpoint-enabled set
--registry_id <value>
--public_endpoint_enabled <value>

Description

Public Endpoint 활성화

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_endpoint_enabled
required
booleanPublic Endpoint 활성화True

4.1.1.34 - Update Repository Description

4.1.1.34.1 - 1.1

scpcli scr repository description set
--repository_id <value>
--description <value>

Description

Repository 설명 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
description
required
string설명Carpe diem.

4.1.1.34.2 - 1.0

scpcli scr repository description set
--repository_id <value>
--description <value>

Description

Repository 설명 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
description
required
string설명Carpe diem.

4.1.1.35 - Update Repository Lifecycle Policy

4.1.1.35.1 - 1.1

scpcli scr repository lifecycle-policy set
--repository_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_tag_expression <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>

Description

Lifecycle 정책 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
untagged_rule_enabled
required
booleanUntagged Image 자동 삭제 활성화True
untagged_rule_duration
required
integerUntagged Image 자동 삭제 기한90
outdated_rule_tag_expression
required
stringTagged rule tag expression*
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle 정책 활성화True

4.1.1.35.2 - 1.0

scpcli scr repository lifecycle-policy set
--repository_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>

Description

Lifecycle 정책 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
untagged_rule_enabled
required
booleanUntagged Image 자동 삭제 활성화True
untagged_rule_duration
required
integerUntagged Image 자동 삭제 기한90
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle 정책 활성화True

4.1.1.36 - Update Repository Lock Policy

4.1.1.36.1 - 1.1

scpcli scr repository lock-policy set
--repository_id <value>
--locked <value>

Description

Lock 정책 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
locked
required
booleanLockedTrue

4.1.1.36.2 - 1.0

scpcli scr repository lock-policy set
--repository_id <value>
--locked <value>

Description

Lock 정책 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
locked
required
booleanLockedTrue

4.1.1.37 - Update Repository Pull Policy

4.1.1.37.1 - 1.1

scpcli scr repository pull-policy set
--repository_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]

Description

Pull 정책 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
vulnerable_image_pull_prevented
required
boolean취약점이 있는 이미지 Pull 제한 여부True
unscanned_image_pull_prevented
required
boolean스캔 되지 않은 이미지 Pull 제한 여부True
unmodified_excepted
required
boolean수정 버전이 없는 취약점 제외 여부True
critical_limit
optional
integerCritical 심각도20
high_limit
optional
integerHigh 심각도20

4.1.1.37.2 - 1.0

scpcli scr repository pull-policy set
--repository_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]

Description

Pull 정책 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
vulnerable_image_pull_prevented
required
boolean취약점이 있는 이미지 Pull 제한 여부True
unscanned_image_pull_prevented
required
boolean스캔 되지 않은 이미지 Pull 제한 여부True
unmodified_excepted
required
boolean수정 버전이 없는 취약점 제외 여부True
critical_limit
optional
integerCritical 심각도20
high_limit
optional
integerHigh 심각도20

4.1.1.38 - Update Repository Scan Policy

4.1.1.38.1 - 1.1

scpcli scr repository scan-policy set
--repository_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>

Description

Scan 정책 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
severity_limit
required
string취약점 레벨High
secret_excepted
required
booleanSecret 제외 여부True
scan_policy_enabled
required
boolean스캔 제외 정책 여부True
language_excepted
required
booleanLanguage 제외 여부True
fixed_version_excepted
required
booleanFixed version 제외 여부True
auto_scan_enabled
required
boolean이미지 자동 스캔 여부True

4.1.1.38.2 - 1.0

scpcli scr repository scan-policy set
--repository_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>

Description

Scan 정책 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
severity_limit
required
string취약점 레벨High
secret_excepted
required
booleanSecret 제외 여부True
scan_policy_enabled
required
boolean스캔 제외 정책 여부True
language_excepted
required
booleanLanguage 제외 여부True
fixed_version_excepted
required
booleanFixed version 제외 여부True
auto_scan_enabled
required
boolean이미지 자동 스캔 여부True

4.1.1.39 - Update Tags Lock Policy

4.1.1.39.1 - 1.1

scpcli scr tags lock-policy set
--tags_id <value>
--locked <value>

Description

태그 잠금 갱신

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
locked
required
booleanLockedTrue

4.1.1.39.2 - 1.0

scpcli scr tags lock-policy set
--tags_id <value>
--locked <value>

Description

태그 잠금 갱신

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
locked
required
booleanLockedTrue

4.2 - Kubernetes

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Kubernetes 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

4.2.1 - CLIs

4.2.1.1 - Create Cluster

4.2.1.1.1 - 1.1

scpcli ske cluster create
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--service_watch_logging_enabled <value>
--security_group_id_list <value>
--name <value>
--kubernetes_version <value>
--cloud_logging_enabled <value>
[--private_endpoint_access_control_resources <value>]
[--public_endpoint_access_control_ip <value>]
[--tags <value>]

Description

create a cluster V1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
volume_id
required
string볼륨 ID['bfdbabf2-04d9-4e8b-a205-020f8e6da438']
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
service_watch_logging_enabled
required
booleanService Watch 사용 여부true
security_group_id_list
required
arraySecurity group ID 목록bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
name
required
string클러스터 이름sample-cluster
kubernetes_version
required
string클러스터 버전v1.29.8
cloud_logging_enabled
required
boolean클라우드 로깅 사용 여부true
private_endpoint_access_control_resources
optional
arrayPrivate Endpoint 접근 제어 리소스 목록'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'
public_endpoint_access_control_ip
optional
stringPublic Endpoint 접근 제어 IP192.168.0.0
tags
optional
array태그 목록'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
request_id요청 ID80a599e031e749b7b260868f441e862b
resource_id자원 ID70a599e031e749b7b260868f441e862b

4.2.1.1.2 - 1.0

scpcli ske cluster create
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--name <value>
--kubernetes_version <value>
--cloud_logging_enabled <value>
[--private_endpoint_access_control_resources <value>]
[--public_endpoint_access_control_ip <value>]
[--tags <value>]

Description

create a cluster

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
volume_id
required
string볼륨 ID['bfdbabf2-04d9-4e8b-a205-020f8e6da438']
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
security_group_id_list
required
arraySecurity group ID 목록bdfda539-bd2e-4a5c-9021-ec6d52d1ca79
name
required
string클러스터 이름sample-cluster
kubernetes_version
required
string클러스터 버전v1.29.8
cloud_logging_enabled
required
boolean클라우드 로깅 사용 여부true
private_endpoint_access_control_resources
optional
arrayPrivate Endpoint 접근 제어 리소스 목록'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'
public_endpoint_access_control_ip
optional
stringPublic Endpoint 접근 제어 IP192.168.0.0
tags
optional
array태그 목록'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
request_id요청 ID80a599e031e749b7b260868f441e862b
resource_id자원 ID70a599e031e749b7b260868f441e862b

4.2.1.2 - Create Cluster Kubeconfig

4.2.1.2.1 - 1.1

scpcli ske cluster kubeconfig create
--cluster_id <value>
--kubeconfig_type <value>

Description

Create kubeconfig file for the cluster

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig 타입 (private/public)private

Responses

NameDescriptionExample

4.2.1.2.2 - 1.0

scpcli ske cluster kubeconfig create
--cluster_id <value>
--kubeconfig_type <value>

Description

Create kubeconfig file for the cluster

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig 타입 (private/public)private

Responses

NameDescriptionExample

4.2.1.3 - Create Nodepool

4.2.1.3.1 - 1.1

scpcli ske nodepool create
--pod_max_pids <value>
--max_pods <value>
--image_gc_low_threshold <value>
--image_gc_high_threshold <value>
--container_log_max_size <value>
--container_log_max_files <value>
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--server_group_id <value>]
[--taints <value>]
[--allowed_unsafe_sysctls <value>]

Description

create a nodepool V1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
pod_max_pids
required
integer파드 최대 PID 수4096
max_pods
required
integer노드당 최대 파드 수110
image_gc_low_threshold
required
integer이미지 GC 하한 퍼센트80
image_gc_high_threshold
required
integer이미지 GC 상한 퍼센트85
container_log_max_size
required
integer컨테이너 로그 최대 사이즈 MB10
container_log_max_files
required
integer컨테이너 로그 최대 파일 수5
volume_type_name
required
string볼륨 타입 이름SSD
volume_size
required
integer볼륨 크기104
server_type_id
required
string서버 타입 ID10a599e031e749b7b260868f441e862b
name
required
string노드풀 이름sample-nodepool
kubernetes_version
required
string쿠버네티스 버전v1.29.8
keypair_name
required
string키페어 이름test_keypair
is_auto_scale
required
boolean자동 확장 사용 여부true
is_auto_recovery
required
boolean자동 복구 사용 여부true
image_os_version
required
string이미지 OS 버전22.04
image_os
required
string이미지 OSubuntu
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
string커스텀 이미지 ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
array노드풀 레이블 목록'{"key": "example.com/my-app", "value": "bar"}'
max_node_count
optional
integerMaximum node count (is_auto_scale = true)5
min_node_count
optional
integerMinimum node count (is_auto_scale = true)1
server_group_id
optional
string서버 그룹 ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
taints
optional
array노드풀 테인트 목록'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'
allowed_unsafe_sysctls
optional
stringunsafe sysctl 허용kernel.msg*,net.ipv4.route.min_pmtu

Responses

NameDescriptionExample
id노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settings노드풀 고급 설정
auto_recovery_enabled자동 복구 사용 여부true
auto_scale_enabled자동 확장 사용 여부true
cluster클러스터
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_node_count현재 노드 수1
desired_node_count요청 노드 수2
image이미지
keypair키페어 이름
kubernetes_version쿠버네티스 버전v1.29.8
labels노드풀 레이블 목록
max_node_count최대 노드 수5
min_node_count최소 노드 수1
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name노드풀 이름sample-nodepool
server_group_id서버 그룹 ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_type서버 타입
status노드풀 상태Running
taints노드풀 테인트 목록
volume_size볼륨 크기104
volume_type볼륨 타입

4.2.1.3.2 - 1.0

scpcli ske nodepool create
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--taints <value>]

Description

create a nodepool

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
volume_type_name
required
string볼륨 타입 이름SSD
volume_size
required
integer볼륨 크기104
server_type_id
required
string서버 타입 ID10a599e031e749b7b260868f441e862b
name
required
string노드풀 이름sample-nodepool
kubernetes_version
required
string쿠버네티스 버전v1.29.8
keypair_name
required
string키페어 이름test_keypair
is_auto_scale
required
boolean자동 확장 사용 여부true
is_auto_recovery
required
boolean자동 복구 사용 여부true
image_os_version
required
string이미지 OS 버전22.04
image_os
required
string이미지 OSubuntu
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
string커스텀 이미지 ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
array노드풀 레이블 목록'{"key": "example.com/my-app", "value": "bar"}'
max_node_count
optional
integerMaximum node count (is_auto_scale = true)5
min_node_count
optional
integerMinimum node count (is_auto_scale = true)1
taints
optional
array노드풀 테인트 목록'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'

Responses

NameDescriptionExample
id노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabled자동 복구 사용 여부true
auto_scale_enabled자동 확장 사용 여부true
cluster클러스터
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_node_count현재 노드 수1
desired_node_count요청 노드 수2
image이미지
keypair키페어 이름
kubernetes_version쿠버네티스 버전v1.29.8
labels노드풀 레이블 목록
max_node_count최대 노드 수5
min_node_count최소 노드 수1
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name노드풀 이름sample-nodepool
server_type서버 타입
status노드풀 상태Running
taints노드풀 테인트 목록
volume_size볼륨 크기104
volume_type볼륨 타입

4.2.1.4 - Delete Cluster

4.2.1.4.1 - 1.1

scpcli ske cluster delete
--cluster_id <value>

Description

delete a specific cluster

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b

4.2.1.4.2 - 1.0

scpcli ske cluster delete
--cluster_id <value>

Description

delete a specific cluster

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b

4.2.1.5 - Delete Nodepool

4.2.1.5.1 - 1.1

scpcli ske nodepool delete
--nodepool_id <value>

Description

delete a nodepool

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

4.2.1.5.2 - 1.0

scpcli ske nodepool delete
--nodepool_id <value>

Description

delete a nodepool

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

4.2.1.6 - List Clusters

4.2.1.6.1 - 1.1

scpcli ske cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--status <value>]
[--kubernetes_version <value>]
[--subnet_id <value>]

Description

get clusters list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string클러스터 이름sample-cluster
status
optional
array클러스터 상태R
kubernetes_version
optional
array클러스터 버전v
subnet_id
optional
string클러스터 Subnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
id클러스터 ID70a599e031e749b7b260868f441e862b
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_at생성 시간2025-03-31T00:23:17Z
kubernetes_version클러스터 버전v1.29.8
modified_at수정 시간2025-03-31T00:23:17Z
name클러스터 이름sample-cluster
node_count클러스터 노드 수5
status클러스터 상태RUNNING
subnet_id클러스터 Subnet ID023c57b14f11483689338d085e061492

4.2.1.6.2 - 1.0

scpcli ske cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--status <value>]
[--kubernetes_version <value>]
[--subnet_id <value>]

Description

get clusters list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string클러스터 이름sample-cluster
status
optional
array클러스터 상태R
kubernetes_version
optional
array클러스터 버전v
subnet_id
optional
string클러스터 Subnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
id클러스터 ID70a599e031e749b7b260868f441e862b
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_at생성 시간2025-03-31T00:23:17Z
kubernetes_version클러스터 버전v1.29.8
modified_at수정 시간2025-03-31T00:23:17Z
name클러스터 이름sample-cluster
node_count클러스터 노드 수5
status클러스터 상태RUNNING
subnet_id클러스터 Subnet ID023c57b14f11483689338d085e061492

4.2.1.7 - List Nodepool Nodes

4.2.1.7.1 - 1.1

scpcli ske nodepool node list
--nodepool_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--node_name <value>]

Description

Get nodepool node list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
node_name
optional
string노드 이름ske-aug-rhel-0805-1-84d799f767-8dr2p

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
kubernetes_version쿠버네티스 버전v1.29.8
name노드 이름ske-aug-rhel-0805-1-84d799f767-8dr2p
status노드풀 상태RUNNING

4.2.1.7.2 - 1.0

scpcli ske nodepool node list
--nodepool_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--node_name <value>]

Description

Get nodepool node list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
node_name
optional
string노드 이름ske-aug-rhel-0805-1-84d799f767-8dr2p

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
kubernetes_version쿠버네티스 버전v1.29.8
name노드 이름ske-aug-rhel-0805-1-84d799f767-8dr2p
status노드풀 상태RUNNING

4.2.1.8 - List Nodepools

4.2.1.8.1 - 1.1

scpcli ske nodepool list
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--nodepool_name <value>]

Description

get nodepools list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
nodepool_name
optional
string노드풀 이름sample-nodepool

Responses

NameDescriptionExample
id노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabled자동 복구 사용 여부
auto_scale_enabled자동 확장 사용 여부
current_node_count현재 노드 수1
desired_node_count요청 노드 수2
image이미지
kubernetes_version쿠버네티스 버전v1.29.8
name노드풀 이름sample-nodepool
server_type서버 타입
status노드풀 상태Running
volume_type볼륨 타입

4.2.1.8.2 - 1.0

scpcli ske nodepool list
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--nodepool_name <value>]

Description

get nodepools list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
nodepool_name
optional
string노드풀 이름sample-nodepool

Responses

NameDescriptionExample
id노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabled자동 복구 사용 여부
auto_scale_enabled자동 확장 사용 여부
current_node_count현재 노드 수1
desired_node_count요청 노드 수2
image이미지
kubernetes_version쿠버네티스 버전v1.29.8
name노드풀 이름sample-nodepool
server_type서버 타입
status노드풀 상태Running
volume_type볼륨 타입

4.2.1.9 - Set Cluster Logging

4.2.1.9.1 - 1.1

scpcli ske cluster logging set
--cluster_id <value>
--cloud_logging_enabled <value>

Description

Set logging on the cluster

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
cloud_logging_enabled
required
boolean클라우드 로깅 사용 여부true

4.2.1.9.2 - 1.0

scpcli ske cluster logging set
--cluster_id <value>
--cloud_logging_enabled <value>

Description

Set logging on the cluster

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
cloud_logging_enabled
required
boolean클라우드 로깅 사용 여부true

4.2.1.10 - Set Cluster Private Access Control

4.2.1.10.1 - 1.1

scpcli ske cluster private access control set
--cluster_id <value>
--private_endpoint_access_control_resources <value>

Description

set a private access control specific cluster

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
private_endpoint_access_control_resources
required
array'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'

4.2.1.10.2 - 1.0

scpcli ske cluster private access control set
--cluster_id <value>
--private_endpoint_access_control_resources <value>

Description

set a private access control specific cluster

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
private_endpoint_access_control_resources
required
array'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'

4.2.1.11 - Set Cluster Public Access Control

4.2.1.11.1 - 1.1

scpcli ske cluster public access control set
--cluster_id <value>
--public_endpoint_access_control_ip <value>

Description

set a public access control specific cluster

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
public_endpoint_access_control_ip
required
stringPublic Endpoint 접근 제어 IP192.168.0.0

4.2.1.11.2 - 1.0

scpcli ske cluster public access control set
--cluster_id <value>
--public_endpoint_access_control_ip <value>

Description

set a public access control specific cluster

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
public_endpoint_access_control_ip
required
stringPublic Endpoint 접근 제어 IP192.168.0.0

4.2.1.12 - Set Cluster Security Groups

4.2.1.12.1 - 1.1

scpcli ske cluster security group set
--cluster_id <value>
--security_group_id_list <value>

Description

Set Cluster Security Groups

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
security_group_id_list
required
arraySecurity group ID 목록b

4.2.1.12.2 - 1.0

scpcli ske cluster security group set
--cluster_id <value>
--security_group_id_list <value>

Description

Set Cluster Security Groups

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
security_group_id_list
required
arraySecurity group ID 목록b

4.2.1.13 - Set Cluster Service Watch Logging

4.2.1.13.1 - 1.1

scpcli ske cluster service watch logging set
--cluster_id <value>
--service_watch_logging_enabled <value>

Description

Set Service Watch logging on the cluster

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
service_watch_logging_enabled
required
booleanService Watch 사용 여부true

4.2.1.14 - Set Cluster Upgrade

4.2.1.14.1 - 1.1

scpcli ske cluster upgrade set
--cluster_id <value>
--kubernetes_version <value>

Description

upgrade a specific cluster

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
kubernetes_version
required
string쿠버네티스 버전v1.29.8

4.2.1.14.2 - 1.0

scpcli ske cluster upgrade set
--cluster_id <value>
--kubernetes_version <value>

Description

upgrade a specific cluster

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
kubernetes_version
required
string쿠버네티스 버전v1.29.8

4.2.1.15 - Set Nodepool

4.2.1.15.1 - 1.1

scpcli ske nodepool set
--nodepool_id <value>
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--max_node_count <value>]
[--min_node_count <value>]

Description

set a nodepool

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
desired_node_count
optional
integer요청 노드 수2
is_auto_recovery
optional
boolean자동 복구 사용 여부true
is_auto_scale
optional
boolean자동 확장 사용 여부true
max_node_count
optional
integer최대 노드 수5
min_node_count
optional
integer최소 노드 수1

4.2.1.15.2 - 1.0

scpcli ske nodepool set
--nodepool_id <value>
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--max_node_count <value>]
[--min_node_count <value>]

Description

set a nodepool

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
desired_node_count
optional
integer요청 노드 수2
is_auto_recovery
optional
boolean자동 복구 사용 여부true
is_auto_scale
optional
boolean자동 확장 사용 여부true
max_node_count
optional
integer최대 노드 수5
min_node_count
optional
integer최소 노드 수1

4.2.1.16 - Set Nodepool Labels

4.2.1.16.1 - 1.1

scpcli ske nodepool labels set
--nodepool_id <value>
--labels <value>

Description

set nodepool labels

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
labels
required
array'{"key": "example.com/my-app", "value": "bar"}'

4.2.1.16.2 - 1.0

scpcli ske nodepool labels set
--nodepool_id <value>
--labels <value>

Description

set nodepool labels

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
labels
required
array'{"key": "example.com/my-app", "value": "bar"}'

4.2.1.17 - Set Nodepool Taints

4.2.1.17.1 - 1.1

scpcli ske nodepool taints set
--nodepool_id <value>
--taints <value>

Description

set nodepool taints

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
taints
required
array'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'

4.2.1.17.2 - 1.0

scpcli ske nodepool taints set
--nodepool_id <value>
--taints <value>

Description

set nodepool taints

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
taints
required
array'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'

4.2.1.18 - Set Nodepool Upgrade

4.2.1.18.1 - 1.1

scpcli ske nodepool upgrade set
--nodepool_id <value>
--os_version <value>

Description

upgrade a nodepool

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
os_version
required
string이미지 OS 버전22.04

4.2.1.18.2 - 1.0

scpcli ske nodepool upgrade set
--nodepool_id <value>

Description

upgrade a nodepool

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

4.2.1.19 - Show Cluster

4.2.1.19.1 - 1.1

scpcli ske cluster show
--cluster_id <value>

Description

show a cluster

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
cloud_logging_enabled클라우드 로깅 사용 여부true
cluster_namespace클러스터 네임스페이스sample-cluster-12345
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
kubernetes_version클러스터 버전v1.29.8
managed_security_groupManaged Security Group
max_node_count클러스터 최대 노드 수5
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name클러스터 이름sample-cluster
node_count클러스터 노드 수5
private_endpoint_access_control_resourcesPrivate Endpoint 접근 제어 리소스 목록
private_endpoint_urlPrivate Kubeconfig Download YnN
private_kubeconfig_download_ynCluster의 Private Endpoint URLhttps://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
public_endpoint_access_control_ipPublic Endpoint 접근 제어 IP192.168.0.0
public_endpoint_urlPublic Endpoint 접근 제어 IPhttps://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
public_kubeconfig_download_ynPublic Kubeconfig Download YnN
security_group_list연결된 Security Group
service_watch_logging_enabledService Watch 사용 여부true
status클러스터 상태RUNNING
subnetCluster가 사용하는 Subnet
volume연결된 File Storage
vpcCluster가 사용하는 VPC

4.2.1.19.2 - 1.0

scpcli ske cluster show
--cluster_id <value>

Description

show a cluster

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
cloud_logging_enabled클라우드 로깅 사용 여부true
cluster_namespace클러스터 네임스페이스sample-cluster-12345
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
kubernetes_version클러스터 버전v1.29.8
managed_security_groupManaged Security Group
max_node_count클러스터 최대 노드 수5
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name클러스터 이름sample-cluster
node_count클러스터 노드 수5
private_endpoint_access_control_resourcesPrivate Endpoint 접근 제어 리소스 목록
private_endpoint_urlPrivate Kubeconfig Download YnN
private_kubeconfig_download_ynCluster의 Private Endpoint URLhttps://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
public_endpoint_access_control_ipPublic Endpoint 접근 제어 IP192.168.0.0
public_endpoint_urlPublic Endpoint 접근 제어 IPhttps://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
public_kubeconfig_download_ynPublic Kubeconfig Download YnN
security_group_list연결된 Security Group
status클러스터 상태RUNNING
subnetCluster가 사용하는 Subnet
volume연결된 File Storage
vpcCluster가 사용하는 VPC

4.2.1.20 - Show Cluster User Kubeconfig

4.2.1.20.1 - 1.1

scpcli ske cluster user kubeconfig show
--cluster_id <value>
--kubeconfig_type <value>

Description

Show user kubeconfig for the cluster

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig 타입 (private/public)private

Responses

NameDescriptionExample

4.2.1.20.2 - 1.0

scpcli ske cluster user kubeconfig show
--cluster_id <value>
--kubeconfig_type <value>

Description

Show user kubeconfig for the cluster

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
string클러스터 ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig 타입 (private/public)private

Responses

NameDescriptionExample

4.2.1.21 - Show Nodepool

4.2.1.21.1 - 1.1

scpcli ske nodepool show
--nodepool_id <value>

Description

show a nodepool

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

Responses

NameDescriptionExample
id노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settings노드풀 고급 설정
auto_recovery_enabled자동 복구 사용 여부true
auto_scale_enabled자동 확장 사용 여부true
cluster클러스터
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_node_count현재 노드 수1
desired_node_count요청 노드 수2
image이미지
keypair키페어 이름
kubernetes_version쿠버네티스 버전v1.29.8
labels노드풀 레이블 목록
max_node_count최대 노드 수5
min_node_count최소 노드 수1
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name노드풀 이름sample-nodepool
server_group_id서버 그룹 ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_type서버 타입
status노드풀 상태Running
taints노드풀 테인트 목록
volume_size볼륨 크기104
volume_type볼륨 타입

4.2.1.21.2 - 1.0

scpcli ske nodepool show
--nodepool_id <value>

Description

show a nodepool

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
string노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

Responses

NameDescriptionExample
id노드풀 IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabled자동 복구 사용 여부true
auto_scale_enabled자동 확장 사용 여부true
cluster클러스터
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_node_count현재 노드 수1
desired_node_count요청 노드 수2
image이미지
keypair키페어 이름
kubernetes_version쿠버네티스 버전v1.29.8
labels노드풀 레이블 목록
max_node_count최대 노드 수5
min_node_count최소 노드 수1
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name노드풀 이름sample-nodepool
server_type서버 타입
status노드풀 상태Running
taints노드풀 테인트 목록
volume_size볼륨 크기104
volume_type볼륨 타입

5 - Networking

5.1 - Direct Connect

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Direct Connect 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

5.1.1 - CLIs

5.1.1.1 - Create Direct Connect

5.1.1.1.1 - 1.0

scpcli direct-connect direct-connect create
--vpc_id <value>
--name <value>
--bandwidth <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Direct Connect를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
name
required
stringDirect Connect명-
bandwidth
required
integer포트용량-
description
optional
stringDirect Connect 설명-
firewall_enabled
optional
booleanFirewall 사용-
firewall_loggable
optional
boolean방화벽 로깅 가능-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idDirect Connect ID
account_idAccount ID
bandwidth포트용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect 설명
firewall_idFirewall ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect명
state상태
vpc_idVPC ID
vpc_nameVPC 명

5.1.1.2 - Create Routing Rule

5.1.1.2.1 - 1.0

scpcli direct-connect routing-rule create
--direct_connect_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
[--destination_resource_id <value>]

Description

Routing Rule을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect ID-
destination_type
required
string목적지 타입-
destination_cidr
required
string목적지 CIDR-
description
optional
string설명-
destination_resource_id
optional
string목적지 자원 ID-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
destination_cidr목적지 CIDR
destination_resource_id목적지 자원 ID
destination_resource_name목적지 자원명
destination_type목적지 타입
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule 소유자 ID
owner_typeRouting Rule 소유자 타입
state상태

5.1.1.3 - Delete Direct Connect

5.1.1.3.1 - 1.0

scpcli direct-connect direct-connect delete
--direct_connect_id <value>

Description

Direct Connect를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect ID-

5.1.1.4 - Delete Routing Rule

5.1.1.4.1 - 1.0

scpcli direct-connect routing-rule delete
--routing_rule_id <value>
--direct_connect_id <value>

Description

Routing Rule을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
direct_connect_id
required
stringDirect Connect ID-

5.1.1.5 - List Direct Connects

5.1.1.5.1 - 1.0

scpcli direct-connect direct-connect list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Direct Connect 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringDirect Connect ID-
name
optional
stringDirect Connect명-
state
optional
****상태-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-

Responses

NameDescriptionExample
idDirect Connect ID
account_idAccount ID
bandwidth포트용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect 설명
firewall_idFirewall ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect명
state상태
vpc_idVPC ID
vpc_nameVPC 명

5.1.1.6 - List Routing Rules

5.1.1.6.1 - 1.0

scpcli direct-connect routing-rule list
--direct_connect_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Routing Rule 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect ID-
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID-
destination_type
optional
****목적지 타입-
destination_cidr
optional
string목적지 CIDR-
state
optional
****상태-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
destination_cidr목적지 CIDR
destination_resource_id목적지 자원 ID
destination_resource_name목적지 자원명
destination_type목적지 타입
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule 소유자 ID
owner_typeRouting Rule 소유자 타입
state상태

5.1.1.7 - Set Direct Connect

5.1.1.7.1 - 1.0

scpcli direct-connect direct-connect set
--direct_connect_id <value>
--description <value>

Description

Direct Connect를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect ID-
description
required
stringDirect Connect 설명-

5.1.1.8 - Show Direct Connect

5.1.1.8.1 - 1.0

scpcli direct-connect direct-connect show
--direct_connect_id <value>

Description

Direct Connect를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect ID-

Responses

NameDescriptionExample
idDirect Connect ID
account_idAccount ID
bandwidth포트용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect 설명
firewall_idFirewall ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect명
state상태
vpc_idVPC ID
vpc_nameVPC 명

5.2 - DNS

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 DNS 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1DEPRECATED20260331
1.2DEPRECATED20260331
1.3CURRENT-

5.2.1 - CLIs

5.2.1.1 - Activate Private DNS

5.2.1.1.1 - 1.3

scpcli dns private-dns activate
--name <value>

Description

Activate Private DNS

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.1.2 - 1.2

scpcli dns private-dns activate
--name <value>

Description

Activate Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.1.3 - 1.1

scpcli dns private-dns activate
--name <value>

Description

Activate Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.1.4 - 1.0

scpcli dns private-dns activate
--name <value>

Description

Activate Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.2 - Create Hosted Zone

5.2.1.2.1 - 1.3

scpcli dns hosted-zone create
--type <value>
--name <value>
[--description <value>]
[--private_dns_id <value>]
[--tags <value>]

Description

Create a new hosted zone.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
type
required
stringType of zone-
name
required
stringnamemy-zone.com
description
optional
stringdescriptionThis is description
private_dns_id
optional
stringPrivate DNS ID-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idHosted Zone ID3432012nfdksdf03ktrld9234lgfg
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
hosted_zone_typeHosted Zone type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameHosted Zone Namemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
private_dns_idPrivate DNS ID10fjkewefprivatedns3193rud543
private_dns_namePrivate DNS Nameprivate-dns01
statusState
ttlTTL for the zone.3600

5.2.1.2.2 - 1.2

scpcli dns hosted-zone create
--name <value>
--email <value>
[--description <value>]
[--private_dns_id <value>]
[--tags <value>]
[--type <value>]

Description

Create a new hosted zone.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
name
required
stringname-
email
required
stringemail-
description
optional
stringdescription-
private_dns_id
optional
stringPrivate DNS ID-
tags
optional
arrayTag List'{"key": "", "value": ""}'
type
optional
stringType of zone-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date
descriptiondescription
emailemail
hosted_zone_typeHosted Zone type
linksLinks to resource
mastersThe servers to slave from to get DNS information
namename
pool_idDesignate Pool ID
private_dns_idPrivate DNS ID
private_dns_namePrivate DNS Name
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe status
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.
typeType of zone
updated_atUpdated Date
versionVersion

5.2.1.2.3 - 1.1

scpcli dns hosted-zone create
--name <value>
--email <value>
[--description <value>]
[--tags <value>]
[--type <value>]

Description

Create a new hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
name
required
stringname-
email
required
stringemail-
description
optional
stringdescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'
type
optional
stringType of zone-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date
descriptiondescription
emailemail
hosted_zone_typeHosted Zone type
linksLinks to resource
mastersThe servers to slave from to get DNS information
namename
pool_idDesignate Pool ID
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe status
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.
typeType of zone
updated_atUpdated Date
versionVersion

5.2.1.2.4 - 1.0

scpcli dns hosted-zone create
--name <value>
--email <value>
[--description <value>]
[--tags <value>]
[--type <value>]

Description

Create a new hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringname-
email
required
stringemail-
description
optional
stringdescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'
type
optional
stringType of zone-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date
descriptiondescription
emailemail
hosted_zone_typeHosted Zone type
linksLinks to resource
mastersThe servers to slave from to get DNS information
namename
pool_idDesignate Pool ID
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe status
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.
typeType of zone
updated_atUpdated Date
versionVersion

5.2.1.3 - Create Hosted Zone Record

5.2.1.3.1 - 1.3

scpcli dns hosted-zone-record create
--hosted_zone_id <value>
--type <value>
--records <value>
--name <value>
[--description <value>]
[--ttl <value>]

Description

Create a new recordset in the hosted zone

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
type
required
stringType of the record-
records
required
arrayA list of data for this record-
name
required
stringname-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsrecords for the record
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.4 - Create Private DNS

5.2.1.4.1 - 1.3

scpcli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]

Description

Create Private DNS

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.4.2 - 1.2

scpcli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]

Description

Create Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.4.3 - 1.1

scpcli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]

Description

Create Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.4.4 - 1.0

scpcli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]

Description

Create Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.5 - Create Public Domain

5.2.1.5.1 - 1.2

scpcli dns public-domain-name create
--register_telno <value>
--register_name_ko <value>
--register_name_en <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--name <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>
[--auto_extension <value>]
[--description <value>]
[--tags <value>]

Description

Create a new Public Domain record

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
register_telno
required
stringRegister telephone number-
register_name_ko
required
stringRegister Name Domestic-
register_name_en
required
stringRegister Name Overseas-
register_email
required
stringRegister email-
postal_code
required
stringPostal code-
overseas_third_address
required
stringOverseas address - State & Country-
overseas_second_address
required
stringOverseas address - City-
overseas_first_address
required
stringOverseas address - Address-
name
required
stringname-
domestic_second_address_ko
required
stringDomestic second address (KO)-
domestic_second_address_en
required
stringDomestic second address (EN)-
domestic_first_address_ko
required
stringDomestic first address (KO)-
domestic_first_address_en
required
stringDomestic first address (EN)-
address_type
required
stringAddress type-
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID
address_typeAddress type
auto_extensionAuto extension flag
created_atCreated Date
created_byCreated By_
descriptiondescription
domestic_address_enDomestic Address (EN)
domestic_address_koDomestic Address (KO)
domestic_first_address_enDomestic first address (EN)
domestic_first_address_koDomestic first address (KO)
domestic_second_address_enDomestic second address (EN)
domestic_second_address_koDomestic second address (KO)
expired_dateExpired date
modified_atModified Date
modified_byModified By_
namePublic Domain Name
overseas_addressOverseas Address
overseas_first_addressOverseas address - Address
overseas_second_addressOverseas address - City
overseas_third_addressOverseas address - State & Country
postal_codePostal code
register_emailRegister email
register_name_enRegister Name Overseas
register_name_koRegister Name Domestic
register_telnoRegister telephone number
start_dateStart date
statusThe status

5.2.1.5.2 - 1.1

scpcli dns public-domain-name create
--register_telno <value>
--register_name_ko <value>
--register_name_en <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--name <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>
[--auto_extension <value>]
[--description <value>]
[--tags <value>]

Description

Create a new Public Domain record

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
register_telno
required
stringRegister telephone number-
register_name_ko
required
stringRegister Name Domestic-
register_name_en
required
stringRegister Name Overseas-
register_email
required
stringRegister email-
postal_code
required
stringPostal code-
overseas_third_address
required
stringOverseas address - State & Country-
overseas_second_address
required
stringOverseas address - City-
overseas_first_address
required
stringOverseas address - Address-
name
required
stringname-
domestic_second_address_ko
required
stringDomestic second address (KO)-
domestic_second_address_en
required
stringDomestic second address (EN)-
domestic_first_address_ko
required
stringDomestic first address (KO)-
domestic_first_address_en
required
stringDomestic first address (EN)-
address_type
required
stringAddress type-
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID
address_typeAddress type
auto_extensionAuto extension flag
created_atCreated Date
created_byCreated By_
descriptiondescription
domestic_address_enDomestic Address (EN)
domestic_address_koDomestic Address (KO)
domestic_first_address_enDomestic first address (EN)
domestic_first_address_koDomestic first address (KO)
domestic_second_address_enDomestic second address (EN)
domestic_second_address_koDomestic second address (KO)
expired_dateExpired date
modified_atModified Date
modified_byModified By_
namePublic Domain Name
overseas_addressOverseas Address
overseas_first_addressOverseas address - Address
overseas_second_addressOverseas address - City
overseas_third_addressOverseas address - State & Country
postal_codePostal code
register_emailRegister email
register_name_enRegister Name Overseas
register_name_koRegister Name Domestic
register_telnoRegister telephone number
start_dateStart date
statusThe status

5.2.1.5.3 - 1.0

scpcli dns public-domain-name create
--register_telno <value>
--register_name_ko <value>
--register_name_en <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--name <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>
[--auto_extension <value>]
[--description <value>]
[--tags <value>]

Description

Create a new Public Domain record

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
register_telno
required
stringRegister telephone number-
register_name_ko
required
stringRegister Name Domestic-
register_name_en
required
stringRegister Name Overseas-
register_email
required
stringRegister email-
postal_code
required
stringPostal code-
overseas_third_address
required
stringOverseas address - State & Country-
overseas_second_address
required
stringOverseas address - City-
overseas_first_address
required
stringOverseas address - Address-
name
required
stringname-
domestic_second_address_ko
required
stringDomestic second address (KO)-
domestic_second_address_en
required
stringDomestic second address (EN)-
domestic_first_address_ko
required
stringDomestic first address (KO)-
domestic_first_address_en
required
stringDomestic first address (EN)-
address_type
required
stringAddress type-
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID
address_typeAddress type
auto_extensionAuto extension flag
created_atCreated Date
created_byCreated By_
descriptiondescription
domestic_address_enDomestic Address (EN)
domestic_address_koDomestic Address (KO)
domestic_first_address_enDomestic first address (EN)
domestic_first_address_koDomestic first address (KO)
domestic_second_address_enDomestic second address (EN)
domestic_second_address_koDomestic second address (KO)
expired_dateExpired date
modified_atModified Date
modified_byModified By_
namePublic Domain Name
overseas_addressOverseas Address
overseas_first_addressOverseas address - Address
overseas_second_addressOverseas address - City
overseas_third_addressOverseas address - State & Country
postal_codePostal code
register_emailRegister email
register_name_enRegister Name Overseas
register_name_koRegister Name Domestic
register_telnoRegister telephone number
start_dateStart date
statusThe status

5.2.1.6 - Create Public Domain Name

5.2.1.6.1 - 1.3

scpcli dns public-domain-name create
--register_telno <value>
--register_name_ko <value>
--register_name_en <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--name <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>
[--auto_extension <value>]
[--description <value>]
[--tags <value>]

Description

Create a new Public Domain Name

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
register_telno
required
stringRegister telephone number-
register_name_ko
required
stringRegister Name Domestic-
register_name_en
required
stringRegister Name Overseas-
register_email
required
stringRegister email-
postal_code
required
stringPostal code-
overseas_third_address
required
stringOverseas address - State & Country-
overseas_second_address
required
stringOverseas address - City-
overseas_first_address
required
stringOverseas address - Address-
name
required
stringname-
domestic_second_address_ko
required
stringDomestic second address (KO)-
domestic_second_address_en
required
stringDomestic second address (EN)-
domestic_first_address_ko
required
stringDomestic first address (KO)-
domestic_first_address_en
required
stringDomestic first address (EN)-
address_type
required
stringAddress type-
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID
address_typeAddress type
auto_extensionAuto extension flag
created_atCreated Date
created_byCreated By_
descriptiondescription
domestic_address_enDomestic Address (EN)
domestic_address_koDomestic Address (KO)
domestic_first_address_enDomestic first address (EN)
domestic_first_address_koDomestic first address (KO)
domestic_second_address_enDomestic second address (EN)
domestic_second_address_koDomestic second address (KO)
expired_dateExpired date
modified_atModified Date
modified_byModified By_
namePublic Domain Name
overseas_addressOverseas Address
overseas_first_addressOverseas address - Address
overseas_second_addressOverseas address - City
overseas_third_addressOverseas address - State & Country
postal_codePostal code
register_emailRegister email
register_name_enRegister Name Overseas
register_name_koRegister Name Domestic
register_telnoRegister telephone number
start_dateStart date
statusThe status

5.2.1.7 - Create Record

5.2.1.7.1 - 1.2

scpcli dns record create
--hosted_zone_id <value>
--type <value>
--records <value>
--name <value>
[--description <value>]
[--ttl <value>]

Description

Create a new recordset in the hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
type
required
stringType of the record-
records
required
arrayA list of data for this record-
name
required
stringname-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsrecords for the record
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.7.2 - 1.1

scpcli dns record create
--hosted_zone_id <value>
--type <value>
--records <value>
--name <value>
[--description <value>]
[--ttl <value>]

Description

Create a new recordset in the hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
type
required
stringType of the record-
records
required
arrayA list of data for this record-
name
required
stringname-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsrecords for the record
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.7.3 - 1.0

scpcli dns record create
--hosted_zone_id <value>
--type <value>
--records <value>
--name <value>
[--description <value>]
[--ttl <value>]

Description

Create a new recordset in the hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
type
required
stringType of the record-
records
required
arrayA list of data for this record-
name
required
stringname-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsrecords for the record
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.8 - Delete Hosted Zone

5.2.1.8.1 - 1.3

scpcli dns hosted-zone delete
--hosted_zone_id <value>

Description

Delete a hosted zone

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-

5.2.1.8.2 - 1.2

scpcli dns hosted-zone delete
--hosted_zone_id <value>

Description

Delete a hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-

5.2.1.8.3 - 1.1

scpcli dns hosted-zone delete
--hosted_zone_id <value>

Description

Delete a hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-

5.2.1.8.4 - 1.0

scpcli dns hosted-zone delete
--hosted_zone_id <value>

Description

Delete a hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-

5.2.1.9 - Delete Hosted Zone Record

5.2.1.9.1 - 1.3

scpcli dns hosted-zone-record delete
--record_id <value>
--hosted_zone_id <value>

Description

Delete hosted zone record

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-

5.2.1.10 - Delete Private DNS

5.2.1.10.1 - 1.3

scpcli dns private-dns delete
--private_dns_id <value>

Description

Delete Private DNS

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

5.2.1.10.2 - 1.2

scpcli dns private-dns delete
--private_dns_id <value>

Description

Delete Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

5.2.1.10.3 - 1.1

scpcli dns private-dns delete
--private_dns_id <value>

Description

Delete Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

5.2.1.10.4 - 1.0

scpcli dns private-dns delete
--private_dns_id <value>

Description

Delete Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

5.2.1.11 - Delete Record

5.2.1.11.1 - 1.2

scpcli dns record delete
--record_id <value>
--hosted_zone_id <value>

Description

Delete a recordset

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-

5.2.1.11.2 - 1.1

scpcli dns record delete
--record_id <value>
--hosted_zone_id <value>

Description

Delete a recordset

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-

5.2.1.11.3 - 1.0

scpcli dns record delete
--record_id <value>
--hosted_zone_id <value>

Description

Delete a recordset

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-

5.2.1.12 - Get Public Domain Detail

5.2.1.12.1 - 1.2

scpcli dns public-domain-name show
--public_domain_id <value>

Description

Retrieve detailed information for a specific public domain by ID

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-

Responses

NameDescriptionExample
idID
address_typeAddress type
auto_extensionAuto extension flag
created_atCreated Date
created_byCreated By_
descriptiondescription
domestic_address_enDomestic Address (EN)
domestic_address_koDomestic Address (KO)
domestic_first_address_enDomestic first address (EN)
domestic_first_address_koDomestic first address (KO)
domestic_second_address_enDomestic second address (EN)
domestic_second_address_koDomestic second address (KO)
expired_dateExpired date
modified_atModified Date
modified_byModified By_
namePublic Domain Name
overseas_addressOverseas Address
overseas_first_addressOverseas address - Address
overseas_second_addressOverseas address - City
overseas_third_addressOverseas address - State & Country
postal_codePostal code
register_emailRegister email
register_name_enRegister Name Overseas
register_name_koRegister Name Domestic
register_telnoRegister telephone number
start_dateStart date
statusThe status

5.2.1.12.2 - 1.1

scpcli dns public-domain-name show
--public_domain_id <value>

Description

Retrieve detailed information for a specific public domain by ID

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-

Responses

NameDescriptionExample
idID
address_typeAddress type
auto_extensionAuto extension flag
created_atCreated Date
created_byCreated By_
descriptiondescription
domestic_address_enDomestic Address (EN)
domestic_address_koDomestic Address (KO)
domestic_first_address_enDomestic first address (EN)
domestic_first_address_koDomestic first address (KO)
domestic_second_address_enDomestic second address (EN)
domestic_second_address_koDomestic second address (KO)
expired_dateExpired date
modified_atModified Date
modified_byModified By_
namePublic Domain Name
overseas_addressOverseas Address
overseas_first_addressOverseas address - Address
overseas_second_addressOverseas address - City
overseas_third_addressOverseas address - State & Country
postal_codePostal code
register_emailRegister email
register_name_enRegister Name Overseas
register_name_koRegister Name Domestic
register_telnoRegister telephone number
start_dateStart date
statusThe status

5.2.1.12.3 - 1.0

scpcli dns public-domain-name show
--public_domain_id <value>

Description

Retrieve detailed information for a specific public domain by ID

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-

Responses

NameDescriptionExample
idID
address_typeAddress type
auto_extensionAuto extension flag
created_atCreated Date
created_byCreated By_
descriptiondescription
domestic_address_enDomestic Address (EN)
domestic_address_koDomestic Address (KO)
domestic_first_address_enDomestic first address (EN)
domestic_first_address_koDomestic first address (KO)
domestic_second_address_enDomestic second address (EN)
domestic_second_address_koDomestic second address (KO)
expired_dateExpired date
modified_atModified Date
modified_byModified By_
namePublic Domain Name
overseas_addressOverseas Address
overseas_first_addressOverseas address - Address
overseas_second_addressOverseas address - City
overseas_third_addressOverseas address - State & Country
postal_codePostal code
register_emailRegister email
register_name_enRegister Name Overseas
register_name_koRegister Name Domestic
register_telnoRegister telephone number
start_dateStart date
statusThe status

5.2.1.13 - List Hosted Zone Records

5.2.1.13.1 - 1.3

scpcli dns hosted-zone-record list
--hosted_zone_id <value>
[--limit <value>]
[--marker <value>]
[--sort_dir <value>]
[--sort_key <value>]
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--data <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]

Description

Get record list in a hosted zone

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
limit
optional
integerlimit-
marker
optional
stringmarker-
sort_dir
optional
stringsort direction-
sort_key
optional
stringsort key-
name
optional
stringname-
exact_name
optional
stringname-
type
optional
stringType of the record-
data
optional
stringRecord data-
status
optional
stringThe status-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsA list of data for this record
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.14 - List Hosted Zones

5.2.1.14.1 - 1.3

scpcli dns hosted-zone list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--type <value>]
[--status <value>]

Description

Return list of hosted zones

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringnamemy-zone.com
type
optional
****Type of zone-
status
optional
****The status-

Responses

NameDescriptionExample
idHosted Zone ID3432012nfdksdf03ktrld9234lgfg
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
hosted_zone_typeHosted Zone type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameHosted Zone Namemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
private_dns_idPrivate DNS ID10fjkewefprivatedns3193rud543
private_dns_namePrivate DNS Nameprivate-dns01
statusState
ttlTTL for the zone.3600

5.2.1.14.2 - 1.2

scpcli dns hosted-zone list
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--email <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Return list of hosted zones

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
name
optional
stringname-
exact_name
optional
stringname-
type
optional
stringType of zone-
email
optional
stringemail-
status
optional
stringThe status-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-
page
optional
integerPage-
size
optional
integerSize-
sort
optional
stringSort-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date
descriptiondescription
emailemail
hosted_zone_typeHosted Zone type
linksLinks to resource
mastersThe servers to slave from to get DNS information
namename
pool_idDesignate Pool ID
private_dns_idPrivate DNS ID
private_dns_namePrivate DNS Name
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe status
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.
typeType of zone
updated_atUpdated Date
versionVersion

5.2.1.14.3 - 1.1

scpcli dns hosted-zone list
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--email <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Return list of hosted zones

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
name
optional
stringname-
exact_name
optional
stringname-
type
optional
stringType of zone-
email
optional
stringemail-
status
optional
stringThe status-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-
page
optional
integerPage-
size
optional
integerSize-
sort
optional
stringSort-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date
descriptiondescription
emailemail
hosted_zone_typeHosted Zone type
linksLinks to resource
mastersThe servers to slave from to get DNS information
namename
pool_idDesignate Pool ID
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe status
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.
typeType of zone
updated_atUpdated Date
versionVersion

5.2.1.14.4 - 1.0

scpcli dns hosted-zone list
[--limit <value>]
[--marker <value>]
[--sort_dir <value>]
[--sort_key <value>]
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--email <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]

Description

Return list of hosted zones

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerlimit-
marker
optional
stringmarker-
sort_dir
optional
stringsort direction-
sort_key
optional
stringsort key-
name
optional
stringname-
exact_name
optional
stringname-
type
optional
stringType of zone-
email
optional
stringemail-
status
optional
stringThe status-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date
descriptiondescription
emailemail
hosted_zone_typeHosted Zone type
linksLinks to resource
mastersThe servers to slave from to get DNS information
namename
pool_idDesignate Pool ID
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe status
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.
typeType of zone
updated_atUpdated Date
versionVersion

5.2.1.15 - List Private DNS

5.2.1.15.1 - 1.3

scpcli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]

Description

List all Private DNS

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivate DNS ID10fjkewefprivatedns3193rud543
name
optional
stringPrivate DNS Name-
vpc_id
optional
stringConnected VPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.15.2 - 1.2

scpcli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]

Description

List all Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivate DNS ID10fjkewefprivatedns3193rud543
name
optional
stringPrivate DNS Name-
vpc_id
optional
stringConnected VPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.15.3 - 1.1

scpcli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]

Description

List all Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivate DNS ID10fjkewefprivatedns3193rud543
name
optional
stringPrivate DNS Name-
vpc_id
optional
stringConnected VPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.15.4 - 1.0

scpcli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]

Description

List all Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivate DNS ID10fjkewefprivatedns3193rud543
name
optional
stringPrivate DNS Name-
vpc_id
optional
stringConnected VPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.16 - List Public Domain Names

5.2.1.16.1 - 1.3

scpcli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]

Description

Return list of Public Domain Names

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringname-
created_by
optional
stringCreated By_-

Responses

NameDescriptionExample
idId
created_atStart date
created_byStart date
expired_dateExpired date
modified_atStart date
modified_byStart date
namename
register_emailRegister email
start_dateStart date
statusThe status

5.2.1.17 - List Public Domains

5.2.1.17.1 - 1.2

scpcli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]

Description

List all Public Domains

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringname-
created_by
optional
stringCreated By_-

Responses

NameDescriptionExample
idId
created_atStart date
created_byStart date
expired_dateExpired date
modified_atStart date
modified_byStart date
namename
register_emailRegister email
start_dateStart date
statusThe status

5.2.1.17.2 - 1.1

scpcli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]

Description

List all Public Domains

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringname-
created_by
optional
stringCreated By_-

Responses

NameDescriptionExample
idId
created_atStart date
created_byStart date
expired_dateExpired date
modified_atStart date
modified_byStart date
namename
register_emailRegister email
start_dateStart date
statusThe status

5.2.1.17.3 - 1.0

scpcli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]

Description

List all Public Domains

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringname-
created_by
optional
stringCreated By_-

Responses

NameDescriptionExample
idId
created_atStart date
created_byStart date
expired_dateExpired date
modified_atStart date
modified_byStart date
namename
register_emailRegister email
start_dateStart date
statusThe status

5.2.1.18 - List Records

5.2.1.18.1 - 1.2

scpcli dns record list
--hosted_zone_id <value>
[--limit <value>]
[--marker <value>]
[--sort_dir <value>]
[--sort_key <value>]
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--data <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]

Description

Get recordset list in a hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
limit
optional
integerlimit-
marker
optional
stringmarker-
sort_dir
optional
stringsort direction-
sort_key
optional
stringsort key-
name
optional
stringname-
exact_name
optional
stringname-
type
optional
stringType of the record-
data
optional
stringRecord data-
status
optional
stringThe status-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsA list of data for this record
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.18.2 - 1.1

scpcli dns record list
--hosted_zone_id <value>
[--limit <value>]
[--marker <value>]
[--sort_dir <value>]
[--sort_key <value>]
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--data <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]

Description

Get recordset list in a hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
limit
optional
integerlimit-
marker
optional
stringmarker-
sort_dir
optional
stringsort direction-
sort_key
optional
stringsort key-
name
optional
stringname-
exact_name
optional
stringname-
type
optional
stringType of the record-
data
optional
stringRecord data-
status
optional
stringThe status-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsA list of data for this record
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.18.3 - 1.0

scpcli dns record list
--hosted_zone_id <value>
[--limit <value>]
[--marker <value>]
[--sort_dir <value>]
[--sort_key <value>]
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--data <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]

Description

Get recordset list in a hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
limit
optional
integerlimit-
marker
optional
stringmarker-
sort_dir
optional
stringsort direction-
sort_key
optional
stringsort key-
name
optional
stringname-
exact_name
optional
stringname-
type
optional
stringType of the record-
data
optional
stringRecord data-
status
optional
stringThe status-
description
optional
stringdescription-
ttl
optional
integerTTL for the zone.-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsA list of data for this record
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.19 - Set Hosted Zone Record

5.2.1.19.1 - 1.3

scpcli dns hosted-zone-record set
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]

Description

Update Hosted Zone record

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-
records
optional
arrayA list of data for this record-
ttl
optional
integerTTL for the record-

5.2.1.20 - Set Private DNS

5.2.1.20.1 - 1.3

scpcli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]

Description

Update Private DNS

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description

5.2.1.20.2 - 1.2

scpcli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]

Description

Update Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description

5.2.1.20.3 - 1.1

scpcli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]

Description

Update Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description

5.2.1.20.4 - 1.0

scpcli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]

Description

Update Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description

5.2.1.21 - Set Public Domain Name

5.2.1.21.1 - 1.3

scpcli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]

Description

Update Public Domain Name

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescription-

5.2.1.22 - Set Public Domain Name Whois Info

5.2.1.22.1 - 1.3

scpcli dns public-domain-name-info update
--public_domain_id <value>
--register_telno <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>

Description

Update Public Domain Name Whois Info

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-
register_telno
required
stringRegister telephone number-
register_email
required
stringRegister email-
postal_code
required
stringPostal code-
overseas_third_address
required
stringOverseas address - State & Country-
overseas_second_address
required
stringOverseas address - City-
overseas_first_address
required
stringOverseas address - Address-
domestic_second_address_ko
required
stringDomestic second address (KO)-
domestic_second_address_en
required
stringDomestic second address (EN)-
domestic_first_address_ko
required
stringDomestic first address (KO)-
domestic_first_address_en
required
stringDomestic first address (EN)-
address_type
required
stringAddress type-

5.2.1.23 - Show Hosted Zone

5.2.1.23.1 - 1.3

scpcli dns hosted-zone show
--hosted_zone_id <value>

Description

Return details of a hosted zone.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-

Responses

NameDescriptionExample
idHosted Zone ID3432012nfdksdf03ktrld9234lgfg
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
hosted_zone_typeHosted Zone type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameHosted Zone Namemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
private_dns_idPrivate DNS ID10fjkewefprivatedns3193rud543
private_dns_namePrivate DNS Nameprivate-dns01
statusState
ttlTTL for the zone.3600

5.2.1.23.2 - 1.2

scpcli dns hosted-zone show
--hosted_zone_id <value>

Description

Return details of a hosted zone.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date
descriptiondescription
emailemail
hosted_zone_typeHosted Zone type
linksLinks to resource
mastersThe servers to slave from to get DNS information
namename
pool_idDesignate Pool ID
private_dns_idPrivate DNS ID
private_dns_namePrivate DNS Name
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe status
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.
typeType of zone
updated_atUpdated Date
versionVersion

5.2.1.23.3 - 1.1

scpcli dns hosted-zone show
--hosted_zone_id <value>

Description

Return details of a hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date
descriptiondescription
emailemail
hosted_zone_typeHosted Zone type
linksLinks to resource
mastersThe servers to slave from to get DNS information
namename
pool_idDesignate Pool ID
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe status
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.
typeType of zone
updated_atUpdated Date
versionVersion

5.2.1.23.4 - 1.0

scpcli dns hosted-zone show
--hosted_zone_id <value>

Description

Return details of a hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date
descriptiondescription
emailemail
hosted_zone_typeHosted Zone type
linksLinks to resource
mastersThe servers to slave from to get DNS information
namename
pool_idDesignate Pool ID
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe status
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.
typeType of zone
updated_atUpdated Date
versionVersion

5.2.1.24 - Show Hosted Zone Record

5.2.1.24.1 - 1.3

scpcli dns hosted-zone-record show
--record_id <value>
--hosted_zone_id <value>

Description

Get details of a hosted zone record

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsrecords for the record.
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.25 - Show Private DNS

5.2.1.25.1 - 1.3

scpcli dns private-dns show
--private_dns_id <value>

Description

Show Private DNS

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.25.2 - 1.2

scpcli dns private-dns show
--private_dns_id <value>

Description

Show Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.25.3 - 1.1

scpcli dns private-dns show
--private_dns_id <value>

Description

Show Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.25.4 - 1.0

scpcli dns private-dns show
--private_dns_id <value>

Description

Show Private DNS

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

5.2.1.26 - Show Public Domain Name

5.2.1.26.1 - 1.3

scpcli dns public-domain-name show
--public_domain_id <value>

Description

Return details of a public domain name

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-

Responses

NameDescriptionExample
idID
address_typeAddress type
auto_extensionAuto extension flag
created_atCreated Date
created_byCreated By_
descriptiondescription
domestic_address_enDomestic Address (EN)
domestic_address_koDomestic Address (KO)
domestic_first_address_enDomestic first address (EN)
domestic_first_address_koDomestic first address (KO)
domestic_second_address_enDomestic second address (EN)
domestic_second_address_koDomestic second address (KO)
expired_dateExpired date
modified_atModified Date
modified_byModified By_
namePublic Domain Name
overseas_addressOverseas Address
overseas_first_addressOverseas address - Address
overseas_second_addressOverseas address - City
overseas_third_addressOverseas address - State & Country
postal_codePostal code
register_emailRegister email
register_name_enRegister Name Overseas
register_name_koRegister Name Domestic
register_telnoRegister telephone number
start_dateStart date
statusThe status

5.2.1.27 - Show Record

5.2.1.27.1 - 1.2

scpcli dns record show
--record_id <value>
--hosted_zone_id <value>

Description

Get details of a recordset

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsrecords for the record.
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.27.2 - 1.1

scpcli dns record show
--record_id <value>
--hosted_zone_id <value>

Description

Get details of a recordset

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsrecords for the record.
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.27.3 - 1.0

scpcli dns record show
--record_id <value>
--hosted_zone_id <value>

Description

Get details of a recordset

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-

Responses

NameDescriptionExample
idId
actioncurrent action in progress
created_atCreated Date
descriptiondescription
linksLinks to resource
namename
project_idProjectID
recordsrecords for the record.
statusThe status
ttlTTL for the zone.
typeType of the record
updated_atUpdated Date
versionVersion
zone_idID for the zone that contains this record
zone_nameThe name of the zone that contains this record

5.2.1.28 - Transfer Public Domain Name

5.2.1.28.1 - 1.3

scpcli dns public-domain-name-transfer update
--public_domain_id <value>
--type <value>
[--target_account_id <value>]

Description

Transfer Public Domain Name

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-
type
required
stringTransfer operation type-
target_account_id
optional
stringTarget account id (required when type=REQUEST)-

Responses

NameDescriptionExample
idID
auto_extensionAuto extension flag
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
expired_dateExpired date
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePublic Domain Name
start_dateStart date
stateState

5.2.1.29 - Update auto_extension or description

5.2.1.29.1 - 1.2

scpcli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]

Description

Update auto_extension or description of a Public Domain

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescription-

5.2.1.29.2 - 1.1

scpcli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]

Description

Update auto_extension or description of a Public Domain

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescription-

5.2.1.29.3 - 1.0

scpcli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]

Description

Update auto_extension or description of a Public Domain

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescription-

5.2.1.30 - Update Hosted Zone

5.2.1.30.1 - 1.3

scpcli dns hosted-zone set
--hosted_zone_id <value>
[--description <value>]

Description

Update a hosted zone.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
description
optional
stringdescriptionThis is description

5.2.1.30.2 - 1.2

scpcli dns hosted-zone update
--hosted_zone_id <value>
[--description <value>]
[--email <value>]

Description

Update a hosted zone.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
description
optional
stringdescription-
email
optional
stringemail-

5.2.1.30.3 - 1.1

scpcli dns hosted-zone update
--hosted_zone_id <value>
[--description <value>]
[--email <value>]

Description

Update a hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
description
optional
stringdescription-
email
optional
stringemail-

5.2.1.30.4 - 1.0

scpcli dns hosted-zone update
--hosted_zone_id <value>
[--description <value>]
[--email <value>]

Description

Update a hosted zone

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId-
description
optional
stringdescription-
email
optional
stringemail-

5.2.1.31 - Update Record

5.2.1.31.1 - 1.2

scpcli dns record update
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]

Description

Update a recordset

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-
records
optional
arrayA list of data for this record-
ttl
optional
integerTTL for the record-

5.2.1.31.2 - 1.1

scpcli dns record update
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]

Description

Update a recordset

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-
records
optional
arrayA list of data for this record-
ttl
optional
integerTTL for the record-

5.2.1.31.3 - 1.0

scpcli dns record update
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]

Description

Update a recordset

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID-
hosted_zone_id
required
stringZone ID-
records
optional
arrayA list of data for this record-
ttl
optional
integerTTL for the record-

5.2.1.32 - Update WHOIS info for Public Domain

5.2.1.32.1 - 1.2

scpcli dns public-domain-name-info update
--public_domain_id <value>
--register_telno <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>

Description

Update WHOIS information and sync with DB for a public domain

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.220260331

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-
register_telno
required
stringRegister telephone number-
register_email
required
stringRegister email-
postal_code
required
stringPostal code-
overseas_third_address
required
stringOverseas address - State & Country-
overseas_second_address
required
stringOverseas address - City-
overseas_first_address
required
stringOverseas address - Address-
domestic_second_address_ko
required
stringDomestic second address (KO)-
domestic_second_address_en
required
stringDomestic second address (EN)-
domestic_first_address_ko
required
stringDomestic first address (KO)-
domestic_first_address_en
required
stringDomestic first address (EN)-
address_type
required
stringAddress type-

5.2.1.32.2 - 1.1

scpcli dns public-domain-name-info update
--public_domain_id <value>
--register_telno <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>

Description

Update WHOIS information and sync with DB for a public domain

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-
register_telno
required
stringRegister telephone number-
register_email
required
stringRegister email-
postal_code
required
stringPostal code-
overseas_third_address
required
stringOverseas address - State & Country-
overseas_second_address
required
stringOverseas address - City-
overseas_first_address
required
stringOverseas address - Address-
domestic_second_address_ko
required
stringDomestic second address (KO)-
domestic_second_address_en
required
stringDomestic second address (EN)-
domestic_first_address_ko
required
stringDomestic first address (KO)-
domestic_first_address_en
required
stringDomestic first address (EN)-
address_type
required
stringAddress type-

5.2.1.32.3 - 1.0

scpcli dns public-domain-name-info update
--public_domain_id <value>
--register_telno <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>

Description

Update WHOIS information and sync with DB for a public domain

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringId-
register_telno
required
stringRegister telephone number-
register_email
required
stringRegister email-
postal_code
required
stringPostal code-
overseas_third_address
required
stringOverseas address - State & Country-
overseas_second_address
required
stringOverseas address - City-
overseas_first_address
required
stringOverseas address - Address-
domestic_second_address_ko
required
stringDomestic second address (KO)-
domestic_second_address_en
required
stringDomestic second address (EN)-
domestic_first_address_ko
required
stringDomestic first address (KO)-
domestic_first_address_en
required
stringDomestic first address (EN)-
address_type
required
stringAddress type-

5.3 - Firewall

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다. 본 가이드는 Firewall 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

5.3.1 - CLIs

5.3.1.1 - Create Firewall Rule

5.3.1.1.1 - 1.0

scpcli firewall firewall-rule create
--status <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
--firewall_id <value>
[--description <value>]
[--order_direction <value>]
[--order_rule_id <value>]

Description

firewall rule 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
status
required
stringFirewall rule 사용 여부-
source_address
required
array출발지 주소192.168.1.1
service
required
array서비스 포트'{"service_type": "TCP", "service_value": "443"}'
direction
required
stringFirewall rule 방향-
destination_address
required
array목적지 주소10.0.0.1
action
required
stringFirewall rule 동작-
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
description
optional
stringFirewall rule 설명Firewall rule description example
order_direction
optional
string순서 방향-
order_rule_id
optional
string순서 규칙 ID043aa63459da466faad71fe4fe587031

Responses

NameDescriptionExample
idFirewall rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall rule 동작
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall rule 설명Firewall rule description example
destination_address목적지 주소[‘10.0.0.1’, ‘10.0.0.2’]
destination_interface목적지 인터페이스 이름IFW1-v1001dn
directionFirewall rule 방향
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall rule 이름b156740b6335468d8354eb9ef8eddf5a
sequenceFirewall rule 순서100
service서비스 포트
source_address출발지 주소[‘192.168.1.1’, ‘192.168.1.2’]
source_interface출발지 인터페이스 이름IFW1-v2501up
stateFirewall rule 상태
statusFirewall rule 사용 여부
vendor_rule_id벤더 규칙 ID72

5.3.1.2 - Delete Firewall Rule

5.3.1.2.1 - 1.0

scpcli firewall firewall-rule delete
--firewall_rule_id <value>

Description

firewall rule 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall rule IDb156740b6335468d8354eb9ef8eddf5a

5.3.1.3 - List Firewall Rules

5.3.1.3.1 - 1.0

scpcli firewall firewall-rule list
--firewall_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--src_ip <value>]
[--dst_ip <value>]
[--description <value>]
[--state <value>]
[--status <value>]
[--fetch_all <value>]

Description

firewall rule 목록 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
src_ip
optional
string출발지 IP192.168.1.1
dst_ip
optional
string목적지 IP192.168.1.1
description
optional
stringFirewall rule 설명Firewall rule description example
state
optional
arrayFirewall rule 상태-
status
optional
****Firewall rule 사용 여부-
fetch_all
optional
booleanFirewall rule 전체 조회-

Responses

NameDescriptionExample
idFirewall rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall rule 동작
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall rule 설명Firewall rule description example
destination_address목적지 주소[‘10.0.0.1’, ‘10.0.0.2’]
destination_interface목적지 인터페이스 이름IFW1-v1001dn
directionFirewall rule 방향
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall rule 이름b156740b6335468d8354eb9ef8eddf5a
sequenceFirewall rule 순서100
service서비스 포트
source_address출발지 주소[‘192.168.1.1’, ‘192.168.1.2’]
source_interface출발지 인터페이스 이름IFW1-v2501up
stateFirewall rule 상태
statusFirewall rule 사용 여부
vendor_rule_id벤더 규칙 ID72

5.3.1.4 - List Firewalls

5.3.1.4.1 - 1.0

scpcli firewall firewall list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_name <value>]
[--product_type <value>]
[--state <value>]

Description

firewall 목록 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringFirewall 이름FW_IGW_secuVPC
vpc_name
optional
stringVPC 명secuVPC
product_type
optional
arrayFirewall 상품 유형-
state
optional
arrayFirewall 상태-

Responses

NameDescriptionExample
idFirewall IDb156740b6335468d8354eb9ef8eddf5a
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
flavor_nameFirewall 사이즈 이름SMALL
flavor_rule_quotaFirewall 규칙 수 제한100
fw_resource_idFW 리소스 ID005fd1d30dea11f08a2c56773bef875b
loggable로그 사용 여부False
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall 이름FW_IGW_secuVPC
pre_product_id선행 상품 ID76479b7ffee1431198d9beb4502cda08
product_typeFirewall 상품 유형
stateFirewall 상태
statusFirewall 활성 여부
total_rule_count전체 규칙 개수8
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명secuVPC

5.3.1.5 - Set Firewall

5.3.1.5.1 - 1.0

scpcli firewall firewall set
--firewall_id <value>
[--flavor_name <value>]
[--loggable <value>]

Description

firewall 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
flavor_name
optional
stringFirewall 사이즈 이름-
loggable
optional
boolean로그 사용 여부False

5.3.1.6 - Set Firewall Rule

5.3.1.6.1 - 1.0

scpcli firewall firewall-rule set
--firewall_rule_id <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
[--description <value>]

Description

firewall rule 수정한다,

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall rule IDb156740b6335468d8354eb9ef8eddf5a
source_address
required
array출발지 주소192.168.1.1
service
required
array서비스 포트'{"service_type": "TCP", "service_value": "443"}'
direction
required
stringFirewall rule 방향-
destination_address
required
array목적지 주소10.0.0.1
action
required
stringFirewall rule 동작-
description
optional
stringFirewall rule 설명Firewall rule description example

5.3.1.7 - Show Firewall

5.3.1.7.1 - 1.0

scpcli firewall firewall show
--firewall_id <value>

Description

firewall 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idFirewall IDb156740b6335468d8354eb9ef8eddf5a
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
flavor_nameFirewall 사이즈 이름SMALL
flavor_rule_quotaFirewall 규칙 수 제한100
fw_resource_idFW 리소스 ID005fd1d30dea11f08a2c56773bef875b
loggable로그 사용 여부False
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall 이름FW_IGW_secuVPC
pre_product_id선행 상품 ID76479b7ffee1431198d9beb4502cda08
product_typeFirewall 상품 유형
stateFirewall 상태
statusFirewall 활성 여부
total_rule_count전체 규칙 개수8
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명secuVPC

5.3.1.8 - Show Firewall Rule

5.3.1.8.1 - 1.0

scpcli firewall firewall-rule show
--firewall_rule_id <value>

Description

firewall rule 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall rule IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idFirewall rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall rule 동작
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall rule 설명Firewall rule description example
destination_address목적지 주소[‘10.0.0.1’, ‘10.0.0.2’]
destination_interface목적지 인터페이스 이름IFW1-v1001dn
directionFirewall rule 방향
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall rule 이름b156740b6335468d8354eb9ef8eddf5a
sequenceFirewall rule 순서100
service서비스 포트
source_address출발지 주소[‘192.168.1.1’, ‘192.168.1.2’]
source_interface출발지 인터페이스 이름IFW1-v2501up
stateFirewall rule 상태
statusFirewall rule 사용 여부
vendor_rule_id벤더 규칙 ID72

5.4 - Global CDN

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Global CDN 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

5.4.1 - CLIs

5.4.1.1 - Create Cdn Service

5.4.1.1.1 - 1.0

scpcli cdn cdn service create
--range_request_allowed <value>
--query_string_ignored <value>
--origin_hostname_type <value>
--name <value>
--forward_host_header <value>
--content_policy <value>
--cdn_service_domain_prefix <value>
--cdn_origin_protocol <value>
--cdn_origin_port <value>
--cdn_origin_hostname <value>
--caching_option <value>
--cache_key_hostname <value>
--cache_expiry_time <value>
[--cdn_service_origin_path <value>]
[--custom_forward_host_header <value>]
[--description <value>]
[--request_custom_headers <value>]
[--response_custom_headers <value>]
[--tags <value>]

Description

create cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
range_request_allowed
required
booleanrange request allowed-
query_string_ignored
required
booleanquery string ignored-
origin_hostname_type
required
stringorigin hostname type-
name
required
stringcdn service nametest1
forward_host_header
required
stringforward host header-
content_policy
required
stringcontent policy-
cdn_service_domain_prefix
required
stringcdn service domain prefixglobal1
cdn_origin_protocol
required
stringcdn service origin protocol-
cdn_origin_port
required
integercdn service origin port-
cdn_origin_hostname
required
stringcdn service origin host nametest.example.com
caching_option
required
stringcaching option-
cache_key_hostname
required
stringcache key hostname-
cache_expiry_time
required
integercache expiry time-
cdn_service_origin_path
optional
stringcdn service origin path/test/global/
custom_forward_host_header
optional
stringcustom forward host header-
description
optional
stringDescription-
request_custom_headers
optional
objectrequest custom headers-
response_custom_headers
optional
objectresponse custom header-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
account_idAccount ID
resource_idresource id
workflow_idworkflow id

5.4.1.2 - Delete Cdn Service

5.4.1.2.1 - 1.0

scpcli cdn cdn service delete
--id <value>

Description

delete cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-

5.4.1.3 - Detail Cdn Service

5.4.1.3.1 - 1.0

scpcli cdn cdn service detail
--id <value>

Description

detail cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-

Responses

NameDescriptionExample
idcdn service id
account_idAccount ID
cache_expiry_timecache expiry time
cache_key_hostnamecache key hostname
caching_optioncaching option
cdn_origin_hostnamecdn service origin host name
cdn_origin_portcdn service origin port
cdn_origin_protocolcdn service origin protocol
cdn_service_activation_statecdn service activation state
cdn_service_config_versioncdn service config version
cdn_service_domaincdn service domain
cdn_service_origin_pathcdn service origin path
cdn_service_statecdn service state
content_policycontent policy
created_atcreate at
created_bycreate by
custom_forward_host_headercustom forward host header
descriptionDescription
forward_host_headerforward host header
modified_atmodified at
modified_bymodified by
namecdn service name
origin_hostname_typeorigin hostname type
query_string_ignoredquery string ignored
range_request_allowedrange request allowed
regionregion
request_custom_headersrequest custom headers
response_custom_headersresponse custom header

5.4.1.4 - List Cdn Service

5.4.1.4.1 - 1.0

scpcli cdn cdn service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--name <value>]
[--cdn_service_domain <value>]
[--cdn_origin_hostname <value>]

Description

list cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
created_by
optional
stringcreate by-
name
optional
stringcdn service name-
cdn_service_domain
optional
stringcdn service domain-
cdn_origin_hostname
optional
stringcdn service origin host name-

Responses

NameDescriptionExample
idcdn service id
account_idAccount ID
cdn_origin_hostnamecdn service origin host name
cdn_service_domaincdn service domain
cdn_service_statecdn service state
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namecdn service name
regionregion

5.4.1.5 - Purge Cdn Service

5.4.1.5.1 - 1.0

scpcli cdn cdn service purge
--id <value>
--target_url <value>
--target_content <value>
[--custom_url <value>]

Description

purge cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-
target_url
required
stringtarget url-
target_content
required
stringtarget content-
custom_url
optional
stringcustom url/test/

Responses

NameDescriptionExample
account_idAccount ID
resource_idresource id
workflow_idworkflow id

5.4.1.6 - Start Cdn Service

5.4.1.6.1 - 1.0

scpcli cdn cdn service start
--id <value>

Description

start cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-

Responses

NameDescriptionExample
account_idAccount ID
resource_idresource id
workflow_idworkflow id

5.4.1.7 - Stop Cdn Service

5.4.1.7.1 - 1.0

scpcli cdn cdn service stop
--id <value>

Description

stop cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-

Responses

NameDescriptionExample
account_idAccount ID
resource_idresource id
workflow_idworkflow id

5.4.1.8 - Update Cdn Service

5.4.1.8.1 - 1.0

scpcli cdn cdn service update
--id <value>
--range_request_allowed <value>
--query_string_ignored <value>
--origin_hostname_type <value>
--forward_host_header <value>
--content_policy <value>
--cdn_origin_protocol <value>
--cdn_origin_port <value>
--cdn_origin_hostname <value>
--caching_option <value>
--cache_key_hostname <value>
--cache_expiry_time <value>
[--cdn_service_origin_path <value>]
[--custom_forward_host_header <value>]
[--request_custom_headers <value>]
[--response_custom_headers <value>]

Description

update cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-
range_request_allowed
required
booleanrange request allowed-
query_string_ignored
required
booleanquery string ignored-
origin_hostname_type
required
stringorigin hostname type-
forward_host_header
required
stringforward host header-
content_policy
required
stringcontent policy-
cdn_origin_protocol
required
stringcdn service origin protocol-
cdn_origin_port
required
integercdn service origin port-
cdn_origin_hostname
required
stringcdn service origin host nametest.example.com
caching_option
required
stringcaching option-
cache_key_hostname
required
stringcache key hostname-
cache_expiry_time
required
integercache expiry time-
cdn_service_origin_path
optional
stringcdn service origin path/test/global/
custom_forward_host_header
optional
stringcustom forward host header-
request_custom_headers
optional
objectrequest custom headers-
response_custom_headers
optional
objectresponse custom header-

5.4.1.9 - Update Description of Cdn Service

5.4.1.9.1 - 1.0

scpcli cdn description update
--id <value>
--description <value>

Description

Update description of cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-
description
required
stringDescription-

5.5 - GSLB

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 GSLB 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0SUPPORTED20260531
1.1CURRENT-

5.5.1 - CLIs

5.5.1.1 - CreateGslb

5.5.1.1.1 - 1.1

scpcli gslb gslb create
--protocol <value>
--resources <value>
--name <value>
--env_usage <value>
--algorithm <value>
[--description <value>]
[--tags <value>]
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]

Description

GSLB 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
protocol
required
stringThe GSLB Health Check Protocol.-
resources
required
array'{"description": "", "destination": "", "region": "", "weight": 0}'
name
required
stringGSLB 이름-
env_usage
required
stringGSLB 용도-
algorithm
required
stringThe GSLB Algorithm.-
description
optional
string설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'
health_check_interval
optional
integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional
stringThe GSLB Health Check User Name.-
health_check_user_password
optional
stringThe GSLB Health Check Password.-
receive_string
optional
stringThe GSLB Health Check Receive String.-
send_string
optional
stringThe GSLB Health Check Send String.-
service_port
optional
integerThe GSLB Health Check Service Port.-
timeout
optional
integerThe GSLB Health Check Timeout.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
env_usageGSLB 용도
health_check
linked_resource_countGSLB 연결 대상
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameGSLB 이름
stateGSLB 상태.

5.5.1.1.2 - 1.0

scpcli gslb gslb create
--protocol <value>
--resources <value>
--name <value>
--env_usage <value>
--algorithm <value>
[--description <value>]
[--tags <value>]
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]

Description

GSLB 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
protocol
required
stringThe GSLB Health Check Protocol.-
resources
required
array'{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}'
name
required
stringGSLB 이름-
env_usage
required
stringGSLB 용도-
algorithm
required
stringThe GSLB Algorithm.-
description
optional
string설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'
health_check_interval
optional
integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional
stringThe GSLB Health Check User Name.-
health_check_user_password
optional
stringThe GSLB Health Check Password.-
receive_string
optional
stringThe GSLB Health Check Receive String.-
send_string
optional
stringThe GSLB Health Check Send String.-
service_port
optional
integerThe GSLB Health Check Service Port.-
timeout
optional
integerThe GSLB Health Check Timeout.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
env_usageGSLB 용도
health_check
linked_resource_countGSLB 연결 대상
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameGSLB 이름
stateGSLB 상태.

5.5.1.2 - DeleteGslb

5.5.1.2.1 - 1.1

scpcli gslb gslb delete
--gslb_id <value>

Description

GSLB 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-

5.5.1.2.2 - 1.0

scpcli gslb gslb delete
--gslb_id <value>

Description

GSLB 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-

5.5.1.3 - ListGslbResources

5.5.1.3.1 - 1.1

scpcli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

GSLB Resource 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
destinationGSLB Resource 목적지.
health_check_statusGSLB Resource 연결 상태
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
regionGSLB Resource 위치
statusGSLB Resource 사용 여부
weightGSLB Resource 가중치.

5.5.1.3.2 - 1.0

scpcli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

GSLB Resource 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
destinationGSLB Resource 목적지.
disabledGSLB Resource 사용 여부.
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
regionGSLB Resource 위치
weightGSLB Resource 가중치.

5.5.1.4 - ListGslbs

5.5.1.4.1 - 1.1

scpcli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]

Description

GSLB 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
state
optional
stringGSLB 상태.-
name
optional
stringGSLB 이름-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
env_usageGSLB 용도
linked_resource_countGSLB 연결 대상
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameGSLB 이름
stateGSLB 상태.

5.5.1.4.2 - 1.0

scpcli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]

Description

GSLB 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
state
optional
stringGSLB 상태.-
name
optional
stringGSLB 이름-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
env_usageGSLB 용도
linked_resource_countGSLB 연결 대상
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameGSLB 이름
stateGSLB 상태.

5.5.1.5 - ListGslbsRegionalRoutingControl

5.5.1.5.1 - 1.1

scpcli gslb gslb regional routing list
[--size <value>]
[--page <value>]
[--sort <value>]
[--region <value>]
[--status <value>]
[--name <value>]

Description

GSLB Region 별 Resource 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
region
optional
stringGSLB Resource 위치-
status
optional
stringGSLB Resource 사용 여부-
name
optional
stringGSLB 이름-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
env_usageGSLB 용도
linked_regional_resource_countGSLB 위치별 연결 대상
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameGSLB 이름
regionGSLB Resource 위치
statusGSLB Resource 사용 여부

5.5.1.6 - SetGslb

5.5.1.6.1 - 1.1

scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]

Description

GSLB 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
algorithm
optional
stringThe GSLB Algorithm.-
description
optional
string설명-

5.5.1.6.2 - 1.0

scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]

Description

GSLB 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
algorithm
optional
stringThe GSLB Algorithm.-
description
optional
string설명-

5.5.1.7 - SetGslbHealthCheck

5.5.1.7.1 - 1.1

scpcli gslb gslb-health-check update
--gslb_id <value>
--protocol <value>
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]

Description

GSLB Health Check 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
protocol
required
stringThe GSLB Health Check Protocol.-
health_check_interval
optional
integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional
stringThe GSLB Health Check User Name.-
health_check_user_password
optional
stringThe GSLB Health Check Password.-
receive_string
optional
stringThe GSLB Health Check Receive String.-
send_string
optional
stringThe GSLB Health Check Send String.-
service_port
optional
integerThe GSLB Health Check Service Port.-
timeout
optional
integerThe GSLB Health Check Timeout.-

5.5.1.7.2 - 1.0

scpcli gslb gslb-health-check update
--gslb_id <value>
--protocol <value>
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]

Description

GSLB Health Check 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
protocol
required
stringThe GSLB Health Check Protocol.-
health_check_interval
optional
integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional
stringThe GSLB Health Check User Name.-
health_check_user_password
optional
stringThe GSLB Health Check Password.-
receive_string
optional
stringThe GSLB Health Check Receive String.-
send_string
optional
stringThe GSLB Health Check Send String.-
service_port
optional
integerThe GSLB Health Check Service Port.-
timeout
optional
integerThe GSLB Health Check Timeout.-

5.5.1.8 - SetGslbRegionalRoutingControl

5.5.1.8.1 - 1.1

scpcli gslb gslb-regional-routing-set
--gslb_id <value>
--status <value>
--region <value>

Description

GSLB Regional Routing 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
status
required
stringGSLB Resource 사용 여부-
region
required
stringGSLB Resource 위치-

5.5.1.9 - SetGslbResources

5.5.1.9.1 - 1.1

scpcli gslb gslb-resource update
--gslb_id <value>
--resources <value>

Description

GSLB Resource 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
resources
required
array'{"description": "", "destination": "", "region": "", "weight": 0}'

5.5.1.9.2 - 1.0

scpcli gslb gslb-resource update
--gslb_id <value>
--resources <value>

Description

GSLB Resource 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
resources
required
array'{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}'

5.5.1.10 - ShowGslb

5.5.1.10.1 - 1.1

scpcli gslb gslb show
--gslb_id <value>

Description

GSLB 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
env_usageGSLB 용도
health_check
linked_resource_countGSLB 연결 대상
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameGSLB 이름
stateGSLB 상태.

5.5.1.10.2 - 1.0

scpcli gslb gslb show
--gslb_id <value>

Description

GSLB 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
env_usageGSLB 용도
health_check
linked_resource_countGSLB 연결 대상
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameGSLB 이름
stateGSLB 상태.

5.6 - Load Balancer

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 LOADBALANCER 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251023
1.1DEPRECATED20260331
1.2CURRENT-

5.6.1 - CLIs

5.6.1.1 - AddLbServerGroupMembers

5.6.1.1.1 - 1.2

scpcli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>

Description

Member를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLb Server Group ID-
members
required
array'{"member_ip": "192.168.0.1", "member_port": 80, "member_state": "ENABLE", "member_weight": 100, "name": "virtualserver-1", "object_id": "1", "object_type": "VM"}'

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
lb_server_group_idLb Server Group ID
member_ipMember ID
member_portMember 포트
member_stateMember State of Member
member_weightWeight of Member
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameMember 명
object_idMember 대상 서버의 ID
object_typeMember의 대상 서버 타입
stateState of Member
subnet_idSunbet ID
uuidUUID of Member

5.6.1.1.2 - 1.1

scpcli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>

Description

Member를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLb Server Group ID-
members
required
array'{"member_ip": "192.168.0.1", "member_port": 80, "member_state": "ENABLE", "member_weight": 100, "name": "virtualserver-1", "object_id": "1", "object_type": "VM"}'

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
lb_server_group_idLb Server Group ID
member_ipMember ID
member_portMember 포트
member_stateMember State of Member
member_weightWeight of Member
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameMember 명
object_idMember 대상 서버의 ID
object_typeMember의 대상 서버 타입
stateState of Member
subnet_idSunbet ID
uuidUUID of Member

5.6.1.2 - CreateLBHealthCheck

5.6.1.2.1 - 1.2

scpcli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]

Description

LB 헬스 체크를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
string프로토콜TCP
name
required
stringLB 헬스 체크명ServerGroup01
description
optional
string설명this is an lb server group
health_check_count
optional
integer탐지 횟수3
health_check_interval
optional
integer헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.5
health_check_port
optional
integer헬스 체크 포트80
health_check_timeout
optional
integer대기 시간5
health_check_url
optional
stringURL 모니터/test
http_method
optional
****LB 헬스 체크 HTTP 방식GET
request_data
optional
string요청 문자열username=admin&password=1234
response_code
optional
string응답 코드200
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명this is an lb server group
health_check_count탐지 횟수3
health_check_interval헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.5
health_check_port헬스 체크 포트80
health_check_timeout대기 시간5
health_check_typeLB 헬스 체크 유형DEFAULT
health_check_urlURL 모니터/test
http_methodLB 헬스 체크 HTTP 방식GET
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 헬스 체크명Test-LbMonitor-01
protocol프로토콜TCP
request_data요청 문자열username=admin&password=1234
response_code응답 코드200
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.2.2 - 1.1

scpcli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]

Description

LB 헬스 체크를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
string프로토콜TCP
name
required
stringLB 헬스 체크명ServerGroup01
description
optional
string설명this is an lb server group
health_check_count
optional
integer탐지 횟수3
health_check_interval
optional
integer헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.5
health_check_port
optional
integer헬스 체크 포트80
health_check_timeout
optional
integer대기 시간5
health_check_url
optional
stringURL 모니터/test
http_method
optional
****LB 헬스 체크 HTTP 방식GET
request_data
optional
string요청 문자열username=admin&password=1234
response_code
optional
string응답 코드200
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명this is an lb server group
health_check_count탐지 횟수3
health_check_interval헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.5
health_check_port헬스 체크 포트80
health_check_timeout대기 시간5
health_check_typeLB 헬스 체크 유형DEFAULT
health_check_urlURL 모니터/test
http_methodLB 헬스 체크 HTTP 방식GET
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 헬스 체크명Test-LbMonitor-01
protocol프로토콜TCP
request_data요청 문자열username=admin&password=1234
response_code응답 코드200
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.3 - CreateLbListener

5.6.1.3.1 - 1.2

scpcli loadbalancer lb-listener create
--service_port <value>
--routing_action <value>
--protocol <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--tags <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]

Description

Listener를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
service_port
required
integer서비스 포트-
routing_action
required
stringThe routing action of the listener.-
protocol
required
string프로토콜-
name
required
stringListener 명-
loadbalancer_id
required
stringLB 아이디-
condition_type
optional
****The condition type of the listener.-
description
optional
string설명-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
string지속성 유형-
response_timeout
optional
integer응답 시간 초과-
server_group_id
optional
stringLB 서버 그룹 아이디-
session_duration_time
optional
integerThe session duration time.-
sni_certificate
optional
arrayThe sni certificate of the listener.'{"domain_name": "", "sni_cert_id": ""}'
support_http2
optional
booleanWhether the HTTP 2.0 is supported-
tags
optional
arrayTag List'{"key": "", "value": ""}'
url_handler
optional
arrayURL 처리-
url_redirection
optional
stringThe URL redirect of the listener.-
x_forwarded_for
optional
booleanWhether the X-Forwarded-For should be inserted.-
x_forwarded_port
optional
booleanWhether the X-Forwarded-Port should be inserted.-
x_forwarded_proto
optional
booleanWhether the X-Forwarded-Protocol should be inserted.-
port
optional
stringport-
response_code
optional
stringresponse_code-
client_cert_id
optional
stringCertificate id for client ssl-
client_cert_level
optional
stringCertificate level for client ssl-
server_cert_level
optional
stringCertificate level for server ssl-

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
https_redirectionThe https redirection of the listener.
insert_client_ipWhether the client IP should be inserted.
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameListener 명
persistence지속성 유형
protocol프로토콜
response_timeout응답 시간 초과
routing_actionThe routing action of the listener.
server_group_idLB 서버 그룹 아이디
server_group_nameLB 서버 그룹 명
service_port서비스 포트
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateSSL 인증서
stateListener 상태
support_http2Whether the HTTP 2.0 is supported
url_handlerURL 처리
url_redirectionThe URL redirect of the listener.
x_forwarded_forWhether the X-Forwarded-For should be inserted.
x_forwarded_portWhether the X-Forwarded-Port should be inserted.
x_forwarded_protoWhether the X-Forwarded-Protocol should be inserted.

5.6.1.3.2 - 1.1

scpcli loadbalancer lb-listener create
--service_port <value>
--routing_action <value>
--protocol <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--tags <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]

Description

Listener를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
service_port
required
integer서비스 포트-
routing_action
required
stringThe routing action of the listener.-
protocol
required
string프로토콜-
name
required
stringListener 명-
loadbalancer_id
required
stringLB 아이디-
condition_type
optional
****The condition type of the listener.-
description
optional
string설명-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
string지속성 유형-
response_timeout
optional
integer응답 시간 초과-
server_group_id
optional
stringLB 서버 그룹 아이디-
session_duration_time
optional
integerThe session duration time.-
sni_certificate
optional
arrayThe sni certificate of the listener.'{"domain_name": "", "sni_cert_id": ""}'
support_http2
optional
booleanWhether the HTTP 2.0 is supported-
tags
optional
arrayTag List'{"key": "", "value": ""}'
url_handler
optional
arrayURL 처리-
url_redirection
optional
stringThe URL redirect of the listener.-
x_forwarded_for
optional
booleanWhether the X-Forwarded-For should be inserted.-
x_forwarded_port
optional
booleanWhether the X-Forwarded-Port should be inserted.-
x_forwarded_proto
optional
booleanWhether the X-Forwarded-Protocol should be inserted.-
port
optional
stringport-
response_code
optional
stringresponse_code-
client_cert_id
optional
stringCertificate id for client ssl-
client_cert_level
optional
stringCertificate level for client ssl-
server_cert_level
optional
stringCertificate level for server ssl-

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
https_redirectionThe https redirection of the listener.
insert_client_ipWhether the client IP should be inserted.
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameListener 명
persistence지속성 유형
protocol프로토콜
response_timeout응답 시간 초과
routing_actionThe routing action of the listener.
server_group_idLB 서버 그룹 아이디
server_group_nameLB 서버 그룹 명
service_port서비스 포트
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateSSL 인증서
stateListener 상태
support_http2Whether the HTTP 2.0 is supported
url_handlerURL 처리
url_redirectionThe URL redirect of the listener.
x_forwarded_forWhether the X-Forwarded-For should be inserted.
x_forwarded_portWhether the X-Forwarded-Port should be inserted.
x_forwarded_protoWhether the X-Forwarded-Protocol should be inserted.

5.6.1.4 - CreateLBServerGroup

5.6.1.4.1 - 1.2

scpcli loadbalancer lb-server-group create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
--lb_method <value>
[--description <value>]
[--lb_health_check_id <value>]
[--tags <value>]

Description

LB 서버 그룹을 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
string프로토콜TCP
name
required
stringLB 헬스 체크명ServerGroup01
lb_method
required
string부하 분산ROUND_ROBIN
description
optional
string설명this is an lb server group
lb_health_check_id
optional
stringLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명this is an lb server group
lb_health_check_idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
lb_method부하 분산ROUND_ROBIN
lb_nameLoad Balancer 명Test-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 서버 그룹 명ServerGroup01
protocol프로토콜TCP
stateLB 서버 그룹 상태ACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.4.2 - 1.1

scpcli loadbalancer lb-server-group create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
--lb_method <value>
[--description <value>]
[--lb_health_check_id <value>]
[--tags <value>]

Description

LB 서버 그룹을 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
string프로토콜TCP
name
required
stringLB 헬스 체크명ServerGroup01
lb_method
required
string부하 분산ROUND_ROBIN
description
optional
string설명this is an lb server group
lb_health_check_id
optional
stringLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명this is an lb server group
lb_health_check_idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
lb_method부하 분산ROUND_ROBIN
lb_nameLoad Balancer 명Test-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 서버 그룹 명ServerGroup01
protocol프로토콜TCP
stateLB 서버 그룹 상태ACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.5 - CreateLoadbalancer

5.6.1.5.1 - 1.2

scpcli loadbalancer loadbalancer create
--vpc_id <value>
--subnet_id <value>
--name <value>
--layer_type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_logging_enabled <value>]
[--health_check_ip_1 <value>]
[--health_check_ip_2 <value>]
[--publicip_id <value>]
[--service_ip <value>]
[--source_nat_ip <value>]
[--tags <value>]

Description

LoadBalancer를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
subnet_id
required
stringSubnet ID-
name
required
string이름-
layer_type
required
string계층 타입-
description
optional
string설명-
firewall_enabled
optional
boolean방화벽 사용 여부-
firewall_logging_enabled
optional
boolean방화벽 로깅 여부-
health_check_ip_1
optional
stringHealth check IP-
health_check_ip_2
optional
stringHealth check IP-
publicip_id
optional
stringPublic IP ID-
service_ip
optional
stringLoadBalancer 서비스 IP-
source_nat_ip
optional
stringSource NAT IP-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
id자원 ID
account_idLoadBalancer account ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
layer_type계층 타입
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name이름
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

5.6.1.5.2 - 1.1

scpcli loadbalancer loadbalancer create
--vpc_id <value>
--subnet_id <value>
--name <value>
--layer_type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_logging_enabled <value>]
[--health_check_ip_1 <value>]
[--health_check_ip_2 <value>]
[--publicip_id <value>]
[--service_ip <value>]
[--source_nat_ip <value>]
[--tags <value>]

Description

LoadBalancer를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
subnet_id
required
stringSubnet ID-
name
required
string이름-
layer_type
required
string계층 타입-
description
optional
string설명-
firewall_enabled
optional
boolean방화벽 사용 여부-
firewall_logging_enabled
optional
boolean방화벽 로깅 여부-
health_check_ip_1
optional
stringHealth check IP-
health_check_ip_2
optional
stringHealth check IP-
publicip_id
optional
stringPublic IP ID-
service_ip
optional
stringLoadBalancer 서비스 IP-
source_nat_ip
optional
stringSource NAT IP-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
id자원 ID
account_idLoadBalancer account ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
layer_type계층 타입
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name이름
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

5.6.1.6 - CreateLoadbalancerPublicNatIp

5.6.1.6.1 - 1.2

scpcli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>

Description

LoadBalancer Public NAT를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-
publicip_id
required
stringpublicip_id-

Responses

NameDescriptionExample
id자원 ID
account_idaccount_id
action_typeaction_type
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
external_ip_addressexternal_ip_address
internal_ip_addressinternal_ip_address
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name이름
owner_idowner_id
owner_nameowner_name
owner_typeowner_type
publicip_idpublicip_id
service_ip_port_idservice_ip_port_id
statestate
subnet_idsubnet_id
typetype
vpc_idvpc_id

5.6.1.6.2 - 1.1

scpcli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>

Description

LoadBalancer Public NAT를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-
publicip_id
required
stringpublicip_id-

Responses

NameDescriptionExample
id자원 ID
account_idaccount_id
action_typeaction_type
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
external_ip_addressexternal_ip_address
internal_ip_addressinternal_ip_address
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name이름
owner_idowner_id
owner_nameowner_name
owner_typeowner_type
publicip_idpublicip_id
service_ip_port_idservice_ip_port_id
statestate
subnet_idsubnet_id
typetype
vpc_idvpc_id

5.6.1.7 - DeleteLBHealthCheck

5.6.1.7.1 - 1.2

scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

LB 헬스 체크를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB 헬스 체크 IDe3cd678b11784734bc366148aa37580e

5.6.1.7.2 - 1.1

scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

LB 헬스 체크를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB 헬스 체크 IDe3cd678b11784734bc366148aa37580e

5.6.1.8 - DeleteLbListener

5.6.1.8.1 - 1.2

scpcli loadbalancer lb-listener delete
--listener_id <value>

Description

Listener를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
listener_id
required
stringListener 아이디-

5.6.1.8.2 - 1.1

scpcli loadbalancer lb-listener delete
--listener_id <value>

Description

Listener를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
listener_id
required
stringListener 아이디-

5.6.1.9 - DeleteLBServerGroup

5.6.1.9.1 - 1.2

scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

LB 서버 그룹을 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b

5.6.1.9.2 - 1.1

scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

LB 서버 그룹을 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b

5.6.1.10 - DeleteLoadbalancer

5.6.1.10.1 - 1.2

scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

LoadBalancer를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-

5.6.1.10.2 - 1.1

scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

LoadBalancer를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-

5.6.1.11 - DeleteLoadbalancerPublicNatIp

5.6.1.11.1 - 1.2

scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

LoadBalancer Public NAT를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-

5.6.1.11.2 - 1.1

scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

LoadBalancer Public NAT를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-

5.6.1.12 - ListLBHealthChecks

5.6.1.12.1 - 1.2

scpcli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]

Description

LB 헬스 체크 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB 헬스 체크명Test-LbMonitor-01
protocol
optional
array프로토콜'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200

Responses

NameDescriptionExample
idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
health_check_typeLB 헬스 체크 유형DEFAULT
lb_server_group_countLB 서버 그룹 수2
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 헬스 체크명Test-LbMonitor-01
protocol프로토콜TCP
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200

5.6.1.12.2 - 1.1

scpcli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]

Description

LB 헬스 체크 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB 헬스 체크명Test-LbMonitor-01
protocol
optional
array프로토콜'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200

Responses

NameDescriptionExample
idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
health_check_typeLB 헬스 체크 유형DEFAULT
lb_server_group_countLB 서버 그룹 수2
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 헬스 체크명Test-LbMonitor-01
protocol프로토콜TCP
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200

5.6.1.13 - ListLbListeners

5.6.1.13.1 - 1.2

scpcli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]

Description

Listener 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
loadbalancer_id
optional
stringLB 아이디-
state
optional
stringListener 상태-
name
optional
stringListener 명-
service_port
optional
integer서비스 포트-
protocol
optional
array프로토콜'TCP'

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameListener 명
protocol프로토콜
service_port서비스 포트
stateListener 상태

5.6.1.13.2 - 1.1

scpcli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]

Description

Listener 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
loadbalancer_id
optional
stringLB 아이디-
state
optional
stringListener 상태-
name
optional
stringListener 명-
service_port
optional
integer서비스 포트-
protocol
optional
array프로토콜'TCP'

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameListener 명
protocol프로토콜
service_port서비스 포트
stateListener 상태

5.6.1.14 - ListLbServerGroupMembers

5.6.1.14.1 - 1.2

scpcli loadbalancer lb-server-group-member list
--lb_server_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--member_ip <value>]
[--member_port <value>]

Description

Member 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLb Server Group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringMember 명-
member_ip
optional
stringMember ID-
member_port
optional
integerMember 포트-

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
health_stateMember의 Health State
lb_server_group_idLb Server Group ID
member_ipMember ID
member_portMember 포트
member_stateMember State of Member
member_weightWeight of Member
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameMember 명
object_idMember 대상 서버의 ID
object_typeMember의 대상 서버 타입
stateState of Member

5.6.1.14.2 - 1.1

scpcli loadbalancer lb-server-group-member list
--lb_server_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--member_ip <value>]
[--member_port <value>]

Description

Member 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLb Server Group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringMember 명-
member_ip
optional
stringMember ID-
member_port
optional
integerMember 포트-

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
health_stateMember의 Health State
lb_server_group_idLb Server Group ID
member_ipMember ID
member_portMember 포트
member_stateMember State of Member
member_weightWeight of Member
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameMember 명
object_idMember 대상 서버의 ID
object_typeMember의 대상 서버 타입
stateState of Member

5.6.1.15 - ListLBServerGroups

5.6.1.15.1 - 1.2

scpcli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

LB 서버 그룹 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB 서버 그룹 명ServerGroup01
protocol
optional
array프로토콜'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_id
optional
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
lb_health_check_id
optional
stringLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
lb_method
optional
array부하 분산'R'

Responses

NameDescriptionExample
idLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
lb_health_check_idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
lb_nameLoad Balancer 명Test-LB-01
lb_server_group_member_count서버 멤버 수2
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 서버 그룹 명ServerGroup01
protocol프로토콜TCP
stateLB 서버 그룹 상태ACTIVE
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.15.2 - 1.1

scpcli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

LB 서버 그룹 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB 서버 그룹 명ServerGroup01
protocol
optional
array프로토콜'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_id
optional
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
lb_health_check_id
optional
stringLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
lb_method
optional
array부하 분산'R'

Responses

NameDescriptionExample
idLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
lb_health_check_idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
lb_nameLoad Balancer 명Test-LB-01
lb_server_group_member_count서버 멤버 수2
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 서버 그룹 명ServerGroup01
protocol프로토콜TCP
stateLB 서버 그룹 상태ACTIVE
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.16 - ListLoadbalancerCertificates

5.6.1.16.1 - 1.2

scpcli loadbalancer loadbalancer-certificate list

Description

인증서 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
cert_kind
cn
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
state

5.6.1.16.2 - 1.1

scpcli loadbalancer loadbalancer-certificate list

Description

인증서 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
cert_kind
cn
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
state

5.6.1.17 - ListLoadbalancers

5.6.1.17.1 - 1.2

scpcli loadbalancer loadbalancer list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--service_ip <value>]
[--subnet_id <value>]
[--layer_type <value>]
[--vpc_id <value>]

Description

LoadBalancer 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLoadBalancer 명-
state
optional
****The state of the load balancer.-
service_ip
optional
stringLoadBalancer 서비스 IP-
subnet_id
optional
stringSubnet ID-
layer_type
optional
****계층 타입-
vpc_id
optional
stringVPC ID-

Responses

NameDescriptionExample
id자원 ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
firewall_id방화벽 ID
layer_type계층 타입
listener_countListener 개수
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLoadBalancer 명
public_nat_enabledPublic NAT Enabled Status
service_ipLoadBalancer 서비스 IP
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

5.6.1.17.2 - 1.1

scpcli loadbalancer loadbalancer list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--service_ip <value>]
[--subnet_id <value>]
[--layer_type <value>]
[--vpc_id <value>]

Description

LoadBalancer 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLoadBalancer 명-
state
optional
****The state of the load balancer.-
service_ip
optional
stringLoadBalancer 서비스 IP-
subnet_id
optional
stringSubnet ID-
layer_type
optional
****계층 타입-
vpc_id
optional
stringVPC ID-

Responses

NameDescriptionExample
id자원 ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
firewall_id방화벽 ID
layer_type계층 타입
listener_countListener 개수
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLoadBalancer 명
public_nat_enabledPublic NAT Enabled Status
service_ipLoadBalancer 서비스 IP
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

5.6.1.18 - RemoveLbServerGroupMember

5.6.1.18.1 - 1.2

scpcli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>

Description

Member를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringLb Server Group ID-

5.6.1.18.2 - 1.1

scpcli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>

Description

Member를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringLb Server Group ID-

5.6.1.19 - RemoveLbServerGroupMembers

5.6.1.19.1 - 1.2

scpcli loadbalancer lb-server-group-members remove
--lb_server_group_id <value>
--member_id_list <value>

Description

Remove Lb Server Group Members

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLb Server Group ID-
member_id_list
required
arrayID list of Member-

5.6.1.20 - SetLBHealthCheck

5.6.1.20.1 - 1.2

scpcli loadbalancer lb-health-check update
--lb_health_check_id <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--protocol <value>]
[--request_data <value>]
[--response_code <value>]

Description

LB 헬스 체크를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB 헬스 체크 IDe3cd678b11784734bc366148aa37580e
description
optional
string설명this is an lb server group
health_check_count
optional
integer탐지 횟수3
health_check_interval
optional
integer헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.5
health_check_port
optional
integer헬스 체크 포트80
health_check_timeout
optional
integer대기 시간5
health_check_url
optional
stringURL 모니터/test
http_method
optional
****LB 헬스 체크 HTTP 방식GET
protocol
optional
****프로토콜TCP
request_data
optional
string요청 문자열username=admin&password=1234
response_code
optional
string응답 코드200

5.6.1.20.2 - 1.1

scpcli loadbalancer lb-health-check update
--lb_health_check_id <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--protocol <value>]
[--request_data <value>]
[--response_code <value>]

Description

LB 헬스 체크를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB 헬스 체크 IDe3cd678b11784734bc366148aa37580e
description
optional
string설명this is an lb server group
health_check_count
optional
integer탐지 횟수3
health_check_interval
optional
integer헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.5
health_check_port
optional
integer헬스 체크 포트80
health_check_timeout
optional
integer대기 시간5
health_check_url
optional
stringURL 모니터/test
http_method
optional
****LB 헬스 체크 HTTP 방식GET
protocol
optional
****프로토콜TCP
request_data
optional
string요청 문자열username=admin&password=1234
response_code
optional
string응답 코드200

5.6.1.21 - SetLbListener

5.6.1.21.1 - 1.2

scpcli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--protocol <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]

Description

리스너 목록을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
listener_id
required
stringListener 아이디-
condition_type
optional
****The condition type of the listener.-
description
optional
string설명-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
string지속성 유형-
response_timeout
optional
integer응답 시간 초과-
server_group_id
optional
stringLB 서버 그룹 아이디-
session_duration_time
optional
integerThe session duration time.-
sni_certificate
optional
arrayThe sni certificate of the listener.'{"domain_name": "", "sni_cert_id": ""}'
support_http2
optional
booleanWhether the HTTP 2.0 is supported-
url_handler
optional
arrayURL 처리-
url_redirection
optional
stringThe URL redirect of the listener.-
x_forwarded_for
optional
booleanWhether the X-Forwarded-For should be inserted.-
x_forwarded_port
optional
booleanWhether the X-Forwarded-Port should be inserted.-
x_forwarded_proto
optional
booleanWhether the X-Forwarded-Protocol should be inserted.-
port
optional
stringport-
protocol
optional
string프로토콜-
response_code
optional
stringresponse_code-
client_cert_id
optional
stringCertificate id for client ssl-
client_cert_level
optional
stringCertificate level for client ssl-
server_cert_level
optional
stringCertificate level for server ssl-

5.6.1.21.2 - 1.1

scpcli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--protocol <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]

Description

리스너 목록을 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
listener_id
required
stringListener 아이디-
condition_type
optional
****The condition type of the listener.-
description
optional
string설명-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
string지속성 유형-
response_timeout
optional
integer응답 시간 초과-
server_group_id
optional
stringLB 서버 그룹 아이디-
session_duration_time
optional
integerThe session duration time.-
sni_certificate
optional
arrayThe sni certificate of the listener.'{"domain_name": "", "sni_cert_id": ""}'
support_http2
optional
booleanWhether the HTTP 2.0 is supported-
url_handler
optional
arrayURL 처리-
url_redirection
optional
stringThe URL redirect of the listener.-
x_forwarded_for
optional
booleanWhether the X-Forwarded-For should be inserted.-
x_forwarded_port
optional
booleanWhether the X-Forwarded-Port should be inserted.-
x_forwarded_proto
optional
booleanWhether the X-Forwarded-Protocol should be inserted.-
port
optional
stringport-
protocol
optional
string프로토콜-
response_code
optional
stringresponse_code-
client_cert_id
optional
stringCertificate id for client ssl-
client_cert_level
optional
stringCertificate level for client ssl-
server_cert_level
optional
stringCertificate level for server ssl-

5.6.1.22 - SetLBServerGroup

5.6.1.22.1 - 1.2

scpcli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

LB 서버 그룹을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b
description
optional
string설명this is an lb server group
lb_health_check_id
optional
stringLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
lb_method
optional
****부하 분산ROUND_ROBIN

5.6.1.22.2 - 1.1

scpcli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

LB 서버 그룹을 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b
description
optional
string설명this is an lb server group
lb_health_check_id
optional
stringLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
lb_method
optional
****부하 분산ROUND_ROBIN

5.6.1.23 - SetLbServerGroupMember

5.6.1.23.1 - 1.2

scpcli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]

Description

Member를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringLb Server Group ID-
member_port
optional
integerMember 포트80
member_state
optional
****Member State of Member-
member_weight
optional
integerWeight of Member100

5.6.1.23.2 - 1.1

scpcli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]

Description

Member를 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringLb Server Group ID-
member_port
optional
integerMember 포트80
member_state
optional
****Member State of Member-
member_weight
optional
integerWeight of Member100

5.6.1.24 - SetLoadbalancer

5.6.1.24.1 - 1.1

scpcli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>

Description

LoadBalancer를 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-
description
required
string설명-

5.6.1.25 - ShowLBHealthCheck

5.6.1.25.1 - 1.2

scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

LB 헬스 체크를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB 헬스 체크 IDe3cd678b11784734bc366148aa37580e

Responses

NameDescriptionExample
idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명this is an lb server group
health_check_count탐지 횟수3
health_check_interval헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.5
health_check_port헬스 체크 포트80
health_check_timeout대기 시간5
health_check_typeLB 헬스 체크 유형DEFAULT
health_check_urlURL 모니터/test
http_methodLB 헬스 체크 HTTP 방식GET
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 헬스 체크명Test-LbMonitor-01
protocol프로토콜TCP
request_data요청 문자열username=admin&password=1234
response_code응답 코드200
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.25.2 - 1.1

scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

LB 헬스 체크를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB 헬스 체크 IDe3cd678b11784734bc366148aa37580e

Responses

NameDescriptionExample
idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명this is an lb server group
health_check_count탐지 횟수3
health_check_interval헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.5
health_check_port헬스 체크 포트80
health_check_timeout대기 시간5
health_check_typeLB 헬스 체크 유형DEFAULT
health_check_urlURL 모니터/test
http_methodLB 헬스 체크 HTTP 방식GET
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 헬스 체크명Test-LbMonitor-01
protocol프로토콜TCP
request_data요청 문자열username=admin&password=1234
response_code응답 코드200
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.26 - ShowLbListener

5.6.1.26.1 - 1.2

scpcli loadbalancer lb-listener show
--listener_id <value>

Description

Listener를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
listener_id
required
stringListener 아이디-

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
https_redirectionThe https redirection of the listener.
insert_client_ipWhether the client IP should be inserted.
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameListener 명
persistence지속성 유형
protocol프로토콜
response_timeout응답 시간 초과
routing_actionThe routing action of the listener.
server_group_idLB 서버 그룹 아이디
server_group_nameLB 서버 그룹 명
service_port서비스 포트
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateSSL 인증서
stateListener 상태
support_http2Whether the HTTP 2.0 is supported
url_handlerURL 처리
url_redirectionThe URL redirect of the listener.
x_forwarded_forWhether the X-Forwarded-For should be inserted.
x_forwarded_portWhether the X-Forwarded-Port should be inserted.
x_forwarded_protoWhether the X-Forwarded-Protocol should be inserted.

5.6.1.26.2 - 1.1

scpcli loadbalancer lb-listener show
--listener_id <value>

Description

Listener를 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
listener_id
required
stringListener 아이디-

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
https_redirectionThe https redirection of the listener.
insert_client_ipWhether the client IP should be inserted.
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameListener 명
persistence지속성 유형
protocol프로토콜
response_timeout응답 시간 초과
routing_actionThe routing action of the listener.
server_group_idLB 서버 그룹 아이디
server_group_nameLB 서버 그룹 명
service_port서비스 포트
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateSSL 인증서
stateListener 상태
support_http2Whether the HTTP 2.0 is supported
url_handlerURL 처리
url_redirectionThe URL redirect of the listener.
x_forwarded_forWhether the X-Forwarded-For should be inserted.
x_forwarded_portWhether the X-Forwarded-Port should be inserted.
x_forwarded_protoWhether the X-Forwarded-Protocol should be inserted.

5.6.1.27 - ShowLBServerGroup

5.6.1.27.1 - 1.2

scpcli loadbalancer lb-server-group read
--lb_server_group_id <value>

Description

LB 서버 그룹을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b

Responses

NameDescriptionExample
idLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명this is an lb server group
lb_health_check_idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
lb_method부하 분산ROUND_ROBIN
lb_nameLoad Balancer 명Test-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 서버 그룹 명ServerGroup01
protocol프로토콜TCP
stateLB 서버 그룹 상태ACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.27.2 - 1.1

scpcli loadbalancer lb-server-group read
--lb_server_group_id <value>

Description

LB 서버 그룹을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b

Responses

NameDescriptionExample
idLB 서버 그룹 ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명this is an lb server group
lb_health_check_idLB 헬스 체크 ID46c681018e33453085ca7c8db54e0076
lb_method부하 분산ROUND_ROBIN
lb_nameLoad Balancer 명Test-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameLB 서버 그룹 명ServerGroup01
protocol프로토콜TCP
stateLB 서버 그룹 상태ACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.28 - ShowLbServerGroupMember

5.6.1.28.1 - 1.2

scpcli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>

Description

Member를 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringLb Server Group ID-

Responses

NameDescriptionExample
member

5.6.1.28.2 - 1.1

scpcli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>

Description

Member를 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringLb Server Group ID-

Responses

NameDescriptionExample
member

5.6.1.29 - ShowLoadbalancer

5.6.1.29.1 - 1.2

scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

LoadBalancer를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-

Responses

NameDescriptionExample
id자원 ID
account_idLoadBalancer account ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
firewall_id방화벽 ID
health_check_ipHealth check IP
layer_type계층 타입
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name이름
public_nat_enabledPublic NAT Enabled Status
service_ipLoadBalancer 서비스 IP
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

5.6.1.29.2 - 1.1

scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

LoadBalancer를 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-

Responses

NameDescriptionExample
id자원 ID
account_idLoadBalancer account ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
firewall_id방화벽 ID
health_check_ipHealth check IP
layer_type계층 타입
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name이름
public_nat_enabledPublic NAT Enabled Status
service_ipLoadBalancer 서비스 IP
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

5.6.1.30 - ShowLoadbalancerCertificate

5.6.1.30.1 - 1.2

scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

인증서를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
lb_certificate_id
required
string인증서 아이디-

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idThe project ID of the certificate
cert_bodyThe body of the certificate
cert_chainThe chain of the certificate
cert_kind
cn
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
organizationThe organization of the certificate
private_key인증서 개인키
state

5.6.1.30.2 - 1.1

scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

인증서를 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
lb_certificate_id
required
string인증서 아이디-

Responses

NameDescriptionExample
id자원 ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idThe project ID of the certificate
cert_bodyThe body of the certificate
cert_chainThe chain of the certificate
cert_kind
cn
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
organizationThe organization of the certificate
private_key인증서 개인키
state

5.6.1.31 - ShowLoadbalancerPublicNatIp

5.6.1.31.1 - 1.2

scpcli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Public NAT IP

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-

Responses

NameDescriptionExample
external_ip_addressStatic Nat External Ip Address
publicip_idPublicip ID
stateStatic Nat State

5.6.1.31.2 - 1.1

scpcli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Public NAT IP

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
string자원 ID-

Responses

NameDescriptionExample
external_ip_addressStatic Nat External Ip Address
publicip_idPublicip ID
stateStatic Nat State

5.7 - Security Group

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Security Group 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

5.7.1 - CLIs

5.7.1.1 - Create Security Group

5.7.1.1.1 - 1.0

scpcli security-group security-group create
--name <value>
[--description <value>]
[--loggable <value>]
[--tags <value>]

Description

Security Group을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
required
stringSecurity Group 이름-
description
optional
stringSecurity Group 설명-
loggable
optional
booleanSecurity Group 로깅 여부-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSecurity Group ID
account_idSecurity Group Account ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group 설명
loggableSecurity Group 로깅 여부
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group 이름
rule_countSecurity Group Rule 수
stateSecurity Group 상태

5.7.1.2 - Create Security Group Rule

5.7.1.2.1 - 1.0

scpcli security-group security-group-rule create
--security_group_id <value>
--direction <value>
[--description <value>]
[--ethertype <value>]
[--port_range_max <value>]
[--port_range_min <value>]
[--protocol <value>]
[--remote_group_id <value>]
[--remote_ip_prefix <value>]

Description

Security Group rule을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-
direction
required
stringSecurity Group Rule Direction (Ingress, Egress)-
description
optional
stringSecurity Group Rule 설명-
ethertype
optional
stringSecurity Group Rule Ethertype (IPV4, IPV6)-
port_range_max
optional
integerSecurity Group Rule 포트 범위 최대값-
port_range_min
optional
integerSecurity Group Rule 포트 범위 최소값-
protocol
optional
stringSecurity Group Rule 프로토콜-
remote_group_id
optional
stringSecurity Group Rule 원격 그룹 ID-
remote_ip_prefix
optional
stringSecurity Group Rule IP 주소-

Responses

NameDescriptionExample
idSecurity Group Rule ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule 설명
directionSecurity Group Rule 방향 (Ingress, Egress)
ethertypeSecurity Group Rule Ethertype (IPV4, IPV6)
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule 포트 범위 최대값
port_range_minSecurity Group Rule 포트 범위 최소값
protocolSecurity Group Rule 프로토콜
remote_group_idSecurity Group Rule 원격 그룹 ID
remote_group_nameSecurity Group Rule 원격 그룹 이름
remote_ip_prefixSecurity Group Rule IP 주소
security_group_idSecurity Group ID

5.7.1.3 - Delete Security Group

5.7.1.3.1 - 1.0

scpcli security-group security-group delete
--security_group_id <value>

Description

Security Group을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-

5.7.1.4 - Delete Security Group Rule

5.7.1.4.1 - 1.0

scpcli security-group security-group-rule delete
--security_group_rule_id <value>

Description

Security Group rule을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
security_group_rule_id
required
stringSecurity Group Rule ID-

5.7.1.5 - List Security Group Rules

5.7.1.5.1 - 1.0

scpcli security-group security-group-rule list
--security_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--remote_ip_prefix <value>]
[--remote_group_id <value>]
[--description <value>]
[--direction <value>]
[--service <value>]

Description

Security Group rule 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSecurity Group Rule ID-
remote_ip_prefix
optional
stringSecurity Group Rule IP 주소-
remote_group_id
optional
stringSecurity Group Rule 원격 그룹 ID-
description
optional
stringSecurity Group Rule 설명-
direction
optional
stringSecurity Group Rule 방향 (Ingress, Egress)-
service
optional
stringSecurity Group Rule 서비스-

Responses

NameDescriptionExample
idSecurity Group Rule ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule 설명
directionSecurity Group Rule 방향 (Ingress, Egress)
ethertypeSecurity Group Rule Ethertype (IPV4, IPV6)
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule 포트 범위 최대값
port_range_minSecurity Group Rule 포트 범위 최소값
protocolSecurity Group Rule 프로토콜
remote_group_idSecurity Group Rule 원격 그룹 ID
remote_group_nameSecurity Group Rule 원격 그룹 이름
remote_ip_prefixSecurity Group Rule IP 주소
security_group_idSecurity Group ID

5.7.1.6 - List Security Groups

5.7.1.6.1 - 1.0

scpcli security-group security-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]

Description

Security Group 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSecurity Group ID-
name
optional
stringSecurity Group 이름-

Responses

NameDescriptionExample
idSecurity Group ID
account_idSecurity Group Account ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group 설명
loggableSecurity Group 로깅 여부
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group 이름
rule_countSecurity Group Rule 수
stateSecurity Group 상태

5.7.1.7 - Set Security Group

5.7.1.7.1 - 1.0

scpcli security-group security-group set
--security_group_id <value>
[--description <value>]
[--loggable <value>]

Description

Security Group을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-
description
optional
stringSecurity Group 설명-
loggable
optional
booleanSecurity Group 로깅 여부-

5.7.1.8 - Show Security Group

5.7.1.8.1 - 1.0

scpcli security-group security-group show
--security_group_id <value>

Description

Security Group 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-

Responses

NameDescriptionExample
idSecurity Group ID
account_idSecurity Group Account ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group 설명
loggableSecurity Group 로깅 여부
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group 이름
rule_countSecurity Group Rule 수
stateSecurity Group 상태

5.7.1.9 - Show Security Group Rule

5.7.1.9.1 - 1.0

scpcli security-group security-group-rule show
--security_group_rule_id <value>
[--fields <value>]

Description

Security Group rule을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
security_group_rule_id
required
stringSecurity Group Rule ID-
fields
optional
array필드명-

Responses

NameDescriptionExample
idSecurity Group Rule ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule 설명
directionSecurity Group Rule 방향 (Ingress, Egress)
ethertypeSecurity Group Rule Ethertype (IPV4, IPV6)
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule 포트 범위 최대값
port_range_minSecurity Group Rule 포트 범위 최소값
protocolSecurity Group Rule 프로토콜
remote_group_idSecurity Group Rule 원격 그룹 ID
remote_group_nameSecurity Group Rule 원격 그룹 이름
remote_ip_prefixSecurity Group Rule IP 주소
security_group_idSecurity Group ID

5.8 - VPC

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 VPC 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

5.8.1 - CLIs

5.8.1.1 - Approval VPC Peering

5.8.1.1.1 - 1.1

scpcli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>

Description

VPC Peering 승인

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
type
required
string승인 유형-

5.8.1.2 - Approve PrivateLink Endpoint

5.8.1.2.1 - 1.1

scpcli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>

Description

Approve PrivateLink Endpoint

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-
type
required
stringPrivateLink Endpoint Action Type-

5.8.1.3 - Connect PrivateLink Endpoint

5.8.1.3.1 - 1.1

scpcli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>

Description

Connect PrivateLink Endpoint

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-
type
required
stringPrivateLink Endpoint Action Type-

5.8.1.4 - Create Internet Gateway

5.8.1.4.1 - 1.1

scpcli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Internet Gateway를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
type
required
stringInternet Gateway 유형-
description
optional
string설명-
firewall_enabled
optional
boolean방화벽 사용-
firewall_loggable
optional
boolean방화벽 로깅 가능-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
firewall_idFirewall ID
loggableNAT 로그 저장 여부
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway 명
state상태
typeInternet Gateway 유형
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.4.2 - 1.0

scpcli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Internet Gateway를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
type
required
stringInternet Gateway 유형-
description
optional
string설명-
firewall_enabled
optional
boolean방화벽 사용-
firewall_loggable
optional
boolean방화벽 로깅 가능-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
firewall_idFirewall ID
loggableNAT 로그 저장 여부
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway 명
state상태
typeInternet Gateway 유형
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.5 - Create NAT Gateway

5.8.1.5.1 - 1.1

scpcli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]

Description

NAT Gateway를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR-
publicip_id
required
stringPublicIP ID-
description
optional
stringNAT Gateway 상세설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway 명
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway 명
nat_gateway_ip_addressNAT Gateway IP 주소
publicip_idPublicIP ID
stateNAT Gateway 상태
subnet_cidrSubnet Cidr
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.5.2 - 1.0

scpcli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]

Description

NAT Gateway를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR-
publicip_id
required
stringPublicIP ID-
description
optional
stringNAT Gateway 상세설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway 명
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway 명
nat_gateway_ip_addressNAT Gateway IP 주소
publicip_idPublicIP ID
stateNAT Gateway 상태
subnet_cidrSubnet Cidr
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.6 - Create Port

5.8.1.6.1 - 1.1

scpcli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]

Description

Port를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID-
name
required
stringPort 명-
description
optional
string설명-
fixed_ip_address
optional
string고정된 IP-
security_groups
optional
arraySecurity Group 목록-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
port

5.8.1.6.2 - 1.0

scpcli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]

Description

Port를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID-
name
required
stringPort 명-
description
optional
string설명-
fixed_ip_address
optional
string고정된 IP-
security_groups
optional
arraySecurity Group 목록-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
port

5.8.1.7 - Create Private NAT

5.8.1.7.1 - 1.1

scpcli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Private NAT 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringPrivate NAT 명-
direct_connect_id
required
stringDirect Connect ID-
cidr
required
stringPrivate NAT IP 대역-
description
optional
string설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP 대역
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT 명
statePrivate NAT 상태
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.7.2 - 1.0

scpcli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Private NAT 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringPrivate NAT 명-
direct_connect_id
required
stringDirect Connect ID-
cidr
required
stringPrivate NAT IP 대역-
description
optional
string설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP 대역
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT 명
statePrivate NAT 상태
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.8 - Create Private NAT IP

5.8.1.8.1 - 1.1

scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Private NAT IP 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
ip_address
required
stringPrivate NAT IP 주소-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP 연결된 자원 ID
attached_resource_namePrivate NAT IP 연결된 자원명
attached_resource_typePrivate NAT IP 연결된 자원 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP 상태

5.8.1.8.2 - 1.0

scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Private NAT IP 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
ip_address
required
stringPrivate NAT IP 주소-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP 연결된 자원 ID
attached_resource_namePrivate NAT IP 연결된 자원명
attached_resource_typePrivate NAT IP 연결된 자원 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP 상태

5.8.1.9 - Create PrivateLink Endpoint

5.8.1.9.1 - 1.1

scpcli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

PrivateLink Endpoint 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID-
name
required
stringPrivateLink Endpoint 명-
endpoint_ip_address
required
stringEndpoint IP 주소-
description
optional
string설명-
privatelink_service_id
optional
stringPrivateLink Service ID-
security_group_ids
optional
arraySecurity Group 목록-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
account_idAccount ID
approval_typePrivateLink Service 승인 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
endpoint_ip_addressEndpoint IP 주소
endpoint_ip_port_idEndpoint IP Port ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint 명
privatelink_service_idPrivateLink Service ID
security_group_idsSecurity Group 목록
statePrivateLink Endpoint 상태
subnet_idSubnet ID
vpc_idVPC ID

5.8.1.10 - Create PrivateLink Service

5.8.1.10.1 - 1.1

scpcli vpc privatelink-service create
--subnet_id <value>
--service_ip_address <value>
--name <value>
--connected_resource_type <value>
--approval_type <value>
[--connected_resource_id <value>]
[--connected_resource_ip_address <value>]
[--description <value>]
[--high_speed_transfer <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

PrivateLink Service 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID-
service_ip_address
required
stringService IP 주소-
name
required
stringPrivateLink Service 명-
connected_resource_type
required
string연결된 자원 Type-
approval_type
required
stringPrivateLink Service 승인 타입-
connected_resource_id
optional
string연결된 자원 ID-
connected_resource_ip_address
optional
string연결된 자원 IP 주소-
description
optional
string설명-
high_speed_transfer
optional
boolean고속 데이터 전송 사용-
security_group_ids
optional
arraySecurity Group 목록-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Service ID
account_idAccount ID
approval_typePrivateLink Service 승인 타입
connected_resource_id연결된 자원 ID
connected_resource_ip_address연결된 자원 IP 주소
connected_resource_name연결된 자원명
connected_resource_type연결된 자원 Type
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
high_speed_transfer고속 데이터 전송 사용
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service 명
security_group_idsSecurity Group 목록
service_ip_addressService IP 주소
service_ip_port_idService IP Port ID
statePrivateLink Service 상태
subnet_idSubnet ID
vpc_idVPC ID

5.8.1.11 - Create PublicIP

5.8.1.11.1 - 1.1

scpcli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]

Description

PublicIP를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP 타입-
description
optional
stringPublicIP 상세 설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP 연결된 자원 ID
attached_resource_namePublicIP 연결된 자원명
attached_resource_typePublicIP 연결된 자원 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP 상세 설명
ip_addressIP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP 상태
typePublicIP 타입

5.8.1.11.2 - 1.0

scpcli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]

Description

PublicIP를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP 타입-
description
optional
stringPublicIP 상세 설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP 연결된 자원 ID
attached_resource_namePublicIP 연결된 자원명
attached_resource_typePublicIP 연결된 자원 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP 상세 설명
ip_addressIP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP 상태
typePublicIP 타입

5.8.1.12 - Create Subnet

5.8.1.12.1 - 1.1

scpcli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--host_routes <value>]
[--tags <value>]

Description

Subnet을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet 유형-
name
required
stringSubnet 명subnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
allocation_pools
optional
arrayIP 할당 범위[
description
optional
string설명Subnet Description
dns_nameservers
optional
arrayDNS Name Server[
host_routes
optional
array호스트 경로[
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsIP 할당 범위
cidrSubnet Cidr192.167.1.0/24
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Subnet Description
dns_nameserversDNS Name Server
gateway_ip_addressGateway IP192.167.1.1
host_routes호스트 경로
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet 명subnetName
state상태
typeSubnet 유형
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC 명vpcName

5.8.1.12.2 - 1.0

scpcli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--host_routes <value>]
[--tags <value>]

Description

Subnet을 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet 유형-
name
required
stringSubnet 명subnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
allocation_pools
optional
arrayIP 할당 범위[
description
optional
string설명Subnet Description
dns_nameservers
optional
arrayDNS Name Server[
host_routes
optional
array호스트 경로[
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsIP 할당 범위
cidrSubnet Cidr192.167.1.0/24
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Subnet Description
dns_nameserversDNS Name Server
gateway_ip_addressGateway IP192.167.1.1
host_routes호스트 경로
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet 명subnetName
state상태
typeSubnet 유형
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC 명vpcName

5.8.1.13 - Create Transit Gateway

5.8.1.13.1 - 1.1

scpcli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]

Description

Transit Gateway 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway 명-
description
optional
string설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway 포트 용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway 상세 설명
firewall_idsFirewall ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway 명
state상태
uplink_enabledUplink 사용

5.8.1.13.2 - 1.0

scpcli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]

Description

Transit Gateway 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway 명-
description
optional
string설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway 포트 용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway 상세 설명
firewall_idsFirewall ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway 명
state상태
uplink_enabledUplink 사용

5.8.1.14 - Create Transit Gateway Rule

5.8.1.14.1 - 1.1

scpcli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Transit Gateway 규칙 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
tgw_connection_vpc_id
required
stringTransit Gateway에 연결된 VPC ID.-
destination_type
required
string목적지 타입-
destination_cidr
required
string목적지 CIDR-
description
optional
string설명-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
destination_cidr목적지 CIDR
destination_resource_id목적지 자원 ID
destination_resource_name목적지 자원명
destination_type목적지 타입
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
source_resource_id출발지 자원 ID
source_resource_name출발지 자원명
source_type출발지 타입
state상태
tgw_connection_vpc_idTransit Gateway에 연결된 VPC ID.
tgw_connection_vpc_nameTransit Gateway에 연결된 VPC명.

5.8.1.14.2 - 1.0

scpcli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Transit Gateway 규칙 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
tgw_connection_vpc_id
required
stringTransit Gateway에 연결된 VPC ID.-
destination_type
required
string목적지 타입-
destination_cidr
required
string목적지 CIDR-
description
optional
string설명-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
destination_cidr목적지 CIDR
destination_resource_id목적지 자원 ID
destination_resource_name목적지 자원명
destination_type목적지 타입
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
source_resource_id출발지 자원 ID
source_resource_name출발지 자원명
source_type출발지 타입
state상태
tgw_connection_vpc_idTransit Gateway에 연결된 VPC ID.
tgw_connection_vpc_nameTransit Gateway에 연결된 VPC명.

5.8.1.15 - Create Transit Gateway VPC Connection

5.8.1.15.1 - 1.1

scpcli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Transit Gateway VPC 연결 생성.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
vpc_id
required
stringVPC ID-

Responses

NameDescriptionExample
idTransit Gateway VPC 연결 ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
state상태
transit_gateway_idTransit Gateway ID
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.15.2 - 1.0

scpcli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Transit Gateway VPC 연결 생성.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
vpc_id
required
stringVPC ID-

Responses

NameDescriptionExample
idTransit Gateway VPC 연결 ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
state상태
transit_gateway_idTransit Gateway ID
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.16 - Create VPC

5.8.1.16.1 - 1.1

scpcli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

VPC를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringVPC 명vpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
string설명VPC Description
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC ID7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명vpcDescription
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC 명vpcName
state상태

5.8.1.16.2 - 1.0

scpcli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

VPC를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringVPC 명vpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
string설명VPC Description
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC ID7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명vpcDescription
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC 명vpcName
state상태

5.8.1.17 - Create VPC Endpoint

5.8.1.17.1 - 1.1

scpcli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]

Description

VPC Endpoint 를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
subnet_id
required
stringSubnet ID-
resource_type
required
stringVPC Endpoint 자원 타입-
resource_key
required
stringVPC Endpoint Resource Key-
resource_info
required
stringVPC Endpoint Resource Key 정보-
name
required
stringVPC Endpoint 명-
endpoint_ip_address
required
stringVPC Endpoint IP 주소-
description
optional
string설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
endpoint_ip_addressVPC Endpoint IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint 명
resource_infoVPC Endpoint Resource Key 정보
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint 자원 타입
stateVPC Endpoint 상태
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.17.2 - 1.0

scpcli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]

Description

VPC Endpoint 를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
subnet_id
required
stringSubnet ID-
resource_type
required
stringVPC Endpoint 자원 타입-
resource_key
required
stringVPC Endpoint Resource Key-
resource_info
required
stringVPC Endpoint Resource Key 정보-
name
required
stringVPC Endpoint 명-
endpoint_ip_address
required
stringVPC Endpoint IP 주소-
description
optional
string설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
endpoint_ip_addressVPC Endpoint IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint 명
resource_infoVPC Endpoint Resource Key 정보
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint 자원 타입
stateVPC Endpoint 상태
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.18 - Create VPC Peering

5.8.1.18.1 - 1.1

scpcli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]

Description

VPC Peering 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
string요청 VPC ID-
name
required
stringVPC Peering 명-
approver_vpc_id
required
string승인 VPC ID-
approver_vpc_account_id
required
string승인 VPC 과제 ID-
description
optional
string설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID
account_type과제 유형
approver_vpc_account_id승인 VPC 과제 ID
approver_vpc_id승인 VPC ID
approver_vpc_name승인 VPC 명
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id요청 VPC 과제 ID
descriptionVPC Peering 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering 명
requester_vpc_account_id요청 VPC 과제 ID
requester_vpc_id요청 VPC ID
requester_vpc_name요청 VPC 명
state상태

5.8.1.18.2 - 1.0

scpcli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]

Description

VPC Peering 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
string요청 VPC ID-
name
required
stringVPC Peering 명-
approver_vpc_id
required
string승인 VPC ID-
approver_vpc_account_id
required
string승인 VPC 과제 ID-
description
optional
string설명-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID
account_type과제 유형
approver_vpc_account_id승인 VPC 과제 ID
approver_vpc_id승인 VPC ID
approver_vpc_name승인 VPC 명
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id요청 VPC 과제 ID
descriptionVPC Peering 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering 명
requester_vpc_account_id요청 VPC 과제 ID
requester_vpc_id요청 VPC ID
requester_vpc_name요청 VPC 명
state상태

5.8.1.19 - Create Vpc Peering Rule

5.8.1.19.1 - 1.1

scpcli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]

Description

VPC Peering 규칙 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
destination_vpc_type
required
string목적지 VPC 유형-
destination_cidr
required
string목적지 CIDR-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering 규칙 ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
destination_cidr목적지 CIDR
destination_vpc_id목적지 VPC ID
destination_vpc_name목적지 VPC 명
destination_vpc_type목적지 VPC 유형
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_id출발지 VPC ID
source_vpc_name출발지 VPC 명
source_vpc_type출발지 VPC 유형
state상태
vpc_peering_idVPC Peering ID

5.8.1.19.2 - 1.0

scpcli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]

Description

VPC Peering 규칙 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
destination_vpc_type
required
string목적지 VPC 유형-
destination_cidr
required
string목적지 CIDR-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering 규칙 ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
destination_cidr목적지 CIDR
destination_vpc_id목적지 VPC ID
destination_vpc_name목적지 VPC 명
destination_vpc_type목적지 VPC 유형
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_id출발지 VPC ID
source_vpc_name출발지 VPC 명
source_vpc_type출발지 VPC 유형
state상태
vpc_peering_idVPC Peering ID

5.8.1.20 - Delete Internet Gateway

5.8.1.20.1 - 1.1

scpcli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Internet Gateway를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-

5.8.1.20.2 - 1.0

scpcli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Internet Gateway를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-

5.8.1.21 - Delete NAT Gateway

5.8.1.21.1 - 1.1

scpcli vpc nat-gateway delete
--nat_gateway_id <value>

Description

NAT Gateway를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway 명-

5.8.1.21.2 - 1.0

scpcli vpc nat-gateway delete
--nat_gateway_id <value>

Description

NAT Gateway를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway 명-

5.8.1.22 - Delete Port

5.8.1.22.1 - 1.1

scpcli vpc port delete
--port_id <value>

Description

Port를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-

5.8.1.22.2 - 1.0

scpcli vpc port delete
--port_id <value>

Description

Port를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-

5.8.1.23 - Delete Private NAT

5.8.1.23.1 - 1.1

scpcli vpc private-nat delete
--private_nat_id <value>

Description

Private NAT 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-

5.8.1.23.2 - 1.0

scpcli vpc private-nat delete
--private_nat_id <value>

Description

Private NAT 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-

5.8.1.24 - Delete Private NAT IP

5.8.1.24.1 - 1.1

scpcli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Private NAT IP 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
private_nat_ip_id
required
stringPrivate NAT IP ID-
private_nat_id
required
stringPrivate NAT ID-

5.8.1.24.2 - 1.0

scpcli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Private NAT IP 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_ip_id
required
stringPrivate NAT IP ID-
private_nat_id
required
stringPrivate NAT ID-

5.8.1.25 - Delete PrivateLink Endpoint

5.8.1.25.1 - 1.1

scpcli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>

Description

PrivateLink Endpoint 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-

5.8.1.26 - Delete PrivateLink Service

5.8.1.26.1 - 1.1

scpcli vpc privatelink-service delete
--privatelink_service_id <value>

Description

PrivateLink Service 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID-

5.8.1.27 - Delete PublicIP

5.8.1.27.1 - 1.1

scpcli vpc public-ip delete
--publicip_id <value>

Description

PublicIP를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-

5.8.1.27.2 - 1.0

scpcli vpc public-ip delete
--publicip_id <value>

Description

PublicIP를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-

5.8.1.28 - Delete Subnet

5.8.1.28.1 - 1.1

scpcli vpc subnet delete
--subnet_id <value>

Description

Subnet을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

5.8.1.28.2 - 1.0

scpcli vpc subnet delete
--subnet_id <value>

Description

Subnet을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

5.8.1.29 - Delete Transit Gateway

5.8.1.29.1 - 1.1

scpcli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Transit Gateway 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-

5.8.1.29.2 - 1.0

scpcli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Transit Gateway 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-

5.8.1.30 - Delete Transit Gateway Rule

5.8.1.30.1 - 1.1

scpcli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Transit Gateway 규칙 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
transit_gateway_id
required
stringTransit Gateway ID-

5.8.1.30.2 - 1.0

scpcli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Transit Gateway 규칙 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
transit_gateway_id
required
stringTransit Gateway ID-

5.8.1.31 - Delete Transit Gateway VPC Connection

5.8.1.31.1 - 1.1

scpcli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Transit Gateway VPC 연결 삭제.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC 연결 ID-
transit_gateway_id
required
stringTransit Gateway ID-

5.8.1.31.2 - 1.0

scpcli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Transit Gateway VPC 연결 삭제.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC 연결 ID-
transit_gateway_id
required
stringTransit Gateway ID-

5.8.1.32 - Delete VPC

5.8.1.32.1 - 1.1

scpcli vpc vpc delete
--vpc_id <value>

Description

VPC를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-

5.8.1.32.2 - 1.0

scpcli vpc vpc delete
--vpc_id <value>

Description

VPC를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-

5.8.1.33 - Delete VPC Endpoint

5.8.1.33.1 - 1.1

scpcli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

VPC Endpoint 를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-

5.8.1.33.2 - 1.0

scpcli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

VPC Endpoint 를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-

5.8.1.34 - Delete VPC Peering

5.8.1.34.1 - 1.1

scpcli vpc vpc-peering delete
--vpc_peering_id <value>

Description

VPC Peering 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-

5.8.1.34.2 - 1.0

scpcli vpc vpc-peering delete
--vpc_peering_id <value>

Description

VPC Peering 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-

5.8.1.35 - Delete VPC Peering Rule

5.8.1.35.1 - 1.1

scpcli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

VPC Peering 규칙 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
vpc_peering_id
required
stringVPC Peering ID-

5.8.1.35.2 - 1.0

scpcli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

VPC Peering 규칙 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
vpc_peering_id
required
stringVPC Peering ID-

5.8.1.36 - List Connected PrivateLink Endpoints

5.8.1.36.1 - 1.1

scpcli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

연결된 PrivateLink Endpoint 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
privatelink_service_idPrivateLink Service ID
statePrivateLink Endpoint 상태

5.8.1.37 - List Internet Gateways

5.8.1.37.1 - 1.1

scpcli vpc internet-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Internet Gateway 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID-
name
optional
stringInternet Gateway 명-
type
optional
****Internet Gateway 유형-
state
optional
string상태-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
firewall_idFirewall ID
loggableNAT 로그 저장 여부
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway 명
state상태
typeInternet Gateway 유형
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.37.2 - 1.0

scpcli vpc internet-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Internet Gateway 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID-
name
optional
stringInternet Gateway 명-
type
optional
****Internet Gateway 유형-
state
optional
string상태-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
firewall_idFirewall ID
loggableNAT 로그 저장 여부
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway 명
state상태
typeInternet Gateway 유형
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.38 - List NAT Gateways

5.8.1.38.1 - 1.1

scpcli vpc nat-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]

Description

NAT Gateway 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway 명-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-
subnet_id
optional
stringSubnet ID-
subnet_name
optional
stringSubnet 명-
nat_gateway_ip_address
optional
stringNAT Gateway IP 주소-
state
optional
****NAT Gateway 상태-

Responses

NameDescriptionExample
idNAT Gateway 명
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway 명
nat_gateway_ip_addressNAT Gateway IP 주소
publicip_idPublicIP ID
stateNAT Gateway 상태
subnet_cidrSubnet Cidr
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.38.2 - 1.0

scpcli vpc nat-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]

Description

NAT Gateway 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway 명-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-
subnet_id
optional
stringSubnet ID-
subnet_name
optional
stringSubnet 명-
nat_gateway_ip_address
optional
stringNAT Gateway IP 주소-
state
optional
****NAT Gateway 상태-

Responses

NameDescriptionExample
idNAT Gateway 명
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway 명
nat_gateway_ip_addressNAT Gateway IP 주소
publicip_idPublicIP ID
stateNAT Gateway 상태
subnet_cidrSubnet Cidr
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.39 - List Ports

5.8.1.39.1 - 1.1

scpcli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]

Description

Port 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort 제한-
marker
optional
stringPort 마커-
sort
optional
stringPort 정렬-
name
optional
stringPort 명-
subnet_id
optional
stringSubnet ID-
subnet_name
optional
stringSubnet 명-
id
optional
stringPort ID-
attached_resource_id
optional
string연결된 자원 ID-
fixed_ip_address
optional
string고정된 IP-
mac_address
optional
stringMAC 주소-
state
optional
string상태-
security_groups
optional
stringSecurity Group 목록-

Responses

NameDescriptionExample
idPort ID
account_idAccount ID
attached_resource_id연결된 자원 ID
attached_resource_type연결된 자원 유형
created_at생성일시
description설명
fixed_ip_address고정된 IP
mac_addressMAC 주소
modified_at수정일시
namePort 명
state상태
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.39.2 - 1.0

scpcli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]

Description

Port 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort 제한-
marker
optional
stringPort 마커-
sort
optional
stringPort 정렬-
name
optional
stringPort 명-
subnet_id
optional
stringSubnet ID-
subnet_name
optional
stringSubnet 명-
id
optional
stringPort ID-
attached_resource_id
optional
string연결된 자원 ID-
fixed_ip_address
optional
string고정된 IP-
mac_address
optional
stringMAC 주소-
state
optional
string상태-
security_groups
optional
stringSecurity Group 목록-

Responses

NameDescriptionExample
idPort ID
account_idAccount ID
attached_resource_id연결된 자원 ID
attached_resource_type연결된 자원 유형
created_at생성일시
description설명
fixed_ip_address고정된 IP
mac_addressMAC 주소
modified_at수정일시
namePort 명
state상태
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.40 - List Private NAT

5.8.1.40.1 - 1.1

scpcli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--direct_connect_id <value>]
[--direct_connect_name <value>]
[--state <value>]

Description

Private NAT 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT 명-
cidr
optional
stringPrivate NAT IP 대역-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-
direct_connect_id
optional
stringDirect Connect ID-
direct_connect_name
optional
stringDirect Connect명-
state
optional
****Private NAT 상태-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP 대역
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT 명
statePrivate NAT 상태
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.40.2 - 1.0

scpcli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--direct_connect_id <value>]
[--direct_connect_name <value>]
[--state <value>]

Description

Private NAT 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT 명-
cidr
optional
stringPrivate NAT IP 대역-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-
direct_connect_id
optional
stringDirect Connect ID-
direct_connect_name
optional
stringDirect Connect명-
state
optional
****Private NAT 상태-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP 대역
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT 명
statePrivate NAT 상태
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.41 - List Private NAT IP

5.8.1.41.1 - 1.1

scpcli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]

Description

Private NAT IP 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringPrivate NAT IP 주소-
state
optional
****Private NAT IP 상태-
attached_resource_type
optional
****Private NAT IP 연결된 자원 타입-
attached_resource_id
optional
stringPrivate NAT IP 연결된 자원 ID-
attached_resource_name
optional
stringPrivate NAT IP 연결된 자원명-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP 연결된 자원 ID
attached_resource_namePrivate NAT IP 연결된 자원명
attached_resource_typePrivate NAT IP 연결된 자원 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP 상태

5.8.1.41.2 - 1.0

scpcli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]

Description

Private NAT IP 목록

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringPrivate NAT IP 주소-
state
optional
****Private NAT IP 상태-
attached_resource_type
optional
****Private NAT IP 연결된 자원 타입-
attached_resource_id
optional
stringPrivate NAT IP 연결된 자원 ID-
attached_resource_name
optional
stringPrivate NAT IP 연결된 자원명-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP 연결된 자원 ID
attached_resource_namePrivate NAT IP 연결된 자원명
attached_resource_typePrivate NAT IP 연결된 자원 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP 상태

5.8.1.42 - List PrivateLink Endpoint

5.8.1.42.1 - 1.1

scpcli vpc privatelink-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--privatelink_service_id <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

PrivateLink Endpoint 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Endpoint ID-
name
optional
stringPrivateLink Endpoint 명-
vpc_id
optional
stringVPC ID-
subnet_id
optional
stringSubnet ID-
privatelink_service_id
optional
stringPrivateLink Service ID-
endpoint_ip_address
optional
stringEndpoint IP 주소-
state
optional
****PrivateLink Endpoint 상태-

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
account_idAccount ID
approval_typePrivateLink Service 승인 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
endpoint_ip_addressEndpoint IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint 명
privatelink_service_idPrivateLink Service ID
statePrivateLink Endpoint 상태
subnet_idSubnet ID
vpc_idVPC ID

5.8.1.43 - List PrivateLink Service

5.8.1.43.1 - 1.1

scpcli vpc privatelink-service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--service_ip_address <value>]
[--connected_resource_id <value>]
[--connected_resource_type <value>]
[--connected_resource_name <value>]
[--connected_resource_ip_address <value>]
[--state <value>]

Description

PrivateLink Service 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Service ID-
name
optional
stringPrivateLink Service 명-
vpc_id
optional
stringVPC ID-
subnet_id
optional
stringSubnet ID-
service_ip_address
optional
stringService IP 주소-
connected_resource_id
optional
string연결된 자원 ID-
connected_resource_type
optional
string연결된 자원 Type-
connected_resource_name
optional
string연결된 자원명-
connected_resource_ip_address
optional
string연결된 자원 IP 주소-
state
optional
****PrivateLink Service 상태-

Responses

NameDescriptionExample
idPrivateLink Service ID
account_idAccount ID
approval_typePrivateLink Service 승인 타입
connected_resource_id연결된 자원 ID
connected_resource_ip_address연결된 자원 IP 주소
connected_resource_name연결된 자원명
connected_resource_type연결된 자원 Type
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service 명
service_ip_addressService IP 주소
statePrivateLink Service 상태
subnet_idSubnet ID
vpc_idVPC ID

5.8.1.44 - List PublicIPs

5.8.1.44.1 - 1.1

scpcli vpc public-ip list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]

Description

PublicIP 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP 주소-
state
optional
stringPublicIP 상태-
attached_resource_type
optional
stringPublicIP 연결된 자원 타입-
attached_resource_id
optional
stringPublicIP 연결된 자원 ID-
attached_resource_name
optional
stringPublicIP 연결된 자원명-
vpc_id
optional
stringVPC ID-
type
optional
****PublicIP 타입-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP 연결된 자원 ID
attached_resource_namePublicIP 연결된 자원명
attached_resource_typePublicIP 연결된 자원 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP 상세 설명
ip_addressIP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP 상태
typePublicIP 타입

5.8.1.44.2 - 1.0

scpcli vpc public-ip list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]

Description

PublicIP 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP 주소-
state
optional
stringPublicIP 상태-
attached_resource_type
optional
stringPublicIP 연결된 자원 타입-
attached_resource_id
optional
stringPublicIP 연결된 자원 ID-
attached_resource_name
optional
stringPublicIP 연결된 자원명-
vpc_id
optional
stringVPC ID-
type
optional
****PublicIP 타입-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP 연결된 자원 ID
attached_resource_namePublicIP 연결된 자원명
attached_resource_typePublicIP 연결된 자원 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP 상세 설명
ip_addressIP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP 상태
typePublicIP 타입

5.8.1.45 - List Subnets

5.8.1.45.1 - 1.1

scpcli vpc subnet list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Subnet 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet ID023c57b14f11483689338d085e061492
name
optional
stringSubnet 명subnetName
type
optional
****Subnet 유형-
state
optional
****상태-
vpc_id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC 명vpcName

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrSubnet Cidr192.167.1.0/24
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP192.167.1.1
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet 명subnetName
state상태
typeSubnet 유형
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC 명vpcName

5.8.1.45.2 - 1.0

scpcli vpc subnet list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Subnet 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet ID023c57b14f11483689338d085e061492
name
optional
stringSubnet 명subnetName
type
optional
****Subnet 유형-
state
optional
****상태-
vpc_id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC 명vpcName

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrSubnet Cidr192.167.1.0/24
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP192.167.1.1
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet 명subnetName
state상태
typeSubnet 유형
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC 명vpcName

5.8.1.46 - List Transit Gateway Rules

5.8.1.46.1 - 1.1

scpcli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Transit Gateway 규칙 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID-
tgw_connection_vpc_id
optional
stringTransit Gateway에 연결된 VPC ID.-
tgw_connection_vpc_name
optional
stringTransit Gateway에 연결된 VPC명.-
source_type
optional
****출발지 타입-
destination_type
optional
****목적지 타입-
destination_cidr
optional
string목적지 CIDR-
state
optional
****상태-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
destination_cidr목적지 CIDR
destination_resource_id목적지 자원 ID
destination_resource_name목적지 자원명
destination_type목적지 타입
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
source_resource_id출발지 자원 ID
source_resource_name출발지 자원명
source_type출발지 타입
state상태
tgw_connection_vpc_idTransit Gateway에 연결된 VPC ID.
tgw_connection_vpc_nameTransit Gateway에 연결된 VPC명.

5.8.1.46.2 - 1.0

scpcli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Transit Gateway 규칙 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID-
tgw_connection_vpc_id
optional
stringTransit Gateway에 연결된 VPC ID.-
tgw_connection_vpc_name
optional
stringTransit Gateway에 연결된 VPC명.-
source_type
optional
****출발지 타입-
destination_type
optional
****목적지 타입-
destination_cidr
optional
string목적지 CIDR-
state
optional
****상태-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
destination_cidr목적지 CIDR
destination_resource_id목적지 자원 ID
destination_resource_name목적지 자원명
destination_type목적지 타입
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
source_resource_id출발지 자원 ID
source_resource_name출발지 자원명
source_type출발지 타입
state상태
tgw_connection_vpc_idTransit Gateway에 연결된 VPC ID.
tgw_connection_vpc_nameTransit Gateway에 연결된 VPC명.

5.8.1.47 - List Transit Gateway VPC Connections

5.8.1.47.1 - 1.1

scpcli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]

Description

Transit Gateway VPC 연결 목록 조회.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC 연결 ID-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-
state
optional
****상태-

Responses

NameDescriptionExample
idTransit Gateway VPC 연결 ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
state상태
transit_gateway_idTransit Gateway ID
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.47.2 - 1.0

scpcli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]

Description

Transit Gateway VPC 연결 목록 조회.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC 연결 ID-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-
state
optional
****상태-

Responses

NameDescriptionExample
idTransit Gateway VPC 연결 ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
state상태
transit_gateway_idTransit Gateway ID
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.48 - List Transit Gateways

5.8.1.48.1 - 1.1

scpcli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]

Description

Transit Gateway 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway ID-
name
optional
stringTransit Gateway 명-
state
optional
****상태-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway 포트 용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway 상세 설명
firewall_idsFirewall ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway 명
state상태
uplink_enabledUplink 사용

5.8.1.48.2 - 1.0

scpcli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]

Description

Transit Gateway 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway ID-
name
optional
stringTransit Gateway 명-
state
optional
****상태-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway 포트 용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway 상세 설명
firewall_idsFirewall ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway 명
state상태
uplink_enabledUplink 사용

5.8.1.49 - List VPC Endpoint

5.8.1.49.1 - 1.1

scpcli vpc vpc-endpoint list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

VPC Endpoint 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID-
name
optional
stringVPC Endpoint 명-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-
subnet_id
optional
stringSubnet ID-
resource_key
optional
stringVPC Endpoint Resource Key-
resource_type
optional
****VPC Endpoint 자원 타입-
endpoint_ip_address
optional
stringVPC Endpoint IP 주소-
state
optional
****VPC Endpoint 상태-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
endpoint_ip_addressVPC Endpoint IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint 명
resource_infoVPC Endpoint Resource Key 정보
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint 자원 타입
stateVPC Endpoint 상태
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.49.2 - 1.0

scpcli vpc vpc-endpoint list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

VPC Endpoint 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID-
name
optional
stringVPC Endpoint 명-
vpc_id
optional
stringVPC ID-
vpc_name
optional
stringVPC 명-
subnet_id
optional
stringSubnet ID-
resource_key
optional
stringVPC Endpoint Resource Key-
resource_type
optional
****VPC Endpoint 자원 타입-
endpoint_ip_address
optional
stringVPC Endpoint IP 주소-
state
optional
****VPC Endpoint 상태-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
endpoint_ip_addressVPC Endpoint IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint 명
resource_infoVPC Endpoint Resource Key 정보
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint 자원 타입
stateVPC Endpoint 상태
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.50 - List VPC Endpoint Connectable Resources

5.8.1.50.1 - 1.1

scpcli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]

Description

List VpcEndpoint connectable resources

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint 자원 타입-
vpc_id
optional
stringVPC ID(resource_type이 DNS인 경우, 필수 입력값입니다)-

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key 정보
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint 자원 타입

5.8.1.50.2 - 1.0

scpcli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]

Description

List VpcEndpoint connectable resources

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint 자원 타입-
vpc_id
optional
stringVPC ID(resource_type이 DNS인 경우, 필수 입력값입니다)-

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key 정보
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint 자원 타입

5.8.1.51 - List VPC Peering

5.8.1.51.1 - 1.1

scpcli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]

Description

VPC Peering 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID-
name
optional
stringVPC Peering 명-
requester_vpc_id
optional
string요청 VPC ID-
requester_vpc_name
optional
string요청 VPC 명-
approver_vpc_id
optional
string승인 VPC ID-
approver_vpc_name
optional
string승인 VPC 명-
account_type
optional
****과제 유형-
state
optional
****상태-

Responses

NameDescriptionExample
idVPC Peering ID
account_type과제 유형
approver_vpc_account_id승인 VPC 과제 ID
approver_vpc_id승인 VPC ID
approver_vpc_name승인 VPC 명
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id요청 VPC 과제 ID
descriptionVPC Peering 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering 명
requester_vpc_account_id요청 VPC 과제 ID
requester_vpc_id요청 VPC ID
requester_vpc_name요청 VPC 명
state상태

5.8.1.51.2 - 1.0

scpcli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]

Description

VPC Peering 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID-
name
optional
stringVPC Peering 명-
requester_vpc_id
optional
string요청 VPC ID-
requester_vpc_name
optional
string요청 VPC 명-
approver_vpc_id
optional
string승인 VPC ID-
approver_vpc_name
optional
string승인 VPC 명-
account_type
optional
****과제 유형-
state
optional
****상태-

Responses

NameDescriptionExample
idVPC Peering ID
account_type과제 유형
approver_vpc_account_id승인 VPC 과제 ID
approver_vpc_id승인 VPC ID
approver_vpc_name승인 VPC 명
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id요청 VPC 과제 ID
descriptionVPC Peering 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering 명
requester_vpc_account_id요청 VPC 과제 ID
requester_vpc_id요청 VPC ID
requester_vpc_name요청 VPC 명
state상태

5.8.1.52 - List VPC Peering Rules

5.8.1.52.1 - 1.1

scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

VPC Peering 규칙 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering 규칙 ID-
name
optional
stringVPC Peering 명-
source_vpc_id
optional
string출발지 VPC ID-
source_vpc_type
optional
****출발지 VPC 유형-
destination_vpc_id
optional
string목적지 VPC ID-
destination_vpc_type
optional
****목적지 VPC 유형-
destination_cidr
optional
string목적지 CIDR-
state
optional
****상태-

Responses

NameDescriptionExample
idVPC Peering 규칙 ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
destination_cidr목적지 CIDR
destination_vpc_id목적지 VPC ID
destination_vpc_name목적지 VPC 명
destination_vpc_type목적지 VPC 유형
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_id출발지 VPC ID
source_vpc_name출발지 VPC 명
source_vpc_type출발지 VPC 유형
state상태
vpc_peering_idVPC Peering ID

5.8.1.52.2 - 1.0

scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

VPC Peering 규칙 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering 규칙 ID-
name
optional
stringVPC Peering 명-
source_vpc_id
optional
string출발지 VPC ID-
source_vpc_type
optional
****출발지 VPC 유형-
destination_vpc_id
optional
string목적지 VPC ID-
destination_vpc_type
optional
****목적지 VPC 유형-
destination_cidr
optional
string목적지 CIDR-
state
optional
****상태-

Responses

NameDescriptionExample
idVPC Peering 규칙 ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
destination_cidr목적지 CIDR
destination_vpc_id목적지 VPC ID
destination_vpc_name목적지 VPC 명
destination_vpc_type목적지 VPC 유형
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_id출발지 VPC ID
source_vpc_name출발지 VPC 명
source_vpc_type출발지 VPC 유형
state상태
vpc_peering_idVPC Peering ID

5.8.1.53 - List VPCs

5.8.1.53.1 - 1.1

scpcli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]

Description

VPC 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC 명vpcName
state
optional
****상태-
cidr
optional
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC ID7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명vpcDescription
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC 명vpcName
state상태

5.8.1.53.2 - 1.0

scpcli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]

Description

VPC 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC 명vpcName
state
optional
****상태-
cidr
optional
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC ID7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명vpcDescription
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC 명vpcName
state상태

5.8.1.54 - Request PrivateLink Endpoint

5.8.1.54.1 - 1.1

scpcli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

Request PrivateLink Endpoint

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-
type
required
stringPrivateLink Endpoint Action Type-

5.8.1.55 - Set Internet Gateway

5.8.1.55.1 - 1.1

scpcli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Internet Gateway를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-
description
optional
string설명-
loggable
optional
booleanNAT 로그 저장 여부-

5.8.1.55.2 - 1.0

scpcli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Internet Gateway를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-
description
optional
string설명-
loggable
optional
booleanNAT 로그 저장 여부-

5.8.1.56 - Set NAT Gateway

5.8.1.56.1 - 1.1

scpcli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

NAT Gateway를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway 명-
description
optional
stringNAT Gateway 상세설명-

5.8.1.56.2 - 1.0

scpcli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

NAT Gateway를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway 명-
description
optional
stringNAT Gateway 상세설명-

5.8.1.57 - Set Port

5.8.1.57.1 - 1.1

scpcli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Port를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-
description
optional
string설명-
security_groups
optional
arraySecurity Group 목록-

5.8.1.57.2 - 1.0

scpcli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Port를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-
description
optional
string설명-
security_groups
optional
arraySecurity Group 목록-

5.8.1.58 - Set Private NAT

5.8.1.58.1 - 1.1

scpcli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Private NAT 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
description
optional
string설명-

5.8.1.58.2 - 1.0

scpcli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Private NAT 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
description
optional
string설명-

5.8.1.59 - Set PrivateLink Endpoint

5.8.1.59.1 - 1.1

scpcli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

PrivateLink Endpoint 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-
description
optional
string설명-

5.8.1.60 - Set PrivateLink Service

5.8.1.60.1 - 1.1

scpcli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]

Description

PrivateLink Service 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID-
description
optional
string설명-

5.8.1.61 - Set PublicIP

5.8.1.61.1 - 1.1

scpcli vpc public-ip set
--publicip_id <value>
--description <value>

Description

PublicIP를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-
description
required
stringPublicIP 상세 설명-

5.8.1.61.2 - 1.0

scpcli vpc public-ip set
--publicip_id <value>
--description <value>

Description

PublicIP를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-
description
required
stringPublicIP 상세 설명-

5.8.1.62 - Set Subnet

5.8.1.62.1 - 1.1

scpcli vpc subnet set
--subnet_id <value>
--description <value>

Description

Subnet을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
description
required
string설명Subnet Description

5.8.1.62.2 - 1.0

scpcli vpc subnet set
--subnet_id <value>
--description <value>

Description

Subnet을 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
description
required
string설명Subnet Description

5.8.1.63 - Set Transit Gateway

5.8.1.63.1 - 1.1

scpcli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Transit Gateway 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
description
optional
string설명-

5.8.1.63.2 - 1.0

scpcli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Transit Gateway 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
description
optional
string설명-

5.8.1.64 - Set VPC

5.8.1.64.1 - 1.1

scpcli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

VPC를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
description
optional
string설명vpcDescription

5.8.1.64.2 - 1.0

scpcli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

VPC를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
description
optional
string설명vpcDescription

5.8.1.65 - Set VPC Endpoint

5.8.1.65.1 - 1.1

scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

VPC Endpoint 를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-
description
optional
string설명-

5.8.1.65.2 - 1.0

scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

VPC Endpoint 를 수정한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-
description
optional
string설명-

5.8.1.66 - Set VPC Peering

5.8.1.66.1 - 1.1

scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

VPC Peering 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
description
optional
string설명-

5.8.1.66.2 - 1.0

scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

VPC Peering 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
description
optional
string설명-

5.8.1.67 - Show Internet Gateway

5.8.1.67.1 - 1.1

scpcli vpc internet-gateway show
--internet_gateway_id <value>

Description

Internet Gateway를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
firewall_idFirewall ID
loggableNAT 로그 저장 여부
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway 명
state상태
typeInternet Gateway 유형
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.67.2 - 1.0

scpcli vpc internet-gateway show
--internet_gateway_id <value>

Description

Internet Gateway를 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
firewall_idFirewall ID
loggableNAT 로그 저장 여부
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway 명
state상태
typeInternet Gateway 유형
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.68 - Show NAT Gateway

5.8.1.68.1 - 1.1

scpcli vpc nat-gateway show
--nat_gateway_id <value>

Description

NAT Gateway를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway 명-

Responses

NameDescriptionExample
idNAT Gateway 명
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway 명
nat_gateway_ip_addressNAT Gateway IP 주소
publicip_idPublicIP ID
stateNAT Gateway 상태
subnet_cidrSubnet Cidr
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.68.2 - 1.0

scpcli vpc nat-gateway show
--nat_gateway_id <value>

Description

NAT Gateway를 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway 명-

Responses

NameDescriptionExample
idNAT Gateway 명
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway 명
nat_gateway_ip_addressNAT Gateway IP 주소
publicip_idPublicIP ID
stateNAT Gateway 상태
subnet_cidrSubnet Cidr
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.69 - Show Port

5.8.1.69.1 - 1.1

scpcli vpc port show
--port_id <value>

Description

Port를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-

Responses

NameDescriptionExample
port

5.8.1.69.2 - 1.0

scpcli vpc port show
--port_id <value>

Description

Port를 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-

Responses

NameDescriptionExample
port

5.8.1.70 - Show Private NAT

5.8.1.70.1 - 1.1

scpcli vpc private-nat show
--private_nat_id <value>

Description

Private NAT 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP 대역
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT 명
statePrivate NAT 상태
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.70.2 - 1.0

scpcli vpc private-nat show
--private_nat_id <value>

Description

Private NAT 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP 대역
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT 명
statePrivate NAT 상태
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.71 - Show PrivateLink Endpoint

5.8.1.71.1 - 1.1

scpcli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>

Description

PrivateLink Endpoint 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
account_idAccount ID
approval_typePrivateLink Service 승인 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
endpoint_ip_addressEndpoint IP 주소
endpoint_ip_port_idEndpoint IP Port ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint 명
privatelink_service_idPrivateLink Service ID
security_group_idsSecurity Group 목록
statePrivateLink Endpoint 상태
subnet_idSubnet ID
vpc_idVPC ID

5.8.1.72 - Show PrivateLink Service

5.8.1.72.1 - 1.1

scpcli vpc privatelink-service show
--privatelink_service_id <value>

Description

PrivateLink Service 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID-

Responses

NameDescriptionExample
idPrivateLink Service ID
account_idAccount ID
approval_typePrivateLink Service 승인 타입
connected_resource_id연결된 자원 ID
connected_resource_ip_address연결된 자원 IP 주소
connected_resource_name연결된 자원명
connected_resource_type연결된 자원 Type
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
high_speed_transfer고속 데이터 전송 사용
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service 명
security_group_idsSecurity Group 목록
service_ip_addressService IP 주소
service_ip_port_idService IP Port ID
statePrivateLink Service 상태
subnet_idSubnet ID
vpc_idVPC ID

5.8.1.73 - Show PublicIP

5.8.1.73.1 - 1.1

scpcli vpc public-ip show
--publicip_id <value>

Description

PublicIP를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP 연결된 자원 ID
attached_resource_namePublicIP 연결된 자원명
attached_resource_typePublicIP 연결된 자원 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP 상세 설명
ip_addressIP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP 상태
typePublicIP 타입

5.8.1.73.2 - 1.0

scpcli vpc public-ip show
--publicip_id <value>

Description

PublicIP를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP 연결된 자원 ID
attached_resource_namePublicIP 연결된 자원명
attached_resource_typePublicIP 연결된 자원 타입
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP 상세 설명
ip_addressIP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP 상태
typePublicIP 타입

5.8.1.74 - Show Subnet

5.8.1.74.1 - 1.1

scpcli vpc subnet show
--subnet_id <value>

Description

Subnet을 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsIP 할당 범위
cidrSubnet Cidr192.167.1.0/24
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Subnet Description
dns_nameserversDNS Name Server
gateway_ip_addressGateway IP192.167.1.1
host_routes호스트 경로
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet 명subnetName
state상태
typeSubnet 유형
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC 명vpcName

5.8.1.74.2 - 1.0

scpcli vpc subnet show
--subnet_id <value>

Description

Subnet을 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsIP 할당 범위
cidrSubnet Cidr192.167.1.0/24
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Subnet Description
dns_nameserversDNS Name Server
gateway_ip_addressGateway IP192.167.1.1
host_routes호스트 경로
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet 명subnetName
state상태
typeSubnet 유형
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC 명vpcName

5.8.1.75 - Show Transit Gateway

5.8.1.75.1 - 1.1

scpcli vpc transit-gateway show
--transit_gateway_id <value>

Description

Transit Gateway 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway 포트 용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway 상세 설명
firewall_idsFirewall ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway 명
state상태
uplink_enabledUplink 사용

5.8.1.75.2 - 1.0

scpcli vpc transit-gateway show
--transit_gateway_id <value>

Description

Transit Gateway 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway 포트 용량
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway 상세 설명
firewall_idsFirewall ID
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway 명
state상태
uplink_enabledUplink 사용

5.8.1.76 - Show VPC

5.8.1.76.1 - 1.1

scpcli vpc vpc show
--vpc_id <value>

Description

VPC를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-

Responses

NameDescriptionExample
idVPC ID7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명vpcDescription
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC 명vpcName
state상태

5.8.1.76.2 - 1.0

scpcli vpc vpc show
--vpc_id <value>

Description

VPC를 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-

Responses

NameDescriptionExample
idVPC ID7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명vpcDescription
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC 명vpcName
state상태

5.8.1.77 - Show VPC Endpoint

5.8.1.77.1 - 1.1

scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

VPC Endpoint 를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
endpoint_ip_addressVPC Endpoint IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint 명
resource_infoVPC Endpoint Resource Key 정보
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint 자원 타입
stateVPC Endpoint 상태
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.77.2 - 1.0

scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

VPC Endpoint 를 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명
endpoint_ip_addressVPC Endpoint IP 주소
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint 명
resource_infoVPC Endpoint Resource Key 정보
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint 자원 타입
stateVPC Endpoint 상태
subnet_idSubnet ID
subnet_nameSubnet 명
vpc_idVPC ID
vpc_nameVPC 명

5.8.1.78 - Show VPC Peering

5.8.1.78.1 - 1.1

scpcli vpc vpc-peering show
--vpc_peering_id <value>

Description

VPC Peering 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-

Responses

NameDescriptionExample
idVPC Peering ID
account_type과제 유형
approver_vpc_account_id승인 VPC 과제 ID
approver_vpc_id승인 VPC ID
approver_vpc_name승인 VPC 명
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id요청 VPC 과제 ID
descriptionVPC Peering 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering 명
requester_vpc_account_id요청 VPC 과제 ID
requester_vpc_id요청 VPC ID
requester_vpc_name요청 VPC 명
state상태

5.8.1.78.2 - 1.0

scpcli vpc vpc-peering show
--vpc_peering_id <value>

Description

VPC Peering 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-

Responses

NameDescriptionExample
idVPC Peering ID
account_type과제 유형
approver_vpc_account_id승인 VPC 과제 ID
approver_vpc_id승인 VPC ID
approver_vpc_name승인 VPC 명
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id요청 VPC 과제 ID
descriptionVPC Peering 상세설명
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering 명
requester_vpc_account_id요청 VPC 과제 ID
requester_vpc_id요청 VPC ID
requester_vpc_name요청 VPC 명
state상태

5.9 - VPN

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 VPN 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

5.9.1 - CLIs

5.9.1.1 - Create VPN Gateway

5.9.1.1.1 - 1.1

scpcli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]

Description

VPN gateway 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC IDceb44ea5ecb34a49b16495f9a63b0718
name
required
stringVPN Gateway NameExampleVpnGW1
ip_type
required
stringVPN Gateway IP 타입PUBLIC
ip_id
required
stringVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_address
required
stringVPN Gateway IP 주소123.0.0.1
description
optional
string설명Example Description for VPN Gateway
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Gateway
ip_addressVPN Gateway IP 주소123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP 타입PUBLIC
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
state상태ACTIVE
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1

5.9.1.1.2 - 1.0

scpcli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]

Description

VPN gateway 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC IDceb44ea5ecb34a49b16495f9a63b0718
name
required
stringVPN Gateway NameExampleVpnGW1
ip_type
required
stringVPN Gateway IP 타입PUBLIC
ip_id
required
stringVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_address
required
stringVPN Gateway IP 주소123.0.0.1
description
optional
string설명Example Description for VPN Gateway
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Gateway
ip_addressVPN Gateway IP 주소123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP 타입PUBLIC
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
state상태ACTIVE
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1

5.9.1.2 - Create VPN Tunnel

5.9.1.2.1 - 1.1

scpcli vpn vpn-tunnel create
--remote_subnets <value>
--phase2_life_time <value>
--phase2_encryptions <value>
--phase2_diffie_hellman_groups <value>
--perfect_forward_secrecy <value>
--pre_shared_key <value>
--phase1_life_time <value>
--phase1_encryptions <value>
--phase1_diffie_hellman_groups <value>
--peer_gateway_ip <value>
--ike_version <value>
--dpd_retry_interval <value>
--vpn_gateway_id <value>
--name <value>
[--description <value>]
[--tags <value>]

Description

VPN tunnel 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
remote_subnets
required
arrayVPN Tunnel IPSec Remote Subnet10.1.1.0/24
phase2_life_time
required
integerVPN Tunnel IPSec Lifetime (sec)43200
phase2_encryptions
required
arrayVPN Tunnel ISAKMP Proposal 목록null-md5
phase2_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group 목록30
perfect_forward_secrecy
required
stringVPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
pre_shared_key
required
stringVPN Tunnel ISAKMP 인증 : Pre-shared KeyPreSharedKey1
phase1_life_time
required
integerVPN Tunnel ISAKMP Lifetime (sec)86400
phase1_encryptions
required
arrayVPN Tunnel ISAKMP Proposal 목록des-md5
phase1_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group 목록30
peer_gateway_ip
required
stringVPN Tunnel Peer Gateway IP 주소123.0.0.2
ike_version
required
integerVPN Tunnel IKE 버전2
dpd_retry_interval
required
integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
name
required
stringVPN Tunnel 이름ExampleVpnTunnel1
description
optional
string설명Example Description for VPN Tunnel
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Tunnel
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel 이름ExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
state상태ACTIVE
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP 주소123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

5.9.1.2.2 - 1.0

scpcli vpn vpn-tunnel create
--remote_subnet <value>
--phase2_life_time <value>
--phase2_encryptions <value>
--phase2_diffie_hellman_groups <value>
--perfect_forward_secrecy <value>
--pre_shared_key <value>
--phase1_life_time <value>
--phase1_encryptions <value>
--phase1_diffie_hellman_groups <value>
--peer_gateway_ip <value>
--ike_version <value>
--dpd_retry_interval <value>
--vpn_gateway_id <value>
--name <value>
[--description <value>]
[--tags <value>]

Description

VPN tunnel 생성

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
remote_subnet
required
stringVPN Tunnel IPSec Remote Subnet10.1.0.0/16
phase2_life_time
required
integerVPN Tunnel IPSec Lifetime (sec)43200
phase2_encryptions
required
arrayVPN Tunnel ISAKMP Proposal 목록null-md5
phase2_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group 목록30
perfect_forward_secrecy
required
stringVPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
pre_shared_key
required
stringVPN Tunnel ISAKMP 인증 : Pre-shared KeyPreSharedKey1
phase1_life_time
required
integerVPN Tunnel ISAKMP Lifetime (sec)86400
phase1_encryptions
required
arrayVPN Tunnel ISAKMP Proposal 목록des-md5
phase1_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group 목록30
peer_gateway_ip
required
stringVPN Tunnel Peer Gateway IP 주소123.0.0.2
ike_version
required
integerVPN Tunnel IKE 버전2
dpd_retry_interval
required
integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
name
required
stringVPN Tunnel 이름ExampleVpnTunnel1
description
optional
string설명Example Description for VPN Tunnel
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Tunnel
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel 이름ExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
state상태ACTIVE
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP 주소123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

5.9.1.3 - Delete VPN Gateway

5.9.1.3.1 - 1.1

scpcli vpn vpn-gateway delete
--vpn_gateway_id <value>

Description

VPN gateway 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

5.9.1.3.2 - 1.0

scpcli vpn vpn-gateway delete
--vpn_gateway_id <value>

Description

VPN gateway 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

5.9.1.4 - Delete VPN Tunnel

5.9.1.4.1 - 1.1

scpcli vpn vpn-tunnel delete
--vpn_tunnel_id <value>

Description

VPN tunnel 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

5.9.1.4.2 - 1.0

scpcli vpn vpn-tunnel delete
--vpn_tunnel_id <value>

Description

VPN tunnel 삭제

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

5.9.1.5 - List VPN Gateways

5.9.1.5.1 - 1.1

scpcli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

VPN gateway 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringVPN Gateway NameExampleVpnGW1
ip_address
optional
stringVPN Gateway IP 주소123.0.0.1
vpc_id
optional
stringVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_name
optional
stringVPC 명ExampleVPC1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Gateway
ip_addressVPN Gateway IP 주소123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP 타입PUBLIC
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
state상태ACTIVE
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1

5.9.1.5.2 - 1.0

scpcli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

VPN gateway 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringVPN Gateway NameExampleVpnGW1
ip_address
optional
stringVPN Gateway IP 주소123.0.0.1
vpc_id
optional
stringVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_name
optional
stringVPC 명ExampleVPC1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Gateway
ip_addressVPN Gateway IP 주소123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP 타입PUBLIC
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
state상태ACTIVE
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1

5.9.1.6 - List VPN Tunnels

5.9.1.6.1 - 1.1

scpcli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]

Description

VPN tunnel 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringVPN Tunnel 이름ExampleVpnTunnel1
vpn_gateway_id
optional
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_name
optional
stringVPN Gateway NameExampleVpnGW1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Tunnel
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel 이름ExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
state상태ACTIVE
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP 주소123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

5.9.1.6.2 - 1.0

scpcli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]
[--peer_gateway_ip <value>]
[--remote_subnet <value>]

Description

VPN tunnel 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringVPN Tunnel 이름ExampleVpnTunnel1
vpn_gateway_id
optional
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_name
optional
stringVPN Gateway NameExampleVpnGW1
peer_gateway_ip
optional
stringVPN Tunnel Peer Gateway IP 주소123.0.0.2
remote_subnet
optional
stringVPN Tunnel IPSec Remote Subnet10.1.0.0/16

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Tunnel
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel 이름ExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
state상태ACTIVE
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP 주소123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

5.9.1.7 - Set VPN Gateway

5.9.1.7.1 - 1.1

scpcli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]

Description

VPN gateway 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
description
optional
string설명Example Description for VPN Gateway

5.9.1.7.2 - 1.0

scpcli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]

Description

VPN gateway 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
description
optional
string설명Example Description for VPN Gateway

5.9.1.8 - Set VPN Tunnel

5.9.1.8.1 - 1.1

scpcli vpn vpn-tunnel set
--vpn_tunnel_id <value>
[--description <value>]
[--dpd_retry_interval <value>]
[--ike_version <value>]
[--peer_gateway_ip <value>]
[--phase1_diffie_hellman_groups <value>]
[--phase1_encryptions <value>]
[--phase1_life_time <value>]
[--pre_shared_key <value>]
[--perfect_forward_secrecy <value>]
[--phase2_diffie_hellman_groups <value>]
[--phase2_encryptions <value>]
[--phase2_life_time <value>]
[--remote_subnets <value>]

Description

VPN tunnel 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1
description
optional
string설명Example Description for VPN Tunnel
dpd_retry_interval
optional
integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
ike_version
optional
integerVPN Tunnel IKE 버전2
peer_gateway_ip
optional
stringVPN Tunnel Peer Gateway IP 주소123.0.0.2
phase1_diffie_hellman_groups
optional
arrayVPN Tunnel ISAKMP Diffie-Hellman Group 목록30
phase1_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal 목록des-md5
phase1_life_time
optional
integerVPN Tunnel ISAKMP Lifetime (sec)86400
pre_shared_key
optional
stringVPN Tunnel ISAKMP 인증 : Pre-shared KeyPreSharedKey1
perfect_forward_secrecy
optional
****VPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
phase2_diffie_hellman_groups
optional
arrayVPN Tunnel ISAKMP Diffie-Hellman Group 목록30
phase2_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal 목록null-md5
phase2_life_time
optional
integerVPN Tunnel IPSec Lifetime (sec)43200
remote_subnets
optional
arrayVPN Tunnel IPSec Remote Subnet10.1.1.0/24

5.9.1.8.2 - 1.0

scpcli vpn vpn-tunnel set
--vpn_tunnel_id <value>
[--description <value>]
[--dpd_retry_interval <value>]
[--ike_version <value>]
[--peer_gateway_ip <value>]
[--phase1_diffie_hellman_groups <value>]
[--phase1_encryptions <value>]
[--phase1_life_time <value>]
[--pre_shared_key <value>]
[--perfect_forward_secrecy <value>]
[--phase2_diffie_hellman_groups <value>]
[--phase2_encryptions <value>]
[--phase2_life_time <value>]
[--remote_subnet <value>]

Description

VPN tunnel 수정

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1
description
optional
string설명Example Description for VPN Tunnel
dpd_retry_interval
optional
integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
ike_version
optional
integerVPN Tunnel IKE 버전2
peer_gateway_ip
optional
stringVPN Tunnel Peer Gateway IP 주소123.0.0.2
phase1_diffie_hellman_groups
optional
arrayVPN Tunnel ISAKMP Diffie-Hellman Group 목록30
phase1_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal 목록des-md5
phase1_life_time
optional
integerVPN Tunnel ISAKMP Lifetime (sec)86400
pre_shared_key
optional
stringVPN Tunnel ISAKMP 인증 : Pre-shared KeyPreSharedKey1
perfect_forward_secrecy
optional
****VPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
phase2_diffie_hellman_groups
optional
arrayVPN Tunnel ISAKMP Diffie-Hellman Group 목록30
phase2_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal 목록null-md5
phase2_life_time
optional
integerVPN Tunnel IPSec Lifetime (sec)43200
remote_subnet
optional
stringVPN Tunnel IPSec Remote Subnet10.1.0.0/16

5.9.1.9 - Show VPN Gateway

5.9.1.9.1 - 1.1

scpcli vpn vpn-gateway show
--vpn_gateway_id <value>

Description

VPN gateway 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Gateway
ip_addressVPN Gateway IP 주소123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP 타입PUBLIC
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
state상태ACTIVE
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1

5.9.1.9.2 - 1.0

scpcli vpn vpn-gateway show
--vpn_gateway_id <value>

Description

VPN gateway 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Gateway
ip_addressVPN Gateway IP 주소123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP 타입PUBLIC
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
state상태ACTIVE
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1

5.9.1.10 - Show VPN Tunnel

5.9.1.10.1 - 1.1

scpcli vpn vpn-tunnel show
--vpn_tunnel_id <value>

Description

VPN tunnel 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Tunnel
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel 이름ExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
state상태ACTIVE
statusVPN Tunnel 상태UP
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP 주소123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

5.9.1.10.2 - 1.0

scpcli vpn vpn-tunnel show
--vpn_tunnel_id <value>

Description

VPN tunnel 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description설명Example Description for VPN Tunnel
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel 이름ExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
state상태ACTIVE
statusVPN Tunnel 상태UP
vpc_idVPC IDceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC 명ExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP 주소123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

6 - Database

6.1 - CacheStore(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 CacheStore(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

6.1.1 - CLIs

6.1.1.1 - Create Cluster

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance 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
stringDBaaS engine version ID-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
replica_count
optional
integerReplica count-
tags
optional
arraytag'{"key": "", "value": ""}'
database_port
optional
integerDatabase service port-
sentinel_port
optional
integerSentinel port-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.2 - Create Restore Cluster

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
server_type_name
required
stringServer type name-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
backup_history_number
optional
stringBackup id-
backup_recovery_time
optional
stringBackup Recovery Time-
block_storage_groups
optional
arrayBlock storage groups list'{"role_type": "", "size_gb": 104, "volume_type": "SSD"}'
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.3 - List Backup Histories

6.1.1.3.1 - 1.0

scpcli cachestore backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

6.1.1.4 - List Clusters

6.1.1.4.1 - 1.0

scpcli cachestore cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

6.1.1.5 - List Commands

6.1.1.5.1 - 1.0

scpcli cachestore command list
--cluster_id <value>

Description

List Commands.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
id
applied_value
description
modifiable
name

6.1.1.6 - List Engine Version Properties

6.1.1.6.1 - 1.0

scpcli cachestore engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

6.1.1.7 - List Engine Versions

6.1.1.7.1 - 1.0

scpcli cachestore engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

6.1.1.8 - List Parameter Groups

6.1.1.8.1 - 1.0

scpcli cachestore parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

6.1.1.9 - List Parameter Values

6.1.1.9.1 - 1.0

scpcli cachestore parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

6.1.1.10 - List Parameters

6.1.1.10.1 - 1.0

scpcli cachestore parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

6.1.1.11 - List Server Types

6.1.1.11.1 - 1.0

scpcli cachestore engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

6.1.1.12 - Remove Backup Histories

6.1.1.12.1 - 1.0

scpcli cachestore backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

6.1.1.13 - Restart Cluster

6.1.1.13.1 - 1.0

scpcli cachestore cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.14 - Set Backup

6.1.1.14.1 - 1.0

scpcli cachestore backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.15 - Set Block Storage Size

6.1.1.15.1 - 1.0

scpcli cachestore block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.16 - Set Maintenance

6.1.1.16.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.17 - Set Parameter Values

6.1.1.17.1 - 1.0

scpcli cachestore parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

6.1.1.18 - Set Security Group Rules

6.1.1.18.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.19 - Set Server Type

6.1.1.19.1 - 1.0

scpcli cachestore server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.20 - Show Cluster

6.1.1.20.1 - 1.0

scpcli cachestore cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
backup_optionBackup setting option
database_port
sentinel_port

6.1.1.21 - Show Request

6.1.1.21.1 - 1.0

scpcli cachestore request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

6.1.1.22 - Start Cluster

6.1.1.22.1 - 1.0

scpcli cachestore cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.23 - Stop Cluster

6.1.1.23.1 - 1.0

scpcli cachestore cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.24 - Switchover Cluster

6.1.1.24.1 - 1.0

scpcli cachestore cluster switchover
--cluster_id <value>
--switch_host_name <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
switch_host_name
required
stringSwitch over target-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.25 - Synchronize Cluster State

6.1.1.25.1 - 1.0

scpcli cachestore cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.26 - Synchronize Commands

6.1.1.26.1 - 1.0

scpcli cachestore command sync
--cluster_id <value>

Description

Synchronize Commands.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.27 - Synchronize Parameter Values

6.1.1.27.1 - 1.0

scpcli cachestore parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.1.1.28 - Terminate Cluster

6.1.1.28.1 - 1.0

scpcli cachestore cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.1.29 - Unset Backup

6.1.1.29.1 - 1.0

scpcli cachestore backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.1.1.30 - Unset Maintenance

6.1.1.30.1 - 1.0

scpcli cachestore maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

6.1.1.31 - Update Commands

6.1.1.31.1 - 1.0

scpcli cachestore command set
--cluster_id <value>
--commands <value>

Description

Update Commands.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
commands
required
arrayApply command information'{"id": "", "name": "", "new_value": ""}'

6.2 - EPAS(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 EPAS(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

6.2.1 - CLIs

6.2.1.1 - Add Block Storages

6.2.1.1.1 - 1.0

scpcli epas block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.2 - Create Cluster

6.2.1.2.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance 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
stringDBaaS engine version ID-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
origin_cluster_id
optional
stringOrigin cluster ID-
tags
optional
arraytag'{"key": "", "value": ""}'
vip_public_ip_id
optional
string(VIP) Public IP ID-
virtual_ip_address
optional
stringVirtual IP address-
audit_enabled
optional
booleanAudit usage state-
database_encoding
optional
stringDatabase encoding-
database_locale
optional
stringDatabase locale information-
database_port
optional
integerDatabase service port-
archive_frequency_minute
optional
stringBackup starting time (minute)-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.3 - Create Replica

6.2.1.3.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas 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
integerReplica count-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.4 - Create Restore Cluster

6.2.1.4.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
server_type_name
required
stringServer type name-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
backup_history_number
optional
stringBackup id-
backup_recovery_time
optional
stringBackup Recovery Time-
block_storage_groups
optional
arrayBlock storage groups list'{"role_type": "", "size_gb": 104, "volume_type": "SSD"}'
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.5 - Delete Archive Log

6.2.1.5.1 - 1.0

scpcli epas archive log delete
--cluster_id <value>
[--type <value>]

Description

Delete Archive Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
stringArchive log typeALL

6.2.1.6 - Export Log

6.2.1.6.1 - 1.0

scpcli epas log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.7 - List Backup Histories

6.2.1.7.1 - 1.0

scpcli epas backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

6.2.1.8 - List Clusters

6.2.1.8.1 - 1.0

scpcli epas cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-
database_name
optional
stringDatabase Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

6.2.1.9 - List Engine Version Properties

6.2.1.9.1 - 1.0

scpcli epas engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

6.2.1.10 - List Engine Versions

6.2.1.10.1 - 1.0

scpcli epas engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

6.2.1.11 - List Log Export Configs

6.2.1.11.1 - 1.0

scpcli epas log export configs list
--cluster_id <value>
[--type <value>]

Description

List Log Export Configs.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
****Log typealert

Responses

NameDescriptionExample
bucket_nameBucket nameexamplebucket
delete_on_exportDelete on exportTrue
is_bucket_deletedBucket deletedFalse
is_registeredLog type registration stateTrue
log_labelLog labelDB Alert Log
log_typeLog typealert
schedule_day_of_monthSchedule day of month28
schedule_day_of_weekSchedule day of weekMON
schedule_frequency_typeSchedule frequency typeDAY
schedule_hourSchedule hour12

6.2.1.12 - List Parameter Groups

6.2.1.12.1 - 1.0

scpcli epas parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

6.2.1.13 - List Parameter Values

6.2.1.13.1 - 1.0

scpcli epas parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

6.2.1.14 - List Parameters

6.2.1.14.1 - 1.0

scpcli epas parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

6.2.1.15 - List Replicas

6.2.1.15.1 - 1.0

scpcli epas replica list
--cluster_id <value>

Description

List Replicas.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
nameServer name
regionReplica region
replica_stateReplica state
replica_state_detailReplica detail state
synced_atReplica check time

6.2.1.16 - List Server Types

6.2.1.16.1 - 1.0

scpcli epas engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

6.2.1.17 - Patch Minor Version

6.2.1.17.1 - 1.0

scpcli epas minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
software_version
required
stringsoftware_version-
backup_before_upgrade
required
booleanbackup_before_upgrade-

6.2.1.18 - Promote Replica Cluster

6.2.1.18.1 - 1.0

scpcli epas replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.19 - Register Log Export Config

6.2.1.19.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
log_type
required
stringLog typealert
delete_on_export
required
booleanDelete on exportTrue
bucket_name
required
stringBucket nameexamplebucket
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.20 - Remove Backup Histories

6.2.1.20.1 - 1.0

scpcli epas backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

6.2.1.21 - Reset Replica

6.2.1.21.1 - 1.0

scpcli epas replica reset
--replica_cluster_id <value>

Description

Reset Replica.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.22 - Restart Cluster

6.2.1.22.1 - 1.0

scpcli epas cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.23 - Set Archive Config

6.2.1.23.1 - 1.0

scpcli epas archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]

Description

Set Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
archive_enabled
required
booleanArchive enabledTrue
retention_period_day
optional
integerBackup retention period (day)-

6.2.1.24 - Set Audit Log

6.2.1.24.1 - 1.0

scpcli epas audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

6.2.1.25 - Set Backup

6.2.1.25.1 - 1.0

scpcli epas backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.26 - Set Block Storage Size

6.2.1.26.1 - 1.0

scpcli epas block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.27 - Set Log Export Config

6.2.1.27.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

6.2.1.28 - Set Maintenance

6.2.1.28.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.29 - Set Parameter Values

6.2.1.29.1 - 1.0

scpcli epas parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

6.2.1.30 - Set Security Group Rules

6.2.1.30.1 - 1.0

scpcli epas security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.31 - Set Server Type

6.2.1.31.1 - 1.0

scpcli epas server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.32 - Show Archive Config

6.2.1.32.1 - 1.0

scpcli epas archive config show
--cluster_id <value>

Description

Show Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

6.2.1.33 - Show Cluster

6.2.1.33.1 - 1.0

scpcli epas cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID
block_storage_groupsBlock storage groups list
instancesInstances list
role_typeRole type
server_type_nameServer type name

6.2.1.34 - Show Request

6.2.1.34.1 - 1.0

scpcli epas request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

6.2.1.35 - Start Cluster

6.2.1.35.1 - 1.0

scpcli epas cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.36 - Stop Cluster

6.2.1.36.1 - 1.0

scpcli epas cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.37 - Switchover Cluster

6.2.1.37.1 - 1.0

scpcli epas cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.38 - Synchronize Archive Config

6.2.1.38.1 - 1.0

scpcli epas archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.39 - Synchronize Cluster State

6.2.1.39.1 - 1.0

scpcli epas cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.40 - Synchronize Parameter Values

6.2.1.40.1 - 1.0

scpcli epas parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.41 - Synchronize Replica State

6.2.1.41.1 - 1.0

scpcli epas replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.2.1.42 - Terminate Cluster

6.2.1.42.1 - 1.0

scpcli epas cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.2.1.43 - Unregister Log Export Config

6.2.1.43.1 - 1.0

scpcli epas log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.2.1.44 - Unset Backup

6.2.1.44.1 - 1.0

scpcli epas backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.2.1.45 - Unset Maintenance

6.2.1.45.1 - 1.0

scpcli epas maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

6.3 - MariaDB(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 MariaDB(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

6.3.1 - CLIs

6.3.1.1 - Add Block Storages

6.3.1.1.1 - 1.0

scpcli mariadb block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.2 - Create Cluster

6.3.1.2.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance 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
stringDBaaS engine version ID-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
origin_cluster_id
optional
stringOrigin cluster ID-
tags
optional
arraytag'{"key": "", "value": ""}'
vip_public_ip_id
optional
string(VIP) Public IP ID-
virtual_ip_address
optional
stringVirtual IP address-
audit_enabled
optional
booleanAudit usage state-
database_character_set
optional
stringDatabase encoding-
database_port
optional
integerDatabase service port-
archive_frequency_minute
optional
stringBackup starting time (minute)-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.3 - Create Replica

6.3.1.3.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas 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
integerReplica count-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.4 - Create Restore Cluster

6.3.1.4.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
server_type_name
required
stringServer type name-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
backup_history_number
optional
stringBackup id-
backup_recovery_time
optional
stringBackup Recovery Time-
block_storage_groups
optional
arrayBlock storage groups list'{"role_type": "", "size_gb": 104, "volume_type": "SSD"}'
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.5 - Export Log

6.3.1.5.1 - 1.0

scpcli mariadb log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.6 - List Backup Histories

6.3.1.6.1 - 1.0

scpcli mariadb backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

6.3.1.7 - List Clusters

6.3.1.7.1 - 1.0

scpcli mariadb cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-
database_name
optional
stringDatabase Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

6.3.1.8 - List Engine Version Properties

6.3.1.8.1 - 1.0

scpcli mariadb engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

6.3.1.9 - List Engine Versions

6.3.1.9.1 - 1.0

scpcli mariadb engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

6.3.1.10 - List Log Export Configs

6.3.1.10.1 - 1.0

scpcli mariadb log export configs list
--cluster_id <value>
[--type <value>]

Description

List Log Export Configs.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
****Log typealert

Responses

NameDescriptionExample
bucket_nameBucket nameexamplebucket
delete_on_exportDelete on exportTrue
is_bucket_deletedBucket deletedFalse
is_registeredLog type registration stateTrue
log_labelLog labelDB Alert Log
log_typeLog typealert
schedule_day_of_monthSchedule day of month28
schedule_day_of_weekSchedule day of weekMON
schedule_frequency_typeSchedule frequency typeDAY
schedule_hourSchedule hour12

6.3.1.11 - List Parameter Groups

6.3.1.11.1 - 1.0

scpcli mariadb parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

6.3.1.12 - List Parameter Values

6.3.1.12.1 - 1.0

scpcli mariadb parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

6.3.1.13 - List Parameters

6.3.1.13.1 - 1.0

scpcli mariadb parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

6.3.1.14 - List Replicas

6.3.1.14.1 - 1.0

scpcli mariadb replica list
--cluster_id <value>

Description

List Replicas.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
nameServer name
regionReplica region
replica_stateReplica state
replica_state_detailReplica detail state
synced_atReplica check time

6.3.1.15 - List Server Types

6.3.1.15.1 - 1.0

scpcli mariadb engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

6.3.1.16 - Patch Minor Version

6.3.1.16.1 - 1.0

scpcli mariadb minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
software_version
required
stringsoftware_version-
backup_before_upgrade
required
booleanbackup_before_upgrade-

6.3.1.17 - Promote Replica Cluster

6.3.1.17.1 - 1.0

scpcli mariadb replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.18 - Register Log Export Config

6.3.1.18.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
log_type
required
stringLog typealert
delete_on_export
required
booleanDelete on exportTrue
bucket_name
required
stringBucket nameexamplebucket
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.19 - Remove Backup Histories

6.3.1.19.1 - 1.0

scpcli mariadb backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

6.3.1.20 - Reset Replica

6.3.1.20.1 - 1.0

scpcli mariadb replica reset
--replica_cluster_id <value>

Description

Reset Replica.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.21 - Restart Cluster

6.3.1.21.1 - 1.0

scpcli mariadb cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.22 - Set Archive Config

6.3.1.22.1 - 1.0

scpcli mariadb archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]

Description

Set Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
archive_enabled
required
booleanArchive enabledTrue
retention_period_day
optional
integerBackup retention period (day)-

6.3.1.23 - Set Audit Log

6.3.1.23.1 - 1.0

scpcli mariadb audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

6.3.1.24 - Set Backup

6.3.1.24.1 - 1.0

scpcli mariadb backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.25 - Set Block Storage Size

6.3.1.25.1 - 1.0

scpcli mariadb block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.26 - Set Log Export Config

6.3.1.26.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

6.3.1.27 - Set Maintenance

6.3.1.27.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.28 - Set Parameter Values

6.3.1.28.1 - 1.0

scpcli mariadb parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

6.3.1.29 - Set Security Group Rules

6.3.1.29.1 - 1.0

scpcli mariadb security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.30 - Set Server Type

6.3.1.30.1 - 1.0

scpcli mariadb server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.31 - Show Archive Config

6.3.1.31.1 - 1.0

scpcli mariadb archive config show
--cluster_id <value>

Description

Show Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

6.3.1.32 - Show Cluster

6.3.1.32.1 - 1.0

scpcli mariadb cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
audit_enabledAudit usage state
backup_optionBackup setting option
database_character_setDatabase encoding
database_nameDatabase Name
database_portDatabase service port
database_user_nameDatabase User Name
origin_regionOrigin Region

6.3.1.33 - Show Request

6.3.1.33.1 - 1.0

scpcli mariadb request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

6.3.1.34 - Start Cluster

6.3.1.34.1 - 1.0

scpcli mariadb cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.35 - Stop Cluster

6.3.1.35.1 - 1.0

scpcli mariadb cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.36 - Switchover Cluster

6.3.1.36.1 - 1.0

scpcli mariadb cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.37 - Synchronize Archive Config

6.3.1.37.1 - 1.0

scpcli mariadb archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.38 - Synchronize Cluster State

6.3.1.38.1 - 1.0

scpcli mariadb cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.39 - Synchronize Parameter Values

6.3.1.39.1 - 1.0

scpcli mariadb parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.40 - Synchronize Replica State

6.3.1.40.1 - 1.0

scpcli mariadb replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.3.1.41 - Terminate Cluster

6.3.1.41.1 - 1.0

scpcli mariadb cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.3.1.42 - Unregister Log Export Config

6.3.1.42.1 - 1.0

scpcli mariadb log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.3.1.43 - Unset Backup

6.3.1.43.1 - 1.0

scpcli mariadb backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.3.1.44 - Unset Maintenance

6.3.1.44.1 - 1.0

scpcli mariadb maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

6.4 - Microsoft SQL Server(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Microsoft SQL Server(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

6.4.1 - CLIs

6.4.1.1 - Add Block Storages

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.2 - Add Secondary

6.4.1.2.1 - 1.0

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

Description

Add Secondary.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
name
required
stringSecondary Name-
license
required
stringlicense-
service_ip_address
optional
stringUser subnet IP address-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.3 - Add/Remove Databases

6.4.1.3.1 - 1.0

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

Description

Add/Remove Databases.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
add_databases
optional
arrayDatabases'{"database_name": "", "drive_letter": "E"}'
del_databases
optional
arrayDatabases'{"database_name": "", "drive_letter": "E"}'

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.4 - Create Cluster

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
archive_frequency_minute
required
stringBackup starting time (minute)-
license
required
stringlicense-
databases
required
arrayDatabases'{"database_name": "", "drive_letter": "E"}'
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_service_name
required
stringDatabase Service Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance 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
stringDBaaS engine version ID-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
tags
optional
arraytag'{"key": "", "value": ""}'
vip_public_ip_id
optional
string(VIP) Public IP ID-
virtual_ip_address
optional
stringVirtual IP address-
audit_enabled
optional
booleanAudit usage state-
database_collation
optional
string-
database_name
optional
****-
database_port
optional
integerDatabase service port-
full_backup_day_of_week
optional
stringFull backup day of week-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.5 - Create Restore Cluster

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
server_type_name
required
stringServer type name-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
backup_history_number
optional
stringBackup id-
backup_recovery_time
optional
stringBackup Recovery Time-
block_storage_groups
optional
arrayBlock storage groups list'{"role_type": "", "size_gb": 104, "volume_type": "SSD"}'
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.6 - Export Log

6.4.1.6.1 - 1.0

scpcli sqlserver log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.7 - List Backup Histories

6.4.1.7.1 - 1.0

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

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

6.4.1.8 - List Clusters

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-
database_name
optional
stringDatabase Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

6.4.1.9 - List Engine Version Properties

6.4.1.9.1 - 1.0

scpcli sqlserver engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

6.4.1.10 - List Engine Versions

6.4.1.10.1 - 1.0

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

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

6.4.1.11 - List Log Export Configs

6.4.1.11.1 - 1.0

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

Description

List Log Export Configs.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
****Log typealert

Responses

NameDescriptionExample
bucket_nameBucket nameexamplebucket
delete_on_exportDelete on exportTrue
is_bucket_deletedBucket deletedFalse
is_registeredLog type registration stateTrue
log_labelLog labelDB Alert Log
log_typeLog typealert
schedule_day_of_monthSchedule day of month28
schedule_day_of_weekSchedule day of weekMON
schedule_frequency_typeSchedule frequency typeDAY
schedule_hourSchedule hour12

6.4.1.12 - List Parameter Groups

6.4.1.12.1 - 1.0

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

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

6.4.1.13 - List Parameter Values

6.4.1.13.1 - 1.0

scpcli sqlserver parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

6.4.1.14 - List Parameters

6.4.1.14.1 - 1.0

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

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

6.4.1.15 - List Server Types

6.4.1.15.1 - 1.0

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

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

6.4.1.16 - Patch Minor Version

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
software_version
required
stringsoftware_version-
backup_before_upgrade
required
booleanbackup_before_upgrade-

6.4.1.17 - Register Log Export Config

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
log_type
required
stringLog typealert
delete_on_export
required
booleanDelete on exportTrue
bucket_name
required
stringBucket nameexamplebucket
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.18 - Remove Backup Histories

6.4.1.18.1 - 1.0

scpcli sqlserver backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
backup_history_number
required
arrayBackup id-

6.4.1.19 - Restart Cluster

6.4.1.19.1 - 1.0

scpcli sqlserver cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.20 - Set Audit Log

6.4.1.20.1 - 1.0

scpcli sqlserver audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
use_audit_log
required
booleanuse_audit_log-

6.4.1.21 - Set Backup

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
archive_frequency_minute
required
stringBackup starting time (minute)-
full_backup_day_of_week
optional
stringFull backup day of week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.22 - Set Block Storage Size

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.23 - Set Log Export Config

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

6.4.1.24 - Set Maintenance

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.25 - Set Parameter Values

6.4.1.25.1 - 1.0

scpcli sqlserver parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

6.4.1.26 - Set Security Group Rules

6.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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.27 - Set Server Type

6.4.1.27.1 - 1.0

scpcli sqlserver server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.28 - Show Cluster

6.4.1.28.1 - 1.0

scpcli sqlserver cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
audit_enabledAudit usage state
backup_optionBackup setting option
database_collation
database_portDatabase service port
database_service_nameDatabase Service Name
database_user_nameDatabase User Name
databasesDatabases

6.4.1.29 - Show Request

6.4.1.29.1 - 1.0

scpcli sqlserver request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

6.4.1.30 - Start Cluster

6.4.1.30.1 - 1.0

scpcli sqlserver cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.31 - Stop Cluster

6.4.1.31.1 - 1.0

scpcli sqlserver cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.32 - Switchover Cluster

6.4.1.32.1 - 1.0

scpcli sqlserver cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.33 - Synchronize Cluster State

6.4.1.33.1 - 1.0

scpcli sqlserver cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.34 - Synchronize Parameter Values

6.4.1.34.1 - 1.0

scpcli sqlserver parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.4.1.35 - Terminate Cluster

6.4.1.35.1 - 1.0

scpcli sqlserver cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.4.1.36 - Unregister Log Export Config

6.4.1.36.1 - 1.0

scpcli sqlserver log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.4.1.37 - Unset Backup

6.4.1.37.1 - 1.0

scpcli sqlserver backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.4.1.38 - Unset Maintenance

6.4.1.38.1 - 1.0

scpcli sqlserver maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.5 - MySQL(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 MySQL(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

6.5.1 - CLIs

6.5.1.1 - Add Block Storages

6.5.1.1.1 - 1.0

scpcli mysql block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.2 - Create Cluster

6.5.1.2.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance 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
stringDBaaS engine version ID-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
origin_cluster_id
optional
stringOrigin cluster ID-
tags
optional
arraytag'{"key": "", "value": ""}'
vip_public_ip_id
optional
string(VIP) Public IP ID-
virtual_ip_address
optional
stringVirtual IP address-
audit_enabled
optional
****-
database_case_sensitive
optional
booleanDatabase case sensitivity-
database_character_set
optional
stringDatabase encoding-
database_port
optional
integerDatabase service port-
archive_frequency_minute
optional
stringBackup starting time (minute)-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.3 - Create Replica

6.5.1.3.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas 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
integerReplica count-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.4 - Create Restore Cluster

6.5.1.4.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
server_type_name
required
stringServer type name-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
backup_history_number
optional
stringBackup id-
backup_recovery_time
optional
stringBackup Recovery Time-
block_storage_groups
optional
arrayBlock storage groups list'{"role_type": "", "size_gb": 104, "volume_type": "SSD"}'
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.5 - Export Log

6.5.1.5.1 - 1.0

scpcli mysql log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.6 - List Backup Histories

6.5.1.6.1 - 1.0

scpcli mysql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

6.5.1.7 - List Clusters

6.5.1.7.1 - 1.0

scpcli mysql cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-
database_name
optional
stringDatabase Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

6.5.1.8 - List Engine Version Properties

6.5.1.8.1 - 1.0

scpcli mysql engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

6.5.1.9 - List Engine Versions

6.5.1.9.1 - 1.0

scpcli mysql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

6.5.1.10 - List Log Export Configs

6.5.1.10.1 - 1.0

scpcli mysql log export configs list
--cluster_id <value>
[--type <value>]

Description

List Log Export Configs.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
****Log typealert

Responses

NameDescriptionExample
bucket_nameBucket nameexamplebucket
delete_on_exportDelete on exportTrue
is_bucket_deletedBucket deletedFalse
is_registeredLog type registration stateTrue
log_labelLog labelDB Alert Log
log_typeLog typealert
schedule_day_of_monthSchedule day of month28
schedule_day_of_weekSchedule day of weekMON
schedule_frequency_typeSchedule frequency typeDAY
schedule_hourSchedule hour12

6.5.1.11 - List Parameter Groups

6.5.1.11.1 - 1.0

scpcli mysql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

6.5.1.12 - List Parameter Values

6.5.1.12.1 - 1.0

scpcli mysql parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

6.5.1.13 - List Parameters

6.5.1.13.1 - 1.0

scpcli mysql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

6.5.1.14 - List Replicas

6.5.1.14.1 - 1.0

scpcli mysql replica list
--cluster_id <value>

Description

List Replicas.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
nameServer name
regionReplica region
replica_stateReplica state
replica_state_detailReplica detail state
synced_atReplica check time

6.5.1.15 - List Server Types

6.5.1.15.1 - 1.0

scpcli mysql engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

6.5.1.16 - Patch Minor Version

6.5.1.16.1 - 1.0

scpcli mysql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
software_version
required
stringsoftware_version-
backup_before_upgrade
required
booleanbackup_before_upgrade-

6.5.1.17 - Promote Replica Cluster

6.5.1.17.1 - 1.0

scpcli mysql replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.18 - Register Log Export Config

6.5.1.18.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
log_type
required
stringLog typealert
delete_on_export
required
booleanDelete on exportTrue
bucket_name
required
stringBucket nameexamplebucket
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.19 - Remove Backup Histories

6.5.1.19.1 - 1.0

scpcli mysql backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

6.5.1.20 - Reset Replica

6.5.1.20.1 - 1.0

scpcli mysql replica reset
--replica_cluster_id <value>

Description

Reset Replica.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.21 - Restart Cluster

6.5.1.21.1 - 1.0

scpcli mysql cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.22 - Set Archive Config

6.5.1.22.1 - 1.0

scpcli mysql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]

Description

Set Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
archive_enabled
required
booleanArchive enabledTrue
retention_period_day
optional
integerBackup retention period (day)-

6.5.1.23 - Set Backup

6.5.1.23.1 - 1.0

scpcli mysql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.24 - Set Block Storage Size

6.5.1.24.1 - 1.0

scpcli mysql block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.25 - Set Log Export Config

6.5.1.25.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

6.5.1.26 - Set Maintenance

6.5.1.26.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.27 - Set Parameter Values

6.5.1.27.1 - 1.0

scpcli mysql parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

6.5.1.28 - Set Security Group Rules

6.5.1.28.1 - 1.0

scpcli mysql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.29 - Set Server Type

6.5.1.29.1 - 1.0

scpcli mysql server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.30 - Show Archive Config

6.5.1.30.1 - 1.0

scpcli mysql archive config show
--cluster_id <value>

Description

Show Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

6.5.1.31 - Show Cluster

6.5.1.31.1 - 1.0

scpcli mysql cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
backup_optionBackup setting option
database_character_setDatabase encoding
database_nameDatabase Name
database_portDatabase service port
database_user_nameDatabase User Name
origin_regionOrigin Region

6.5.1.32 - Show Request

6.5.1.32.1 - 1.0

scpcli mysql request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

6.5.1.33 - Start Cluster

6.5.1.33.1 - 1.0

scpcli mysql cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.34 - Stop Cluster

6.5.1.34.1 - 1.0

scpcli mysql cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.35 - Switchover Cluster

6.5.1.35.1 - 1.0

scpcli mysql cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.36 - Synchronize Archive Config

6.5.1.36.1 - 1.0

scpcli mysql archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.37 - Synchronize Cluster State

6.5.1.37.1 - 1.0

scpcli mysql cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.38 - Synchronize Parameter Values

6.5.1.38.1 - 1.0

scpcli mysql parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.39 - Synchronize Replica State

6.5.1.39.1 - 1.0

scpcli mysql replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.5.1.40 - Terminate Cluster

6.5.1.40.1 - 1.0

scpcli mysql cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.5.1.41 - Unregister Log Export Config

6.5.1.41.1 - 1.0

scpcli mysql log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.5.1.42 - Unset Backup

6.5.1.42.1 - 1.0

scpcli mysql backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.5.1.43 - Unset Maintenance

6.5.1.43.1 - 1.0

scpcli mysql maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

6.6 - PostgreSQL(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 PostgreSQL(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

6.6.1 - CLIs

6.6.1.1 - Add Block Storages

6.6.1.1.1 - 1.0

scpcli postgresql block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.2 - Create Cluster

6.6.1.2.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance 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
stringDBaaS engine version ID-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
ha_enabled
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
origin_cluster_id
optional
stringOrigin cluster ID-
tags
optional
arraytag'{"key": "", "value": ""}'
vip_public_ip_id
optional
string(VIP) Public IP ID-
virtual_ip_address
optional
stringVirtual IP address-
audit_enabled
optional
booleanAudit usage state-
database_encoding
optional
stringDatabase encoding-
database_locale
optional
stringDatabase locale information-
database_port
optional
integerDatabase service port-
archive_frequency_minute
optional
stringBackup starting time (minute)-
retention_period_day
optional
stringBackup retention period (day)7
starting_time_hour
optional
stringBackup starting time (hour)2
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.3 - Create Other region Replica

6.6.1.3.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
subnet_id
required
stringSubnet ID-
replicas
required
arrayReplicas 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
integerReplica count-
region
required
stringReplica region-
nat_enabled
required
booleanNAT availability-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.4 - Create Replica

6.6.1.4.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
replicas
required
arrayReplicas 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
integerReplica count-
allowable_ip_addresses
required
arrayAllowed IP addresses list-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.5 - Create Restore Cluster

6.6.1.5.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
server_type_name
required
stringServer type name-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
backup_history_number
optional
stringBackup id-
backup_recovery_time
optional
stringBackup Recovery Time-
block_storage_groups
optional
arrayBlock storage groups list'{"role_type": "", "size_gb": 104, "volume_type": "SSD"}'
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.6 - Delete Archive Log

6.6.1.6.1 - 1.0

scpcli postgresql archive log delete
--cluster_id <value>
[--type <value>]

Description

Delete Archive Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
stringArchive log typeALL

6.6.1.7 - Export Log

6.6.1.7.1 - 1.0

scpcli postgresql log export
--log_type <value>
--cluster_id <value>

Description

Export Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.8 - List Backup Histories

6.6.1.8.1 - 1.0

scpcli postgresql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

6.6.1.9 - List Clusters

6.6.1.9.1 - 1.0

scpcli postgresql cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-
database_name
optional
stringDatabase Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

6.6.1.10 - List Engine Version Properties

6.6.1.10.1 - 1.0

scpcli postgresql engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

6.6.1.11 - List Engine Versions

6.6.1.11.1 - 1.0

scpcli postgresql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

6.6.1.12 - List Log Export Configs

6.6.1.12.1 - 1.0

scpcli postgresql log export configs list
--cluster_id <value>
[--type <value>]

Description

List Log Export Configs.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
type
optional
****Log typealert

Responses

NameDescriptionExample
bucket_nameBucket nameexamplebucket
delete_on_exportDelete on exportTrue
is_bucket_deletedBucket deletedFalse
is_registeredLog type registration stateTrue
log_labelLog labelDB Alert Log
log_typeLog typealert
schedule_day_of_monthSchedule day of month28
schedule_day_of_weekSchedule day of weekMON
schedule_frequency_typeSchedule frequency typeDAY
schedule_hourSchedule hour12

6.6.1.13 - List Parameter Groups

6.6.1.13.1 - 1.0

scpcli postgresql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

6.6.1.14 - List Parameter Values

6.6.1.14.1 - 1.0

scpcli postgresql parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

6.6.1.15 - List Parameters

6.6.1.15.1 - 1.0

scpcli postgresql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

6.6.1.16 - List Replicas

6.6.1.16.1 - 1.0

scpcli postgresql replica list
--cluster_id <value>

Description

List Replicas.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
nameServer name
regionReplica region
replica_stateReplica state
replica_state_detailReplica detail state
synced_atReplica check time

6.6.1.17 - List Server Types

6.6.1.17.1 - 1.0

scpcli postgresql engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

6.6.1.18 - Patch Minor Version

6.6.1.18.1 - 1.0

scpcli postgresql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>

Description

Patch Minor Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
software_version
required
stringsoftware_version-
backup_before_upgrade
required
booleanbackup_before_upgrade-

6.6.1.19 - Promote Replica Cluster

6.6.1.19.1 - 1.0

scpcli postgresql replica cluster promote
--cluster_id <value>

Description

Promote Replica Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.20 - Register Log Export Config

6.6.1.20.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
log_type
required
stringLog typealert
delete_on_export
required
booleanDelete on exportTrue
bucket_name
required
stringBucket nameexamplebucket
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.21 - Remove Backup Histories

6.6.1.21.1 - 1.0

scpcli postgresql backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

6.6.1.22 - Reset Replica

6.6.1.22.1 - 1.0

scpcli postgresql replica reset
--replica_cluster_id <value>

Description

Reset Replica.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
replica_cluster_id
required
stringReplica cluster id-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.23 - Restart Cluster

6.6.1.23.1 - 1.0

scpcli postgresql cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.24 - Set Archive Config

6.6.1.24.1 - 1.0

scpcli postgresql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]

Description

Set Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
archive_enabled
required
booleanArchive enabledTrue
retention_period_day
optional
integerBackup retention period (day)-

6.6.1.25 - Set Audit Log

6.6.1.25.1 - 1.0

scpcli postgresql audit log set
--cluster_id <value>
--use_audit_log <value>

Description

Set Audit Log.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
use_audit_log
required
booleanuse_audit_log-

6.6.1.26 - Set Backup

6.6.1.26.1 - 1.0

scpcli postgresql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
archive_frequency_minute
required
stringBackup starting time (minute)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.27 - Set Block Storage Size

6.6.1.27.1 - 1.0

scpcli postgresql block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.28 - Set Log Export Config

6.6.1.28.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74
secret_key
required
stringSecret keysecretkey
schedule_hour
required
stringSchedule hour12
schedule_frequency_type
required
stringSchedule frequency typeDAY
schedule_day_of_week
required
****Schedule day of weekMON
schedule_day_of_month
required
stringSchedule day of month28
delete_on_export
required
booleanDelete on exportTrue
access_key
required
stringAccess key13952a8851244213f2de8d95069bf161

6.6.1.29 - Set Maintenance

6.6.1.29.1 - 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.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.30 - Set Parameter Values

6.6.1.30.1 - 1.0

scpcli postgresql parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

6.6.1.31 - Set Security Group Rules

6.6.1.31.1 - 1.0

scpcli postgresql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.32 - Set Server Type

6.6.1.32.1 - 1.0

scpcli postgresql server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.33 - Show Archive Config

6.6.1.33.1 - 1.0

scpcli postgresql archive config show
--cluster_id <value>

Description

Show Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
archive_enabledArchive enabledTrue
retention_period_dayBackup retention period (day)

6.6.1.34 - Show Cluster

6.6.1.34.1 - 1.0

scpcli postgresql cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID
block_storage_groupsBlock storage groups list
instancesInstances list
role_typeRole type
server_type_nameServer type name

6.6.1.35 - Show Request

6.6.1.35.1 - 1.0

scpcli postgresql request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

6.6.1.36 - Start Cluster

6.6.1.36.1 - 1.0

scpcli postgresql cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.37 - Stop Cluster

6.6.1.37.1 - 1.0

scpcli postgresql cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.38 - Switchover Cluster

6.6.1.38.1 - 1.0

scpcli postgresql cluster switchover
--cluster_id <value>

Description

Switchover Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.39 - Synchronize Archive Config

6.6.1.39.1 - 1.0

scpcli postgresql archive config sync
--cluster_id <value>

Description

Synchronize Archive Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.40 - Synchronize Cluster State

6.6.1.40.1 - 1.0

scpcli postgresql cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.41 - Synchronize Parameter Values

6.6.1.41.1 - 1.0

scpcli postgresql parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.42 - Synchronize Replica State

6.6.1.42.1 - 1.0

scpcli postgresql replica state sync
--origin_cluster_id <value>

Description

Synchronize Replica State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
origin_cluster_id
required
stringOrigin cluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

6.6.1.43 - Terminate Cluster

6.6.1.43.1 - 1.0

scpcli postgresql cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.6.1.44 - Unregister Log Export Config

6.6.1.44.1 - 1.0

scpcli postgresql log export config unregister
--log_type <value>
--cluster_id <value>

Description

Unregister Log Export Config.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
log_type
required
****Log typealert
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.6.1.45 - Unset Backup

6.6.1.45.1 - 1.0

scpcli postgresql backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

6.6.1.46 - Unset Maintenance

6.6.1.46.1 - 1.0

scpcli postgresql maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

7 - Data Analytics

7.1 - Data Flow

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Data Flow 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

7.1.1 - CLIs

7.1.1.1 - CheckClusterResourceSizeForDataFlowServiceCreate

7.1.1.1.1 - 1.1

scpcli data-flow check cluster resource size for data flow service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Flow Service Creation.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_workload{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

7.1.1.1.2 - 1.0

scpcli data-flow check cluster resource size for data flow service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Flow Service Creation.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_workload{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

7.1.1.2 - CheckClusterResourceSizeForDataFlowServiceUpdate

7.1.1.2.1 - 1.1

scpcli data-flow check cluster resource size for data flow service update
--data_flow_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Flow Service Update.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
service_workload
required
objectservice_workload{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

7.1.1.2.2 - 1.0

scpcli data-flow check cluster resource size for data flow service update
--data_flow_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Flow Service Update.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
service_workload
required
objectservice_workload{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

7.1.1.3 - CheckDataFlowNameDuplication

7.1.1.3.1 - 1.1

scpcli data-flow check data flow name duplication
--data_flow_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Check Duplication Data Flow Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_name
required
stringData flow name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
resultData flow check result

7.1.1.3.2 - 1.0

scpcli data-flow check data flow name duplication
--data_flow_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Check Duplication Data Flow Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_name
required
stringData flow name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
resultData flow check result

7.1.1.4 - CheckDataFlowServiceNameDuplication

7.1.1.4.1 - 1.1

scpcli data-flow check data flow service name duplication
--data_flow_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Check Duplication Data Flow Service Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_service_name
required
stringData flow service name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
resultData flow service check result

7.1.1.4.2 - 1.0

scpcli data-flow check data flow service name duplication
--data_flow_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Check Duplication Data Flow Service Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_service_name
required
stringData flow service name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
resultData flow service check result

7.1.1.5 - CreateDataFlow

7.1.1.5.1 - 1.1

scpcli data-flow create data flow
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_flow_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create data flow

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
ingress_controller_name
required
stringingress_controller_name-
image_id
required
stringimage_id-
host_alias_list
required
arrayhost_alias_list{'hostnames': [''], 'ip': ''}
domain
required
stringdomain-
data_flow_name
required
stringdata_flow_name-
cluster_id
required
stringcluster_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
dsc_domain
optional
stringdsc_domain-
instance_id
optional
stringinstance_id-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.1.1.5.2 - 1.0

scpcli data-flow create data flow
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_flow_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create data flow

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
ingress_controller_name
required
stringingress_controller_name-
image_id
required
stringimage_id-
host_alias_list
required
arrayhost_alias_list{'hostnames': [''], 'ip': ''}
domain
required
stringdomain-
data_flow_name
required
stringdata_flow_name-
cluster_id
required
stringcluster_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
dsc_domain
optional
stringdsc_domain-
instance_id
optional
stringinstance_id-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.1.1.6 - CreateDataFlowService

7.1.1.6.1 - 1.1

scpcli data-flow create data flow service
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_flow_service_name <value>
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Create dataflow service console

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
service_workload
required
objectservice_workload{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}
host_alias
required
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
domain
required
stringdescription-
data_flow_service_name
required
stringdata_flow_service_name-
data_flow_id
required
stringdata_flow_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.1.1.6.2 - 1.0

scpcli data-flow create data flow service
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_flow_service_name <value>
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Create dataflow service console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
service_workload
required
objectservice_workload{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}
host_alias
required
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
domain
required
stringdescription-
data_flow_service_name
required
stringdata_flow_service_name-
data_flow_id
required
stringdata_flow_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.1.1.7 - DeleteDataFlow

7.1.1.7.1 - 1.1

scpcli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data flow

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.1.1.7.2 - 1.0

scpcli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data flow

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.1.1.8 - DeleteDataFlowService

7.1.1.8.1 - 1.1

scpcli data-flow delete data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete dataflow service console

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.1.1.8.2 - 1.0

scpcli data-flow delete data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete dataflow service console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.1.1.9 - ListDataFlowImages

7.1.1.9.1 - 1.1

scpcli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Get List of Data Flow Images.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
image_idImage ID
image_nameImage name
versionVersion

7.1.1.9.2 - 1.0

scpcli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Get List of Data Flow Images.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
image_idImage ID
image_nameImage name
versionVersion

7.1.1.10 - ListDataFlows

7.1.1.10.1 - 1.1

scpcli data-flow list data flow
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataflow_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_flow_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataflow list console v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
sort
optional
stringsortcreated_dt:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
state
optional
****state-
dataflow_version
optional
stringversion-
size
optional
integersize20
page
optional
integerpage0
cluster_id
optional
stringcluster_id-
data_flow_name
optional
stringdata_flow_name-
region
optional
stringregion-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_flow_iddata_flow_id
data_flow_namedata_flow_name
image_idimage_id
instance_idinstance_id
is_active_imageis_active_image
modified_bymodified_by
modified_dtmodified_at
namespace_namenamespace_name
statestate
versionversion

7.1.1.10.2 - 1.0

scpcli data-flow list data flow
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataflow_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_flow_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataflow list console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
sort
optional
stringsortcreated_dt:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
state
optional
****state-
dataflow_version
optional
stringversion-
size
optional
integersize20
page
optional
integerpage0
cluster_id
optional
stringcluster_id-
data_flow_name
optional
stringdata_flow_name-
region
optional
stringregion-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_flow_iddata_flow_id
data_flow_namedata_flow_name
image_idimage_id
instance_idinstance_id
is_active_imageis_active_image
modified_bymodified_by
modified_dtmodified_at
namespace_namenamespace_name
statestate
versionversion

7.1.1.11 - ListDataFlowService

7.1.1.11.1 - 1.1

scpcli data-flow list data flow service
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--state <value>]
[--data_flow_service_name <value>]
[--data_flow_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataflow service list console v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsort-
created_by
optional
stringcreated_by-
state
optional
****state-
data_flow_service_name
optional
stringdata_flow_service_name-
data_flow_name
optional
stringdata_flow_name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_flow_iddata_flow_id
data_flow_namedata_flow_name
data_flow_service_iddata_flow_service_id
data_flow_service_namedata_flow_service_name
descriptiondescription
modified_bymodified_by
modified_dtmodified_at
statestate
versionversion

7.1.1.11.2 - 1.0

scpcli data-flow list data flow service
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--state <value>]
[--data_flow_service_name <value>]
[--data_flow_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataflow service list console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsort-
created_by
optional
stringcreated_by-
state
optional
****state-
data_flow_service_name
optional
stringdata_flow_service_name-
data_flow_name
optional
stringdata_flow_name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_flow_iddata_flow_id
data_flow_namedata_flow_name
data_flow_service_iddata_flow_service_id
data_flow_service_namedata_flow_service_name
descriptiondescription
modified_bymodified_by
modified_dtmodified_at
statestate
versionversion

7.1.1.12 - ShowDataFlow

7.1.1.12.1 - 1.1

scpcli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data flow

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
count_data_flow_servicecount_data_flow_service
created_dtcreated_dt
data_flow_iddata_flow_id
data_flow_namedata_flow_name
descriptiondescription
domaindomain
host_alias_listhost_alias[{‘hostnames’: [’’], ‘ip’: ‘’}]
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

7.1.1.12.2 - 1.0

scpcli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data flow

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
count_data_flow_servicecount_data_flow_service
created_dtcreated_dt
data_flow_iddata_flow_id
data_flow_namedata_flow_name
descriptiondescription
domaindomain
host_alias_listhost_alias[{‘hostnames’: [’’], ‘ip’: ‘’}]
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

7.1.1.13 - ShowDataFlowService

7.1.1.13.1 - 1.1

scpcli data-flow show data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

GET dataflow service console v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_flow_iddata_flow_id
data_flow_namedata_flow_name
data_flow_service_iddata_flow_service_id
data_flow_service_namedata_flow_service_name
descriptiondescription
domaindomain
host_aliashost_alias{’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]}
host_file_registryhost_file_registry
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
service_workloadservice_workload
statestate
storage_class_namestorage_class_name
versionversion
web_url_nifiweb_url_nifi
web_url_registryweb_url_registry

7.1.1.13.2 - 1.0

scpcli data-flow show data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

GET dataflow service console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_flow_iddata_flow_id
data_flow_namedata_flow_name
data_flow_service_iddata_flow_service_id
data_flow_service_namedata_flow_service_name
descriptiondescription
domaindomain
host_aliashost_alias{’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]}
host_file_registryhost_file_registry
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
service_workloadservice_workload
statestate
storage_class_namestorage_class_name
versionversion
web_url_nifiweb_url_nifi
web_url_registryweb_url_registry

7.1.1.14 - ShowDataFlowServiceSubVersions

7.1.1.14.1 - 1.1

scpcli data-flow show data flow service sub versions
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Get List of Data Flow Service Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringData flow ID-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
data_flow_service_countDataFlowService count
versionsimage versions

7.1.1.14.2 - 1.0

scpcli data-flow show data flow service sub versions
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Get List of Data Flow Service Versions.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringData flow ID-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
data_flow_service_countDataFlowService count
versionsimage versions

7.1.1.15 - UpdateDataFlow

7.1.1.15.1 - 1.1

scpcli data-flow update data flow
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update data flow by flow id

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias_list
optional
arrayhost_alias{'hostnames': [''], 'ip': ''}
node_selector
optional
stringnode_selector-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.1.1.15.2 - 1.0

scpcli data-flow update data flow
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update data flow by flow id

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241s
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias_list
optional
arrayhost_alias{'hostnames': [''], 'ip': ''}
node_selector
optional
stringnode_selector-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.1.1.16 - UpdateDataFlowService

7.1.1.16.1 - 1.1

scpcli data-flow update data flow service
--data_flow_service_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update dataflow service console

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias
optional
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
node_selector
optional
stringnode_selector-
service_workload
optional
objectservice_workload{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.1.1.16.2 - 1.0

scpcli data-flow update data flow service
--data_flow_service_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update dataflow service console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_flow_service_id
required
stringdata_flow_service_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias
optional
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
node_selector
optional
stringnode_selector-
service_workload
optional
objectservice_workload{'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.2 - Data Ops

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Data Ops 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

7.2.1 - CLIs

7.2.1.1 - CheckClusterResourceSizeForDataOpsServiceCreate

7.2.1.1.1 - 1.1

scpcli data-ops check cluster resource size for data ops service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Ops Service Creation.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

7.2.1.1.2 - 1.0

scpcli data-ops check cluster resource size for data ops service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Ops Service Creation.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

7.2.1.2 - CheckClusterResourceSizeForDataOpsServiceUpdate

7.2.1.2.1 - 1.1

scpcli data-ops check cluster resource size for data ops service update
--data_ops_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Ops Service Update.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

7.2.1.2.2 - 1.0

scpcli data-ops check cluster resource size for data ops service update
--data_ops_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

Validate Cluster Resource Size for Data Ops Service Update.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cpu
err_codeError code
memory
resultCluster resource check result

7.2.1.3 - CheckDataOpsNameDuplication

7.2.1.3.1 - 1.1

scpcli data-ops check data ops name duplication
--data_ops_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

check duplication controller

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_name
required
stringdata ops name2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.2.1.3.2 - 1.0

scpcli data-ops check data ops name duplication
--data_ops_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

check duplication controller

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_name
required
stringdata ops name2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.2.1.4 - CheckDataOpsServiceNameDuplication

7.2.1.4.1 - 1.1

scpcli data-ops check data ops service name duplication
--data_ops_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

check duplication controller

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_service_name
required
stringdata ops service name2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.2.1.4.2 - 1.0

scpcli data-ops check data ops service name duplication
--data_ops_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

check duplication controller

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_service_name
required
stringdata ops service name2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.2.1.5 - CreateDataOps

7.2.1.5.1 - 1.1

scpcli data-ops create data ops
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_ops_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create dataops

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
ingress_controller_name
required
stringingress_controller_name-
image_id
required
stringimage_id-
host_alias_list
required
arrayhost_alias_list{'hostnames': [''], 'ip': ''}
domain
required
stringdomain-
data_ops_name
required
stringdata_ops_name-
cluster_id
required
stringcluster_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
dsc_domain
optional
stringdsc_domain-
instance_id
optional
stringinstance_id-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.2.1.5.2 - 1.0

scpcli data-ops create data ops
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_ops_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create dataops

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
storage_class_name
required
stringstorage_class_name-
ingress_controller_name
required
stringingress_controller_name-
image_id
required
stringimage_id-
host_alias_list
required
arrayhost_alias_list{'hostnames': [''], 'ip': ''}
domain
required
stringdomain-
data_ops_name
required
stringdata_ops_name-
cluster_id
required
stringcluster_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
dsc_domain
optional
stringdsc_domain-
instance_id
optional
stringinstance_id-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.2.1.6 - CreateDataOpsService

7.2.1.6.1 - 1.1

scpcli data-ops create data ops service
--worker_type <value>
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_ops_service_name <value>
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create dataops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
worker_type
required
stringworker_type-
storage_class_name
required
stringstorage_class_name-
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
host_alias
required
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
domain
required
stringdescription-
data_ops_service_name
required
stringdata_ops_service_name-
data_ops_id
required
stringdata_ops_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.2.1.6.2 - 1.0

scpcli data-ops create data ops service
--worker_type <value>
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_ops_service_name <value>
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

create dataops service

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
worker_type
required
stringworker_type-
storage_class_name
required
stringstorage_class_name-
service_workload
required
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
host_alias
required
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
domain
required
stringdescription-
data_ops_service_name
required
stringdata_ops_service_name-
data_ops_id
required
stringdata_ops_id-
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
node_selector
optional
stringnode_selector-
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample

7.2.1.7 - DeleteDataOps

7.2.1.7.1 - 1.1

scpcli data-ops delete data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete dataops v1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.2.1.7.2 - 1.0

scpcli data-ops delete data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete dataops v1

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.2.1.8 - DeleteDataOpsService

7.2.1.8.1 - 1.1

scpcli data-ops delete data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete data ops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.2.1.8.2 - 1.0

scpcli data-ops delete data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

delete data ops service

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.2.1.9 - ListDataOps

7.2.1.9.1 - 1.1

scpcli data-ops list data ops
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataops_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_ops_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

{aianalytics.GetDataOpsListConsole.notes} v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
sort
optional
stringsortcreated_dt:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
state
optional
****state-
dataops_version
optional
stringversion-
size
optional
integersize20
page
optional
integerpage0
cluster_id
optional
stringcluster_id-
data_ops_name
optional
stringdata_ops_name-
region
optional
stringregion-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_ops_iddata_ops_id
data_ops_namedata_ops_name
image_idimage_id
instance_idinstance_id
is_active_imageis_active_image
modified_bymodified_by
modified_dtmodified_at
namespace_namenamespace_name
statestate
versionversion

7.2.1.9.2 - 1.0

scpcli data-ops list data ops
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataops_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_ops_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

{aianalytics.GetDataOpsListConsole.notes}

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
sort
optional
stringsortcreated_dt:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
state
optional
****state-
dataops_version
optional
stringversion-
size
optional
integersize20
page
optional
integerpage0
cluster_id
optional
stringcluster_id-
data_ops_name
optional
stringdata_ops_name-
region
optional
stringregion-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_ops_iddata_ops_id
data_ops_namedata_ops_name
image_idimage_id
instance_idinstance_id
is_active_imageis_active_image
modified_bymodified_by
modified_dtmodified_at
namespace_namenamespace_name
statestate
versionversion

7.2.1.10 - ListDataOpsImageVersions

7.2.1.10.1 - 1.1

scpcli data-ops list data ops image versions
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataops image version v1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
image_attrimage_attr
image_idimage_id
image_nameimage_name
versionversion

7.2.1.10.2 - 1.0

scpcli data-ops list data ops image versions
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataops image version v1

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
image_attrimage_attr
image_idimage_id
image_nameimage_name
versionversion

7.2.1.11 - ListDataOpsService

7.2.1.11.1 - 1.1

scpcli data-ops list data ops service
[--created_by <value>]
[--state <value>]
[--sort <value>]
[--size <value>]
[--page <value>]
[--data_ops_service_name <value>]
[--data_ops_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

GetDataOpsServiceListConsole v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
created_by
optional
stringcreated_by-
state
optional
****state-
sort
optional
stringsortcreated_dt:desc
size
optional
integersize20
page
optional
integerpage0
data_ops_service_name
optional
stringdata_ops_service_name-
data_ops_name
optional
stringdata_ops_name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_ops_iddata_ops_id
data_ops_namedata_ops_name
data_ops_service_iddata_ops_service_id
data_ops_service_namedata_ops_service_name
descriptiondescription
modified_bymodified_by
modified_dtmodified_at
statestate
versionversion

7.2.1.11.2 - 1.0

scpcli data-ops list data ops service
[--created_by <value>]
[--state <value>]
[--sort <value>]
[--size <value>]
[--page <value>]
[--data_ops_service_name <value>]
[--data_ops_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

GetDataOpsServiceListConsole

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
created_by
optional
stringcreated_by-
state
optional
****state-
sort
optional
stringsortcreated_dt:desc
size
optional
integersize20
page
optional
integerpage0
data_ops_service_name
optional
stringdata_ops_service_name-
data_ops_name
optional
stringdata_ops_name-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
data_ops_iddata_ops_id
data_ops_namedata_ops_name
data_ops_service_iddata_ops_service_id
data_ops_service_namedata_ops_service_name
descriptiondescription
modified_bymodified_by
modified_dtmodified_at
statestate
versionversion

7.2.1.12 - ShowDataOps

7.2.1.12.1 - 1.1

scpcli data-ops show data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataops detail v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_ops_iddata_ops_id
data_ops_namedata_ops_name
descriptiondescription
domaindomain
host_alias_listhost_alias[{‘hostnames’: [’’], ‘ip’: ‘’}]
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

7.2.1.12.2 - 1.0

scpcli data-ops show data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get dataops detail

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_ops_iddata_ops_id
data_ops_namedata_ops_name
descriptiondescription
domaindomain
host_alias_listhost_alias[{‘hostnames’: [’’], ‘ip’: ‘’}]
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

7.2.1.13 - ShowDataOpsService

7.2.1.13.1 - 1.1

scpcli data-ops show data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data ops service v1.1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
account_idaccount_id
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_ops_iddata_ops_id
data_ops_namedata_ops_name
data_ops_service_iddata_ops_service_id
data_ops_service_namedata_ops_service_name
descriptiondescription
domaindomain
host_aliashost_alias{’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]}
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
service_workloadservice_workload
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

7.2.1.13.2 - 1.0

scpcli data-ops show data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data ops service

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
accountaccount{‘account_id’: ‘’, ‘account_password’: ‘’}
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_dtcreated_dt
data_ops_iddata_ops_id
data_ops_namedata_ops_name
data_ops_service_iddata_ops_service_id
data_ops_service_namedata_ops_service_name
descriptiondescription
domaindomain
host_aliashost_alias{’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]}
hosts_filehosts_file
http_porthttp_port
https_porthttps_port
image_idimage_id
ingress_class_nameingress_class_name
instance_idinstance_id
is_active_imageis_active_image
modified_dtmodified_dt
namespace_namenamespace_name
node_selectornode_selector
service_workloadservice_workload
statestate
storage_class_namestorage_class_name
versionversion
web_urlweb_url

7.2.1.14 - ShowDataOpsServiceSubVersion

7.2.1.14.1 - 1.1

scpcli data-ops show data ops service sub version
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data ops sub version

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
data_ops_service_countDataOpsService count
versionsimage versions

7.2.1.14.2 - 1.0

scpcli data-ops show data ops service sub version
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

get data ops sub version

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

Responses

NameDescriptionExample
data_ops_service_countDataOpsService count
versionsimage versions

7.2.1.15 - UpdateDataOps

7.2.1.15.1 - 1.1

scpcli data-ops update data ops
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update dataops v1

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias_list
optional
arrayhost_alias{'hostnames': [''], 'ip': ''}
node_selector
optional
stringnode_selector-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.2.1.15.2 - 1.0

scpcli data-ops update data ops
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update dataops v1

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_id
required
stringdata ops ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account
optional
objectaccount{'account_id': '', 'account_password': ''}
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias_list
optional
arrayhost_alias{'hostnames': [''], 'ip': ''}
node_selector
optional
stringnode_selector-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.2.1.16 - UpdateDataOpsService

7.2.1.16.1 - 1.1

scpcli data-ops update data ops service
--data_ops_service_id <value>
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--worker_type <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update data ops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias
optional
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
node_selector
optional
stringnode_selector-
service_workload
optional
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
worker_type
optional
stringworker_type-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.2.1.16.2 - 1.0

scpcli data-ops update data ops service
--data_ops_service_id <value>
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--worker_type <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]

Description

update data ops service

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
data_ops_service_id
required
stringdata ops service ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
description
optional
stringdescription-
domain
optional
stringdomain-
host_alias
optional
objecthost_alias{'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]}
node_selector
optional
stringnode_selector-
service_workload
optional
objectservice_workload{'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}}
worker_type
optional
stringworker_type-
accept
optional
stringAccept-
content-type
optional
stringContent-Type-
scp-request-path
optional
stringScp-Request-Path-

7.3 - Event Streams

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Event Streams 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

7.3.1 - CLIs

7.3.1.1 - Add Instances

7.3.1.1.1 - 1.0

scpcli eventstreams instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]

Description

Add Instances.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
service_ip_addresses
required
arrayUser subnet IP address-
instance_count
required
integerInstance Count-
public_ip_ids
optional
arrayPublic IP ID List-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.2 - Create Cluster

7.3.1.2.1 - 1.0

scpcli eventstreams cluster create
--zookeeper_sasl_password <value>
--zookeeper_sasl_id <value>
--broker_sasl_password <value>
--broker_sasl_id <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--akhq_enabled <value>]
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--nat_enabled <value>]
[--tags <value>]
[--akhq_id <value>]
[--akhq_password <value>]
[--broker_port <value>]
[--zookeeper_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
zookeeper_sasl_password
required
stringzookeeper sasl password-
zookeeper_sasl_id
required
stringzookeeper sasl id-
broker_sasl_password
required
stringbroker sasl password-
broker_sasl_id
required
stringbroker sasl id-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance 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
stringDBaaS engine version ID-
akhq_enabled
optional
booleanAKHQ availability-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
is_combined
optional
booleanHA availability-
nat_enabled
optional
booleanNAT availability-
tags
optional
arraytag'{"key": "", "value": ""}'
akhq_id
optional
stringakhq id-
akhq_password
optional
stringakhq password-
broker_port
optional
integerbroker port-
zookeeper_port
optional
integerzookeeper port-
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.3 - List Clusters

7.3.1.3.1 - 1.0

scpcli eventstreams cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

7.3.1.4 - List Engine Version Properties

7.3.1.4.1 - 1.0

scpcli eventstreams engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

7.3.1.5 - List Engine Versions

7.3.1.5.1 - 1.0

scpcli eventstreams engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

7.3.1.6 - List Parameter Groups

7.3.1.6.1 - 1.0

scpcli eventstreams parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]

Description

List Parameter Groups.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
major_version
optional
stringSoftware major version-
product_image_type
optional
stringProduct image type-
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter group ID
major_versionSoftware major version
nameParameter group name
product_image_typeProduct image type
product_typeProduct type

7.3.1.7 - List Parameter Values

7.3.1.7.1 - 1.0

scpcli eventstreams parameter value list
--cluster_id <value>

Description

List Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idParameter id
allows_valueParameter allows value
applied_valueParameter applied value
apply_typeParameter apply type
data_typeParameter data type
default_valueParameter default value
descriptionParameter description
is_modifiableParameter is_modifiable
nameParameter name
software_typeParameter software type

7.3.1.8 - List Parameters

7.3.1.8.1 - 1.0

scpcli eventstreams parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List Parameters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_parameter_group_id
required
stringParameter group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idParameter id
dbaas_parameter_group_idParameter id
default_valueParameter default value
descriptionParameter description
nameParameter name
software_typeParameter software type

7.3.1.9 - List Server Types

7.3.1.9.1 - 1.0

scpcli eventstreams engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

7.3.1.10 - Restart Cluster

7.3.1.10.1 - 1.0

scpcli eventstreams cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.11 - Set Block Storage Size

7.3.1.11.1 - 1.0

scpcli eventstreams block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.12 - Set Maintenance

7.3.1.12.1 - 1.0

scpcli eventstreams maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.13 - Set Parameter Values

7.3.1.13.1 - 1.0

scpcli eventstreams parameter value set
--cluster_id <value>
--parameters <value>

Description

Set Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
parameters
required
arrayParameter request list'{"id": "", "new_value": "", "old_value": ""}'

7.3.1.14 - Set Security Group Rules

7.3.1.14.1 - 1.0

scpcli eventstreams security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.15 - Set Server Type

7.3.1.15.1 - 1.0

scpcli eventstreams server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.16 - Show Cluster

7.3.1.16.1 - 1.0

scpcli eventstreams cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID
block_storage_groupsBlock storage groups list
instancesInstances list
role_typeRole type
server_type_nameServer type name

7.3.1.17 - Show Request

7.3.1.17.1 - 1.0

scpcli eventstreams request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

7.3.1.18 - Start Cluster

7.3.1.18.1 - 1.0

scpcli eventstreams cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.19 - Stop Cluster

7.3.1.19.1 - 1.0

scpcli eventstreams cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.20 - Synchronize Cluster State

7.3.1.20.1 - 1.0

scpcli eventstreams cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.21 - Synchronize Parameter Values

7.3.1.21.1 - 1.0

scpcli eventstreams parameter value sync
--cluster_id <value>

Description

Synchronize Parameter Values.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.3.1.22 - Terminate Cluster

7.3.1.22.1 - 1.0

scpcli eventstreams cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

7.3.1.23 - Unset Maintenance

7.3.1.23.1 - 1.0

scpcli eventstreams maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

7.4 - Quick Query

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Quick Query 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

7.4.1 - CLIs

7.4.1.1 - CheckClusterResourceSizeForQuickQuery

7.4.1.1.1 - 1.1

scpcli quick-query check resource validation
--node_pool_validation_request <value>
[--cluster_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--is_engine_type_private <value>]
[--memory <value>]
[--replica <value>]

Description

Check if resource is verified to be modified/created

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
node_pool_validation_request
required
arraynode_pool_validation_request'{"auto_scale": "", "desired_node_count": "", "max_node_count": "", "min_node_count": "", "scale_name": ""}'
cluster_id
optional
stringcluster_id-
auto_scale
optional
booleanauto_scale-
cluster_size
optional
stringcluster_size-
cpu
optional
stringcpu-
is_engine_type_private
optional
booleanis_engine_type_private-
memory
optional
stringmemory-
replica
optional
stringreplica-

Responses

NameDescriptionExample
cpucpu
is_node_pool_auto_scalableis_node_pool_auto_scalable
memorymemory
replicareplica

7.4.1.1.2 - 1.0

scpcli quick-query check resource validation
--node_pool_validation_request <value>
[--cluster_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--is_engine_type_private <value>]
[--memory <value>]
[--replica <value>]

Description

Check if resource is verified to be modified/created

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
node_pool_validation_request
required
arraynode_pool_validation_request'{"auto_scale": "", "desired_node_count": "", "max_node_count": "", "min_node_count": "", "scale_name": ""}'
cluster_id
optional
stringcluster_id-
auto_scale
optional
booleanauto_scale-
cluster_size
optional
stringcluster_size-
cpu
optional
stringcpu-
is_engine_type_private
optional
booleanis_engine_type_private-
memory
optional
stringmemory-
replica
optional
stringreplica-

Responses

NameDescriptionExample
cpucpu
is_node_pool_auto_scalableis_node_pool_auto_scalable
memorymemory
replicareplica

7.4.1.2 - CheckDuplicationQuickQueryName

7.4.1.2.1 - 1.1

scpcli quick-query check quick query duplication
--quick_query_name <value>

Description

Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_name
required
stringquick query name-

Responses

NameDescriptionExample
resultcheck result

7.4.1.2.2 - 1.0

scpcli quick-query check quick query duplication
--quick_query_name <value>

Description

Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_name
required
stringquick query name-

Responses

NameDescriptionExample
resultcheck result

7.4.1.3 - CreateQuickQuery

7.4.1.3.1 - 1.1

scpcli quick-query create quick query
--quickquery_version <value>
--quick_query_name <value>
--max_query <value>
--is_engine_type_private <value>
--image_id <value>
--dsc_domain <value>
--domain <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--cloud_logging_enabled <value>
--node_pool_create_requests <value>
[--tags <value>]
[--cifs_volume_id <value>]
[--lb_id <value>]
[--public_acl_ip_address <value>]
[--description <value>]
[--dsc_console_ip <value>]
[--host_alias_list <value>]
[--instance_id <value>]
[--product_group_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--memory <value>]
[--replica <value>]

Description

Create Quick Query.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quickquery_version
required
stringversion-
quick_query_name
required
stringquick_query_name-
max_query
required
stringmax_query-
is_engine_type_private
required
booleanis_engine_type_private-
image_id
required
stringimage_id-
dsc_domain
required
stringdsc_domain-
domain
required
stringdomain-
vpc_id
required
stringvpc_id-
volume_id
required
stringvolume_id-
subnet_id
required
stringsubnet_id-
security_group_id_list
required
arraysecurity_group_id_list-
kubernetes_engine_name
required
stringkubernetes_engine_name-
k8s_version
required
stringk8s_version-
cloud_logging_enabled
required
booleancloud_logging_enabled-
node_pool_create_requests
required
arraynode_pool_create_requests'{"auto_recovery": false, "auto_scale": false, "desired_node_count": "", "image_os": "", "image_os_version": "", "k8s_version": "", "keypair_name": "", "max_node_count": "", "min_node_count": "", "name": "", "scale_name": "", "volume_size": "", "volume_type_name": ""}'
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
cifs_volume_id
optional
stringcifs_volume_id-
lb_id
optional
stringlb_id-
public_acl_ip_address
optional
stringpublic_acl_ip_address-
description
optional
stringdescription-
dsc_console_ip
optional
stringdsc_console_ip-
host_alias_list
optional
arrayhost_alias_list'{"hostnames": "", "ip": ""}'
instance_id
optional
stringinstance_id-
product_group_id
optional
stringproduct_group_id-
auto_scale
optional
booleanauto_scale-
cluster_size
optional
stringcluster_size-
cpu
optional
stringcpu-
memory
optional
stringmemory-
replica
optional
stringreplica-

Responses

NameDescriptionExample
project_idProject ID10a599e031e749b7b260868f441e862b
request_idRequest ID10a599e031e749b7b260868f441e862b
resource_idResource ID10a599e031e749b7b260868f441e862b

7.4.1.3.2 - 1.0

scpcli quick-query create quick query
--quickquery_version <value>
--quick_query_name <value>
--max_query <value>
--is_engine_type_private <value>
--image_id <value>
--dsc_domain <value>
--domain <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--cloud_logging_enabled <value>
--node_pool_create_requests <value>
[--tags <value>]
[--cifs_volume_id <value>]
[--lb_id <value>]
[--public_acl_ip_address <value>]
[--description <value>]
[--dsc_console_ip <value>]
[--host_alias_list <value>]
[--instance_id <value>]
[--product_group_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--memory <value>]
[--replica <value>]

Description

Create Quick Query.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quickquery_version
required
stringversion-
quick_query_name
required
stringquick_query_name-
max_query
required
stringmax_query-
is_engine_type_private
required
booleanis_engine_type_private-
image_id
required
stringimage_id-
dsc_domain
required
stringdsc_domain-
domain
required
stringdomain-
vpc_id
required
stringvpc_id-
volume_id
required
stringvolume_id-
subnet_id
required
stringsubnet_id-
security_group_id_list
required
arraysecurity_group_id_list-
kubernetes_engine_name
required
stringkubernetes_engine_name-
k8s_version
required
stringk8s_version-
cloud_logging_enabled
required
booleancloud_logging_enabled-
node_pool_create_requests
required
arraynode_pool_create_requests'{"auto_recovery": false, "auto_scale": false, "desired_node_count": "", "image_os": "", "image_os_version": "", "k8s_version": "", "keypair_name": "", "max_node_count": "", "min_node_count": "", "name": "", "scale_name": "", "volume_size": "", "volume_type_name": ""}'
tags
optional
arraytags'{"tag_key": "", "tag_value": ""}'
cifs_volume_id
optional
stringcifs_volume_id-
lb_id
optional
stringlb_id-
public_acl_ip_address
optional
stringpublic_acl_ip_address-
description
optional
stringdescription-
dsc_console_ip
optional
stringdsc_console_ip-
host_alias_list
optional
arrayhost_alias_list'{"hostnames": "", "ip": ""}'
instance_id
optional
stringinstance_id-
product_group_id
optional
stringproduct_group_id-
auto_scale
optional
booleanauto_scale-
cluster_size
optional
stringcluster_size-
cpu
optional
stringcpu-
memory
optional
stringmemory-
replica
optional
stringreplica-

Responses

NameDescriptionExample
project_idProject ID10a599e031e749b7b260868f441e862b
request_idRequest ID10a599e031e749b7b260868f441e862b
resource_idResource ID10a599e031e749b7b260868f441e862b

7.4.1.4 - DeleteQuickQuery

7.4.1.4.1 - 1.1

scpcli quick-query delete quick query
--quick_query_id <value>

Description

delete quick query

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-

7.4.1.4.2 - 1.0

scpcli quick-query delete quick query
--quick_query_id <value>

Description

delete quick query

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-

7.4.1.5 - ListQuickQuery

7.4.1.5.1 - 1.1

scpcli quick-query list quick query
--page <value>
--size <value>
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--quick_query_state <value>]
[--quickquery_version <value>]
[--quick_query_name <value>]

Description

get quick query list console

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
page
required
integerpage0
size
required
integersize20
sort
optional
stringsortcreated_at:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
quick_query_state
optional
****state-
quickquery_version
optional
stringversion-
quick_query_name
optional
stringquick_query_name-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
modified_bymodified_by
modified_dtmodified_at
quick_query_idquick_query_id
quick_query_namequick_query_name
quick_query_statequick_query_state
quick_query_versionquick_query_version

7.4.1.5.2 - 1.0

scpcli quick-query list quick query
--page <value>
--size <value>
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--quick_query_state <value>]
[--quickquery_version <value>]
[--quick_query_name <value>]

Description

get quick query list console

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
page
required
integerpage0
size
required
integersize20
sort
optional
stringsortcreated_at:desc
cluster_name
optional
stringcluster_name-
created_by
optional
stringcreated_by-
quick_query_state
optional
****state-
quickquery_version
optional
stringversion-
quick_query_name
optional
stringquick_query_name-

Responses

NameDescriptionExample
cluster_idcluster_id
cluster_namecluster_name
cluster_permissioncluster_permission
cluster_request_failedcluster_request_failed
created_bycreated_by
created_dtcreated_at
modified_bymodified_by
modified_dtmodified_at
quick_query_idquick_query_id
quick_query_namequick_query_name
quick_query_statequick_query_state
quick_query_versionquick_query_version

7.4.1.6 - ListQuickQueryImages

7.4.1.6.1 - 1.1

scpcli quick-query list quick query images

Description

get quick query image versions

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
image_attrimage_attr
image_idimage_id
image_nameimage_name
versionversion

7.4.1.6.2 - 1.0

scpcli quick-query list quick query images

Description

get quick query image versions

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Responses

NameDescriptionExample
image_attrimage_attr
image_idimage_id
image_nameimage_name
versionversion

7.4.1.7 - ShowQuickQuery

7.4.1.7.1 - 1.1

scpcli quick-query show quick query
--quick_query_id <value>

Description

Get Quick Query details.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-

Responses

NameDescriptionExample
ageage
cluster_idcluster id
container_versionContainer Version
created_atcreated at
external_ip_addressExternal IP Address
gpu_nameGPU Name
ipIP
kernel_versionKernel Version
kubernetes_versionKubernetes Version
namename
node_capacitiesNode Capacities
node_statusnode status
number_of_allocated_podsNumber of allocated pods
number_of_gpuNumber of GPU
os_imageOS Image
uiduid

7.4.1.7.2 - 1.0

scpcli quick-query show quick query
--quick_query_id <value>

Description

Get Quick Query details.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-

Responses

NameDescriptionExample
ageage
cluster_idcluster id
container_versionContainer Version
created_atcreated at
external_ip_addressExternal IP Address
gpu_nameGPU Name
ipIP
kernel_versionKernel Version
kubernetes_versionKubernetes Version
namename
node_capacitiesNode Capacities
node_statusnode status
number_of_allocated_podsNumber of allocated pods
number_of_gpuNumber of GPU
os_imageOS Image
uiduid

7.4.1.8 - UpdateQuickQueryDescription

7.4.1.8.1 - 1.1

scpcli quick-query update quick query description
--quick_query_id <value>
--description <value>

Description

update quick query description

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
description
required
stringdescription-

7.4.1.8.2 - 1.0

scpcli quick-query update quick query description
--quick_query_id <value>
--description <value>

Description

update quick query description

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
description
required
stringdescription-

7.4.1.9 - UpdateQuickQueryDomain

7.4.1.9.1 - 1.1

scpcli quick-query update quick query domain
--quick_query_id <value>
--domain <value>

Description

update quick query domain

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
domain
required
stringdomain-

7.4.1.9.2 - 1.0

scpcli quick-query update quick query domain
--quick_query_id <value>
--domain <value>

Description

update quick query domain

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
domain
required
stringdomain-

7.4.1.10 - UpdateQuickQueryDscDomain

7.4.1.10.1 - 1.1

scpcli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>

Description

update quick query dsc domain

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
dsc_domain
required
stringdsc_domain-

7.4.1.10.2 - 1.0

scpcli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>

Description

update quick query dsc domain

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
dsc_domain
required
stringdsc_domain-

7.4.1.11 - UpdateQuickQueryEngine

7.4.1.11.1 - 1.1

scpcli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]

Description

update quick query engine

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
replica
required
stringreplica-
memory
required
stringmemory-
cpu
required
stringcpu-
cluster_size
optional
stringcluster_size-

7.4.1.11.2 - 1.0

scpcli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]

Description

update quick query engine

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
replica
required
stringreplica-
memory
required
stringmemory-
cpu
required
stringcpu-
cluster_size
optional
stringcluster_size-

7.4.1.12 - UpdateQuickQueryHostAlias

7.4.1.12.1 - 1.1

scpcli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]

Description

update quick query host alias

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
host_alias_list
optional
arrayhost_alias_list'{"hostnames": "", "ip": ""}'

7.4.1.12.2 - 1.0

scpcli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]

Description

update quick query host alias

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
quick_query_id
required
stringquick_query_id-
host_alias_list
optional
arrayhost_alias_list'{"hostnames": "", "ip": ""}'

7.5 - Search Engine

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Search Engine 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

7.5.1 - CLIs

7.5.1.1 - Add Block Storages

7.5.1.1.1 - 1.0

scpcli searchengine block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.2 - Add Instances

7.5.1.2.1 - 1.0

scpcli searchengine instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]

Description

Add Instances.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
service_ip_addresses
required
arrayUser subnet IP address-
instance_count
required
integerInstance Count-
public_ip_ids
optional
arrayPublic IP ID List-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.3 - Create Cluster

7.5.1.3.1 - 1.0

scpcli searchengine cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_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>]
[--is_combined <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance 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
stringDBaaS engine version ID-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
is_combined
optional
booleanMaster Data server separation state-
license
optional
stringlicense-
nat_enabled
optional
booleanNAT availability-
tags
optional
arraytag'{"key": "", "value": ""}'
database_port
optional
integerDatabase service port-
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.4 - Create Restore Cluster

7.5.1.4.1 - 1.0

scpcli searchengine restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Restore Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "role_type": "ACTIVE"}'
backup_history_number
required
stringBackup id-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
license
optional
stringlicense-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.5 - List Backup Histories

7.5.1.5.1 - 1.0

scpcli searchengine backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

7.5.1.6 - List Clusters

7.5.1.6.1 - 1.0

scpcli searchengine cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
role_typeRole type
service_stateService state

7.5.1.7 - List Engine Version Properties

7.5.1.7.1 - 1.0

scpcli searchengine engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

7.5.1.8 - List Engine Versions

7.5.1.8.1 - 1.0

scpcli searchengine engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

7.5.1.9 - List Server Types

7.5.1.9.1 - 1.0

scpcli searchengine engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

7.5.1.10 - Remove Backup Histories

7.5.1.10.1 - 1.0

scpcli searchengine backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

7.5.1.11 - Restart Cluster

7.5.1.11.1 - 1.0

scpcli searchengine cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.12 - Set Backup

7.5.1.12.1 - 1.0

scpcli searchengine backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.13 - Set Block Storage Size

7.5.1.13.1 - 1.0

scpcli searchengine block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.14 - Set Maintenance

7.5.1.14.1 - 1.0

scpcli searchengine maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.15 - Set Security Group Rules

7.5.1.15.1 - 1.0

scpcli searchengine security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.16 - Set Server Type

7.5.1.16.1 - 1.0

scpcli searchengine server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.17 - Show Cluster

7.5.1.17.1 - 1.0

scpcli searchengine cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID
block_storage_groupsBlock storage groups list
instancesInstances list
role_typeRole type
server_type_nameServer type name

7.5.1.18 - Show Request

7.5.1.18.1 - 1.0

scpcli searchengine request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

7.5.1.19 - Start Cluster

7.5.1.19.1 - 1.0

scpcli searchengine cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.20 - Stop Cluster

7.5.1.20.1 - 1.0

scpcli searchengine cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.21 - Synchronize Cluster State

7.5.1.21.1 - 1.0

scpcli searchengine cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.5.1.22 - Terminate Cluster

7.5.1.22.1 - 1.0

scpcli searchengine cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

7.5.1.23 - Unset Backup

7.5.1.23.1 - 1.0

scpcli searchengine backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

7.5.1.24 - Unset Maintenance

7.5.1.24.1 - 1.0

scpcli searchengine maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

7.6 - Vertica(DBaaS)

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Vertica(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

7.6.1 - CLIs

7.6.1.1 - Add Block Storages

7.6.1.1.1 - 1.0

scpcli vertica block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]

Description

Add Block Storages.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
size_gb
required
integerSize in GB104
role_type
required
stringRole type-
volume_type
optional
stringVolume type-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.2 - Create Cluster

7.6.1.2.1 - 1.0

scpcli vertica cluster create
--starting_time_hour <value>
--retention_period_day <value>
--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>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_locale <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-
database_user_password
required
stringDatabase user password-
database_user_name
required
stringDatabase User Name-
database_name
required
stringDatabase Name-
timezone
required
stringTimezone-
subnet_id
required
stringSubnet ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance 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
stringDBaaS engine version ID-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
license
optional
stringlicense-
nat_enabled
optional
booleanNAT availability-
tags
optional
arraytag'{"key": "", "value": ""}'
database_locale
optional
stringDatabase locale information-
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.3 - Create Restore Cluster

7.6.1.3.1 - 1.0

scpcli vertica restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]

Description

Create Restore Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
name
required
stringCluster name-
instance_name_prefix
required
stringInstance name prefix-
instance_groups
required
arrayInstance groups list'{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "role_type": "ACTIVE", "server_type_name": ""}'
backup_history_number
required
stringBackup id-
allowable_ip_addresses
optional
arrayAllowed IP addresses list-
license
optional
stringlicense-
tags
optional
arraytag'{"key": "", "value": ""}'
period_hour
optional
stringPeriod in hours-
starting_day_of_week
optional
stringStarting day of week-
starting_time
optional
stringStarting time-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.4 - List Backup Histories

7.6.1.4.1 - 1.0

scpcli vertica backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]

Description

List Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
limit
optional
integerNumber of backup lists-
page
optional
integerBackup list page-

Responses

NameDescriptionExample
backup_end_atBackup end time
backup_history_numberBackup id
backup_size_gbBackup amount(GB)
backup_start_atBackup start time
backup_stateBackup state
backup_state_detailBackup detail state
software_versionSoftware version

7.6.1.5 - List Clusters

7.6.1.5.1 - 1.0

scpcli vertica cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]

Description

List Clusters.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster name-
service_state
optional
stringService state-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
console_includedManagement Console included state
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
instance_countInstance Count
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameCluster name
nat_enabledNAT availability
role_typeRole type
service_stateService state

7.6.1.6 - List Engine Version Properties

7.6.1.6.1 - 1.0

scpcli vertica engine version property list
--dbaas_engine_version_id <value>

Description

List Engine Version Properties.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
dbaas_engine_version_id
required
stringDBaaS engine version ID-

Responses

NameDescriptionExample
nameDBaas engine property name
valueDBaas engine property value

7.6.1.7 - List Engine Versions

7.6.1.7.1 - 1.0

scpcli vertica engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]

Description

List Engine Versions.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
optional
stringDBaaS engine version ID-
product_image_type
optional
****Product image type-
eos_included
optional
booleanEoS included-

Responses

NameDescriptionExample
idID
end_of_serviceEnd of Service
major_versionSoftware major version
nameDBaaS engine version name
os_typeOS type
os_versionOS version
product_image_typeProduct type
software_versionSoftware version

7.6.1.8 - List Server Types

7.6.1.8.1 - 1.0

scpcli vertica engine server type list
[--name <value>]
[--product_image_type <value>]

Description

List Server Types.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringServer type name-
product_image_type
optional
stringProduct image type-

Responses

NameDescriptionExample
cpu_coreServer type cpu core
descriptionServer type description
memory_gbServer type memory
nameServer type name
product_image_typeProduct image type
product_typeProduct type
purposeServer type purpose
typeServer type class

7.6.1.9 - Remove Backup Histories

7.6.1.9.1 - 1.0

scpcli vertica backup history remove
--cluster_id <value>
--backup_history_number <value>

Description

Remove Backup Histories.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
backup_history_number
required
arrayBackup id-

7.6.1.10 - Restart Cluster

7.6.1.10.1 - 1.0

scpcli vertica cluster restart
--cluster_id <value>

Description

Restart Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.11 - Set Backup

7.6.1.11.1 - 1.0

scpcli vertica backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>

Description

Set Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
starting_time_hour
required
stringBackup starting time (hour)-
retention_period_day
required
stringBackup retention period (day)-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.12 - Set Block Storage Size

7.6.1.12.1 - 1.0

scpcli vertica block storage size set
--block_storage_group_id <value>
--size_gb <value>

Description

Set Block Storage Size.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
block_storage_group_id
required
stringBlock storage group IDafc33891202643ba8ba1a5298a1affff
size_gb
required
integerSize in GB16

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.13 - Set Maintenance

7.6.1.13.1 - 1.0

scpcli vertica maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>

Description

Set Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
term_hour
required
stringterm_hour-
start_time
required
stringstart_time-
start_minute
required
stringstart_minute-
start_day_of_week
required
stringstart_day_of_week-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.14 - Set Security Group Rules

7.6.1.14.1 - 1.0

scpcli vertica security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]

Description

Set Security Group Rules.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
add_ip_addresses
optional
arrayAllowed IP addresses list-
del_ip_addresses
optional
arrayAllowed IP addresses list-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.15 - Set Server Type

7.6.1.15.1 - 1.0

scpcli vertica server type set
--instance_group_id <value>
--server_type_name <value>

Description

Set Server Type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
instance_group_id
required
stringInstance group ID-
server_type_name
required
stringServer type name-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.16 - Show Cluster

7.6.1.16.1 - 1.0

scpcli vertica cluster show
--cluster_id <value>

Description

Show Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
idID
block_storage_groupsBlock storage groups list
instancesInstances list
role_typeRole type
server_type_nameServer type name

7.6.1.17 - Show Request

7.6.1.17.1 - 1.0

scpcli vertica request show
--request_id <value>

Description

Show Request.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID-

Responses

NameDescriptionExample
request_idRequest ID
stateRequest state

7.6.1.18 - Start Cluster

7.6.1.18.1 - 1.0

scpcli vertica cluster start
--cluster_id <value>

Description

Start Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.19 - Stop Cluster

7.6.1.19.1 - 1.0

scpcli vertica cluster stop
--cluster_id <value>

Description

Stop Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.20 - Synchronize Cluster State

7.6.1.20.1 - 1.0

scpcli vertica cluster state sync
--cluster_id <value>

Description

Synchronize Cluster State.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

Responses

NameDescriptionExample
request_idRequest IDreq-4f668846-8a3d-49f1-8111-451ebccf445c
resourceResource

7.6.1.21 - Terminate Cluster

7.6.1.21.1 - 1.0

scpcli vertica cluster delete
--cluster_id <value>

Description

Terminate Cluster.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

7.6.1.22 - Unset Backup

7.6.1.22.1 - 1.0

scpcli vertica backup unset
--cluster_id <value>

Description

Unset Backup.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

7.6.1.23 - Unset Maintenance

7.6.1.23.1 - 1.0

scpcli vertica maintenance unset
--cluster_id <value>

Description

Unset Maintenance.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

8 - Application Service

8.1 - API Gateway

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 API Gateway 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1DEPRECATED20260430
1.2CURRENT-

8.1.1 - CLIs

8.1.1.1 - Approve PrivateLink Endpoint

8.1.1.1.1 - 1.2

scpcli application-apigateway privatelink endpoint approve
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

PrivateLink 엔드포인트를 승인한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink 엔드포인트 액션 유형CANCEL
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.2 - Connect PrivateLink Endpoint

8.1.1.2.1 - 1.2

scpcli application-apigateway privatelink endpoint connect
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

PrivateLink 엔드포인트를 연결한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink 엔드포인트 액션 유형CANCEL
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.3 - Create AccessControl

8.1.1.3.1 - 1.2

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string접근제어명DenyTest
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

8.1.1.3.2 - 1.1

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string접근제어명DenyTest
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

8.1.1.3.3 - 1.0

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string접근제어명DenyTest
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

8.1.1.4 - Create Api

8.1.1.4.1 - 1.2

scpcli application-apigateway api create
--name <value>
[--description <value>]
[--endpoint_type <value>]
[--id <value>]
[--tags <value>]

Description

API를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
name
required
string이름test-api
description
optional
string설명description
endpoint_type
optional
string엔드포인트 유형-
id
optional
stringApi ID-
tags
optional
array태그 목록'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
description설명Description
name이름test-api

8.1.1.4.2 - 1.1

scpcli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]

Description

API를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
name
required
string이름test-api
description
optional
string설명description
id
optional
stringApi ID-
tags
optional
array태그 목록'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
description설명Description
name이름test-api

8.1.1.4.3 - 1.0

scpcli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]

Description

API를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
string이름test-api
description
optional
string설명description
id
optional
stringApi ID-
tags
optional
array태그 목록'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
description설명Description
name이름test-api

8.1.1.5 - Create Api Deployment

8.1.1.5.1 - 1.2

scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

API를 배포한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
string스테이지 유형new
description
optional
string설명description
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description

8.1.1.5.2 - 1.1

scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

API를 배포한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
string스테이지 유형new
description
optional
string설명description
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description

8.1.1.5.3 - 1.0

scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

API를 배포한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
string스테이지 유형new
description
optional
string설명description
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description

8.1.1.6 - Create Api Key

8.1.1.6.1 - 1.2

scpcli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

API Key를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
name
required
string이름api-key-name
description
optional
string설명description

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시
description설명description
keyKeykey
name이름api-key-name

8.1.1.6.2 - 1.1

scpcli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

API Key를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
name
required
string이름api-key-name
description
optional
string설명description

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시
description설명description
keyKeykey
name이름api-key-name

8.1.1.7 - Create Auth

8.1.1.7.1 - 1.2

scpcli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

인증을 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string인증명Token01
expiration_period
required
integer만료 기간90
connected_stages
required
array연결된 스테이지dev,stg

Responses

NameDescriptionExample
access_token액세스 토큰***********************************************************

8.1.1.7.2 - 1.1

scpcli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

인증을 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string인증명Token01
expiration_period
required
integer만료 기간90
connected_stages
required
array연결된 스테이지dev,stg

Responses

NameDescriptionExample
access_token액세스 토큰***********************************************************

8.1.1.7.3 - 1.0

scpcli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

인증을 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string인증명Token01
expiration_period
required
integer만료 기간90
connected_stages
required
array연결된 스테이지dev,stg

Responses

NameDescriptionExample
access_token액세스 토큰***********************************************************

8.1.1.8 - Create Method

8.1.1.8.1 - 1.2

scpcli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

메서드를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
string메서드 유형GET
integration_type
required
string메서드 통합 유형HTTP
api_key_required
optional
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
object메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
object메서드 요청 헤더{'test1' : True}

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
privatelink_endpoint_idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

8.1.1.8.2 - 1.1

scpcli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

메서드를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
string메서드 유형GET
integration_type
required
string메서드 통합 유형HTTP
api_key_required
optional
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
object메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
object메서드 요청 헤더{'test1' : True}

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

8.1.1.8.3 - 1.0

scpcli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

메서드를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
string메서드 유형GET
integration_type
required
string메서드 통합 유형HTTP
api_key_required
optional
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
object메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
object메서드 요청 헤더{'test1' : True}

Responses

NameDescriptionExample
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

8.1.1.9 - Create PrivateLink Endpoint

8.1.1.9.1 - 1.2

scpcli application-apigateway privatelink endpoint create
--privatelink_service_id <value>
--name <value>
[--description <value>]

Description

PrivateLink 엔드포인트를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
name
required
stringPrivateLink 엔드포인트명endpoint
description
optional
string설명description

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명description
namePrivateLink 엔드포인트명endpoint
privatelink_service_idPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink 엔드포인트 상태CANCELED

8.1.1.10 - Create Resource

8.1.1.10.1 - 1.2

scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

리소스를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
parent_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
string경로명test

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로

8.1.1.10.2 - 1.1

scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

리소스를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
parent_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
string경로명test

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로

8.1.1.10.3 - 1.0

scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

리소스를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
parent_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
string경로명test

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로

8.1.1.11 - Create Stage

8.1.1.11.1 - 1.2

scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

스테이지를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string이름test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

8.1.1.11.2 - 1.1

scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

스테이지를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string이름test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

8.1.1.11.3 - 1.0

scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

스테이지를 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string이름test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
ip_restriction_enabledIP 접근제어 사용여부False
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage

8.1.1.12 - Create Usage Plans

8.1.1.12.1 - 1.2

scpcli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

사용량 정책을 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
string사용량 정책 주기day
name
required
string이름usage-plan-name
limit
required
integer사용량 정책 할당량10
description
optional
string설명description

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Key[]
created_at생성 일시
created_by_id생성자27bb070b564349f8a31cc60734cc36a5
created_by_name생성자username
description설명description
limit사용량 정책 할당량10
modified_at수정시간
modified_by_id수정자27bb070b564349f8a31cc60734cc36a5
modified_by_name수정자username
name이름usage-plan-name
rate사용량 정책 주기day

8.1.1.12.2 - 1.1

scpcli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

사용량 정책을 생성한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
string사용량 정책 주기day
name
required
string이름usage-plan-name
limit
required
integer사용량 정책 할당량10
description
optional
string설명description

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Key[]
created_at생성 일시
created_by_id생성자27bb070b564349f8a31cc60734cc36a5
created_by_name생성자username
description설명description
limit사용량 정책 할당량10
modified_at수정시간
modified_by_id수정자27bb070b564349f8a31cc60734cc36a5
modified_by_name수정자username
name이름usage-plan-name
rate사용량 정책 주기day

8.1.1.13 - Delete Access Control

8.1.1.13.1 - 1.2

scpcli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

접근제어를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

8.1.1.13.2 - 1.1

scpcli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

접근제어를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

8.1.1.13.3 - 1.0

scpcli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

접근제어를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

8.1.1.14 - Delete an API Key

8.1.1.14.1 - 1.2

scpcli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

API Key를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.14.2 - 1.1

scpcli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

API Key를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.15 - Delete Api

8.1.1.15.1 - 1.2

scpcli application-apigateway api delete
--api_id <value>

Description

API를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

8.1.1.15.2 - 1.1

scpcli application-apigateway api delete
--api_id <value>

Description

API를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

8.1.1.15.3 - 1.0

scpcli application-apigateway api delete
--api_id <value>

Description

API를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

8.1.1.16 - Delete Auth

8.1.1.16.1 - 1.2

scpcli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

인증을 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

8.1.1.16.2 - 1.1

scpcli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

인증을 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

8.1.1.16.3 - 1.0

scpcli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

인증을 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

8.1.1.17 - Delete Method

8.1.1.17.1 - 1.2

scpcli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.17.2 - 1.1

scpcli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.17.3 - 1.0

scpcli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.18 - Delete PrivateLink Endpoint

8.1.1.18.1 - 1.2

scpcli application-apigateway privatelink endpoint delete
--privatelink_endpoint_id <value>

Description

PrivateLink 엔드포인트를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

8.1.1.19 - Delete Resource

8.1.1.19.1 - 1.2

scpcli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

리소스를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.19.2 - 1.1

scpcli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

리소스를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.19.3 - 1.0

scpcli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

리소스를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.20 - Delete Stage

8.1.1.20.1 - 1.2

scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

스테이지를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

8.1.1.20.2 - 1.1

scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

스테이지를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

8.1.1.20.3 - 1.0

scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

스테이지를 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

8.1.1.21 - Delete Usage Plan

8.1.1.21.1 - 1.2

scpcli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

사용량 정책을 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.21.2 - 1.1

scpcli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

사용량 정책을 삭제한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

8.1.1.22 - List AccessControls

8.1.1.22.1 - 1.2

scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

접근제어 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

8.1.1.22.2 - 1.1

scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

접근제어 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

8.1.1.22.3 - 1.0

scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

접근제어 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

8.1.1.23 - List Api Deployments

8.1.1.23.1 - 1.2

scpcli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

API 배포 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
string이름27bb070b564349f8a31cc60734cc36a5
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_date배포 일시2024-05-17T00:23:17Z
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
status상태Active

8.1.1.23.2 - 1.1

scpcli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

API 배포 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
string이름27bb070b564349f8a31cc60734cc36a5
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_date배포 일시2024-05-17T00:23:17Z
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
status상태Active

8.1.1.23.3 - 1.0

scpcli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

API 배포 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
string이름27bb070b564349f8a31cc60734cc36a5
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_date배포 일시2024-05-17T00:23:17Z
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
status상태Active

8.1.1.24 - List Api Keys

8.1.1.24.1 - 1.2

scpcli application-apigateway api key list
--usage_plan_id <value>
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API Key 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름api-key-name

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시
description설명description
keyKeykey
name이름api-key-name

8.1.1.24.2 - 1.1

scpcli application-apigateway api key list
--usage_plan_id <value>
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API Key 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름api-key-name

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시
description설명description
keyKeykey
name이름api-key-name

8.1.1.25 - List Apis

8.1.1.25.1 - 1.2

scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름test-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

8.1.1.25.2 - 1.1

scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름test-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

8.1.1.25.3 - 1.0

scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름test-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

8.1.1.26 - List Auths

8.1.1.26.1 - 1.2

scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

인증 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

8.1.1.26.2 - 1.1

scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

인증 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

8.1.1.26.3 - 1.0

scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

인증 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

8.1.1.27 - List Connected PrivateLink Endpoints

8.1.1.27.1 - 1.2

scpcli application-apigateway api connected endpoint list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

연결요청된 PrivateLink 엔드포인트를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
statusPrivateLink 엔드포인트 상태Active

8.1.1.28 - List Methods

8.1.1.28.1 - 1.2

scpcli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

메서드 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
privatelink_endpoint_idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

8.1.1.28.2 - 1.1

scpcli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

메서드 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

8.1.1.28.3 - 1.0

scpcli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

메서드 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

8.1.1.29 - List PrivateLink Endpoints

8.1.1.29.1 - 1.2

scpcli application-apigateway privatelink endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

PrivateLink 엔드포인트 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivateLink 엔드포인트명endpoint

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
namePrivateLink 엔드포인트명endpoint
privatelink_service_idPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink 엔드포인트 상태CANCELED

8.1.1.30 - List Reports

8.1.1.30.1 - 1.2

scpcli application-apigateway report list
--api_id <value>
--end_date <value>
--start_date <value>
--stage_name <value>

Description

Report 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
end_date
required
string종료일자2025-07-30
start_date
required
string시작일자2025-07-01
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
call_count호출 수10
date날짜
error_4xx_count4xx 에러 수10
error_5xx_count5xx 에러 수10
integration_latency통합 지연시간10
latency지연시간10

8.1.1.30.2 - 1.1

scpcli application-apigateway report list
--api_id <value>
--end_date <value>
--start_date <value>
--stage_name <value>

Description

Report 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
end_date
required
string종료일자2025-07-30
start_date
required
string시작일자2025-07-01
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
call_count호출 수10
date날짜
error_4xx_count4xx 에러 수10
error_5xx_count5xx 에러 수10
integration_latency통합 지연시간10
latency지연시간10

8.1.1.31 - List Resources

8.1.1.31.1 - 1.2

scpcli application-apigateway resource list
--api_id <value>

Description

리소스 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

8.1.1.31.2 - 1.1

scpcli application-apigateway resource list
--api_id <value>

Description

리소스 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

8.1.1.31.3 - 1.0

scpcli application-apigateway resource list
--api_id <value>

Description

리소스 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

8.1.1.32 - List Stages

8.1.1.32.1 - 1.2

scpcli application-apigateway stage list
--api_id <value>

Description

스테이지 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
api_summaryAPI 요약[{‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/’}, {‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/test’}]
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

8.1.1.32.2 - 1.1

scpcli application-apigateway stage list
--api_id <value>

Description

스테이지 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
api_summaryAPI 요약[{‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/’}, {‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/test’}]
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

8.1.1.32.3 - 1.0

scpcli application-apigateway stage list
--api_id <value>

Description

스테이지 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_summaryAPI 요약[{‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/’}, {‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/test’}]
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
ip_restriction_enabledIP 접근제어 사용여부False
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage

8.1.1.33 - List Usage Plans

8.1.1.33.1 - 1.2

scpcli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

사용량 정책 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름usage-plan-name

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
connected_api_keys연결된 API Key 목록[‘key1’, ‘key2’]
created_at생성 일시
description설명description
limit사용량 정책 할당량10
name이름usage-plan-name
rate사용량 정책 주기day

8.1.1.33.2 - 1.1

scpcli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

사용량 정책 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름usage-plan-name

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
connected_api_keys연결된 API Key 목록[‘key1’, ‘key2’]
created_at생성 일시
description설명description
limit사용량 정책 할당량10
name이름usage-plan-name
rate사용량 정책 주기day

8.1.1.34 - Request PrivateLink Endpoint

8.1.1.34.1 - 1.2

scpcli application-apigateway privatelink endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

PrivateLink 엔드포인트를 요청한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink 엔드포인트 액션 유형CANCEL

8.1.1.35 - Set Access Control

8.1.1.35.1 - 1.2

scpcli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

8.1.1.35.2 - 1.1

scpcli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

8.1.1.35.3 - 1.0

scpcli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

8.1.1.36 - Set Api Description

8.1.1.36.1 - 1.2

scpcli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

API 설명을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
string설명description

8.1.1.36.2 - 1.1

scpcli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

API 설명을 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
string설명description

8.1.1.36.3 - 1.0

scpcli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

API 설명을 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
string설명description

8.1.1.37 - Set API Key Description

8.1.1.37.1 - 1.2

scpcli application-apigateway api key set
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

API Key 설명을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

8.1.1.37.2 - 1.1

scpcli application-apigateway api key set
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

API Key 설명을 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

8.1.1.38 - Set Auth

8.1.1.38.1 - 1.2

scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

인증을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg

8.1.1.38.2 - 1.1

scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

인증을 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg

8.1.1.38.3 - 1.0

scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

인증을 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg

8.1.1.39 - Set Method

8.1.1.39.1 - 1.2

scpcli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>
--integration_type <value>
--api_key_required <value>
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]

Description

메서드를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dict메서드 요청 헤더{'test1' : True}
query_strings
required
dict메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
integration_type
required
string메서드 통합 유형HTTP
api_key_required
required
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

8.1.1.39.2 - 1.1

scpcli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>
--integration_type <value>
--api_key_required <value>
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]

Description

메서드를 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dict메서드 요청 헤더{'test1' : True}
query_strings
required
dict메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
integration_type
required
string메서드 통합 유형HTTP
api_key_required
required
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

8.1.1.39.3 - 1.0

scpcli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>

Description

메서드를 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dict메서드 요청 헤더{'test1' : True}
query_strings
required
dict메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}

8.1.1.40 - Set PrivateLink Endpoint

8.1.1.40.1 - 1.2

scpcli application-apigateway privatelink endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

PrivateLink 엔드포인트를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

8.1.1.41 - Set Stage Active Deployment

8.1.1.41.1 - 1.2

scpcli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

스테이지 활성화 배포를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5

8.1.1.41.2 - 1.1

scpcli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

스테이지 활성화 배포를 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5

8.1.1.41.3 - 1.0

scpcli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

스테이지 활성화 배포를 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5

8.1.1.42 - Set Stage Configuration

8.1.1.42.1 - 1.2

scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]

Description

스테이지 설정을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
jwt_enabled
required
booleanJWT 사용여부False
cors_enabled
required
booleanCORS 사용여부False
allow_credentials
optional
boolean허용 인증True
allow_headers
optional
array허용 헤더Content-Type
allow_methods
optional
array허용 메서드'{}'
allow_origins
optional
array허용 원본*
connected_api_keys
optional
array연결된 API Key 목록key1
description
optional
string설명description
expose_headers
optional
array노출 헤더test1
max_age
optional
integer최대 캐시 기간3600
usage_plan_id
optional
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5

8.1.1.42.2 - 1.1

scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]

Description

스테이지 설정을 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
jwt_enabled
required
booleanJWT 사용여부False
cors_enabled
required
booleanCORS 사용여부False
allow_credentials
optional
boolean허용 인증True
allow_headers
optional
array허용 헤더Content-Type
allow_methods
optional
array허용 메서드'{}'
allow_origins
optional
array허용 원본*
connected_api_keys
optional
array연결된 API Key 목록key1
description
optional
string설명description
expose_headers
optional
array노출 헤더test1
max_age
optional
integer최대 캐시 기간3600
usage_plan_id
optional
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5

8.1.1.42.3 - 1.0

scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--ip_restriction_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--expose_headers <value>]
[--max_age <value>]

Description

스테이지 설정을 수정한다(ip_restriction_enabled 수정은 더 이상 지원되지 않음)

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
jwt_enabled
required
booleanJWT 사용여부False
ip_restriction_enabled
required
booleanIP 접근제어 사용여부False
cors_enabled
required
booleanCORS 사용여부False
allow_credentials
optional
boolean허용 인증True
allow_headers
optional
array허용 헤더Content-Type
allow_methods
optional
array허용 메서드'{}'
allow_origins
optional
array허용 원본*
expose_headers
optional
array노출 헤더test1
max_age
optional
integer최대 캐시 기간3600

8.1.1.43 - Set Usage Plan Description

8.1.1.43.1 - 1.2

scpcli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

사용량 정책 설명을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

8.1.1.43.2 - 1.1

scpcli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

사용량 정책 설명을 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

8.1.1.44 - Set Usage Plan Quota

8.1.1.44.1 - 1.2

scpcli application-apigateway usage plan set quota
--usage_plan_id <value>
--api_id <value>
--rate <value>
--limit <value>

Description

사용량 정책 할당량을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
string사용량 정책 주기day
limit
required
integer사용량 정책 할당량10

8.1.1.44.2 - 1.1

scpcli application-apigateway usage plan set quota
--usage_plan_id <value>
--api_id <value>
--rate <value>
--limit <value>

Description

사용량 정책 할당량을 수정한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
string사용량 정책 주기day
limit
required
integer사용량 정책 할당량10

8.1.1.45 - Show Access Control

8.1.1.45.1 - 1.2

scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

접근제어를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

8.1.1.45.2 - 1.1

scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

접근제어를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

8.1.1.45.3 - 1.0

scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

접근제어를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

8.1.1.46 - Show Api

8.1.1.46.1 - 1.2

scpcli application-apigateway api show
--api_id <value>

Description

API를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

8.1.1.46.2 - 1.1

scpcli application-apigateway api show
--api_id <value>

Description

API를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

8.1.1.46.3 - 1.0

scpcli application-apigateway api show
--api_id <value>

Description

API를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

8.1.1.47 - Show Auth

8.1.1.47.1 - 1.2

scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

인증을 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

8.1.1.47.2 - 1.1

scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

인증을 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

8.1.1.47.3 - 1.0

scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

인증을 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

8.1.1.48 - Show Method

8.1.1.48.1 - 1.2

scpcli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
privatelink_endpoint_idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

8.1.1.48.2 - 1.1

scpcli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

8.1.1.48.3 - 1.0

scpcli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

8.1.1.49 - Show PrivateLink Endpoint

8.1.1.49.1 - 1.2

scpcli application-apigateway privatelink endpoint show
--privatelink_endpoint_id <value>

Description

PrivateLink 엔드포인트를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명description
namePrivateLink 엔드포인트명endpoint
privatelink_service_idPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink 엔드포인트 상태CANCELED

8.1.1.50 - Show Resource

8.1.1.50.1 - 1.2

scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

리소스를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

8.1.1.50.2 - 1.1

scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

리소스를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

8.1.1.50.3 - 1.0

scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

리소스를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

8.1.1.51 - Show Stage

8.1.1.51.1 - 1.2

scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

스테이지를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

8.1.1.51.2 - 1.1

scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

스테이지를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

8.1.1.51.3 - 1.0

scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

스테이지를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
ip_restriction_enabledIP 접근제어 사용여부False
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage

8.1.1.52 - Show Usage Plan

8.1.1.52.1 - 1.2

scpcli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>

Description

사용량 정책을 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Key[]
created_at생성 일시
created_by_id생성자27bb070b564349f8a31cc60734cc36a5
created_by_name생성자username
description설명description
limit사용량 정책 할당량10
modified_at수정시간
modified_by_id수정자27bb070b564349f8a31cc60734cc36a5
modified_by_name수정자username
name이름usage-plan-name
rate사용량 정책 주기day

8.1.1.52.2 - 1.1

scpcli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>

Description

사용량 정책을 상세조회한다

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Key[]
created_at생성 일시
created_by_id생성자27bb070b564349f8a31cc60734cc36a5
created_by_name생성자username
description설명description
limit사용량 정책 할당량10
modified_at수정시간
modified_by_id수정자27bb070b564349f8a31cc60734cc36a5
modified_by_name수정자username
name이름usage-plan-name
rate사용량 정책 주기day

8.2 - Queue Service

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Queue Service 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

8.2.1 - CLIs

8.2.1.1 - Check Queue Name Duplication

8.2.1.1.1 - 1.0

scpcli queueservice check queue name duplication
--name <value>

Description

Queue명 중복 체크

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
required
stringQueue명test-queue.fifo

Responses

NameDescriptionExample
result결과True

8.2.1.2 - Create Queue

8.2.1.2.1 - 1.0

scpcli queueservice queue create
--id <value>
--name <value>
--message_size <value>
--message_retention_period_unit <value>
--message_retention_period <value>
[--data_key_reuse_period <value>]
[--data_key_reuse_period_unit <value>]
[--description <value>]
[--tags <value>]

Description

Queue 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS명test-kms
message_size
required
integer메시지 크기256
message_retention_period_unit
required
string기간 단위minute
message_retention_period
required
integer메시지 보존 기간40
data_key_reuse_period
optional
integer데이터 키 재사용 기간40
data_key_reuse_period_unit
optional
****기간 단위minute
description
optional
string설명Queue description
tags
optional
array태그 목록'{"key": "key1", "value": "value1"}'

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
messages설명Create Queue
stateQueue 상태ACTIVE

8.2.1.3 - Delete Acl

8.2.1.3.1 - 1.0

scpcli queueservice queue delete acl
--queue_id <value>
--ip_address <value>

Description

접근 허용 IP 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
array접근 허용 IP 목록0.0.0.0

8.2.1.4 - Delete Queue

8.2.1.4.1 - 1.0

scpcli queueservice queue delete
--queue_id <value>

Description

Queue 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

8.2.1.5 - List Queue

8.2.1.5.1 - 1.0

scpcli queueservice queue list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Queue 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringQueue명test-queue.fifo

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID8c9f6c1c928a45b4bbd1e4da5531d656
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
encryption암호화
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameQueue명test-queue.fifo
number_wait_messages대기 메시지 수10
stateQueue 상태ACTIVE
typeQueue 유형FIFO

8.2.1.6 - Set Acl

8.2.1.6.1 - 1.0

scpcli queueservice queue set acl
--queue_id <value>
--ip_address <value>

Description

접근 허용 IP 추가

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
array접근 허용 IP 목록0.0.0.0

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

8.2.1.7 - Show Queue

8.2.1.7.1 - 1.0

scpcli queueservice queue show
--queue_id <value>

Description

Queue 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
ip_addressIP 주소192.168.0.0

8.2.1.8 - Update Queue Config

8.2.1.8.1 - 1.0

scpcli queueservice queue set config
--queue_id <value>
--name <value>
--id <value>
--message_size <value>
--message_retention_period_unit <value>
--message_retention_period <value>
[--data_key_reuse_period <value>]
[--data_key_reuse_period_unit <value>]

Description

Queue 구성 설정 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS명test-kms
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
message_size
required
integer메시지 크기256
message_retention_period_unit
required
string기간 단위minute
message_retention_period
required
integer메시지 보존 기간40
data_key_reuse_period
optional
integer데이터 키 재사용 기간40
data_key_reuse_period_unit
optional
****기간 단위minute

8.2.1.9 - Update Queue Description

8.2.1.9.1 - 1.0

scpcli queueservice queue set description
--queue_id <value>
--description <value>

Description

Queue 설명 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
description
required
string설명Queue description

9 - Security

9.1 - Certificate Manager

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Certificate Manager 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0SUPPORTED20260531
1.1CURRENT-

9.1.1 - CLIs

9.1.1.1 - Check duplicate name

9.1.1.1.1 - 1.1

scpcli certificatemanager certificate check
--name <value>

Description

인증서 이름 중복 여부

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
string인증서 이름-

Responses

NameDescriptionExample
resultTrue, False 체크True

9.1.1.1.2 - 1.0

scpcli certificatemanager certificate check
--name <value>

Description

인증서 이름 중복 여부

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
name
required
string인증서 이름-

Responses

NameDescriptionExample
resultTrue, False 체크True

9.1.1.2 - Create a certificate

9.1.1.2.1 - 1.1

scpcli certificatemanager certificate create
--timezone <value>
--region <value>
--private_key <value>
--name <value>
--cert_body <value>
[--cert_chain <value>]
[--recipients <value>]
[--tags <value>]

Description

인증서 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
timezone
required
string타임존Asia/Seoul
region
required
string리즌 이름west1
private_key
required
string개인키<encoded private key data>
name
required
string인증서 이름test-certificate
cert_body
required
string인증서 body<encoded certificate body data>
cert_chain
optional
string인증서 체인<encoded certificate chain data>
recipients
optional
array만료된 인증서 수신인'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 idb82909b3576449fda984fb25c3123542da
cert_body인증서 body
cert_chain인증서 체인
cert_kind인증서 타입PRD
cert_type인증서 타입pem
cert_version인증서 버전2
cn인증서 CN 정보test.go.kr
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size키 bit 크기2048
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name인증서 이름test-certificate
not_after_dt인증서 만료일2026-02-07T18:07:59
not_before_dt인증서 시작일2025-02-08T18:07:00
organization인증서 O(조직) 정보samsungSDS
private_key개인키
recipients만료된 인증서 수신인[{‘region’: ‘’, ‘user_id’: ‘sdaFDQSDADZ2488e195c0e97d9b9eb’, ‘user_name’: ‘kildong.hong’}]
state인증서 상태VALID
tags태그 리스트
user_name사용자 이름kildong@samsung.com

9.1.1.2.2 - 1.0

scpcli certificatemanager certificate create
--timezone <value>
--region <value>
--private_key <value>
--name <value>
--cert_body <value>
[--cert_chain <value>]
[--recipients <value>]
[--tags <value>]

Description

인증서 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
timezone
required
string타임존Asia/Seoul
region
required
string리즌 이름west1
private_key
required
string개인키<encoded private key data>
name
required
string인증서 이름test-certificate
cert_body
required
string인증서 body<encoded certificate body data>
cert_chain
optional
string인증서 체인<encoded certificate chain data>
recipients
optional
array만료된 인증서 수신인'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 idb82909b3576449fda984fb25c3123542da
cert_body인증서 body
cert_chain인증서 체인
cert_kind인증서 타입PRD
cert_type인증서 타입pem
cert_version인증서 버전2
cn인증서 CN 정보test.go.kr
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size키 bit 크기2048
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name인증서 이름test-certificate
not_after_dt인증서 만료일2026-02-07T18:07:59
not_before_dt인증서 시작일2025-02-08T18:07:00
organization인증서 O(조직) 정보samsungSDS
private_key개인키
recipients만료된 인증서 수신인[{‘region’: ‘’, ‘user_id’: ‘sdaFDQSDADZ2488e195c0e97d9b9eb’, ‘user_name’: ‘kildong.hong’}]
state인증서 상태VALID
tags태그 리스트
user_name사용자 이름kildong@samsung.com

9.1.1.3 - Delete a certificate

9.1.1.3.1 - 1.1

scpcli certificatemanager certificate delete
--certificate_id <value>

Description

인증서 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
certificate_id
required
string인증서 id-

9.1.1.3.2 - 1.0

scpcli certificatemanager certificate delete
--certificate_id <value>

Description

인증서 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
certificate_id
required
string인증서 id-

9.1.1.4 - Detail a certificate

9.1.1.4.1 - 1.1

scpcli certificatemanager certificate detail
--certificate_id <value>

Description

인증서 상세정보

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
certificate_id
required
string인증서 id-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 idb82909b3576449fda984fb25c3123542da
cert_body인증서 body
cert_chain인증서 체인
cert_kind인증서 타입DEV
cert_type인증서 타입pem
cert_version인증서 버전2
cn인증서 CN 정보test.go.kr
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size키 bit 크기2048
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name인증서 이름test-certificate
not_after_dt인증서 만료일2026-02-07T18:07:59
not_before_dt인증서 시작일2025-02-08T18:07:00
organization인증서 O(조직) 정보samsungSDS
private_key개인키
state인증서 상태VALID
user_name사용자 이름2048

9.1.1.4.2 - 1.0

scpcli certificatemanager certificate detail
--certificate_id <value>

Description

인증서 상세정보

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
certificate_id
required
string인증서 id-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 idb82909b3576449fda984fb25c3123542da
cert_body인증서 body
cert_chain인증서 체인
cert_kind인증서 타입DEV
cert_type인증서 타입pem
cert_version인증서 버전2
cn인증서 CN 정보test.go.kr
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size키 bit 크기2048
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name인증서 이름test-certificate
not_after_dt인증서 만료일2026-02-07T18:07:59
not_before_dt인증서 시작일2025-02-08T18:07:00
organization인증서 O(조직) 정보samsungSDS
private_key개인키
state인증서 상태VALID
user_name사용자 이름2048

9.1.1.5 - List certificates

9.1.1.5.1 - 1.1

scpcli certificatemanager certificate list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ismine <value>]
[--name <value>]
[--cn <value>]
[--state <value>]

Description

인증서 리스트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ismine
optional
boolean사용자가 등록한 인증서인지 확인 여부-
name
optional
string인증서 이름test-certificate
cn
optional
string인증서 CN 정보test.go.kr
state
optional
array인증서 상태V

Responses

NameDescriptionExample
id인증서 id
cert_kind인증서 타입PRD
cn인증서 CN 정보test.go.kr
name인증서 이름test-certificate
not_after_dt인증서 만료일2026-02-07T18:07:59
not_before_dt인증서 시작일2025-02-08T18:07:00
state인증서 상태VALID

9.1.1.5.2 - 1.0

scpcli certificatemanager certificate list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ismine <value>]
[--name <value>]
[--cn <value>]
[--state <value>]

Description

인증서 리스트

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ismine
optional
boolean사용자가 등록한 인증서인지 확인 여부-
name
optional
string인증서 이름test-certificate
cn
optional
string인증서 CN 정보test.go.kr
state
optional
array인증서 상태V

Responses

NameDescriptionExample
id인증서 id
cert_kind인증서 타입PRD
cn인증서 CN 정보test.go.kr
name인증서 이름test-certificate
not_after_dt인증서 만료일2026-02-07T18:07:59
not_before_dt인증서 시작일2025-02-08T18:07:00
state인증서 상태VALID

9.1.1.6 - Self-sign a certificate

9.1.1.6.1 - 1.1

scpcli certificatemanager certificate selfSign
--timezone <value>
--region <value>
--organization <value>
--not_before_dt <value>
--not_after_dt <value>
--name <value>
--cn <value>
[--recipients <value>]
[--tags <value>]

Description

인증서 자체 서명

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
timezone
required
string타임존Asia/Seoul
region
required
string리즌 이름west1
organization
required
string인증서 O(조직) 정보samsungSDS
not_before_dt
required
string인증서 시작일20250101
not_after_dt
required
string인증서 만료일20251212
name
required
string인증서 이름test-certificate
cn
required
string인증서 CN 정보test.go.kr
recipients
optional
array만료된 인증서 수신인'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 idb82909b3576449fda984fb25c3123542da
cert_body인증서 body
cert_chain인증서 체인
cert_kind인증서 타입DEV
cert_type인증서 타입pem
cert_version인증서 버전2
cn인증서 CN 정보test.go.kr
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size키 bit 크기2048
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name인증서 이름test-certificate
not_after_dt인증서 만료일2026-02-07T18:07:59
not_before_dt인증서 시작일2025-02-08T18:07:00
organization인증서 O(조직) 정보samsungSDS
private_key개인키
state인증서 상태VALID
user_name사용자 이름2048

9.1.1.6.2 - 1.0

scpcli certificatemanager certificate selfSign
--timezone <value>
--region <value>
--organization <value>
--not_before_dt <value>
--not_after_dt <value>
--name <value>
--cn <value>
[--recipients <value>]
[--tags <value>]

Description

인증서 자체 서명

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
timezone
required
string타임존Asia/Seoul
region
required
string리즌 이름west1
organization
required
string인증서 O(조직) 정보samsungSDS
not_before_dt
required
string인증서 시작일20250101
not_after_dt
required
string인증서 만료일20251212
name
required
string인증서 이름test-certificate
cn
required
string인증서 CN 정보test.go.kr
recipients
optional
array만료된 인증서 수신인'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 idb82909b3576449fda984fb25c3123542da
cert_body인증서 body
cert_chain인증서 체인
cert_kind인증서 타입DEV
cert_type인증서 타입pem
cert_version인증서 버전2
cn인증서 CN 정보test.go.kr
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size키 bit 크기2048
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name인증서 이름test-certificate
not_after_dt인증서 만료일2026-02-07T18:07:59
not_before_dt인증서 시작일2025-02-08T18:07:00
organization인증서 O(조직) 정보samsungSDS
private_key개인키
state인증서 상태VALID
user_name사용자 이름2048

9.1.1.7 - Validate a certificate

9.1.1.7.1 - 1.1

scpcli certificatemanager certificate validate
--private_key <value>
--cert_body <value>
[--cert_chain <value>]

Description

인증서 검증

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
private_key
required
string개인키<encoded private key data>
cert_body
required
string인증서 body<encoded certificate body data>
cert_chain
optional
string인증서 체인<encoded certificate chain data>

Responses

NameDescriptionExample
validate_check

9.1.1.7.2 - 1.0

scpcli certificatemanager certificate validate
--private_key <value>
--is_need_cert_chain <value>
--cert_body <value>
[--cert_chain <value>]

Description

인증서 검증

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
private_key
required
string개인키<encoded private key data>
is_need_cert_chain
required
boolean인증서 체인 필요 여부True
cert_body
required
string인증서 body<encoded certificate body data>
cert_chain
optional
string인증서 체인<encoded certificate chain data>

Responses

NameDescriptionExample
resultTrue, False 체크True

9.2 - Config Inspection

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Config Inspection에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0SUPPORTED20260531
1.1CURRENT-

9.2.1 - CLIs

9.2.1.1 - Create Config Inspection

9.2.1.1.1 - 1.1

scpcli configinspection ci create
--use_diagnosis_check_type_ssi <value>
--use_diagnosis_check_type_bp <value>
--frequency_value <value>
--frequency_type <value>
--diagnosis_start_time_pattern <value>
--auth_key_id <value>
--plan_type <value>
--diagnosis_type <value>
--diagnosis_name <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--diagnosis_account_id <value>
--csp_type <value>
--account_id <value>
[--tags <value>]
[--auth_key_created_at <value>]
[--auth_key_expired_at <value>]

Description

진단 상품 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
use_diagnosis_check_type_ssi
required
string체크리스트 SSI 사용 여부y
use_diagnosis_check_type_bp
required
string체크리스트 Best Practice 사용 여부y
frequency_value
required
stringSchedule value (01~31, MONDAY~SUNDAY, everyDay)1
frequency_type
required
stringSchedule type( monthly, weekly, daily)MONTH
diagnosis_start_time_pattern
required
stringStart time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes )08:00
auth_key_id
required
string인증키 ID9b72a9856e494e67afc69atd3631fe38
plan_type
required
string요금제STANDARD
diagnosis_type
required
string진단 유형Console
diagnosis_name
required
string진단명Sample Diagnosis Name
diagnosis_id
required
string진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
string진단 체크리스트BP
diagnosis_account_id
required
string진단 ID0e3dffc50eb247a1adf4f2e5c82c4f99
csp_type
required
string클라우드 서비스 제공자의 유형SCP
account_id
required
string진단 계정0e3dffc50eb247a1adf4f2e5c82c4f99
tags
optional
arrayTag List'{"key": "", "value": ""}'
auth_key_created_at
optional
string인증 키 생성 날짜2022-01-01 12:00:00
auth_key_expired_at
optional
string인증 키 만료 날짜2023-01-01 12:00:00

Responses

NameDescriptionExample
diagnosis_id진단 IDSample Diagnosis Name
resultTrue, False 체크True

9.2.1.1.2 - 1.0

scpcli configinspection ci create
--use_diagnosis_check_type_ssi <value>
--use_diagnosis_check_type_bp <value>
--frequency_value <value>
--frequency_type <value>
--diagnosis_start_time_pattern <value>
--auth_key_id <value>
--plan_type <value>
--diagnosis_type <value>
--diagnosis_name <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--diagnosis_account_id <value>
--csp_type <value>
--account_id <value>
[--tags <value>]
[--auth_key_created_at <value>]
[--auth_key_expired_at <value>]

Description

진단 상품 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
use_diagnosis_check_type_ssi
required
string체크리스트 SSI 사용 여부y
use_diagnosis_check_type_bp
required
string체크리스트 Best Practice 사용 여부y
frequency_value
required
stringSchedule value (01~31, MONDAY~SUNDAY, everyDay)1
frequency_type
required
stringSchedule type( monthly, weekly, daily)MONTH
diagnosis_start_time_pattern
required
stringStart time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes )08:00
auth_key_id
required
string인증키 ID9b72a9856e494e67afc69atd3631fe38
plan_type
required
string요금제STANDARD
diagnosis_type
required
string진단 유형Console
diagnosis_name
required
string진단명Sample Diagnosis Name
diagnosis_id
required
string진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
string진단 체크리스트BP
diagnosis_account_id
required
string진단 ID0e3dffc50eb247a1adf4f2e5c82c4f99
csp_type
required
string클라우드 서비스 제공자의 유형SCP
account_id
required
string진단 계정0e3dffc50eb247a1adf4f2e5c82c4f99
tags
optional
arrayTag List'{"key": "", "value": ""}'
auth_key_created_at
optional
string인증 키 생성 날짜2022-01-01 12:00:00
auth_key_expired_at
optional
string인증 키 만료 날짜2023-01-01 12:00:00

Responses

NameDescriptionExample
resultTrue, False 체크True

9.2.1.2 - Delete Config Inspection

9.2.1.2.1 - 1.1

scpcli configinspection ci delete
--diagnosis_id <value>

Description

config inspection 목록 가져오기

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
diagnosis_id
required
string진단 IDSample Diagnosis Name

9.2.1.2.2 - 1.0

scpcli configinspection ci delete
--diagnosis_id <value>

Description

config inspection 목록 가져오기

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_id
required
string진단 IDSample Diagnosis Name

9.2.1.3 - Diagnosis Request

9.2.1.3.1 - 1.1

scpcli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>

Description

진단 요청

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
tenant_id
required
stringTenant ID1234567890
secret_key
required
stringSecret KeySAMPLE KEY
diagnosis_id
required
string진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
string진단 체크리스트BP
access_key
required
stringAccess KeySAMPLE KEY

Responses

NameDescriptionExample
resultTrue, False 체크True

9.2.1.3.2 - 1.0

scpcli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>

Description

진단 요청

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
tenant_id
required
stringTenant ID1234567890
secret_key
required
stringSecret KeySAMPLE KEY
diagnosis_id
required
string진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
string진단 체크리스트BP
access_key
required
stringAccess KeySAMPLE KEY

Responses

NameDescriptionExample
resultTrue, False 체크True

9.2.1.4 - Get Diagnosis Object Detail

9.2.1.4.1 - 1.1

scpcli configinspection ci detail
--diagnosis_id <value>

Description

진단 결과 세부 정보 가져오기

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
diagnosis_id
required
string진단 IDSample Diagnosis Name

Responses

NameDescriptionExample
auth_key_created_at인증 키 생성 날짜2022-01-01T12:00:00Z
auth_key_expired_at인증 키 만료 날짜2022-01-01T12:00:00Z
auth_key_id인증키 ID9b72a9856e494e67afc69atd3631fe38
auth_key_state인증키 상태ACTIVATED
user_id사용자 ID4f5d60e9e08b48d0a0881e21ab14e266

9.2.1.4.2 - 1.0

scpcli configinspection ci detail
--diagnosis_id <value>

Description

진단 결과 세부 정보 가져오기

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_id
required
string진단 IDSample Diagnosis Name

Responses

NameDescriptionExample
auth_key_created_at인증 키 생성 날짜2022-01-01T12:00:00Z
auth_key_expired_at인증 키 만료 날짜2022-01-01T12:00:00Z
auth_key_id인증키 ID9b72a9856e494e67afc69atd3631fe38
auth_key_state인증키 상태ACTIVATED
user_id사용자 ID4f5d60e9e08b48d0a0881e21ab14e266

9.2.1.5 - Get Diagnosis Result Detail

9.2.1.5.1 - 1.1

scpcli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]

Description

진단 결과 세부 정보 가져오기

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
diagnosis_request_sequence
required
string진단 요청 SequenceSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
diagnosis_id
required
string진단 IDDIA-943731CB8E3045C289BAECAEC3532097
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
action_guide조치 가이드원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.
changed관리결과 변경 여부True
diagnosis_check_type진단 체크리스트BP
diagnosis_criteria진단 기준【 Security Group 규칙 】
① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다.
diagnosis_item진단 항목2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다.
diagnosis_layer영역2.NETWORK
diagnosis_method진단 방법Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다.
diagnosis_result확인결과 상태03
result_contents상세 결과상세 내역
sub_categorySub CategoryNURIBP_SCP_02.NW_004

9.2.1.5.2 - 1.0

scpcli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]

Description

진단 결과 세부 정보 가져오기

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_request_sequence
required
string진단 요청 SequenceSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
diagnosis_id
required
string진단 IDDIA-943731CB8E3045C289BAECAEC3532097
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
action_guide조치 가이드원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.
changed관리결과 변경 여부True
diagnosis_check_type진단 체크리스트BP
diagnosis_criteria진단 기준【 Security Group 규칙 】
① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다.
diagnosis_item진단 항목2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다.
diagnosis_layer영역2.NETWORK
diagnosis_method진단 방법Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다.
diagnosis_result확인결과 상태03
result_contents상세 결과상세 내역
sub_categorySub CategoryNURIBP_SCP_02.NW_004

9.2.1.6 - List Config Inspection

9.2.1.6.1 - 1.1

scpcli configinspection ci list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ismine <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--csp_type <value>]
[--diagnosis_account_id <value>]
[--recent_diagnosis_state <value>]
[--start_date <value>]
[--end_date <value>]

Description

config inspection 목록 가져오기

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ismine
optional
boolean나의 Config InspectionFalse
diagnosis_id
optional
string진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
string진단명My Diagnosis
csp_type
optional
string클라우드 서비스 제공자의 유형SCP
diagnosis_account_id
optional
string진단 ID0e3dffc50eb247a1adf4f2e5c82c4f99
recent_diagnosis_state
optional
array최근 진단 상태C
start_date
optional
string시작일2022-01-01 12:00:00
end_date
optional
string종료일2022-01-02 12:00:00

Responses

NameDescriptionExample
created_at생성일시2022-01-01T12:00:00Z
csp_type클라우드 서비스 제공자의 유형SCP
diagnosis_account_id진단 ID0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_type진단 체크리스트BP
diagnosis_id진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name진단명Sample Diagnosis Name
diagnosis_type진단 유형Console
error_state최근 진단 오류 타입CONNECTION_FAIL
plan_type요금제STANDARD
recent_diagnosis_at최근 진단 일시2022-01-01T12:00:00Z
recent_diagnosis_state최근 진단 상태Completed

9.2.1.6.2 - 1.0

scpcli configinspection ci list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ismine <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--csp_type <value>]
[--diagnosis_account_id <value>]
[--recent_diagnosis_state <value>]
[--start_date <value>]
[--end_date <value>]

Description

config inspection 목록 가져오기

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ismine
optional
boolean나의 Config InspectionFalse
diagnosis_id
optional
string진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
string진단명My Diagnosis
csp_type
optional
string클라우드 서비스 제공자의 유형SCP
diagnosis_account_id
optional
string진단 ID0e3dffc50eb247a1adf4f2e5c82c4f99
recent_diagnosis_state
optional
array최근 진단 상태C
start_date
optional
string시작일2022-01-01 12:00:00
end_date
optional
string종료일2022-01-02 12:00:00

Responses

NameDescriptionExample
created_at생성일시2022-01-01T12:00:00Z
csp_type클라우드 서비스 제공자의 유형SCP
diagnosis_account_id진단 ID0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_type진단 체크리스트BP
diagnosis_id진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name진단명Sample Diagnosis Name
diagnosis_type진단 유형Console
error_state최근 진단 오류 타입CONNECTION_FAIL
plan_type요금제STANDARD
recent_diagnosis_at최근 진단 일시2022-01-01T12:00:00Z
recent_diagnosis_state최근 진단 상태Completed

9.2.1.7 - List Diagnosis Result

9.2.1.7.1 - 1.1

scpcli configinspection ci result list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--start_date <value>]
[--end_date <value>]
[--csp_type <value>]
[--diagnosis_state <value>]
[--user_id <value>]

Description

진단 결과 목록 가져오기

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
string진단 계정0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_id
optional
string진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
string진단명Sample Diagnosis Name
start_date
optional
string시작일2022-01-01
end_date
optional
string종료일2022-12-31
csp_type
optional
string클라우드 서비스 제공자의 유형SCP
diagnosis_state
optional
string진단 상태Completed
user_id
optional
string사용자 ID76b563a009584b1380715c00703a02ff

Responses

NameDescriptionExample
count_checkcheck 개수10
count_errorerror 개수0
count_failfail 개수3
count_nana 개수2
count_passpass 개수5
csp_type클라우드 서비스 제공자의 유형SCP
diagnosis_account_id진단 ID0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_type진단 체크리스트BP
diagnosis_id진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name진단명Sample Diagnosis Name
diagnosis_request_sequence진단 요청 Sequence1234567890
diagnosis_result진단 결과SUCCESS
diagnosis_total_count총 개수10
proceed_date진단 일자2022-01-01T12:00:00Z
total전체 개수10

9.2.1.7.2 - 1.0

scpcli configinspection ci result list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--start_date <value>]
[--end_date <value>]
[--csp_type <value>]
[--diagnosis_state <value>]
[--user_id <value>]

Description

진단 결과 목록 가져오기

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260531

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
string진단 계정0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_id
optional
string진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
string진단명Sample Diagnosis Name
start_date
optional
string시작일2022-01-01
end_date
optional
string종료일2022-12-31
csp_type
optional
string클라우드 서비스 제공자의 유형SCP
diagnosis_state
optional
string진단 상태Completed
user_id
optional
string사용자 ID76b563a009584b1380715c00703a02ff

Responses

NameDescriptionExample
count_checkcheck 개수10
count_errorerror 개수0
count_failfail 개수3
count_nana 개수2
count_passpass 개수5
csp_type클라우드 서비스 제공자의 유형SCP
diagnosis_account_id진단 ID0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_type진단 체크리스트BP
diagnosis_id진단 IDDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name진단명Sample Diagnosis Name
diagnosis_request_sequence진단 요청 Sequence1234567890
diagnosis_result진단 결과SUCCESS
diagnosis_total_count총 개수10
proceed_date진단 일자2022-01-01T12:00:00Z
total전체 개수10

9.3 - Key Management Service

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Key Management Service(KMS)에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

9.3.1 - CLIs

9.3.1.1 - Change Rotate Info

9.3.1.1.1 - 1.1

scpcli kms kms change rotate info
--key_id <value>
--rotate_cycle <value>
--auto_rotate <value>

Description

키 회전정보를 변경한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
rotate_cycle
required
integer회전 주기7
auto_rotate
required
string자동회전 Y 또는 NY

9.3.1.1.2 - 1.0

scpcli kms kms change rotate info
--key_id <value>
--rotate_cycle <value>
--auto_rotate <value>

Description

키 회전정보를 변경한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
rotate_cycle
required
integer회전 주기7
auto_rotate
required
string자동회전 Y 또는 NY

9.3.1.2 - Change State Of Key

9.3.1.2.1 - 1.1

scpcli kms kms change state
--key_id <value>
--state <value>

Description

키 상태를 변경한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
state
required
stringState of key(Active, Stop)Active

9.3.1.2.2 - 1.0

scpcli kms kms change state
--key_id <value>
--state <value>

Description

키 상태를 변경한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
state
required
stringState of key(Active, Stop)Active

9.3.1.3 - Check Duplicate Name

9.3.1.3.1 - 1.1

scpcli kms kms check duplicate name
--name <value>

Description

키 이름 중복을 체크한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
string키 이름testkey

Responses

NameDescriptionExample
isDuplicateNameTrue

9.3.1.3.2 - 1.0

scpcli kms kms check duplicate name
--name <value>

Description

키 이름 중복을 체크한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
string키 이름testkey

Responses

NameDescriptionExample
isDuplicateNameTrue

9.3.1.4 - Create Datakey

9.3.1.4.1 - 1.1

scpcli kms kms datakey
--key_id <value>
--key_type <value>

Description

새 데이터키를 생성하고, 키(용도:암호화/복호화)로 암호화된 값을 생성합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
key_type
required
stringKey type( plaintext or wrapped )plaintext

Responses

NameDescriptionExample
ciphertext암호화된 데이터 키vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionKMS 키 버전1
plaintext데이터키 (base64로 인코딩된)oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

9.3.1.4.2 - 1.0

scpcli kms kms datakey
--key_id <value>
--key_type <value>

Description

새 데이터키를 생성하고, 키(용도:암호화/복호화)로 암호화된 값을 생성합니다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
key_type
required
stringKey type( plaintext or wrapped )plaintext

Responses

NameDescriptionExample
ciphertext암호화된 데이터 키vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionKMS 키 버전1
plaintext데이터키 (base64로 인코딩된)oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

9.3.1.5 - Create Key

9.3.1.5.1 - 1.1

scpcli kms kms create
--rotate_cycle <value>
--purpose <value>
--name <value>
--description <value>
--auto_rotate <value>
[--key_type <value>]
[--tags <value>]

Description

키를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
rotate_cycle
required
integer회전 주기7
purpose
required
string키 용도rsa-2048
name
required
string키 이름testkey
description
required
string키 설명description1
auto_rotate
required
string자동회전 Y 또는 NY
key_type
optional
string기본 또는 고급advanced
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
auto_rotate자동회전 Y 또는 NY
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_versionKMS키 현재 버전7
delete_atDate of deletion20251008
delete_target_yn키 삭제예정 여부Y
description키 설명description1
key_type기본 또는 고급advanced
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름testkey
next_rotate_at다음 회전일20241008
order_ref오더 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose키 용도rsa-2048
region리즌 이름kr-west1
rotate_cycle회전 주기7
secret_ref시크릿 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countKMS키 사용횟수1004

9.3.1.5.2 - 1.0

scpcli kms kms create
--rotate_cycle <value>
--purpose <value>
--name <value>
--description <value>
--auto_rotate <value>
[--key_type <value>]
[--tags <value>]

Description

키를 생성한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
rotate_cycle
required
integer회전 주기7
purpose
required
string키 용도rsa-2048
name
required
string키 이름testkey
description
required
string키 설명description1
auto_rotate
required
string자동회전 Y 또는 NY
key_type
optional
string기본 또는 고급advanced
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
auto_rotate자동회전 Y 또는 NY
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_versionKMS키 현재 버전7
delete_atDate of deletion20251008
delete_target_yn키 삭제예정 여부Y
description키 설명description1
key_type기본 또는 고급advanced
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름testkey
next_rotate_at다음 회전일20241008
order_ref오더 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose키 용도rsa-2048
region리즌 이름kr-west1
rotate_cycle회전 주기7
secret_ref시크릿 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countKMS키 사용횟수1004

9.3.1.6 - Decrypt Data

9.3.1.6.1 - 1.1

scpcli kms kms decrypt
--key_id <value>
--ciphertext <value>

Description

키(용도:암호화/복호화)를 사용하여 제공된 암호문을 해독합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringKMS에 의해 암호화된 데이터vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
plaintext데이터키 (base64로 인코딩된 )dGhlIHF1aWNrIGJyb3duIGZveAo=

9.3.1.6.2 - 1.0

scpcli kms kms decrypt
--key_id <value>
--ciphertext <value>

Description

키(용도:암호화/복호화)를 사용하여 제공된 암호문을 해독합니다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringKMS에 의해 암호화된 데이터vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
plaintext데이터키 (base64로 인코딩된 )dGhlIHF1aWNrIGJyb3duIGZveAo=

9.3.1.7 - Delete Key

9.3.1.7.1 - 1.1

scpcli kms kms delete
--key_id <value>
[--is_directly <value>]

Description

키를 지금 또는 나중에 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
is_directly
optional
boolean즉시삭제 여부True

9.3.1.7.2 - 1.0

scpcli kms kms delete
--key_id <value>
[--is_directly <value>]

Description

키를 지금 또는 나중에 삭제한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
is_directly
optional
boolean즉시삭제 여부True

9.3.1.8 - Encrypt Data

9.3.1.8.1 - 1.1

scpcli kms kms encrypt
--key_id <value>
--plaintext <value>

Description

제공된 일반 텍스트(base64 인코딩)를 키(용도:암호화/복호화)를 사용하여 암호화합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
plaintext
required
stringData(base64 encoded) to encryptdGhlIHF1aWNrIGJyb3duIGZveAo=

Responses

NameDescriptionExample
ciphertextKMS에 의해 암호화된 데이터vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionKMS 키 버전1

9.3.1.8.2 - 1.0

scpcli kms kms encrypt
--key_id <value>
--plaintext <value>

Description

제공된 일반 텍스트(base64 인코딩)를 키(용도:암호화/복호화)를 사용하여 암호화합니다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
plaintext
required
stringData(base64 encoded) to encryptdGhlIHF1aWNrIGJyb3duIGZveAo=

Responses

NameDescriptionExample
ciphertextKMS에 의해 암호화된 데이터vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionKMS 키 버전1

9.3.1.9 - List Keys

9.3.1.9.1 - 1.1

scpcli kms kms list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

키 리스트 조회하기

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string키 이름testkey

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
auto_rotate자동회전 Y 또는 NY
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_versionKMS키 현재 버전7
delete_atDate of deletion20251008
delete_target_yn키 삭제예정 여부Y
description키 설명description1
key_type기본 또는 고급advanced
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름testkey
next_rotate_at다음 회전일20241008
order_ref오더 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose키 용도rsa-2048
region리즌 이름kr-west1
rotate_cycle회전 주기7
secret_ref시크릿 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countKMS키 사용횟수1004

9.3.1.9.2 - 1.0

scpcli kms kms list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

키 리스트 조회하기

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string키 이름testkey

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
auto_rotate자동회전 Y 또는 NY
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_versionKMS키 현재 버전7
delete_atDate of deletion20251008
delete_target_yn키 삭제예정 여부Y
description키 설명description1
key_type기본 또는 고급advanced
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름testkey
next_rotate_at다음 회전일20241008
order_ref오더 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose키 용도rsa-2048
region리즌 이름kr-west1
rotate_cycle회전 주기7
secret_ref시크릿 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countKMS키 사용횟수1004

9.3.1.10 - List Users

9.3.1.10.1 - 1.1

scpcli kms kms list users
--key_id <value>

Description

키를 사용한 사람 목록을 보여준다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
user_id사용자 id138c2fc8c29a449dbfa8681f8f1d78e2
user_name사용자 이름kimsamsung

9.3.1.10.2 - 1.0

scpcli kms kms list users
--key_id <value>

Description

키를 사용한 사람 목록을 보여준다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
user_id사용자 id138c2fc8c29a449dbfa8681f8f1d78e2
user_name사용자 이름kimsamsung

9.3.1.11 - Make hmac

9.3.1.11.1 - 1.1

scpcli kms kms generate hmac
--key_id <value>
--input <value>

Description

HMAC 키를 사용해 생성합니다.( 용도: 생성/확인 )

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
hmacHMAC 데이터vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

9.3.1.11.2 - 1.0

scpcli kms kms generate hmac
--key_id <value>
--input <value>

Description

HMAC 키를 사용해 생성합니다.( 용도: 생성/확인 )

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
hmacHMAC 데이터vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

9.3.1.12 - Rewrap Data

9.3.1.12.1 - 1.1

scpcli kms kms rewrap
--key_id <value>
--ciphertext <value>

Description

최신 버전의 키(용도:암호화/복호화)를 사용하여 제공된 암호문을 다시 래핑합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringKMS에 의해 암호화된 데이터vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
ciphertextKMS에 의해 암호화된 재래핑할 데이터vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionKMS 키 버전1

9.3.1.12.2 - 1.0

scpcli kms kms rewrap
--key_id <value>
--ciphertext <value>

Description

최신 버전의 키(용도:암호화/복호화)를 사용하여 제공된 암호문을 다시 래핑합니다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringKMS에 의해 암호화된 데이터vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
ciphertextKMS에 의해 암호화된 재래핑할 데이터vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionKMS 키 버전1

9.3.1.13 - Rotate Key

9.3.1.13.1 - 1.1

scpcli kms kms rotate
--key_id <value>

Description

키를 회전한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
auto_rotate자동회전 Y 또는 NY
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_versionKMS키 현재 버전7
delete_atDate of deletion20251008
delete_target_yn키 삭제예정 여부Y
description키 설명description1
key_type기본 또는 고급advanced
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름testkey
next_rotate_at다음 회전일20241008
order_ref오더 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose키 용도rsa-2048
region리즌 이름kr-west1
rotate_cycle회전 주기7
secret_ref시크릿 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countKMS키 사용횟수1004

9.3.1.13.2 - 1.0

scpcli kms kms rotate
--key_id <value>

Description

키를 회전한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
auto_rotate자동회전 Y 또는 NY
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_versionKMS키 현재 버전7
delete_atDate of deletion20251008
delete_target_yn키 삭제예정 여부Y
description키 설명description1
key_type기본 또는 고급advanced
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름testkey
next_rotate_at다음 회전일20241008
order_ref오더 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose키 용도rsa-2048
region리즌 이름kr-west1
rotate_cycle회전 주기7
secret_ref시크릿 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countKMS키 사용횟수1004

9.3.1.14 - Show Key

9.3.1.14.1 - 1.1

scpcli kms kms show
--key_id <value>

Description

키 정보를 보여준다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
auto_rotate자동회전 Y 또는 NY
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_versionKMS키 현재 버전7
delete_atDate of deletion20251008
delete_target_yn키 삭제예정 여부Y
description키 설명description1
key_type기본 또는 고급advanced
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름testkey
next_rotate_at다음 회전일20241008
order_ref오더 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose키 용도rsa-2048
region리즌 이름kr-west1
rotate_cycle회전 주기7
secret_ref시크릿 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countKMS키 사용횟수1004

9.3.1.14.2 - 1.0

scpcli kms kms show
--key_id <value>

Description

키 정보를 보여준다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
auto_rotate자동회전 Y 또는 NY
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
current_versionKMS키 현재 버전7
delete_atDate of deletion20251008
delete_target_yn키 삭제예정 여부Y
description키 설명description1
key_type기본 또는 고급advanced
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름testkey
next_rotate_at다음 회전일20241008
order_ref오더 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose키 용도rsa-2048
region리즌 이름kr-west1
rotate_cycle회전 주기7
secret_ref시크릿 참조0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countKMS키 사용횟수1004

9.3.1.15 - Sign Data

9.3.1.15.1 - 1.1

scpcli kms kms sign
--key_id <value>
--input <value>

Description

키(용도:서명/검증)를 사용하여 주어진 데이터의 암호화 서명을 반환합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for SignaturedGVzdCBpbnB1dA==

Responses

NameDescriptionExample
key_versionKMS 키 버전1
signature확인을 위한 시그니쳐vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

9.3.1.15.2 - 1.0

scpcli kms kms sign
--key_id <value>
--input <value>

Description

키(용도:서명/검증)를 사용하여 주어진 데이터의 암호화 서명을 반환합니다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for SignaturedGVzdCBpbnB1dA==

Responses

NameDescriptionExample
key_versionKMS 키 버전1
signature확인을 위한 시그니쳐vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

9.3.1.16 - Update Description

9.3.1.16.1 - 1.1

scpcli kms kms update description
--key_id <value>
--description <value>

Description

설명을 업데이트한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
description
required
string키 설명-

9.3.1.16.2 - 1.0

scpcli kms kms update description
--key_id <value>
--description <value>

Description

설명을 업데이트한다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
description
required
string키 설명-

9.3.1.17 - Verify Data

9.3.1.17.1 - 1.1

scpcli kms kms verify
--key_id <value>
--signature <value>
--input <value>

Description

제공된 서명이 서명 데이터 중 하나에서 지정된 데이터에 대해 유효한지 여부를 키(용도:서명/검증)를 사용해 반환합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
signature
required
string확인을 위한 시그니쳐vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
valid확인결과True

9.3.1.17.2 - 1.0

scpcli kms kms verify
--key_id <value>
--signature <value>
--input <value>

Description

제공된 서명이 서명 데이터 중 하나에서 지정된 데이터에 대해 유효한지 여부를 키(용도:서명/검증)를 사용해 반환합니다.

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
signature
required
string확인을 위한 시그니쳐vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
valid확인결과True

9.3.1.18 - Verify hmac with input

9.3.1.18.1 - 1.1

scpcli kms kms verify hmac
--key_id <value>
--input <value>
--hmac <value>

Description

INPUT이 유효한지 아닌지 키를 사용해 확인합니다(용도: 생성/확인)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==
hmac
required
string확인을 위한 시그니쳐vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

Responses

NameDescriptionExample
valid확인결과True

9.3.1.18.2 - 1.0

scpcli kms kms verify hmac
--key_id <value>
--input <value>
--hmac <value>

Description

INPUT이 유효한지 아닌지 키를 사용해 확인합니다(용도: 생성/확인)

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringKMS 키 자원 아이디138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==
hmac
required
string확인을 위한 시그니쳐vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

Responses

NameDescriptionExample
valid확인결과True

9.4 - Secret Vault

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Secret Vault에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

9.4.1 - CLIs

9.4.1.1 - Create Secret Vault

9.4.1.1.1 - 1.0

scpcli secretvault sv create
--vault_token_ttl_ndays <value>
--temporary_key_ttl_nhours <value>
--name <value>
--acl_cidr <value>
--access_key_id <value>
[--description <value>]
[--tags <value>]

Description

시크릿볼트 생성.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
vault_token_ttl_ndays
required
integer볼트 토큰 유효시간720
temporary_key_ttl_nhours
required
integer임시키 유효 시간3
name
required
string시크릿볼트 아이디name
acl_cidr
required
string접근제한을 위한 CIDR192.168.1.1/24, 10.0.0.1/16
access_key_id
required
stringAccess key IDb754b12b39da4ce29a40c5e324650bd0
description
optional
stringDescriptiondescription
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key_idAccess key ID0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeaccess key 유형Temporary
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidr접근제한을 위한 CIDR192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescriptiondescription
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름vaultkey
temporary_key_ttl_nhours임시키 유효 시간36
user_name사용자명username
vault_token_expired_at볼트 토큰 만료일2025-02-25 03:07:17.000
vault_token_id볼트토큰 아이디aace85da-965e-d95a-b4ed-8d32b5d6079
vault_token_secret_value볼트토큰 시크릿6171392c-5fd9-43db-9e15-e14af0068f96
vault_token_ttl_ndays볼트 토큰 유효시간10
vaultkey_state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_type볼트키 타입SCP Open API Key
waiting_time_ndays삭제까지 남은 일수10

9.4.1.2 - Delete Secret Vault

9.4.1.2.1 - 1.0

scpcli secretvault sv delete
--secret_vault_id <value>
--waiting_time_ndays <value>

Description

시크릿볼트 상태는 To be terminated 가 아닙니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_vault_id
required
string시크릿볼트 아이디3265ab469f0d406d83073da3e11e7a6c
waiting_time_ndays
required
integer삭제까지 남은 일수7

9.4.1.3 - List Secret Vaults

9.4.1.3.1 - 1.0

scpcli secretvault sv list

Description

시크릿볼트 리스트 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key_idAccess key ID0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeaccess key 유형Temporary
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidr접근제한을 위한 CIDR192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescriptiondescription
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름vaultkey
temporary_key_ttl_nhours임시키 유효 시간36
user_name사용자명username
vault_token_expired_at볼트 토큰 만료일2025-02-25 03:07:17.000
vault_token_id볼트토큰 아이디[AES] SZtB6RasvLypCv4soJlQO3ZmYpUPjFblz7pstjBeTQJXcz/d5KB9TUR3gMY08mga4fxWaF6IfUzTMBh6j/CAaw==
vault_token_secret_value볼트토큰 시크릿[AES] 91/kdnK4NDfs2HGWgNH/EYNnqD7OcM1unXWs0ZAuaFttIqgP8xMUx0dOaRfD6kOD7uuujFxF2nzx35D9Gz9nwQ==
vault_token_ttl_ndays볼트 토큰 유효시간10
vaultkey_state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_type볼트키 타입SCP Open API Key
waiting_time_ndays삭제까지 남은 일수10

9.4.1.4 - Show Secret Vault

9.4.1.4.1 - 1.0

scpcli secretvault sv show
--secret_vault_id <value>

Description

시크릿볼트 조회.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_vault_id
required
string시크릿볼트 아이디3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key삼성 클라우드 플랫폼 포털에서 발급받은 Access Key[‘0e3*****************************’]
access_key_idAccess key ID0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeaccess key 유형[‘Temporary’, ‘Permanent’]
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidr접근제한을 위한 CIDR192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
description키 설명description
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름[‘vaultkey’]
temp_key_expired_at임시키 만료일2025-02-25 03:07:17.000
temporary_key_ttl_nhours임시키 유효 시간[‘36’]
vault_token_expired_at볼트 토큰 만료일2025-02-25 03:07:17.000
vault_token_id볼트토큰 아이디aace85da-965e-d95a-b4ed-8d32b5d6079
vault_token_secret_value볼트토큰 시크릿6171392c-5fd9-43db-9e15-e14af0068f96
vault_token_ttl_ndays볼트 토큰 유효시간[‘10’]
vaultkey_state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_type볼트키 타입[‘SCP Open API Key’]
waiting_time_ndays삭제까지 남은 일수10

9.5 - Secrets Manager

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Secrets Manager에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

9.5.1 - CLIs

9.5.1.1 - Create Secret

9.5.1.1.1 - 1.0

scpcli secretsmanager secret create
--secret_value <value>
--name <value>
--kms_id <value>
--acl_cidr <value>
[--description <value>]
[--tags <value>]

Description

Secret 을 생성합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_value
required
stringThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{"key1":"value1","key2":"value2"}
name
required
stringSecret 이름name
kms_id
required
stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required
stringSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
description
optional
stringSecret 설명description
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidrSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionSecret 설명description
kms_idKey Management Service 상품에서 생성한 자원 ID3265ab469f0d406d83073da3e11e7a6c
kms_nameKMS 키 이름kmsname
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름my-secret-name
recent_searched_at최근 검색일2025-02-25 03:07:17.000
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeSecret 타입General

9.5.1.2 - Delete Secret

9.5.1.2.1 - 1.0

scpcli secretsmanager secret delete
--secret_id <value>
--waiting_time_ndays <value>

Description

Secret을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
waiting_time_ndays
required
integer삭제까지 남은 일수7

9.5.1.3 - Generate Random Password

9.5.1.3.1 - 1.0

scpcli secretsmanager generate random password
[--exclude_characters <value>]
[--exclude_lowercase <value>]
[--exclude_numbers <value>]
[--exclude_punctuation <value>]
[--exclude_uppercase <value>]
[--include_space <value>]
[--password_length <value>]
[--require_each_included_type <value>]

Description

임의 비밀번호 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
exclude_characters
optional
string비밀번호 생성 시 제외할 문자들abcdefg
exclude_lowercase
optional
boolean소문자 제외 옵션false
exclude_numbers
optional
boolean숫자 제외 옵션false
exclude_punctuation
optional
boolean특수문자 제외 옵션false
exclude_uppercase
optional
boolean대문자 제외 옵션false
include_space
optional
boolean공백 포함 옵션false
password_length
optional
integer생성할 비밀번호의 길이32
require_each_included_type
optional
boolean포함된 모든 문자 유형 필수 요구true

Responses

NameDescriptionExample
random_password임의 비밀번호 생성random-value

9.5.1.4 - List Secrets

9.5.1.4.1 - 1.0

scpcli secretsmanager secret list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]

Description

Secret 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringSecret 이름name
state
optional
arraySecret 상태A

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidrSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionSecret 설명description
kms_idKey Management Service 상품에서 생성한 자원 ID3265ab469f0d406d83073da3e11e7a6c
kms_nameKMS 키 이름kmsname
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름my-secret-name
recent_searched_at최근 검색일2025-02-25 03:07:17.000
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeSecret 타입General

9.5.1.5 - List Versions of Secret

9.5.1.5.1 - 1.0

scpcli secretsmanager secret list version
--secret_id <value>

Description

Secrets 버전 리스트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
version_list

9.5.1.6 - Restore Secret

9.5.1.6.1 - 1.0

scpcli secretsmanager secret restore
--secret_id <value>

Description

Secret 삭제 절차를 취소한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c

9.5.1.7 - Set CIDR of Secret

9.5.1.7.1 - 1.0

scpcli secretsmanager secret set cidr
--secret_id <value>
--acl_cidr <value>

Description

Secret의 Value 조회 접근제어를 위한 IP CIDR 값을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required
stringSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16

9.5.1.8 - Set Description of Secret

9.5.1.8.1 - 1.0

scpcli secretsmanager secret set description
--secret_id <value>
--description <value>

Description

Secret의 설명값을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
description
required
stringSecret 설명description

9.5.1.9 - Set KMS ID of Secret

9.5.1.9.1 - 1.0

scpcli secretsmanager secret set kmsid
--secret_id <value>
--kms_id <value>

Description

Secret Value 암호화에 사용한 KMS ID 를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
kms_id
required
stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c

9.5.1.10 - Set Label of Version

9.5.1.10.1 - 1.0

scpcli secretsmanager secret update label
--secret_id <value>
--label <value>
[--move_to_version_id <value>]
[--remove_from_version_id <value>]

Description

Version 에 라벨을 추가/이동/삭제합니다. move_to_version_id 값만 사용하는 경우 라벨이 추가되고, remove_from_version_id 값만 사용하는경우 라벨이 제거됩니다. 둘다 사용하는경우, remove_from_version_id 의 라벨값이 move_to_version_id로 이동합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
label
required
stringSecret 버전 라벨. 중복 불가.My Custom Label
move_to_version_id
optional
stringSecret 버전 아이디3265ab469f0d406d83073da3e11e7a6c
remove_from_version_id
optional
stringSecret 버전 아이디3265ab469f0d406d83073da3e11e7a6c

9.5.1.11 - Show Secret Detail

9.5.1.11.1 - 1.0

scpcli secretsmanager secret show
--secret_id <value>

Description

Secret 상세정보 보기

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id계정 id3265ab469f0d406d83073da3e11e7a6c
acl_cidrSecret 접근허용 CIDR 리스트192.168.1.1/24, 10.0.0.1/16
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionSecret 설명description
kms_idKey Management Service 상품에서 생성한 자원 ID3265ab469f0d406d83073da3e11e7a6c
kms_nameKMS 키 이름kmsname
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name키 이름my-secret-name
recent_searched_at최근 검색일2025-02-25 03:07:17.000
state키 상태(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeSecret 타입General

9.5.1.12 - Show Secret Value

9.5.1.12.1 - 1.0

scpcli secretsmanager secret show value
--secret_id <value>
[--label <value>]
[--version_id <value>]

Description

Secret value 보기

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
label
optional
stringSecret 버전 라벨. 중복 불가.CURRENT
version_id
optional
stringSecret 버전 아이디e7b638507d9f4feeb6032a22b7640bf7

Responses

NameDescriptionExample
secret_valueSecret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다.{“key1”:“value1”,“key2”:“value2”}

9.5.1.13 - Update Secret Value

9.5.1.13.1 - 1.0

scpcli secretsmanager secret update value
--secret_id <value>
--secret_value <value>

Description

Secret value 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret 아이디3265ab469f0d406d83073da3e11e7a6c
secret_value
required
stringThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{"key1":"value1","key2":"value2"}

10 - Management

10.1 - Cloud Control

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 CloudControl 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

10.1.1 - CLIs

10.1.1.1 - AddBaselineAssignment

10.1.1.1.1 - 1.0

scpcli cloudcontrol baseline assignment add
--assignment_id <value>
--resource_type <value>
--landing_zone_id <value>
[--agree_yn <value>]
[--parent_unit_id <value>]
[--sso_user_name <value>]
[--sso_user_real_name <value>]

Description

add a new baseline assignment

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
assignment_id
required
string루트/조직 단위/계정 IDou-b30e9fcc39f84a20bf9e7458e5ec3801
resource_type
required
stringOU/ACCOUNTOU
landing_zone_id
required
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681
agree_yn
optional
****약관 동의 여부Y
parent_unit_id
optional
stringROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
sso_user_name
optional
stringID Center 사용자명testuser
sso_user_real_name
optional
stringID Center 사용자 실명test user

Responses

NameDescriptionExample
job_idID0a36e0746dbf4908acf0357829701381
resource_id루트/조직 단위/계정 IDou-b30e9fcc39f84a20bf9e7458e5ec3801
resource_typeOU/ACCOUNTOU

10.1.1.2 - CreateAccountFactoryAccount

10.1.1.2.1 - 1.0

scpcli cloudcontrol account create from factory
--parent_unit_id <value>
--name <value>
--landing_zone_id <value>
[--email <value>]
[--sso_user_email <value>]
[--sso_user_name <value>]
[--sso_user_real_name <value>]

Description

create an account using account factory.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
parent_unit_id
required
string상위 조직 단위 IDou-b30e9fcc39f84a20bf9e7458e5ec3801
name
required
string계정명foo-account
landing_zone_id
required
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681
email
optional
string계정 이메일myaccount@example.com
sso_user_email
optional
stringID Center 사용자 이메일user_email@example.com
sso_user_name
optional
stringID Center 사용자 이름John Doe
sso_user_real_name
optional
stringID Center 사용자 실명John Doe

Responses

NameDescriptionExample
account_id조직 계정 IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
job_idID0a36e0746dbf4908acf0357829701381

10.1.1.3 - CreateLandingZone

10.1.1.3.1 - 1.0

scpcli cloudcontrol landing zone create
--sso_type <value>
--log_archive_login_id <value>
--log_archive_account_name <value>
--basic_ou_name <value>
--audit_login_id <value>
--audit_account_name <value>
--agree_yn <value>
--additional_ou_name <value>

Description

Create a landing zone

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
sso_type
required
stringAccount 액세스 구성ID_CENTER
log_archive_login_id
required
string로그인 IDlog-archive@samsung.com
log_archive_account_name
required
string로그 아카이브 계정명LOG_ARCHIVE
basic_ou_name
required
string기본 조직 단위명Security
audit_login_id
required
string로그인 IDaudit@samsung.com
audit_account_name
required
string감사 계정명AUDIT
agree_yn
required
string약관 동의 여부Y
additional_ou_name
required
string추가 조직 단위명Sandbox

Responses

NameDescriptionExample
job_idID0a36e0746dbf4908acf0357829701381
landing_zone_id랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681

10.1.1.4 - DeleteLandingZone

10.1.1.4.1 - 1.0

scpcli cloudcontrol landing zone delete
--landing_zone_id <value>

Description

Delete a landing zone

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
landing_zone_id
required
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681

10.1.1.5 - DisableGuardrailBindings

10.1.1.5.1 - 1.0

scpcli cloudcontrol guardrail disable
--unit_ids <value>
--guardrail_ids <value>
[--landing_zone_id <value>]

Description

disable guardrail bindings

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
unit_ids
required
array타겟 정보ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
guardrail_ids
required
array가드레일 목록 IDf98e76d54c32b10a9z8y7x6w5v4u3
landing_zone_id
optional
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681

10.1.1.6 - EnableGuardrailBindings

10.1.1.6.1 - 1.0

scpcli cloudcontrol guardrail enable
--unit_ids <value>
--guardrail_ids <value>
[--landing_zone_id <value>]

Description

enable guardrail bindings

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
unit_ids
required
array타겟 정보ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
guardrail_ids
required
array가드레일 목록 IDf98e76d54c32b10a9z8y7x6w5v4u3
landing_zone_id
optional
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681

Responses

NameDescriptionExample
error_codeerror codeCloudControl.AlreadyEnabledGuardrails
failed_caused실패 원인guardrail already enabled
guardrail_id가드레일 IDf98e76d54c32b10a9z8y7x6w5v4u3
unit_id타겟 IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5

10.1.1.7 - ListBaselineAssignments

10.1.1.7.1 - 1.0

scpcli cloudcontrol baseline assignment list
[--landing_zone_id <value>]
[--resource_type <value>]
[--assignment_id <value>]
[--status <value>]

Description

get baseline assignment list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
landing_zone_id
optional
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681
resource_type
optional
****OU/ACCOUNTOU
assignment_id
optional
string루트/조직 단위/계정 IDou-b30e9fcc39f84a20bf9e7458e5ec3801
status
optional
****상태REGISTRATION_FAILED

Responses

NameDescriptionExample
id루트/조직 단위/계정 IDou-b30e9fcc39f84a20bf9e7458e5ec3801
account_assigned_count등록된 계정 수3
account_count전체 계정 수4
ou_assigned_count등록된 조직 단위 수5
ou_count전체 조직 단위 수10
preventive_guardrail_activated_count활성화된 예방 가드레일 수8
sso_user_nameID Center 사용자명testuser
status상태REGISTERED
typeOU/ACCOUNTOU

10.1.1.8 - ListGuardrails

10.1.1.8.1 - 1.0

scpcli cloudcontrol guardrail list
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--exclude_unit_id <value>]
[--guidance <value>]
[--service_name <value>]
[--status <value>]

Description

get guardrails list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
landing_zone_id
optional
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string가드레일명foo-guardrail
exclude_unit_id
optional
string연결된(제외) 유닛 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
guidance
optional
string정책 가이드MANDATORY
service_name
optional
stringOrganizationiam
status
optional
string적용 상태ENABLED

Responses

NameDescriptionExample
id가드레일 ID2c8a138f8d78e1fc29a449dbfa8681
binding_ous
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
description가드레일 설명This is an example guardrail.
guidance정책 가이드MANDATORY
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
name가드레일명foo-guardrail
service_nameOrganizationiam
srn가드레일 SRNsrn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681
status적용 상태
type가드레일 유형PREVENTIVE

10.1.1.9 - ListGuardrailsForTarget

10.1.1.9.1 - 1.0

scpcli cloudcontrol target guardrail list
--target_id <value>
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

list guardrails for target

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
target_id
required
string타겟 IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
landing_zone_id
optional
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string가드레일명guardrail-example

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
guidance정책 가이드MANDATORY
link_types연결 유형{‘directed’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’}], ‘inherited’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’}]}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
name가드레일명foo-guardrail
service_nameOrganizationiam
type가드레일 유형PREVENTIVE

10.1.1.10 - ListTargetsForGuardrail

10.1.1.10.1 - 1.0

scpcli cloudcontrol guardrail target list
--target_type <value>
--guardrail_id <value>
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

list targets for guardrail

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
target_type
required
****타겟유형ACCOUNT
guardrail_id
required
string가드레일 IDf98e76d54c32b10a9z8y7x6w5v4u3
landing_zone_id
optional
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string타겟명ou-test

Responses

NameDescriptionExample
id조직 계정 IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
email계정 이메일score@samsung.com
name계정명score-account
parent_unit_idROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameROOT 또는 부모 조직 단위명parent-unit-name

10.1.1.11 - ShowGuardrail

10.1.1.11.1 - 1.0

scpcli cloudcontrol guardrail show
--guardrail_id <value>
[--landing_zone_id <value>]

Description

show a specific guardrail.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
guardrail_id
required
string가드레일 ID2c8a138f8d78e1fc29a449dbfa8681
landing_zone_id
optional
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681

Responses

NameDescriptionExample
id가드레일 ID2c8a138f8d78e1fc29a449dbfa8681
binding_ous
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
description가드레일 설명This is an example guardrail.
guidance정책 가이드MANDATORY
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
name가드레일명foo-guardrail
service_nameOrganizationiam
srn가드레일 SRNsrn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681
status적용 상태
type가드레일 유형PREVENTIVE

10.1.1.12 - ShowLandingZone

10.1.1.12.1 - 1.0

scpcli cloudcontrol landing zone show
--landing_zone_id <value>

Description

Show a landing zone

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
landing_zone_id
required
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681

Responses

NameDescriptionExample
id랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681
agree_yn약관 동의 여부Y
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
identity_center_idIdentity Center ID0xnw6g1xh2q5
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
region리전kr-west1
service_name서비스명Cloud Control
srn랜딩 존 SRNsrn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b
sso_typeAccount 액세스 구성ID_CENTER
status상태ACTIVE
version_id랜딩 존 버전1.0

10.1.1.13 - UpdateBaselineAssignment

10.1.1.13.1 - 1.0

scpcli cloudcontrol baseline assignment update
--assignment_id <value>
--landing_zone_id <value>
[--agree_yn <value>]

Description

update a specific baseline assignment.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
assignment_id
required
string루트/조직 단위/계정 IDou-b30e9fcc39f84a20bf9e7458e5ec3801
landing_zone_id
required
string랜딩 존 ID2c8a138f8d78e1fc29a449dbfa8681
agree_yn
optional
****약관 동의 여부Y

10.2 - Cloud Monitoring

Overview

None

Version

VersionStatusSupported Until
1.0DEPRECATED20260223

10.2.1 - CLIs

10.2.1.1 - CreateEventPolicy

10.2.1.1.1 - 1.0

scpcli cloudmonitoring event eventpolicy create
--value <value>
--comparisonoperator <value>
--minvalue <value>
--mincomparisonoperator <value>
--maxvalue <value>
--maxcomparisonoperator <value>
--thresholdtype <value>
--eventpolicystatisticstype <value>
--eventpolicystatisticsperiod <value>
--metrickey <value>
--islogmetric <value>
--ftcount <value>
--eventlevel <value>
--disableyn <value>
--productresourceid <value>
[--notificationrecipients <value>]
[--eventmessageprefix <value>]
[--eventoccurtimezone <value>]
[--metricname <value>]
[--objectdisplayname <value>]
[--objectname <value>]
[--objecttype <value>]
[--podobjectdisplayname <value>]
[--podobjectname <value>]
[--metricfunction <value>]
--x-resourcetype <value>

Description

Create Event Policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
value
required
number10
comparisonoperator
required
string비교 연산자LT
minvalue
required
number최소 값80
mincomparisonoperator
required
string최소 비교 연산자GT
maxvalue
required
number최대 값90
maxcomparisonoperator
required
string최대 비교 연산자LT
thresholdtype
required
string임계치 유형 - 임계치를 범위로 지정할 경우에는 “RANGE_VALUE"를, 임계치를 단일값으로 지정할 경우에는 “SINGLE_VALUE” 지정해야 합니다.RANGE_VALUE
eventpolicystatisticstype
required
string이벤트 정책 통계 유형MAX
eventpolicystatisticsperiod
required
integer이벤트 정책 통계 기간 - 단위: 분10
metrickey
required
string메트릭 키system.diskio.read.bytes
islogmetric
required
string로그 메트릭 여부N
ftcount
required
integer결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값3
eventlevel
required
string이벤트 레벨WARNING
disableyn
required
stringswagger.event.eventPolicyResponse.disableYn.valueN
productresourceid
required
stringProduct Resource ID - Product Resource ID can be viewed using @[ListAccountResources].INSTANCE-c4Hsd27ttDaLw533X4B6Sp
notificationrecipients
optional
array이벤트 알림 수신인 정보 - 알림 대상자 정보는 10개까지 지정할 수 있습니다.'{"notificationMethods": [{"eventLevel": "FATAL", "notificationMethod": "", "sendMethod": ["MAIL"]}], "recipientKey": "1347", "recipientType": "USER"}'
eventmessageprefix
optional
string이벤트 메시지 접두사SCP
eventoccurtimezone
optional
stringswagger.event.eventPolicyResponse.eventOccurTimeZone.valueGMT+9
metricname
optional
string-
objectdisplayname
optional
string오브젝트 이름dm0
objectname
optional
string오브젝트 이름dm0
objecttype
optional
string개별항목 유형SCP
podobjectdisplayname
optional
stringswagger.event.eventPolicyResponse.podObjectDisplayName.valuedm0
podobjectname
optional
stringswagger.event.eventPolicyResponse.podObjectName.valuedm0
metricfunction
optional
string메트릭 함수 - 유효한 값: [delta] - 이벤트 발생 여부를 판단하기 위해 성능항목의 현재 값을 사용할지, 이전 값과 현재 값의 차이를 사용할지를 지정합니다. - 이전 값과 현재 값의 차이를 사용하고자 할 경우에만 delta로 지정합니다.delta
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
eventPolicyStatisticsPeriod이벤트 정책 통계 기간 - 단위: 분10
eventPolicyStatisticsType이벤트 정책 통계 유형MAX

10.2.1.2 - DeleteEventPolicy

10.2.1.2.1 - 1.0

scpcli cloudmonitoring event eventpolicy delete
--eventpolicyid <value>
--x-resourcetype <value>

Description

Delete Event policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
eventpolicyid
required
integerEvent policy ID to delete - Event Policy ID can be viewed using @[ListEventPolicies].7226
x-resourcetype
required
stringResource Type-

10.2.1.3 - ListAccountEvents

10.2.1.3.1 - 1.0

scpcli cloudmonitoring event accountevent list
--queryenddt <value>
--querystartdt <value>
--eventstate <value>
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Search Account Event List

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
queryenddt
required
stringQuery End Date2021-10-23T23:59:59.000Z
querystartdt
required
stringQuery Start Date2021-10-23T18:00:00.000Z
eventstate
required
stringEvent StateALL
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
durationSecond이벤트 지속 시간 - 단위: 초100
endDt종료일시2021-10-23T23:59:59Z
eventId이벤트 아이디
eventLevel이벤트 레벨FATAL
eventMessage이벤트 메시지
eventPolicyId이벤트 정책 아이디7240
eventStateEvent StateACTIVE
metricKey메트릭 키system.cpu.system.norm.pct
metricName메트릭 이름system.cpu.system.norm.pct
objectDisplayName오브젝트 이름CPU0
objectName오브젝트 이름CPU0
objectType개별항목 유형cluster
objectTypeName개별항목 유형 이름cluster
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
productTypeName상품 유형 이름Virtual Server
startDt시작일시2021-10-23T18:00:00Z

10.2.1.4 - ListAccountMember

10.2.1.4.1 - 1.0

scpcli cloudmonitoring product accountmember list
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Search members included in an Account.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
companyNameswagger.product.ProjectMemberDto.companyName.value삼성SDS
createdByswagger.product.ProjectMemberDto.createdBy.value469
createdByEmailswagger.product.ProjectMemberDto.createdByEmail.valuesoonshin.lee@cloud.com
createdByNameswagger.product.ProjectMemberDto.createdByName.value이순신
createdDtswagger.product.ProjectMemberDto.userTimezone.value2021-08-06T10:23:41.547Z
emailswagger.product.ProjectMemberDto.userEmail.valuekdhong@cloud.com
lastAccessDtswagger.product.ProjectMemberDto.lastAccessDt.value2022-11-06T10:23:41.547Z
modifiedByswagger.product.ProjectMemberDto.modifiedBy.value469
modifiedByEmailswagger.product.ProjectMemberDto.modifiedByEmail.valuesoonshin.lee@cloud.com
modifiedByNameswagger.product.ProjectMemberDto.modifiedByName.value이순신
modifiedDtswagger.product.ProjectMemberDto.modifiedDt.value2021-08-06T10:23:41.547Z
organizationIdswagger.product.ProjectMemberDto.organizationId.value
positionNameswagger.product.ProjectMemberDto.positionName.value프로
userGroupCountswagger.product.ProjectMemberDto.userGroupCount.value10
userIdswagger.product.ProjectMemberDto.userId.value1984
userNameswagger.product.ProjectMemberDto.userName.value홍길동

10.2.1.5 - ListAccountResources

10.2.1.5.1 - 1.0

scpcli cloudmonitoring product accountresource list
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search Resource included in an Account.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
accountId프로젝트 아이디UqXgOSnoqOfKB0_LKO6xId
endDt상품 삭제 일시9999-12-31T23:59:59.999Z
lastEventLevel최종 이벤트 레벨WARNING
poolName풀 이름POOL-A8-C1DpGqRdQMlfNXdJxLb
productIpAddress상품 IP주소192.168.245.161
productName상품 이름VM-Server-01
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productState상품 상태 - 유효한 값 : Running, DownRunning
productTypeCode상품 유형코드VM
productTypeName상품 유형이름Virtual Server
startDt상품 생성 일시2021-10-23T08:30:00Z

10.2.1.6 - ListAddressBookMembers

10.2.1.6.1 - 1.0

scpcli cloudmonitoring product addressbookmember list
--addrbookid <value>
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Search address book members

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
addrbookid
required
integerAddress book ID - Address book IDs can be obtained from @[ListAddressBooks].-
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
userEmail사용자 이메일kdhong@cloud.com
userId사용자 리소스 아이디1346
userLanguage사용자 언어ko
userMobileTelNo사용자 휴대전화번호010-0000-0000
userName사용자 이름홍길동
userTimezone사용자 타임존Asia/Seoul

10.2.1.7 - ListAddressBooks

10.2.1.7.1 - 1.0

scpcli cloudmonitoring product addressbook list
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Search a list of address books created by user.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
addrBookName주소록 이름contact name
addrbookId주소록 아이디74
createdBy생성자 아이디1984
createdByName생성자 이름김삼성
createdDt생성 일시2021-10-23T22:00:00Z
memberCount멤버 수10

10.2.1.8 - ListEventPolicies

10.2.1.8.1 - 1.0

scpcli cloudmonitoring event eventpolicy list
--productresourceid <value>
[--metrickey <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search Event Policies

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
productresourceid
required
stringProduct Resource ID - Product Resource ID can be viewed using @[ListAccountResources].c94607c8-6a15-4e13-84f3-99cb77d478e3
metrickey
optional
stringMetric Key - Metric Key can be viewed using @[ListMetrics].system.cpu.system.pct
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
checkAsg
createBy
createById
eventLevel이벤트 레벨WARNING
eventMessagePrefix이벤트 메시지 접두사SCP
eventOccurTimeZoneswagger.event.eventPolicyResponse.eventOccurTimeZone.valueGMT+9
eventPolicyId이벤트 정책 아이디7226
eventPolicyStatistics
eventThreshold
ftCount결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값3
isLogMetric로그 메트릭 여부N
metricDescription메트릭 설명커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
metricDescriptionEn메트릭 설명Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
metricKey메트릭 키system.cpu.system.pct
metricName메트릭 이름system.cpu.system.pct
objectName오브젝트 이름cpu0
productName상품 이름VM-002
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productSq상품 시퀀스7321
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
updateBy
updateById

10.2.1.9 - ListEventPolicyHistories

10.2.1.9.1 - 1.0

scpcli cloudmonitoring event eventpolicyhistory list
--eventpolicyid <value>
--queryenddt <value>
--querystartdt <value>
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search event policy histories

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
eventpolicyid
required
integerEvent Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies].7226
queryenddt
required
stringQuery End Date2021-10-23T23:59:59.000Z
querystartdt
required
stringQuery Start Date2021-10-23T18:00:00.000Z
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
createBy
createById
disableObjectswagger.event.eventPolicyResponse.disableObject.valueN
disableYnswagger.event.eventPolicyResponse.disableObject.valueN
eventLevel이벤트 레벨WARNING
eventMessagePrefix이벤트 메시지 접두사SCP
eventOccurTimeZoneswagger.event.eventPolicyResponse.eventOccurTimeZone.valueGMT+9
eventPolicyHistoryId이벤트 정책 이력 아이디8759
eventPolicyHistoryType이벤트 정책 이력 유형 - C : 등록, U : 수정, D : 삭제U
eventPolicyId이벤트 정책 아이디7240
eventPolicyStatistics
eventThreshold
ftCount결함허용 개수3
metricDescription메트릭 설명커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
metricDescriptionEn메트릭 설명Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
metricKey메트릭 키system.cpu.system.pct
metricName메트릭 이름system.cpu.system.pct
metricUnit메트릭 단위%
modifiedBy
modifiedByName
modifiedDt
notificationRecipientHistory
objectDisplayName오브젝트 이름cpu0
objectName오브젝트 이름cpu0
objectType개별항목 유형cluster
productName상품 이름VM-Server-01
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
updateBy
updateById

10.2.1.10 - ListEventPolicyNotification

10.2.1.10.1 - 1.0

scpcli cloudmonitoring event eventpolicynotification list
--eventpolicyid <value>
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search Event Policy Notification

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
eventpolicyid
required
integerEvent Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies].7226
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
addrbookAdditionalInfo
notificationMethods알림 메소드 정보
recipientKey수신인 키 - 수신인 키는 @[프로젝트 멤버 조회] 또는 @[사용자의 주소록 목록 조회]를 이용하여 조회합니다.1984
recipientName수신인 이름홍길동
recipientType수신인 유형 - USER : 사용자, ADDRBOOK : 주소록USER
userAdditionalInfo

10.2.1.11 - ListMetricPefData

10.2.1.11.1 - 1.0

scpcli cloudmonitoring product metricperfdata list
--querystartdt <value>
--queryenddt <value>
--metricdataconditions <value>
[--ignoreinvalid <value>]
--x-resourcetype <value>

Description

Search the performance values of the collected metrics. Up to 10 query conditions can be specified, and the maximum query period is 24 hours.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
querystartdt
required
string조회 시작 일시2022-08-07T23:50:00.000Z
queryenddt
required
string조회 종료 일시2022-08-07T23:59:00.000Z
metricdataconditions
required
array메트릭 데이터 조건'{"metricKey": "system.diskio.read.bytes", "objectType": "replicaset", "productResourceInfos": [{"objectList": ["kube-01", "kube-02"], "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp"}], "statisticsPeriod": 5, "statisticsTypeList": ["SUM", "MIN"]}'
ignoreinvalid
optional
string유효하지 않은 값 제외 여부Y
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
metricKey메트릭 키system.filesystem.used.bytes
metricName메트릭 이름system.filesystem.used.bytes
metricType메트릭 유형NUM
metricUnit메트릭 단위bytes
objectDisplayName개별항목 출력 이름dm-1
objectName개별항목 이름dm-1
objectType개별항목 유형replicaset
perfData성능 데이터[{’time’: 1627378200000, ‘value’: ‘0.0766’}]
productName상품의 이름VM-Server-01
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
statisticsPeriod통계 집계 주기 (단위: 분)5
statisticsType통계 유형SUM

10.2.1.12 - ListMetrics

10.2.1.12.1 - 1.0

scpcli cloudmonitoring product metric list
[--producttypecode <value>]
[--objecttype <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

View the list of metrics provided by Monitoring. You can view the full list of metrics or the list of metrics for each service type.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
producttypecode
optional
stringProduct type code - Product type codes can be obtained using @[ListServiceMonitoring]. If not specified, the entire metric list will be retrieved.VM
objecttype
optional
stringObject Type - Only available for services that have subtypes, such as when the 'productTypeCode' is 'Kubernetes' or 'Load Balancer'.node
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
disableObjectswagger.product.MetricInfoDto.disableObject.valueN
displayUnit
fixedUnit메트릭 단위 (고정)sec
isLogMetric로그 메트릭 여부N
isObjectExist개별항목 성능 존재 여부Y
metricDescription메트릭 설명커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
metricDescriptionEn메트릭 설명Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
metricKey메트릭 키system.filesystem.used.bytes
metricName메트릭 이름FileSystem
metricOrder메트릭 순서1
metricSetKeyswagger.product.MetricInfoDto.metricSetKey.valuesystem.filesystem
metricSetName메트릭 세트 이름FileSystem
metricType메트릭 유형NUM
metricUnit메트릭 단위bytes
objectKeyName오브젝트 키 이름system.core.iowait.pct
objectTypeswagger.product.MetricInfoDto.disableObject.valueN
objectTypeNameEngswagger.product.MetricInfoDto.disableObject.valueN
objectTypeNameLocswagger.product.MetricInfoDto.disableObject.valueN
perfTitleswagger.product.MetricInfoDto.perfTitle.valueFile System
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
productTypeCode상품 유형 코드VM
productTypeName상품 유형 이름Virtual Server

10.2.1.13 - ListResourceEvents

10.2.1.13.1 - 1.0

scpcli cloudmonitoring event resourceevent list
--queryenddt <value>
--querystartdt <value>
--eventstate <value>
--productresourceid <value>
[--metrickey <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search a list of events that occurred on a product resource.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
queryenddt
required
stringQuery End Date2021-10-23T23:59:59.000Z
querystartdt
required
stringQuery Start Date2021-10-23T18:00:00.000Z
eventstate
required
stringEvent StateALL
productresourceid
required
stringProduct Resource ID - Product Resource ID can be viewed using @[ListAccountResources].INSTANCE-c4Hsd27ttDaLw533X4B6Sp
metrickey
optional
stringMetric Key - Metric Key can be viewed using @[ListMetrics].system.cpu.system.pct
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
durationSecond이벤트 지속 시간 - 단위: 초100
endDt종료일시2021-10-23T23:59:59Z
eventId이벤트 아이디
eventLevel이벤트 레벨FATAL
eventMessage이벤트 메시지
eventPolicyId이벤트 정책 아이디7240
eventStateEvent StateACTIVE
metricKey메트릭 키system.cpu.system.norm.pct
metricName메트릭 이름system.cpu.system.norm.pct
objectDisplayName오브젝트 이름CPU0
objectName오브젝트 이름CPU0
objectType개별항목 유형cluster
objectTypeName개별항목 유형 이름cluster
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
productTypeName상품 유형 이름Virtual Server
startDt시작일시2021-10-23T18:00:00Z

10.2.1.14 - ListService

10.2.1.14.1 - 1.0

scpcli cloudmonitoring product service list
[--productcategorycode <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Search a list of product types supported by monitoring.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
productcategorycode
optional
stringProduct type category - If not specified, the entire product type code will be retrieved.Compute
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
parentProductTypeName부모 상품 이름Compute
productTypeCode상품 코드VM
productTypeName상품 이름Virtual Server
stateMetricKey상태 메트릭 키vsphere.mxvm.runtime.state

10.2.1.15 - SetEventPolicy

10.2.1.15.1 - 1.0

scpcli cloudmonitoring event eventpolicy set
--eventpolicyid <value>
--value <value>
--comparisonoperator <value>
--minvalue <value>
--mincomparisonoperator <value>
--maxvalue <value>
--maxcomparisonoperator <value>
--thresholdtype <value>
--eventpolicystatisticstype <value>
--eventpolicystatisticsperiod <value>
--ftcount <value>
--eventlevel <value>
--disableyn <value>
[--notificationrecipients <value>]
[--eventmessageprefix <value>]
[--eventoccurtimezone <value>]
[--objectdisplayname <value>]
[--objectname <value>]
[--objecttype <value>]
[--podobjectdisplayname <value>]
[--podobjectname <value>]
[--metricfunction <value>]
--x-resourcetype <value>

Description

Set Event Policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
eventpolicyid
required
integerEvent policy ID to modify - Event Policy ID can be viewed using @[ListEventPolicies].7226
value
required
number10
comparisonoperator
required
string비교 연산자LT
minvalue
required
number최소 값80
mincomparisonoperator
required
string최소 비교 연산자GT
maxvalue
required
number최대 값90
maxcomparisonoperator
required
string최대 비교 연산자LT
thresholdtype
required
string임계치 유형 - 임계치를 범위로 지정할 경우에는 “RANGE_VALUE"를, 임계치를 단일값으로 지정할 경우에는 “SINGLE_VALUE” 지정해야 합니다.RANGE_VALUE
eventpolicystatisticstype
required
string이벤트 정책 통계 유형MAX
eventpolicystatisticsperiod
required
integer이벤트 정책 통계 기간 - 단위: 분10
ftcount
required
integer결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값3
eventlevel
required
string이벤트 레벨WARNING
disableyn
required
stringswagger.event.eventPolicyResponse.disableYn.valueN
notificationrecipients
optional
array이벤트 알림 수신인 정보'{"notificationMethods": [{"eventLevel": "FATAL", "notificationMethod": "", "sendMethod": ["MAIL"]}], "recipientKey": "1347", "recipientType": "USER"}'
eventmessageprefix
optional
string이벤트 메시지 접두사SCP
eventoccurtimezone
optional
stringswagger.event.eventPolicyResponse.eventOccurTimeZone.valueGMT+9
objectdisplayname
optional
string오브젝트 이름cpu0
objectname
optional
string오브젝트 이름cpu0
objecttype
optional
string개별항목 유형cluster
podobjectdisplayname
optional
stringswagger.event.eventPolicyResponse.podObjectName.valuecpu0
podobjectname
optional
stringswagger.event.eventPolicyResponse.podObjectName.valuecpu0
metricfunction
optional
string메트릭 함수 - 유효한 값: [delta] - 이벤트 발생 여부를 판단하기 위해 성능항목의 현재 값을 사용할지, 이전 값과 현재 값의 차이를 사용할지를 지정합니다. - 이전 값과 현재 값의 차이를 사용하고자 할 경우에만 delta로 지정합니다.delta
x-resourcetype
required
stringResource Type-

10.2.1.16 - ShowEventNotificationStates

10.2.1.16.1 - 1.0

scpcli cloudmonitoring event eventnotificationstate show
--eventid <value>
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search Event Notification States

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
eventid
required
stringEvent ID - Event ID can be viewed using @[ListResourceEvents].-
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
notificationStates이벤트 알림 상태
user
userEmail사용자 이메일kdhong@cloud.com
userId사용자 아이디1984
userMobileTelNo사용자 휴대 전화번호010-000-0000
userNameNotification사용자 이름홍길동

10.2.1.17 - ShowEventPolicy

10.2.1.17.1 - 1.0

scpcli cloudmonitoring event eventpolicy show
--eventpolicyid <value>
--x-resourcetype <value>

Description

Show Event Policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
eventpolicyid
required
integerEvent Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies].7226
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
eventPolicyStatisticsPeriod이벤트 정책 통계 기간 - 단위: 분10
eventPolicyStatisticsType이벤트 정책 통계 유형MAX

10.2.1.18 - ShowResourceEvent

10.2.1.18.1 - 1.0

scpcli cloudmonitoring event resourceevent show
--eventid <value>
--x-resourcetype <value>

Description

Show Resource Event

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.020260701

Parameters

NameTypeDescriptionExample
eventid
required
stringEvent ID - Event ID can be viewed using @[ListResourceEvents].-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
checkAsg
createBy
createById
eventLevel이벤트 레벨WARNING
eventMessagePrefix이벤트 메시지 접두사SCP
eventOccurTimeZoneswagger.event.eventPolicyResponse.eventOccurTimeZone.valueGMT+9
eventPolicyId이벤트 정책 아이디7226
eventPolicyStatistics
eventThreshold
ftCount결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값3
isLogMetric로그 메트릭 여부N
metricDescription메트릭 설명커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
metricDescriptionEn메트릭 설명Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
metricKey메트릭 키system.cpu.system.pct
metricName메트릭 이름system.cpu.system.pct
objectName오브젝트 이름cpu0
productName상품 이름VM-002
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productSq상품 시퀀스7321
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
updateBy
updateById

10.3 - IAM

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 IAM 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20260223
1.1SUPPORTED20260531
1.2CURRENT-

10.3.1 - CLIs

10.3.1.1 - Add a permission into the resource based policy

10.3.1.1.1 - 1.2

scpcli iam permission add
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Add a permission into the resource based policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

Responses

NameDescriptionExample
StatementStatement{‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’}

10.3.1.1.2 - 1.1

scpcli iam permission add
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Add a permission into the resource based policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

Responses

NameDescriptionExample
StatementStatement{‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’}

10.3.1.1.3 - 1.0

scpcli iam permission add
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Add a permission into the resource based policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

Responses

NameDescriptionExample
StatementStatement{‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’}

10.3.1.2 - Add a user to a group

10.3.1.2.1 - 1.2

scpcli iam group user add
--group_id <value>
--user_id <value>

Description

Add a user to a group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
user_id
required
stringGroup Member User IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
user_emailUser Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_nameUser 성, 이름Kim Samsung

10.3.1.2.2 - 1.1

scpcli iam group user add
--group_id <value>
--user_id <value>

Description

Add a user to a group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
user_id
required
stringGroup Member User IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
user_emailUser Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_nameUser 성, 이름Kim Samsung

10.3.1.2.3 - 1.0

scpcli iam group user add
--group_id <value>
--user_id <value>

Description

Add a user to a group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
user_id
required
stringGroup Member User IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
user_emailUser Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_nameUser 성, 이름Kim Samsung

10.3.1.3 - Assign policies to the group

10.3.1.3.1 - 1.2

scpcli iam group policy create
--group_id <value>
--policy_ids <value>

Description

Assign policies to the group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
policy_ids
required
arrayPolicy ID List37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.3.2 - 1.1

scpcli iam group policy create
--group_id <value>
--policy_ids <value>

Description

Assign policies to the group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
policy_ids
required
arrayPolicy ID List37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.3.3 - 1.0

scpcli iam group policy create
--group_id <value>
--policy_ids <value>

Description

Assign policies to the group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
policy_ids
required
arrayPolicy ID List37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.4 - Assign policies to user

10.3.1.4.1 - 1.2

scpcli iam user policy create
--user_id <value>
[--policy_ids <value>]

Description

Assign policies to user

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 ID-
policy_ids
optional
arrayUser Policy Bindings-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.4.2 - 1.1

scpcli iam user policy create
--user_id <value>
[--policy_ids <value>]

Description

Assign policies to user

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 ID-
policy_ids
optional
arrayUser Policy Bindings-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.4.3 - 1.0

scpcli iam user policy create
--user_id <value>
[--policy_ids <value>]

Description

Assign policies to user

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 ID-
policy_ids
optional
arrayUser Policy Bindings-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.5 - Attach policies to Role

10.3.1.5.1 - 1.2

scpcli iam role policy binding attach
--role_id <value>
--policy_ids <value>

Description

Attach policies to Role

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
policy_ids
required
arrayPolicy ID List-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.5.2 - 1.1

scpcli iam role policy binding attach
--role_id <value>
--policy_ids <value>

Description

Attach policies to Role

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
policy_ids
required
arrayPolicy ID List-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.5.3 - 1.0

scpcli iam role policy binding attach
--role_id <value>
--policy_ids <value>

Description

Attach policies to Role

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
policy_ids
required
arrayPolicy ID List-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.6 - Create a group

10.3.1.6.1 - 1.2

scpcli iam group create
--name <value>
--description <value>
[--policy_ids <value>]
[--tags <value>]
[--user_ids <value>]

Description

Create a group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringGroup 이름TestGroup
description
required
stringGroup 설명Descriptions for group
policy_ids
optional
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d
tags
optional
arrayGroup Tag{'key': 'company', 'value': 'SDS'}
user_ids
optional
arrayGroup Member User ID Listf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
descriptionGroup 설명Descriptions for group
domain_name도메인 이름scp
membersProject Group Member List
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
nameGroup 이름TestGroup
policiesPolicy[]
resource_type리소스 명group
rolesRole 정보[]
service_name서비스 Display 명Identity Access Management
service_type서비스 명iam
srnGroup SRNsrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypeUSER_DEFINED

10.3.1.6.2 - 1.1

scpcli iam group create
--name <value>
--description <value>
[--policy_ids <value>]
[--tags <value>]
[--user_ids <value>]

Description

Create a group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
name
required
stringGroup 이름TestGroup
description
required
stringGroup 설명Descriptions for group
policy_ids
optional
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d
tags
optional
arrayGroup Tag{'key': 'company', 'value': 'SDS'}
user_ids
optional
arrayGroup Member User ID Listf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
descriptionGroup 설명Descriptions for group
domain_name도메인 이름scp
membersProject Group Member List
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
nameGroup 이름TestGroup
policiesPolicy[]
resource_type리소스 명group
rolesRole 정보[]
service_name서비스 Display 명Identity Access Management
service_type서비스 명iam
srnGroup SRNsrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypeUSER_DEFINED

10.3.1.6.3 - 1.0

scpcli iam group create
--name <value>
--description <value>
[--policy_ids <value>]
[--tags <value>]
[--user_ids <value>]

Description

Create a group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
name
required
stringGroup 이름TestGroup
description
required
stringGroup 설명Descriptions for group
policy_ids
optional
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d
tags
optional
arrayGroup Tag{'key': 'company', 'value': 'SDS'}
user_ids
optional
arrayGroup Member User ID Listf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
descriptionGroup 설명Descriptions for group
domain_name도메인 이름scp
membersProject Group Member List
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
nameGroup 이름TestGroup
policiesPolicy[]
resource_type리소스 명group
rolesRole 정보[]
service_name서비스 Display 명Identity Access Management
service_type서비스 명iam
srnGroup SRNsrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypeUSER_DEFINED

10.3.1.7 - Create a policy

10.3.1.7.1 - 1.2

scpcli iam policy create
--version <value>
--statement <value>
--policy_name <value>
[--default_version_id <value>]
[--description <value>]
[--policy_category <value>]
[--policy_type <value>]
[--service_type <value>]
[--tags <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Create a policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_name
required
stringPolicy NamePolicyName
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_category
optional
stringPolicy CategoryIDENTITY_BASED
policy_type
optional
stringPolicy TypeUSER_DEFINED
service_type
optional
stringService Typescp-iam
tags
optional
arrayPolicy Tag{'key': 'foo', 'value': 'bar'}
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

10.3.1.7.2 - 1.1

scpcli iam policy create
--version <value>
--statement <value>
--policy_name <value>
[--default_version_id <value>]
[--description <value>]
[--policy_category <value>]
[--policy_type <value>]
[--service_type <value>]
[--tags <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Create a policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_name
required
stringPolicy NamePolicyName
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_category
optional
stringPolicy CategoryIDENTITY_BASED
policy_type
optional
stringPolicy TypeUSER_DEFINED
service_type
optional
stringService Typescp-iam
tags
optional
arrayPolicy Tag{'key': 'foo', 'value': 'bar'}
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

10.3.1.7.3 - 1.0

scpcli iam policy create
--version <value>
--statement <value>
--policy_name <value>
[--default_version_id <value>]
[--description <value>]
[--policy_category <value>]
[--policy_type <value>]
[--service_type <value>]
[--tags <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Create a policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_name
required
stringPolicy NamePolicyName
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_category
optional
stringPolicy CategoryIDENTITY_BASED
policy_type
optional
stringPolicy TypeUSER_DEFINED
service_type
optional
stringService Typescp-iam
tags
optional
arrayPolicy Tag{'key': 'foo', 'value': 'bar'}
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

10.3.1.8 - Create a saml provider

10.3.1.8.1 - 1.2

scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]

Description

Create a saml provider

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
saml_provider_name
required
string자격증명공급자 이름IdpTest
federation_type
required
string자격증명공급자 유형SAML
description
optional
string자격증명공급자 설명SAML provider Description
file
optional
string메타데이터 파일keycloak-idp-saml.xml
tags
optional
array태그{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
idp_cert_end유효기간
idp_file_name메타데이터 파일 이름
idp_file_size메타데이터 파일 크기
idp_issuer_url발행자 URL
idp_sso_urlSSO 서비스 위치
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자
saml_provider_name자격증명공급자 이름

10.3.1.8.2 - 1.1

scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]

Description

Create a saml provider

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
saml_provider_name
required
string자격증명공급자 이름IdpTest
federation_type
required
string자격증명공급자 유형SAML
description
optional
string자격증명공급자 설명SAML provider Description
file
optional
string메타데이터 파일keycloak-idp-saml.xml
tags
optional
array태그{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
idp_cert_end유효기간
idp_file_name메타데이터 파일 이름
idp_file_size메타데이터 파일 크기
idp_issuer_url발행자 URL
idp_sso_urlSSO 서비스 위치
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자
saml_provider_name자격증명공급자 이름

10.3.1.8.3 - 1.0

scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]

Description

Create a saml provider

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
saml_provider_name
required
string자격증명공급자 이름IdpTest
federation_type
required
string자격증명공급자 유형SAML
description
optional
string자격증명공급자 설명SAML provider Description
file
optional
string메타데이터 파일keycloak-idp-saml.xml
tags
optional
array태그{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
idp_cert_end유효기간
idp_file_name메타데이터 파일 이름
idp_file_size메타데이터 파일 크기
idp_issuer_url발행자 URL
idp_sso_urlSSO 서비스 위치
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자
saml_provider_name자격증명공급자 이름

10.3.1.9 - Create an access key

10.3.1.9.1 - 1.2

scpcli iam access-key create
--access_key_type <value>
[--account_id <value>]
[--description <value>]
[--duration <value>]
[--parent_access_key_id <value>]
[--passcode <value>]

Description

Create an access key

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
access_key_type
required
stringAccess key typePERMANENT
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
description
optional
stringDescriptiondescription
duration
optional
stringExpiration durationP1Y2M10DT2H30M15S
parent_access_key_id
optional
stringRequired access key for creating temporary access key92d6eid9e9ae4f868s842910k11573a3
passcode
optional
stringRequired for temporary access key000000

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess key typePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent access key ID which is used for temporary access key to create by92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

10.3.1.9.2 - 1.1

scpcli iam access-key create
--access_key_type <value>
[--account_id <value>]
[--description <value>]
[--duration <value>]
[--parent_access_key_id <value>]
[--passcode <value>]

Description

Create an access key

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
access_key_type
required
stringAccess key typePERMANENT
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
description
optional
stringDescriptiondescription
duration
optional
stringExpiration durationP1Y2M10DT2H30M15S
parent_access_key_id
optional
stringRequired access key for creating temporary access key92d6eid9e9ae4f868s842910k11573a3
passcode
optional
stringRequired for temporary access key000000

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess key typePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent access key ID which is used for temporary access key to create by92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

10.3.1.9.3 - 1.0

scpcli iam access-key create
--access_key_type <value>
[--account_id <value>]
[--description <value>]
[--duration <value>]
[--parent_access_key_id <value>]
[--passcode <value>]

Description

Create an access key

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
access_key_type
required
stringAccess key typePERMANENT
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
description
optional
stringDescriptiondescription
duration
optional
stringExpiration durationP1Y2M10DT2H30M15S
parent_access_key_id
optional
stringRequired access key for creating temporary access key92d6eid9e9ae4f868s842910k11573a3
passcode
optional
stringRequired for temporary access key000000

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess key typePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent access key ID which is used for temporary access key to create by92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

10.3.1.10 - Create IAM user

10.3.1.10.1 - 1.2

scpcli iam iam user create
--account_id <value>
--user_name <value>
--temporary_password <value>
--password <value>
[--description <value>]
[--group_ids <value>]
[--policy_ids <value>]
[--tags <value>]

Description

Create IAM user

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID-
user_name
required
string사용자 이름-
temporary_password
required
booleantemporary-
password
required
string비밀 번호-
description
optional
stringdescription-
group_ids
optional
arrayGroup IDs-
policy_ids
optional
arrayPolicy IDs-
tags
optional
arrayUser Tag-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.10.2 - 1.1

scpcli iam iam user create
--account_id <value>
--user_name <value>
--temporary_password <value>
--password <value>
[--description <value>]
[--group_ids <value>]
[--policy_ids <value>]
[--tags <value>]

Description

Create IAM user

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID-
user_name
required
string사용자 이름-
temporary_password
required
booleantemporary-
password
required
string비밀 번호-
description
optional
stringdescription-
group_ids
optional
arrayGroup IDs-
policy_ids
optional
arrayPolicy IDs-
tags
optional
arrayUser Tag-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.10.3 - 1.0

scpcli iam iam user create
--account_id <value>
--user_name <value>
--temporary_password <value>
--password <value>
[--description <value>]
[--group_ids <value>]
[--policy_ids <value>]
[--tags <value>]

Description

Create IAM user

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID-
user_name
required
string사용자 이름-
temporary_password
required
booleantemporary-
password
required
string비밀 번호-
description
optional
stringdescription-
group_ids
optional
arrayGroup IDs-
policy_ids
optional
arrayPolicy IDs-
tags
optional
arrayUser Tag-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.11 - Create role

10.3.1.11.1 - 1.2

scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]

Description

Create role

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_ids
required
array역할에 연결할 정책 ID 목록37f2e31ff86b415698d7e8eeafab445d
name
required
string역할명-
account_id
optional
string역할이 속한 계정의 ID-
description
optional
string역할 설명-
max_session_duration
optional
integer역할 세션 최대 지속 시간(초)3600
principals
optional
array신뢰 정책 수행 주체 목록'{"type": "", "value": ""}'
tags
optional
array역할 태그{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_id역할이 속한 계정의 ID
assume_role_policy_document역할 신뢰 정책
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Email
creator_name생성자 성, 이름
description역할 설명
max_session_duration역할 세션 최대 지속 시간(초)
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Email
modifier_name수정자 성, 이름
name역할명
policies역할에 연결된 정책 목록
type역할 유형

10.3.1.11.2 - 1.1

scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]

Description

Create role

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_ids
required
array역할에 연결할 정책 ID 목록37f2e31ff86b415698d7e8eeafab445d
name
required
string역할명-
account_id
optional
string역할이 속한 계정의 ID-
description
optional
string역할 설명-
max_session_duration
optional
integer역할 세션 최대 지속 시간(초)3600
principals
optional
array신뢰 정책 수행 주체 목록'{"type": "", "value": ""}'
tags
optional
array역할 태그{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_id역할이 속한 계정의 ID
assume_role_policy_document역할 신뢰 정책
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Email
creator_name생성자 성, 이름
description역할 설명
max_session_duration역할 세션 최대 지속 시간(초)
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Email
modifier_name수정자 성, 이름
name역할명
policies역할에 연결된 정책 목록
type역할 유형

10.3.1.11.3 - 1.0

scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]

Description

Create role

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_ids
required
array역할에 연결할 정책 ID 목록37f2e31ff86b415698d7e8eeafab445d
name
required
string역할명-
account_id
optional
string역할이 속한 계정의 ID-
description
optional
string역할 설명-
max_session_duration
optional
integer역할 세션 최대 지속 시간(초)3600
principals
optional
array신뢰 정책 수행 주체 목록'{"type": "", "value": ""}'
tags
optional
array역할 태그{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_id역할이 속한 계정의 ID
assume_role_policy_document역할 신뢰 정책
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Email
creator_name생성자 성, 이름
description역할 설명
max_session_duration역할 세션 최대 지속 시간(초)
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Email
modifier_name수정자 성, 이름
name역할명
policies역할에 연결된 정책 목록
type역할 유형

10.3.1.12 - Delete bulk role

10.3.1.12.1 - 1.2

scpcli iam role bulk delete
[--account_id <value>]
[--role_ids <value>]
[--role_names <value>]

Description

Delete bulk role

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
account_id
optional
string역할이 속한 계정의 ID-
role_ids
optional
array역할 ID 목록-
role_names
optional
array역할명 목록-

10.3.1.12.2 - 1.1

scpcli iam role bulk delete
[--account_id <value>]
[--role_ids <value>]
[--role_names <value>]

Description

Delete bulk role

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
account_id
optional
string역할이 속한 계정의 ID-
role_ids
optional
array역할 ID 목록-
role_names
optional
array역할명 목록-

10.3.1.12.3 - 1.0

scpcli iam role bulk delete
[--account_id <value>]
[--role_ids <value>]
[--role_names <value>]

Description

Delete bulk role

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
account_id
optional
string역할이 속한 계정의 ID-
role_ids
optional
array역할 ID 목록-
role_names
optional
array역할명 목록-

10.3.1.13 - Delete IAM user

10.3.1.13.1 - 1.2

scpcli iam iam user delete
--user_id <value>
--account_id <value>

Description

Delete IAM user

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-

10.3.1.13.2 - 1.1

scpcli iam iam user delete
--user_id <value>
--account_id <value>

Description

Delete IAM user

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-

10.3.1.14 - Delete IAM users

10.3.1.14.1 - 1.2

scpcli iam iam user bulk delete
--account_id <value>
[--user_ids <value>]

Description

Delete IAM users

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID-
user_ids
optional
array사용자 ID 목록-

10.3.1.14.2 - 1.1

scpcli iam iam user bulk delete
--account_id <value>
[--user_ids <value>]

Description

Delete IAM users

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID-
user_ids
optional
array사용자 ID 목록-

10.3.1.14.3 - 1.0

scpcli iam iam user bulk delete
--account_id <value>
[--user_ids <value>]

Description

Delete IAM users

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID-
user_ids
optional
array사용자 ID 목록-

10.3.1.15 - Delete role

10.3.1.15.1 - 1.2

scpcli iam role delete
--role_id <value>

Description

Delete role

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-

10.3.1.15.2 - 1.1

scpcli iam role delete
--role_id <value>

Description

Delete role

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-

10.3.1.15.3 - 1.0

scpcli iam role delete
--role_id <value>

Description

Delete role

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-

10.3.1.16 - Delete the policy

10.3.1.16.1 - 1.2

scpcli iam policy delete
--policy_id <value>

Description

Delete the policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

10.3.1.16.2 - 1.1

scpcli iam policy delete
--policy_id <value>

Description

Delete the policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

10.3.1.16.3 - 1.0

scpcli iam policy delete
--policy_id <value>

Description

Delete the policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

10.3.1.17 - Delete the resource based policy

10.3.1.17.1 - 1.2

scpcli iam resource policy delete
--srn <value>

Description

Delete the resource based policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

10.3.1.17.2 - 1.1

scpcli iam resource policy delete
--srn <value>

Description

Delete the resource based policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

10.3.1.17.3 - 1.0

scpcli iam resource policy delete
--srn <value>

Description

Delete the resource based policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

10.3.1.18 - Delete user policy

10.3.1.18.1 - 1.2

scpcli iam user policy delete
--policy_id <value>
--user_id <value>

Description

Delete user policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID-
user_id
required
string사용자 ID-

10.3.1.18.2 - 1.1

scpcli iam user policy delete
--policy_id <value>
--user_id <value>

Description

Delete user policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID-
user_id
required
string사용자 ID-

10.3.1.18.3 - 1.0

scpcli iam user policy delete
--policy_id <value>
--user_id <value>

Description

Delete user policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID-
user_id
required
string사용자 ID-

10.3.1.19 - Detach policies to Role

10.3.1.19.1 - 1.2

scpcli iam role policy binding bulk detach
--role_id <value>
--policy_ids <value>

Description

Detach policies to Role

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
policy_ids
required
arrayPolicy ID List-

10.3.1.19.2 - 1.1

scpcli iam role policy binding bulk detach
--role_id <value>
--policy_ids <value>

Description

Detach policies to Role

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
policy_ids
required
arrayPolicy ID List-

10.3.1.19.3 - 1.0

scpcli iam role policy binding bulk detach
--role_id <value>
--policy_ids <value>

Description

Detach policies to Role

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
policy_ids
required
arrayPolicy ID List-

10.3.1.20 - Detach policy to Role

10.3.1.20.1 - 1.2

scpcli iam role policy binding detach
--policy_id <value>
--role_id <value>

Description

Detach policy to Role

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
string역할에 연결된 정책 ID-
role_id
required
string역할 ID-

10.3.1.20.2 - 1.1

scpcli iam role policy binding detach
--policy_id <value>
--role_id <value>

Description

Detach policy to Role

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
string역할에 연결된 정책 ID-
role_id
required
string역할 ID-

10.3.1.20.3 - 1.0

scpcli iam role policy binding detach
--policy_id <value>
--role_id <value>

Description

Detach policy to Role

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
string역할에 연결된 정책 ID-
role_id
required
string역할 ID-

10.3.1.21 - Get a Group

10.3.1.21.1 - 1.2

scpcli iam group show
--group_id <value>

Description

Get a Group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
descriptionGroup 설명Descriptions for group
domain_name도메인 이름scp
membersProject Group Member List
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
nameGroup 이름TestGroup
policiesPolicy[]
resource_type리소스 명group
rolesRole 정보[]
service_name서비스 Display 명Identity Access Management
service_type서비스 명iam
srnGroup SRNsrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypeUSER_DEFINED

10.3.1.21.2 - 1.1

scpcli iam group show
--group_id <value>

Description

Get a Group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
descriptionGroup 설명Descriptions for group
domain_name도메인 이름scp
membersProject Group Member List
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
nameGroup 이름TestGroup
policiesPolicy[]
resource_type리소스 명group
rolesRole 정보[]
service_name서비스 Display 명Identity Access Management
service_type서비스 명iam
srnGroup SRNsrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypeUSER_DEFINED

10.3.1.21.3 - 1.0

scpcli iam group show
--group_id <value>

Description

Get a Group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
descriptionGroup 설명Descriptions for group
domain_name도메인 이름scp
membersProject Group Member List
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
nameGroup 이름TestGroup
policiesPolicy[]
resource_type리소스 명group
rolesRole 정보[]
service_name서비스 Display 명Identity Access Management
service_type서비스 명iam
srnGroup SRNsrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypeUSER_DEFINED

10.3.1.22 - Get a specific policy binding list

10.3.1.22.1 - 1.2

scpcli iam policy binding list
--policy_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--identity_id <value>]
[--identity_type <value>]
[--name <value>]

Description

Get a specific policy binding list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
identity_id
optional
stringIdentity IDf39c460fade34fecb05ede8f904b24b7
identity_type
optional
stringIdentity TypeGROUP
name
optional
stringNameTestGroup

Responses

NameDescriptionExample
countcount20
groupsGroup[{‘created_at’: ‘2025-03-26T10:18:04Z’, ‘created_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘openapi-ga2-test-group’, ‘domain_name’: ‘scp’, ‘id’: ‘19fca177a57940daa5817960373c6542’, ‘modified_at’: ‘2025-03-26T10:18:04Z’, ‘modified_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘openapi-ga2-testgroup5’, ‘policies’: [], ‘roles’: [], ‘srn’: ‘srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542’, ’type’: ‘USER_DEFINED’}]
pagepage0
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
rolesRole[{‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘assume_role_policy_document’: {‘Statement’: [{‘Action’: ‘’, ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘NotAction’: ‘’, ‘Principal’: ‘’, ‘Resource’: ‘’, ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}, ‘created_at’: ‘2024-05-17T00:23:17Z’, ‘created_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘string’, ‘id’: ‘f39c460fade34fecb05ede8f904b24b7’, ‘max_session_duration’: 0, ‘modified_at’: ‘2024-05-17T00:23:17Z’, ‘modified_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘string’, ’type’: ‘DEFAULT’}]
sizesize20
sortsort[‘created_at:asc’]
usersUser[{‘access_control’: False, ‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘account_name’: ‘’, ‘allowed_ip_addresses’: ‘’, ‘company_name’: ‘’, ‘created_at’: ‘2024-11-15T06:57:42.000000Z’, ‘created_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘description’: ‘’, ‘domain_name’: ‘scp’, ‘dst_offset’: ‘+09:00’, ’email’: ‘samsung.kim@samsung.com’, ’email_authenticate_code’: ‘8ada8861bad2423295e4bb576bee5886’, ’email_authenticated’: True, ‘first_name’: ‘’, ‘groups’: [], ‘id’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘keycloak_id’: ‘127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507’, ‘keystone_credential’: ‘’, ’last_login_at’: ‘2024-11-25T06:57:42.000000Z’, ’last_name’: ‘’, ’last_password_update_at’: ‘’, ’login_id’: ‘’, ‘modified_at’: ‘2024-11-17T06:57:42.000000Z’, ‘modified_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ’nation_id’: ‘+82’, ‘phone_authenticated’: False, ‘phone_number’: ‘0000000000’, ‘policies’: [], ‘state’: ‘ACTIVE’, ’temporary_password’: False, ’term_region_id’: ‘1’, ’timezone’: ‘Asia/Seoul’, ’type’: ‘IAM’, ’tz_id’: ‘Asia/Seoul’, ‘user_name’: ‘Kim Samsung’, ‘utc_offset’: ‘+09:00’}]

10.3.1.22.2 - 1.1

scpcli iam policy binding list
--policy_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--identity_id <value>]
[--identity_type <value>]
[--name <value>]

Description

Get a specific policy binding list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
identity_id
optional
stringIdentity IDf39c460fade34fecb05ede8f904b24b7
identity_type
optional
stringIdentity TypeGROUP
name
optional
stringNameTestGroup

Responses

NameDescriptionExample
countcount20
groupsGroup[{‘created_at’: ‘2025-03-26T10:18:04Z’, ‘created_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘openapi-ga2-test-group’, ‘domain_name’: ‘scp’, ‘id’: ‘19fca177a57940daa5817960373c6542’, ‘modified_at’: ‘2025-03-26T10:18:04Z’, ‘modified_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘openapi-ga2-testgroup5’, ‘policies’: [], ‘roles’: [], ‘srn’: ‘srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542’, ’type’: ‘USER_DEFINED’}]
pagepage0
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
rolesRole[{‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘assume_role_policy_document’: {‘Statement’: [{‘Action’: ‘’, ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘NotAction’: ‘’, ‘Principal’: ‘’, ‘Resource’: ‘’, ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}, ‘created_at’: ‘2024-05-17T00:23:17Z’, ‘created_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘string’, ‘id’: ‘f39c460fade34fecb05ede8f904b24b7’, ‘max_session_duration’: 0, ‘modified_at’: ‘2024-05-17T00:23:17Z’, ‘modified_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘string’, ’type’: ‘DEFAULT’}]
sizesize20
sortsort[‘created_at:asc’]
usersUser[{‘access_control’: False, ‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘account_name’: ‘’, ‘allowed_ip_addresses’: ‘’, ‘company_name’: ‘’, ‘created_at’: ‘2024-11-15T06:57:42.000000Z’, ‘created_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘description’: ‘’, ‘domain_name’: ‘scp’, ‘dst_offset’: ‘+09:00’, ’email’: ‘samsung.kim@samsung.com’, ’email_authenticate_code’: ‘8ada8861bad2423295e4bb576bee5886’, ’email_authenticated’: True, ‘first_name’: ‘’, ‘groups’: [], ‘id’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘keycloak_id’: ‘127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507’, ‘keystone_credential’: ‘’, ’last_login_at’: ‘2024-11-25T06:57:42.000000Z’, ’last_name’: ‘’, ’last_password_update_at’: ‘’, ’login_id’: ‘’, ‘modified_at’: ‘2024-11-17T06:57:42.000000Z’, ‘modified_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ’nation_id’: ‘+82’, ‘phone_authenticated’: False, ‘phone_number’: ‘0000000000’, ‘policies’: [], ‘state’: ‘ACTIVE’, ’temporary_password’: False, ’term_region_id’: ‘1’, ’timezone’: ‘Asia/Seoul’, ’type’: ‘IAM’, ’tz_id’: ‘Asia/Seoul’, ‘user_name’: ‘Kim Samsung’, ‘utc_offset’: ‘+09:00’}]

10.3.1.22.3 - 1.0

scpcli iam policy binding list
--policy_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--identity_id <value>]
[--identity_type <value>]
[--name <value>]

Description

Get a specific policy binding list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
identity_id
optional
stringIdentity IDf39c460fade34fecb05ede8f904b24b7
identity_type
optional
stringIdentity TypeGROUP
name
optional
stringNameTestGroup

Responses

NameDescriptionExample
countcount20
groupsGroup[{‘created_at’: ‘2025-03-26T10:18:04Z’, ‘created_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘openapi-ga2-test-group’, ‘domain_name’: ‘scp’, ‘id’: ‘19fca177a57940daa5817960373c6542’, ‘modified_at’: ‘2025-03-26T10:18:04Z’, ‘modified_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘openapi-ga2-testgroup5’, ‘policies’: [], ‘roles’: [], ‘srn’: ‘srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542’, ’type’: ‘USER_DEFINED’}]
pagepage0
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
rolesRole[{‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘assume_role_policy_document’: {‘Statement’: [{‘Action’: ‘’, ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘NotAction’: ‘’, ‘Principal’: ‘’, ‘Resource’: ‘’, ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}, ‘created_at’: ‘2024-05-17T00:23:17Z’, ‘created_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘string’, ‘id’: ‘f39c460fade34fecb05ede8f904b24b7’, ‘max_session_duration’: 0, ‘modified_at’: ‘2024-05-17T00:23:17Z’, ‘modified_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘string’, ’type’: ‘DEFAULT’}]
sizesize20
sortsort[‘created_at:asc’]
usersUser[{‘access_control’: False, ‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘account_name’: ‘’, ‘allowed_ip_addresses’: ‘’, ‘company_name’: ‘’, ‘created_at’: ‘2024-11-15T06:57:42.000000Z’, ‘created_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘description’: ‘’, ‘domain_name’: ‘scp’, ‘dst_offset’: ‘+09:00’, ’email’: ‘samsung.kim@samsung.com’, ’email_authenticate_code’: ‘8ada8861bad2423295e4bb576bee5886’, ’email_authenticated’: True, ‘first_name’: ‘’, ‘groups’: [], ‘id’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘keycloak_id’: ‘127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507’, ‘keystone_credential’: ‘’, ’last_login_at’: ‘2024-11-25T06:57:42.000000Z’, ’last_name’: ‘’, ’last_password_update_at’: ‘’, ’login_id’: ‘’, ‘modified_at’: ‘2024-11-17T06:57:42.000000Z’, ‘modified_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ’nation_id’: ‘+82’, ‘phone_authenticated’: False, ‘phone_number’: ‘0000000000’, ‘policies’: [], ‘state’: ‘ACTIVE’, ’temporary_password’: False, ’term_region_id’: ‘1’, ’timezone’: ‘Asia/Seoul’, ’type’: ‘IAM’, ’tz_id’: ‘Asia/Seoul’, ‘user_name’: ‘Kim Samsung’, ‘utc_offset’: ‘+09:00’}]

10.3.1.23 - Get an access key

10.3.1.23.1 - 1.2

scpcli iam access-key show
--access_key_id <value>

Description

Get an access key

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess key typePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent access key ID which is used for temporary access key to create by92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

10.3.1.23.2 - 1.1

scpcli iam access-key show
--access_key_id <value>

Description

Get an access key

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess key typePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent access key ID which is used for temporary access key to create by92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

10.3.1.23.3 - 1.0

scpcli iam access-key show
--access_key_id <value>

Description

Get an access key

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess key typePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent access key ID which is used for temporary access key to create by92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

10.3.1.24 - Get endpoint list

10.3.1.24.1 - 1.2

scpcli iam endpoint list

Description

Get endpoint list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Responses

NameDescriptionExample
regionRegionkr-west1
service_nameService namescp-iam
service_typeService typescp-iam
urlURLhttps://iam.dev2.samsungsdscloud.com

10.3.1.24.2 - 1.1

scpcli iam endpoint list

Description

Get endpoint list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Responses

NameDescriptionExample
regionRegionkr-west1
service_nameService namescp-iam
service_typeService typescp-iam
urlURLhttps://iam.dev2.samsungsdscloud.com

10.3.1.24.3 - 1.0

scpcli iam endpoint list

Description

Get endpoint list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Responses

NameDescriptionExample
regionRegionkr-west1
service_nameService namescp-iam
service_typeService typescp-iam
urlURLhttps://iam.dev2.samsungsdscloud.com

10.3.1.25 - Get IAM users

10.3.1.25.1 - 1.2

scpcli iam iam user show
--user_id <value>
--account_id <value>

Description

Get IAM users

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.25.2 - 1.1

scpcli iam iam user show
--user_id <value>
--account_id <value>

Description

Get IAM users

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.25.3 - 1.0

scpcli iam iam user show
--user_id <value>
--account_id <value>

Description

Get IAM users

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.26 - Get policy list

10.3.1.26.1 - 1.2

scpcli iam policy list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]

Description

Get policy list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringPolicy 생성자 성, 이름test1
creator_email
optional
stringPolicy 생성자 Emailtest@test.com
modifier_name
optional
stringPolicy 수정자 성, 이름test1
modifier_email
optional
stringPolicy 수정자 Emailtest@test.com
exclude_group_id
optional
string제외할 Group IDa946662dc4314dac93da413a32457459
exclude_user_id
optional
string제외할 User ID-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.26.2 - 1.1

scpcli iam policy list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]

Description

Get policy list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringPolicy 생성자 성, 이름test1
creator_email
optional
stringPolicy 생성자 Emailtest@test.com
modifier_name
optional
stringPolicy 수정자 성, 이름test1
modifier_email
optional
stringPolicy 수정자 Emailtest@test.com
exclude_group_id
optional
string제외할 Group IDa946662dc4314dac93da413a32457459
exclude_user_id
optional
string제외할 User ID-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.26.3 - 1.0

scpcli iam policy list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]

Description

Get policy list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringPolicy 생성자 성, 이름test1
creator_email
optional
stringPolicy 생성자 Emailtest@test.com
modifier_name
optional
stringPolicy 수정자 성, 이름test1
modifier_email
optional
stringPolicy 수정자 Emailtest@test.com
exclude_group_id
optional
string제외할 Group IDa946662dc4314dac93da413a32457459
exclude_user_id
optional
string제외할 User ID-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.27 - Get role

10.3.1.27.1 - 1.2

scpcli iam role show
--role_id <value>

Description

Get role

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_id역할이 속한 계정의 ID
assume_role_policy_document역할 신뢰 정책
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Email
creator_name생성자 성, 이름
description역할 설명
max_session_duration역할 세션 최대 지속 시간(초)
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Email
modifier_name수정자 성, 이름
name역할명
policies역할에 연결된 정책 목록
type역할 유형

10.3.1.27.2 - 1.1

scpcli iam role show
--role_id <value>

Description

Get role

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_id역할이 속한 계정의 ID
assume_role_policy_document역할 신뢰 정책
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Email
creator_name생성자 성, 이름
description역할 설명
max_session_duration역할 세션 최대 지속 시간(초)
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Email
modifier_name수정자 성, 이름
name역할명
policies역할에 연결된 정책 목록
type역할 유형

10.3.1.27.3 - 1.0

scpcli iam role show
--role_id <value>

Description

Get role

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_id역할이 속한 계정의 ID
assume_role_policy_document역할 신뢰 정책
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Email
creator_name생성자 성, 이름
description역할 설명
max_session_duration역할 세션 최대 지속 시간(초)
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Email
modifier_name수정자 성, 이름
name역할명
policies역할에 연결된 정책 목록
type역할 유형

10.3.1.28 - Get role list

10.3.1.28.1 - 1.2

scpcli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]

Description

Get role list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string역할명-
role_type
optional
string역할 유형-
account_id
optional
string역할이 속한 계정의 ID-
exclude_policy_id
optional
string예외 대상 정책-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_id역할이 속한 계정의 ID
assume_role_policy_document역할 신뢰 정책
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Email
creator_name생성자 성, 이름
description역할 설명
max_session_duration역할 세션 최대 지속 시간(초)
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Email
modifier_name수정자 성, 이름
name역할명
policies역할에 연결된 정책 목록
type역할 유형

10.3.1.28.2 - 1.1

scpcli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]

Description

Get role list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string역할명-
role_type
optional
string역할 유형-
account_id
optional
string역할이 속한 계정의 ID-
exclude_policy_id
optional
string예외 대상 정책-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_id역할이 속한 계정의 ID
assume_role_policy_document역할 신뢰 정책
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Email
creator_name생성자 성, 이름
description역할 설명
max_session_duration역할 세션 최대 지속 시간(초)
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Email
modifier_name수정자 성, 이름
name역할명
policies역할에 연결된 정책 목록
type역할 유형

10.3.1.28.3 - 1.0

scpcli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]

Description

Get role list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string역할명-
role_type
optional
string역할 유형-
account_id
optional
string역할이 속한 계정의 ID-
exclude_policy_id
optional
string예외 대상 정책-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_id역할이 속한 계정의 ID
assume_role_policy_document역할 신뢰 정책
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Email
creator_name생성자 성, 이름
description역할 설명
max_session_duration역할 세션 최대 지속 시간(초)
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Email
modifier_name수정자 성, 이름
name역할명
policies역할에 연결된 정책 목록
type역할 유형

10.3.1.29 - Get Role Policy-Binding list

10.3.1.29.1 - 1.2

scpcli iam role policy binding list
--role_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get Role Policy-Binding list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
string역할에 연결된 정책 ID-
policy_name
optional
string역할에 연결된 정책 이름-
policy_type
optional
string역할에 연결된 정책 유형 목록['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.29.2 - 1.1

scpcli iam role policy binding list
--role_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get Role Policy-Binding list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
string역할에 연결된 정책 ID-
policy_name
optional
string역할에 연결된 정책 이름-
policy_type
optional
string역할에 연결된 정책 유형 목록['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.29.3 - 1.0

scpcli iam role policy binding list
--role_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get Role Policy-Binding list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
string역할에 연결된 정책 ID-
policy_name
optional
string역할에 연결된 정책 이름-
policy_type
optional
string역할에 연결된 정책 유형 목록['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.30 - Get saml provider information

10.3.1.30.1 - 1.2

scpcli iam saml provider show
--saml_provider_id <value>

Description

Get saml provider information

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
saml_provider_id
required
string자격증명공급자 ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
idp_cert_end유효기간
idp_file_data메타데이터 내용
idp_file_name메타데이터 파일 이름
idp_file_size메타데이터 파일 크기
idp_issuer_url발행자 URL
idp_sso_urlSSO 서비스 위치
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자
saml_provider_name자격증명공급자 이름

10.3.1.30.2 - 1.1

scpcli iam saml provider show
--saml_provider_id <value>

Description

Get saml provider information

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
saml_provider_id
required
string자격증명공급자 ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
idp_cert_end유효기간
idp_file_data메타데이터 내용
idp_file_name메타데이터 파일 이름
idp_file_size메타데이터 파일 크기
idp_issuer_url발행자 URL
idp_sso_urlSSO 서비스 위치
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자
saml_provider_name자격증명공급자 이름

10.3.1.30.3 - 1.0

scpcli iam saml provider show
--saml_provider_id <value>

Description

Get saml provider information

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
saml_provider_id
required
string자격증명공급자 ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
idp_cert_end유효기간
idp_file_data메타데이터 내용
idp_file_name메타데이터 파일 이름
idp_file_size메타데이터 파일 크기
idp_issuer_url발행자 URL
idp_sso_urlSSO 서비스 위치
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자
saml_provider_name자격증명공급자 이름

10.3.1.31 - Get service account

10.3.1.31.1 - 1.2

scpcli iam service account show
--service_account_id <value>

Description

Get service account

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
service_account_id
required
stringService Account ID-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
passwordService Account’s Password
serviceService Account’s Service

10.3.1.31.2 - 1.1

scpcli iam service account show
--service_account_id <value>

Description

Get service account

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
service_account_id
required
stringService Account ID-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
passwordService Account’s Password
serviceService Account’s Service

10.3.1.31.3 - 1.0

scpcli iam service account show
--service_account_id <value>

Description

Get service account

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
service_account_id
required
stringService Account ID-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
passwordService Account’s Password
serviceService Account’s Service

10.3.1.32 - Get user policy-binding list

10.3.1.32.1 - 1.2

scpcli iam user policy show
--user_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get user policy-binding list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy Id-
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type List['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.32.2 - 1.1

scpcli iam user policy show
--user_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get user policy-binding list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy Id-
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type List['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.32.3 - 1.0

scpcli iam user policy show
--user_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get user policy-binding list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy Id-
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type List['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.33 - Group Member list

10.3.1.33.1 - 1.2

scpcli iam group user list
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
[--user_email <value>]
[--creator_name <value>]
[--creator_email <value>]

Description

Group Member list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_name
optional
stringGroup Member 성, 이름Kim Samsung
user_email
optional
stringGroup Member Emailsamsung.kim@samsung.com
creator_name
optional
stringGroup Member 생성자 성, 이름Kim Samsung
creator_email
optional
stringGroup Member 생성자 Emailsamsung.kim@samsung.com

Responses

NameDescriptionExample
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_created_at생성 일시2024-05-17T00:23:17Z
creator_email생성자 Emailsamsung.kim@samsung.com
creator_last_login_atGroup Member last login at2024-05-17T00:23:17Z
creator_name생성자 성, 이름Kim Samsung
group_namesGroup names[‘TestGroup’, ‘SampleGroup’]
user_created_at생성 일시2024-05-17T00:23:17Z
user_emailUser Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_last_login_atGroup Member last login at2024-05-17T00:23:17Z
user_nameUser 성, 이름Kim Samsung

10.3.1.33.2 - 1.1

scpcli iam group user list
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
[--user_email <value>]
[--creator_name <value>]
[--creator_email <value>]

Description

Group Member list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_name
optional
stringGroup Member 성, 이름Kim Samsung
user_email
optional
stringGroup Member Emailsamsung.kim@samsung.com
creator_name
optional
stringGroup Member 생성자 성, 이름Kim Samsung
creator_email
optional
stringGroup Member 생성자 Emailsamsung.kim@samsung.com

Responses

NameDescriptionExample
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_created_at생성 일시2024-05-17T00:23:17Z
creator_email생성자 Emailsamsung.kim@samsung.com
creator_last_login_atGroup Member last login at2024-05-17T00:23:17Z
creator_name생성자 성, 이름Kim Samsung
group_namesGroup names[‘TestGroup’, ‘SampleGroup’]
user_created_at생성 일시2024-05-17T00:23:17Z
user_emailUser Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_last_login_atGroup Member last login at2024-05-17T00:23:17Z
user_nameUser 성, 이름Kim Samsung

10.3.1.33.3 - 1.0

scpcli iam group user list
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
[--user_email <value>]
[--creator_name <value>]
[--creator_email <value>]

Description

Group Member list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_name
optional
stringGroup Member 성, 이름Kim Samsung
user_email
optional
stringGroup Member Emailsamsung.kim@samsung.com
creator_name
optional
stringGroup Member 생성자 성, 이름Kim Samsung
creator_email
optional
stringGroup Member 생성자 Emailsamsung.kim@samsung.com

Responses

NameDescriptionExample
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_created_at생성 일시2024-05-17T00:23:17Z
creator_email생성자 Emailsamsung.kim@samsung.com
creator_last_login_atGroup Member last login at2024-05-17T00:23:17Z
creator_name생성자 성, 이름Kim Samsung
group_namesGroup names[‘TestGroup’, ‘SampleGroup’]
user_created_at생성 일시2024-05-17T00:23:17Z
user_emailUser Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_last_login_atGroup Member last login at2024-05-17T00:23:17Z
user_nameUser 성, 이름Kim Samsung

10.3.1.34 - List access keys

10.3.1.34.1 - 1.2

scpcli iam access-key list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--access_key_type <value>]
[--parent_access_key_id <value>]

Description

List access keys

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
access_key_type
optional
stringAccess key typePERMANENT
parent_access_key_id
optional
stringParent access key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess key typePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent access key ID which is used for temporary access key to create by92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

10.3.1.34.2 - 1.1

scpcli iam access-key list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--access_key_type <value>]
[--parent_access_key_id <value>]

Description

List access keys

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
access_key_type
optional
stringAccess key typePERMANENT
parent_access_key_id
optional
stringParent access key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess key typePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent access key ID which is used for temporary access key to create by92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

10.3.1.34.3 - 1.0

scpcli iam access-key list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--access_key_type <value>]
[--parent_access_key_id <value>]

Description

List access keys

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
access_key_type
optional
stringAccess key typePERMANENT
parent_access_key_id
optional
stringParent access key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess key typePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent access key ID which is used for temporary access key to create by92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

10.3.1.35 - List Groups

10.3.1.35.1 - 1.2

scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]

Description

List Groups

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup 이름TestGroup
types
optional
stringGroup TypesUSER_DEFINED,DEFAULT
ids
optional
stringGroup IDs629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765
has_member
optional
stringGroup Member 존재 여부false
has_role
optional
stringGroup Role 존재 여부false
is_completed
optional
stringGroup 완결 여부false
creator_name
optional
stringGroup 생성자 성, 이름Kim Samsung
creator_email
optional
stringGroup 생성자 Emailsamsung.kim@samsung.com
modifier_name
optional
stringGroup 수정자 성, 이름Kim Samsung
modifier_email
optional
stringGroup 수정자 Emailsamsung.kim@samsung.com
exclude_user_id
optional
string제외할 사용자 IDf39c460fade34fecb05ede8f904b24b7
exclude_policy_id
optional
string제외할 정책 ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
descriptionGroup 설명Descriptions for group
domain_name도메인 이름scp
membersProject Group Member List
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
nameGroup 이름TestGroup
policiesPolicy[]
resource_type리소스 명group
rolesRole 정보[]
service_name서비스 Display 명Identity Access Management
service_type서비스 명iam
srnGroup SRNsrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypeUSER_DEFINED

10.3.1.35.2 - 1.1

scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]

Description

List Groups

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup 이름TestGroup
types
optional
stringGroup TypesUSER_DEFINED,DEFAULT
ids
optional
stringGroup IDs629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765
has_member
optional
stringGroup Member 존재 여부false
has_role
optional
stringGroup Role 존재 여부false
is_completed
optional
stringGroup 완결 여부false
creator_name
optional
stringGroup 생성자 성, 이름Kim Samsung
creator_email
optional
stringGroup 생성자 Emailsamsung.kim@samsung.com
modifier_name
optional
stringGroup 수정자 성, 이름Kim Samsung
modifier_email
optional
stringGroup 수정자 Emailsamsung.kim@samsung.com
exclude_user_id
optional
string제외할 사용자 IDf39c460fade34fecb05ede8f904b24b7
exclude_policy_id
optional
string제외할 정책 ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
descriptionGroup 설명Descriptions for group
domain_name도메인 이름scp
membersProject Group Member List
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
nameGroup 이름TestGroup
policiesPolicy[]
resource_type리소스 명group
rolesRole 정보[]
service_name서비스 Display 명Identity Access Management
service_type서비스 명iam
srnGroup SRNsrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypeUSER_DEFINED

10.3.1.35.3 - 1.0

scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]

Description

List Groups

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup 이름TestGroup
types
optional
stringGroup TypesUSER_DEFINED,DEFAULT
ids
optional
stringGroup IDs629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765
has_member
optional
stringGroup Member 존재 여부false
has_role
optional
stringGroup Role 존재 여부false
is_completed
optional
stringGroup 완결 여부false
creator_name
optional
stringGroup 생성자 성, 이름Kim Samsung
creator_email
optional
stringGroup 생성자 Emailsamsung.kim@samsung.com
modifier_name
optional
stringGroup 수정자 성, 이름Kim Samsung
modifier_email
optional
stringGroup 수정자 Emailsamsung.kim@samsung.com
exclude_user_id
optional
string제외할 사용자 IDf39c460fade34fecb05ede8f904b24b7
exclude_policy_id
optional
string제외할 정책 ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_at생성 일시2024-05-17T00:23:17Z
created_by생성자ef50cdc207f05f6fb8f20219f229ed1f
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
descriptionGroup 설명Descriptions for group
domain_name도메인 이름scp
membersProject Group Member List
modified_at수정 일시2024-05-17T00:23:17Z
modified_by수정자ef50cdc207f05f6fb8f20219f229ed1f
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
nameGroup 이름TestGroup
policiesPolicy[]
resource_type리소스 명group
rolesRole 정보[]
service_name서비스 Display 명Identity Access Management
service_type서비스 명iam
srnGroup SRNsrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypeUSER_DEFINED

10.3.1.36 - List IAM users

10.3.1.36.1 - 1.2

scpcli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]

Description

List IAM users

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
login_id
optional
stringLogin ID-
email
optional
string사용자 Email-
nation_id
optional
string국가 ID-
phone_number
optional
string사용자 휴대 전화 번호-
user_name
optional
string사용자 이름-
exclude_group_id
optional
string예외 대상 그룹-
exclude_policy_id
optional
string예외 대상 정책-
type
optional
stringUser Type-

Responses

NameDescriptionExample
idID
account_idAccount ID
company_name회사 이름
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionUser Description
dst_offsetDST Offset
emailUser Email
email_authenticatedemail 인증 여부
first_name사용자 이름
groupsgroup names
last_login_at마지막 로그인
last_name사용자 성
last_password_update_at마지막 비밀번호 수정시간
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameName
password_reuse_count비밀 번호 재사용 가능 횟수
phone_authenticated휴대폰 인증 여부
policiesUser Policies[]
state상태
timezoneTimezone ID
typeType
tz_idTimezone ID
user_nameUser Name
utc_offsetUTC Offset

10.3.1.36.2 - 1.1

scpcli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]

Description

List IAM users

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
login_id
optional
stringLogin ID-
email
optional
string사용자 Email-
nation_id
optional
string국가 ID-
phone_number
optional
string사용자 휴대 전화 번호-
user_name
optional
string사용자 이름-
exclude_group_id
optional
string예외 대상 그룹-
exclude_policy_id
optional
string예외 대상 정책-
type
optional
stringUser Type-

Responses

NameDescriptionExample
idID
account_idAccount ID
company_name회사 이름
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionUser Description
dst_offsetDST Offset
emailUser Email
email_authenticatedemail 인증 여부
first_name사용자 이름
groupsgroup names
last_login_at마지막 로그인
last_name사용자 성
last_password_update_at마지막 비밀번호 수정시간
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameName
password_reuse_count비밀 번호 재사용 가능 횟수
phone_authenticated휴대폰 인증 여부
policiesUser Policies[]
state상태
timezoneTimezone ID
typeType
tz_idTimezone ID
user_nameUser Name
utc_offsetUTC Offset

10.3.1.36.3 - 1.0

scpcli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]

Description

List IAM users

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
login_id
optional
stringLogin ID-
email
optional
string사용자 Email-
nation_id
optional
string국가 ID-
phone_number
optional
string사용자 휴대 전화 번호-
user_name
optional
string사용자 이름-
exclude_group_id
optional
string예외 대상 그룹-
exclude_policy_id
optional
string예외 대상 정책-
type
optional
stringUser Type-

Responses

NameDescriptionExample
idID
account_idAccount ID
company_name회사 이름
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionUser Description
dst_offsetDST Offset
emailUser Email
email_authenticatedemail 인증 여부
first_name사용자 이름
groupsgroup names
last_login_at마지막 로그인
last_name사용자 성
last_password_update_at마지막 비밀번호 수정시간
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
nameName
password_reuse_count비밀 번호 재사용 가능 횟수
phone_authenticated휴대폰 인증 여부
policiesUser Policies[]
state상태
timezoneTimezone ID
typeType
tz_idTimezone ID
user_nameUser Name
utc_offsetUTC Offset

10.3.1.37 - List saml providers

10.3.1.37.1 - 1.2

scpcli iam saml provider list
[--size <value>]
[--page <value>]
[--sort <value>]
[--federation_type <value>]
[--saml_provider_name <value>]

Description

List saml providers

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
federation_type
optional
string자격증명공급자 유형-
saml_provider_name
optional
string자격증명공급자 이름-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자
saml_provider_name자격증명공급자 이름

10.3.1.37.2 - 1.1

scpcli iam saml provider list
[--size <value>]
[--page <value>]
[--sort <value>]
[--federation_type <value>]
[--saml_provider_name <value>]

Description

List saml providers

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
federation_type
optional
string자격증명공급자 유형-
saml_provider_name
optional
string자격증명공급자 이름-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자
saml_provider_name자격증명공급자 이름

10.3.1.37.3 - 1.0

scpcli iam saml provider list
[--size <value>]
[--page <value>]
[--sort <value>]
[--federation_type <value>]
[--saml_provider_name <value>]

Description

List saml providers

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
federation_type
optional
string자격증명공급자 유형-
saml_provider_name
optional
string자격증명공급자 이름-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자
saml_provider_name자격증명공급자 이름

10.3.1.38 - List service accounts

10.3.1.38.1 - 1.2

scpcli iam service account list
[--name <value>]
[--service <value>]

Description

List service accounts

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
name
optional
stringService Account Name-
service
optional
stringService Account's Service-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
serviceService Account’s Service

10.3.1.38.2 - 1.1

scpcli iam service account list
[--name <value>]
[--service <value>]

Description

List service accounts

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
name
optional
stringService Account Name-
service
optional
stringService Account's Service-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
serviceService Account’s Service

10.3.1.38.3 - 1.0

scpcli iam service account list
[--name <value>]
[--service <value>]

Description

List service accounts

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
name
optional
stringService Account Name-
service
optional
stringService Account's Service-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
serviceService Account’s Service

10.3.1.39 - Modify a Group

10.3.1.39.1 - 1.2

scpcli iam group set
--group_id <value>
--name <value>
--description <value>

Description

Modify a Group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
name
required
stringGroup 이름TestGroup
description
required
stringGroup 설명Descriptions for group

10.3.1.39.2 - 1.1

scpcli iam group set
--group_id <value>
--name <value>
--description <value>

Description

Modify a Group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
name
required
stringGroup 이름TestGroup
description
required
stringGroup 설명Descriptions for group

10.3.1.39.3 - 1.0

scpcli iam group set
--group_id <value>
--name <value>
--description <value>

Description

Modify a Group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
name
required
stringGroup 이름TestGroup
description
required
stringGroup 설명Descriptions for group

10.3.1.40 - Query policy list

10.3.1.40.1 - 1.2

scpcli iam policy query
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
[--excluded_policy_ids <value>]

Description

Query policy list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringPolicy 생성자 성, 이름test1
creator_email
optional
stringPolicy 생성자 Emailtest@test.com
modifier_name
optional
stringPolicy 수정자 성, 이름test1
modifier_email
optional
stringPolicy 수정자 Emailtest@test.com
exclude_group_id
optional
string제외할 Group IDa946662dc4314dac93da413a32457459
exclude_user_id
optional
string제외할 User ID-
excluded_policy_ids
optional
array제외할 Policy IDs37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.40.2 - 1.1

scpcli iam policy query
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
[--excluded_policy_ids <value>]

Description

Query policy list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringPolicy 생성자 성, 이름test1
creator_email
optional
stringPolicy 생성자 Emailtest@test.com
modifier_name
optional
stringPolicy 수정자 성, 이름test1
modifier_email
optional
stringPolicy 수정자 Emailtest@test.com
exclude_group_id
optional
string제외할 Group IDa946662dc4314dac93da413a32457459
exclude_user_id
optional
string제외할 User ID-
excluded_policy_ids
optional
array제외할 Policy IDs37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.40.3 - 1.0

scpcli iam policy query
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
[--excluded_policy_ids <value>]

Description

Query policy list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringPolicy 생성자 성, 이름test1
creator_email
optional
stringPolicy 생성자 Emailtest@test.com
modifier_name
optional
stringPolicy 수정자 성, 이름test1
modifier_email
optional
stringPolicy 수정자 Emailtest@test.com
exclude_group_id
optional
string제외할 Group IDa946662dc4314dac93da413a32457459
exclude_user_id
optional
string제외할 User ID-
excluded_policy_ids
optional
array제외할 Policy IDs37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.41 - Remove a permission into the resource based policy

10.3.1.41.1 - 1.2

scpcli iam permission remove
--sid <value>
--srn <value>

Description

Remove a permission into the resource based policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

10.3.1.41.2 - 1.1

scpcli iam permission remove
--sid <value>
--srn <value>

Description

Remove a permission into the resource based policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

10.3.1.41.3 - 1.0

scpcli iam permission remove
--sid <value>
--srn <value>

Description

Remove a permission into the resource based policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

10.3.1.42 - Remove a User from a Group

10.3.1.42.1 - 1.2

scpcli iam group user remove
--user_id <value>
--group_id <value>

Description

Remove a User from a Group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser IDef50cdc207f05f6fb8f20219f229ed1f
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

10.3.1.42.2 - 1.1

scpcli iam group user remove
--user_id <value>
--group_id <value>

Description

Remove a User from a Group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser IDef50cdc207f05f6fb8f20219f229ed1f
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

10.3.1.42.3 - 1.0

scpcli iam group user remove
--user_id <value>
--group_id <value>

Description

Remove a User from a Group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser IDef50cdc207f05f6fb8f20219f229ed1f
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

10.3.1.43 - Remove policies

10.3.1.43.1 - 1.2

scpcli iam policy bulk delete
[--ids <value>]

Description

Remove policies

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
ids
optional
arrayPolicy id list37f2e31ff86b415698d7e8eeafab445d

10.3.1.43.2 - 1.1

scpcli iam policy bulk delete
[--ids <value>]

Description

Remove policies

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
ids
optional
arrayPolicy id list37f2e31ff86b415698d7e8eeafab445d

10.3.1.43.3 - 1.0

scpcli iam policy bulk delete
[--ids <value>]

Description

Remove policies

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
ids
optional
arrayPolicy id list37f2e31ff86b415698d7e8eeafab445d

10.3.1.44 - Remove policy assignment from group

10.3.1.44.1 - 1.2

scpcli iam group policy delete
--policy_id <value>
--group_id <value>

Description

Remove policy assignment from group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

10.3.1.44.2 - 1.1

scpcli iam group policy delete
--policy_id <value>
--group_id <value>

Description

Remove policy assignment from group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

10.3.1.44.3 - 1.0

scpcli iam group policy delete
--policy_id <value>
--group_id <value>

Description

Remove policy assignment from group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

10.3.1.45 - Remove saml providers

10.3.1.45.1 - 1.2

scpcli iam saml provider bulk delete
[--ids <value>]

Description

Remove saml providers

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
ids
optional
arraySaml provider id list-

10.3.1.45.2 - 1.1

scpcli iam saml provider bulk delete
[--ids <value>]

Description

Remove saml providers

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
ids
optional
arraySaml provider id list-

10.3.1.45.3 - 1.0

scpcli iam saml provider bulk delete
[--ids <value>]

Description

Remove saml providers

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
ids
optional
arraySaml provider id list-

10.3.1.46 - Remove the access key

10.3.1.46.1 - 1.2

scpcli iam access-key delete
--access_key_id <value>

Description

Remove the access key

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess key IDf39c460fade34fecb05ede8f904b24b7

10.3.1.46.2 - 1.1

scpcli iam access-key delete
--access_key_id <value>

Description

Remove the access key

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess key IDf39c460fade34fecb05ede8f904b24b7

10.3.1.46.3 - 1.0

scpcli iam access-key delete
--access_key_id <value>

Description

Remove the access key

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess key IDf39c460fade34fecb05ede8f904b24b7

10.3.1.47 - Remove the access keys

10.3.1.47.1 - 1.2

scpcli iam access-key remove
[--ids <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--with_count <value>]

Description

Remove the access keys

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
ids
optional
arrayAccess key id list-
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
with_count
optional
stringwith counttrue

10.3.1.47.2 - 1.1

scpcli iam access-key remove
[--ids <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--with_count <value>]

Description

Remove the access keys

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
ids
optional
arrayAccess key id list-
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
with_count
optional
stringwith counttrue

10.3.1.47.3 - 1.0

scpcli iam access-key remove
[--ids <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--with_count <value>]

Description

Remove the access keys

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
ids
optional
arrayAccess key id list-
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
with_count
optional
stringwith counttrue

10.3.1.48 - Remove the Group

10.3.1.48.1 - 1.2

scpcli iam group delete
--group_id <value>

Description

Remove the Group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

10.3.1.48.2 - 1.1

scpcli iam group delete
--group_id <value>

Description

Remove the Group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

10.3.1.48.3 - 1.0

scpcli iam group delete
--group_id <value>

Description

Remove the Group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

10.3.1.49 - Send Temporary Access Key OTP

10.3.1.49.1 - 1.2

scpcli iam access-key send otp
[--locale <value>]
[--method <value>]

Description

Send Temporary Access Key OTP

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
locale
optional
stringLocale-
method
optional
stringOTP method (EMAIL or PHONE)-

Responses

NameDescriptionExample

10.3.1.49.2 - 1.1

scpcli iam access-key send otp
[--locale <value>]
[--method <value>]

Description

Send Temporary Access Key OTP

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
locale
optional
stringLocale-
method
optional
stringOTP method (EMAIL or PHONE)-

Responses

NameDescriptionExample

10.3.1.49.3 - 1.0

scpcli iam access-key send otp
[--locale <value>]
[--method <value>]

Description

Send Temporary Access Key OTP

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
locale
optional
stringLocale-
method
optional
stringOTP method (EMAIL or PHONE)-

Responses

NameDescriptionExample

10.3.1.50 - Set a permission into the resource based policy

10.3.1.50.1 - 1.2

scpcli iam permission set
--sid <value>
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Set a permission into the resource based policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

10.3.1.50.2 - 1.1

scpcli iam permission set
--sid <value>
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Set a permission into the resource based policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

10.3.1.50.3 - 1.0

scpcli iam permission set
--sid <value>
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Set a permission into the resource based policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

10.3.1.51 - Set an access key

10.3.1.51.1 - 1.2

scpcli iam access-key set
--access_key_id <value>
[--is_enabled <value>]

Description

Set or update an access key

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess key IDf39c460fade34fecb05ede8f904b24b7
is_enabled
optional
boolean활성화 여부true

10.3.1.51.2 - 1.1

scpcli iam access-key set
--access_key_id <value>
[--is_enabled <value>]

Description

Set or update an access key

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess key IDf39c460fade34fecb05ede8f904b24b7
is_enabled
optional
boolean활성화 여부true

10.3.1.51.3 - 1.0

scpcli iam access-key set
--access_key_id <value>
[--is_enabled <value>]

Description

Set or update an access key

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess key IDf39c460fade34fecb05ede8f904b24b7
is_enabled
optional
boolean활성화 여부true

10.3.1.52 - Set role

10.3.1.52.1 - 1.2

scpcli iam role set
--role_id <value>
[--description <value>]
[--max_session_duration <value>]

Description

Set role

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
description
optional
string역할 설명-
max_session_duration
optional
integer역할 세션 최대 지속 시간(초)3600

10.3.1.52.2 - 1.1

scpcli iam role set
--role_id <value>
[--description <value>]
[--max_session_duration <value>]

Description

Set role

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
description
optional
string역할 설명-
max_session_duration
optional
integer역할 세션 최대 지속 시간(초)3600

10.3.1.52.3 - 1.0

scpcli iam role set
--role_id <value>
[--description <value>]
[--max_session_duration <value>]

Description

Set role

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
description
optional
string역할 설명-
max_session_duration
optional
integer역할 세션 최대 지속 시간(초)3600

10.3.1.53 - Set role trust policy

10.3.1.53.1 - 1.2

scpcli iam role trust policy
--role_id <value>
--version <value>
--statement <value>

Description

Set role trust policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

10.3.1.53.2 - 1.1

scpcli iam role trust policy
--role_id <value>
--version <value>
--statement <value>

Description

Set role trust policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

10.3.1.53.3 - 1.0

scpcli iam role trust policy
--role_id <value>
--version <value>
--statement <value>

Description

Set role trust policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

10.3.1.54 - Set the policy

10.3.1.54.1 - 1.2

scpcli iam policy set
--policy_id <value>
--version <value>
--statement <value>
[--default_version_id <value>]
[--description <value>]
[--policy_name <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
default_version_id
optional
stringPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_name
optional
stringPolicy NamePolicy1
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

10.3.1.54.2 - 1.1

scpcli iam policy set
--policy_id <value>
--version <value>
--statement <value>
[--default_version_id <value>]
[--description <value>]
[--policy_name <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
default_version_id
optional
stringPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_name
optional
stringPolicy NamePolicy1
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

10.3.1.54.3 - 1.0

scpcli iam policy set
--policy_id <value>
--version <value>
--statement <value>
[--default_version_id <value>]
[--description <value>]
[--policy_name <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
default_version_id
optional
stringPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_name
optional
stringPolicy NamePolicy1
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

10.3.1.55 - Set the resource based policy

10.3.1.55.1 - 1.2

scpcli iam resource policy set
--srn <value>
--version <value>
--statement <value>
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the resource based policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

10.3.1.55.2 - 1.1

scpcli iam resource policy set
--srn <value>
--version <value>
--statement <value>
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the resource based policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

10.3.1.55.3 - 1.0

scpcli iam resource policy set
--srn <value>
--version <value>
--statement <value>
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the resource based policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

10.3.1.56 - Show group policy

10.3.1.56.1 - 1.2

scpcli iam group policy show
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Show group policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy Id37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type List['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.56.2 - 1.1

scpcli iam group policy show
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Show group policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy Id37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type List['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.56.3 - 1.0

scpcli iam group policy show
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Show group policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy Id37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type List['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_email수정자 Emailsamsung.kim@samsung.com
modifier_name수정자 성, 이름Kim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_name서비스 Display 명Identity Access Management
service_typeService Typeiam
srn삼성 리소스 자원명srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

10.3.1.57 - Show the policy

10.3.1.57.1 - 1.2

scpcli iam policy show
--policy_id <value>

Description

Show the policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

10.3.1.57.2 - 1.1

scpcli iam policy show
--policy_id <value>

Description

Show the policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

10.3.1.57.3 - 1.0

scpcli iam policy show
--policy_id <value>

Description

Show the policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

10.3.1.58 - Show the resource based policy

10.3.1.58.1 - 1.2

scpcli iam resource policy show
--srn <value>

Description

Show the resource based policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document{‘Statement’: [{‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’}

10.3.1.58.2 - 1.1

scpcli iam resource policy show
--srn <value>

Description

Show the resource based policy

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document{‘Statement’: [{‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’}

10.3.1.58.3 - 1.0

scpcli iam resource policy show
--srn <value>

Description

Show the resource based policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document{‘Statement’: [{‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’}

10.3.1.59 - Update IAM user

10.3.1.59.1 - 1.2

scpcli iam iam user set
--user_id <value>
--account_id <value>
--password_reuse_count <value>
[--description <value>]

Description

Update IAM user

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-
password_reuse_count
required
integer비밀 번호 재사용 가능 횟수-
description
optional
stringdescription-

10.3.1.59.2 - 1.1

scpcli iam iam user set
--user_id <value>
--account_id <value>
--password_reuse_count <value>
[--description <value>]

Description

Update IAM user

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-
password_reuse_count
required
integer비밀 번호 재사용 가능 횟수-
description
optional
stringdescription-

10.3.1.59.3 - 1.0

scpcli iam iam user set
--user_id <value>
--account_id <value>
--password_reuse_count <value>
[--description <value>]

Description

Update IAM user

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-
password_reuse_count
required
integer비밀 번호 재사용 가능 횟수-
description
optional
stringdescription-

10.3.1.60 - Update IAM user password

10.3.1.60.1 - 1.2

scpcli iam iam user password set
--user_id <value>
--account_id <value>
--password <value>
[--temporary_password <value>]

Description

Update IAM user password

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-
password
required
string비밀 번호-
temporary_password
optional
booleantemporary-

10.3.1.60.2 - 1.1

scpcli iam iam user password set
--user_id <value>
--account_id <value>
--password <value>
[--temporary_password <value>]

Description

Update IAM user password

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-
password
required
string비밀 번호-
temporary_password
optional
booleantemporary-

10.3.1.60.3 - 1.0

scpcli iam iam user password set
--user_id <value>
--account_id <value>
--password <value>
[--temporary_password <value>]

Description

Update IAM user password

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-
password
required
string비밀 번호-
temporary_password
optional
booleantemporary-

10.3.1.61 - Update saml provider information

10.3.1.61.1 - 1.2

scpcli iam saml provider set
--saml_provider_id <value>
[--description <value>]
[--file <value>]
[--saml_provider_name <value>]
[--tags <value>]

Description

Update saml provider information

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
saml_provider_id
required
string자격증명공급자 ID-
description
optional
string자격증명공급자 설명SAML provider Description
file
optional
string메타데이터 파일keycloak-idp-saml.xml
saml_provider_name
optional
string자격증명공급자 이름IdpTest
tags
optional
array태그{'key': 'company', 'value': 'SDS'}

10.3.1.61.2 - 1.1

scpcli iam saml provider set
--saml_provider_id <value>
[--description <value>]
[--file <value>]
[--saml_provider_name <value>]
[--tags <value>]

Description

Update saml provider information

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
saml_provider_id
required
string자격증명공급자 ID-
description
optional
string자격증명공급자 설명SAML provider Description
file
optional
string메타데이터 파일keycloak-idp-saml.xml
saml_provider_name
optional
string자격증명공급자 이름IdpTest
tags
optional
array태그{'key': 'company', 'value': 'SDS'}

10.3.1.61.3 - 1.0

scpcli iam saml provider set
--saml_provider_id <value>
[--description <value>]
[--file <value>]
[--saml_provider_name <value>]
[--tags <value>]

Description

Update saml provider information

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
saml_provider_id
required
string자격증명공급자 ID-
description
optional
string자격증명공급자 설명SAML provider Description
file
optional
string메타데이터 파일keycloak-idp-saml.xml
saml_provider_name
optional
string자격증명공급자 이름IdpTest
tags
optional
array태그{'key': 'company', 'value': 'SDS'}

10.4 - ID Center

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 IAM 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20260223
1.1SUPPORTED20260531
1.2CURRENT-

10.4.1 - CLIs

10.4.1.1 - CreateAccountAssignment

10.4.1.1.1 - 1.2

scpcli iam-identity-center create account assignments
--instance_id <value>
[--accounts <value>]
[--permission_sets <value>]
[--principals <value>]

Description

set a specific account Assignment

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
accounts
optional
array'{"target_account_email": "target_account@example.com", "target_account_id": "3265ab469f0d406d83073da3e11e7a6c", "target_account_name": "target_account@example.com"}'
permission_sets
optional
array'{"custom_policies": [], "inline_policies": [], "managed_policies": [], "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1", "permission_set_name": "Permission Set", "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}", "session_duration": 3600}'
principals
optional
array'{"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2", "principal_type": "USER"}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
permission_set_id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_id주체 ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_type주체 유형USER
target_account_id할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c

10.4.1.1.2 - 1.1

scpcli iam-identity-center create account assignments
--instance_id <value>
[--accounts <value>]
[--permission_sets <value>]
[--principals <value>]

Description

set a specific account Assignment

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
accounts
optional
array'{"target_account_email": "target_account@example.com", "target_account_id": "3265ab469f0d406d83073da3e11e7a6c", "target_account_name": "target_account@example.com"}'
permission_sets
optional
array'{"customer_policies": [], "inline_policies": [], "managed_policies": [], "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1", "permission_set_name": "Permission Set", "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}", "session_duration": 3600}'
principals
optional
array'{"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2", "principal_type": "USER"}'

Responses

NameDescriptionExample
account_assignment_id할당 IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
permission_set_id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_id주체 ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_type주체 유형USER
role_srn권한 세트 설명Permissions for administrators
target_account_id할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c

10.4.1.1.3 - 1.0

scpcli iam-identity-center create account assignments
--instance_id <value>
[--accounts <value>]
[--permission_sets <value>]
[--principals <value>]

Description

set a specific account Assignment

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
accounts
optional
array'{"target_account_email": "target_account@example.com", "target_account_id": "3265ab469f0d406d83073da3e11e7a6c", "target_account_name": "target_account@example.com"}'
permission_sets
optional
array'{"customer_policies": [], "inline_policies": [], "managed_policies": [], "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1", "permission_set_name": "Permission Set", "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}", "session_duration": 3600}'
principals
optional
array'{"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2", "principal_type": "USER"}'

Responses

NameDescriptionExample
account_assignment_id할당 IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
permission_set_id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_id주체 ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_type주체 유형USER
role_srn권한 세트 설명Permissions for administrators
target_account_id할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c

10.4.1.2 - CreateBulkGroupUsers

10.4.1.2.1 - 1.2

scpcli iam-identity-center group bulk user add
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

add multiple users to a specific group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
array사용자 ID 목록user-12345
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.2.2 - 1.1

scpcli iam-identity-center group bulk user add
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

add multiple users to a specific group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
array사용자 ID 목록user-12345
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.2.3 - 1.0

scpcli iam-identity-center group bulk user add
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

add multiple users to a specific group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
array사용자 ID 목록user-12345
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.3 - CreateGroup

10.4.1.3.1 - 1.2

scpcli iam-identity-center group create
--name <value>
--instance_id <value>
[--description <value>]
[--user_uuids <value>]

Description

create a group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
name
required
string그룹 이름Admin_Group
instance_id
required
string인스턴스 IDssoins-12345
description
optional
string그룹 설명Group for administrators
user_uuids
optional
array그룹에 추가할 사용자 ID 목록138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.3.2 - 1.1

scpcli iam-identity-center group create
--name <value>
--instance_id <value>
[--description <value>]
[--user_uuids <value>]

Description

create a group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
name
required
string그룹 이름Admin_Group
instance_id
required
string인스턴스 IDssoins-12345
description
optional
string그룹 설명Group for administrators
user_uuids
optional
array그룹에 추가할 사용자 ID 목록138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.3.3 - 1.0

scpcli iam-identity-center group create
--name <value>
--instance_id <value>
[--description <value>]
[--user_uuids <value>]

Description

create a group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
name
required
string그룹 이름Admin_Group
instance_id
required
string인스턴스 IDssoins-12345
description
optional
string그룹 설명Group for administrators
user_uuids
optional
array그룹에 추가할 사용자 ID 목록138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.4 - CreateInstance

10.4.1.4.1 - 1.2

scpcli iam-identity-center instance create
--name <value>
[--description <value>]
[--identity_store_type <value>]
[--bind_credential <value>]
[--bind_dn <value>]
[--connection_url <value>]
[--rdn_ldap_attribute <value>]
[--user_object_classes <value>]
[--username_ldap_attribute <value>]
[--users_dn <value>]

Description

create a instance

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
name
required
string인스턴스 이름My Instance
description
optional
string인스턴스 설명My Instance Description
identity_store_type
optional
string자격 증명 소스 유형-
bind_credential
optional
stringBind 비밀번호password
bind_dn
optional
stringBind DNCN=Administrator,CN=Users,DC=test,DC=add
connection_url
optional
stringLDAP 서버 URLldaps://test.subdomain.company.com:123
rdn_ldap_attribute
optional
stringRDN LDAP 속성cn
user_object_classes
optional
string사용자 객체 클래스person, organizationalPerson, user
username_ldap_attribute
optional
string사용자 이름 LDAP 속성sAMAccountName
users_dn
optional
string사용자 DNOU=Employees,OU=Accounts,DC=sub,DC=org

Responses

NameDescriptionExample
id인스턴스 IDssoins-12345
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delegated_account_id위임된 관리자 계정 IDacc-2353
delegated_at위임 일시2023-10-15 14:30:00
delegated_by위임자 IDsef2w3c8c29a449dbfa8681f8f1d78e2
description인스턴스 설명My Instance Description
identity_store_config자격 증명 소스 설정{‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’}
identity_store_id자격 증명 소스 IDd-12345
identity_store_type자격 증명 소스 유형
last_sync_at마지막 동기화 날짜2025-08-06 10:30:00
last_sync_status마지막 동기화 상태[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’]
master_account_id관리자 계정 IDacc-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name인스턴스 이름My Instance
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srn인스턴스 SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO 시작 URLhttps://login.e.samsungsdscloud.com/d-12345
state상태

10.4.1.4.2 - 1.1

scpcli iam-identity-center instance create
--name <value>
[--description <value>]
[--identity_store_type <value>]
[--bind_credential <value>]
[--bind_dn <value>]
[--connection_url <value>]
[--rdn_ldap_attribute <value>]
[--user_object_classes <value>]
[--username_ldap_attribute <value>]
[--users_dn <value>]

Description

create a instance

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
name
required
string인스턴스 이름My Instance
description
optional
string인스턴스 설명My Instance Description
identity_store_type
optional
string자격 증명 소스 유형-
bind_credential
optional
stringBind 비밀번호password
bind_dn
optional
stringBind DNCN=Administrator,CN=Users,DC=test,DC=add
connection_url
optional
stringLDAP 서버 URLldaps://test.subdomain.company.com:123
rdn_ldap_attribute
optional
stringRDN LDAP 속성cn
user_object_classes
optional
string사용자 객체 클래스person, organizationalPerson, user
username_ldap_attribute
optional
string사용자 이름 LDAP 속성sAMAccountName
users_dn
optional
string사용자 DNOU=Employees,OU=Accounts,DC=sub,DC=org

Responses

NameDescriptionExample
id인스턴스 IDssoins-12345
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
delegated_account_id위임된 관리자 계정 IDacc-2353
delegated_at위임 일시2023-10-15 14:30:00
delegated_by위임자 IDsef2w3c8c29a449dbfa8681f8f1d78e2
description인스턴스 설명My Instance Description
identity_store_config자격 증명 소스 설정{‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’}
identity_store_id자격 증명 소스 IDd-12345
identity_store_type자격 증명 소스 유형
last_sync_at마지막 동기화 날짜2025-08-06 10:30:00
last_sync_status마지막 동기화 상태[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’]
master_account_id관리자 계정 IDacc-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name인스턴스 이름My Instance
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srn인스턴스 SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO 시작 URLhttps://login.e.samsungsdscloud.com/d-12345
state상태

10.4.1.5 - CreatePermissionSet

10.4.1.5.1 - 1.2

scpcli iam-identity-center permission set create
--session_duration <value>
--name <value>
--instance_id <value>
[--custom_policies <value>]
[--description <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

create a permission set

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
session_duration
required
integer최대 세션 지속 시간3600
name
required
string인스턴스 이름My Instance
instance_id
required
string인스턴스 IDssoins-12345
custom_policies
optional
array고객 관리 정책-
description
optional
string인스턴스 설명My Instance Description
inline_policies
optional
array인라인 정책-
managed_policies
optional
array관리 정책'{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}'

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
custom_policies고객 관리 정책
description권한 세트 설명Permissions for administrators
inline_policies인라인 정책
instance_id인스턴스 IDssoins-12345
managed_policies관리 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
session_duration최대 세션 지속 시간3600
srn권한 세트 SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
state상태

10.4.1.5.2 - 1.1

scpcli iam-identity-center permission set create
--session_duration <value>
--name <value>
--instance_id <value>
[--customer_policies <value>]
[--description <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

create a permission set

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
session_duration
required
integer최대 세션 지속 시간3600
name
required
string인스턴스 이름My Instance
instance_id
required
string인스턴스 IDssoins-12345
customer_policies
optional
array고객 관리 정책-
description
optional
string인스턴스 설명My Instance Description
inline_policies
optional
array인라인 정책-
managed_policies
optional
array관리 정책'{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}'

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
customer_policies고객 관리 정책
description권한 세트 설명Permissions for administrators
inline_policies인라인 정책
instance_id인스턴스 IDssoins-12345
managed_policies관리 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
session_duration최대 세션 지속 시간3600
srn권한 세트 SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
state상태

10.4.1.5.3 - 1.0

scpcli iam-identity-center permission set create
--session_duration <value>
--name <value>
--instance_id <value>
[--customer_policies <value>]
[--description <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

create a permission set

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
session_duration
required
integer최대 세션 지속 시간3600
name
required
string인스턴스 이름My Instance
instance_id
required
string인스턴스 IDssoins-12345
customer_policies
optional
array고객 관리 정책-
description
optional
string인스턴스 설명My Instance Description
inline_policies
optional
array인라인 정책-
managed_policies
optional
array관리 정책'{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}'

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
customer_policies고객 관리 정책
description권한 세트 설명Permissions for administrators
inline_policies인라인 정책
instance_id인스턴스 IDssoins-12345
managed_policies관리 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
session_duration최대 세션 지속 시간3600
srn권한 세트 SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
state상태

10.4.1.6 - CreateUser

10.4.1.6.1 - 1.2

scpcli iam-identity-center user create
--user_id <value>
--name <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--group_ids <value>]
[--manager <value>]
[--nation_id <value>]
[--password <value>]
[--phone_number <value>]
[--temporary_password <value>]

Description

create a user

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 로그인 IDjohndoe
name
required
string사용자 실명John Doe
instance_id
required
string인스턴스 IDssoins-12345
business_unit
optional
string사업부Business Unit A
department
optional
string부서Department X
description
optional
string사용자 설명Description of John Doe
email
optional
string사용자 이메일john.doe@example.com
employee_id
optional
string사번emp-12345
group_ids
optional
array사용자 속한 그룹 목록39520424-440c-41c0-9b9c-f22b2129f6f9
manager
optional
string관리자Alice Smith
nation_id
optional
string국가 ID+82
password
optional
string비밀번호-
phone_number
optional
string휴대폰 번호010-1234-5678
temporary_password
optional
boolean임시 비밀번호 여부-

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unit사업부Business Unit A
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
department부서Department X
description사용자 설명Description of John Doe
email사용자 이메일john.doe@example.com
email_authenticated이메일 인증 여부
employee_id사번emp-12345
groups그룹 목록
instance_id인스턴스 IDssoins-12345
last_login_at마지막 로그인 일시2024-12-19 01:09:05.000
last_password_update_at최근 비밀번호 변경 일시2025-11-24T08:14:51.694996
manager관리자Alice Smith
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name사용자 실명John Doe
nation_id국가 ID+82
password비밀번호
password_failed_count비밀번호 실패 횟수6
password_reuse_count비밀번호 재사용 제한 횟수6
phone_authenticated휴대폰 인증 여부
phone_number휴대폰 번호010-1234-5678
temporary_password임시 비밀번호 여부
tz_id타임존 IDAsia/Seoul
user_id사용자 로그인 IDjohndoe

10.4.1.6.2 - 1.1

scpcli iam-identity-center user create
--user_id <value>
--name <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--group_ids <value>]
[--manager <value>]
[--nation_id <value>]
[--password <value>]
[--phone_number <value>]
[--temporary_password <value>]

Description

create a user

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 로그인 IDjohndoe
name
required
string사용자 실명John Doe
instance_id
required
string인스턴스 IDssoins-12345
business_unit
optional
string사업부Business Unit A
department
optional
string부서Department X
description
optional
string사용자 설명Description of John Doe
email
optional
string사용자 이메일john.doe@example.com
employee_id
optional
string사번emp-12345
group_ids
optional
array사용자 속한 그룹 목록39520424-440c-41c0-9b9c-f22b2129f6f9
manager
optional
string관리자Alice Smith
nation_id
optional
string국가 ID+82
password
optional
string비밀번호-
phone_number
optional
string휴대폰 번호010-1234-5678
temporary_password
optional
boolean임시 비밀번호 여부-

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unit사업부Business Unit A
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
department부서Department X
description사용자 설명Description of John Doe
email사용자 이메일john.doe@example.com
email_authenticated이메일 인증 여부
employee_id사번emp-12345
groups그룹 목록
instance_id인스턴스 IDssoins-12345
last_login_at마지막 로그인 일시2024-12-19 01:09:05.000
last_password_update_at최근 비밀번호 변경 일시2025-11-24T08:14:51.694996
manager관리자Alice Smith
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name사용자 실명John Doe
nation_id국가 ID+82
password비밀번호
password_failed_count비밀번호 실패 횟수6
password_reuse_count비밀번호 재사용 제한 횟수6
phone_authenticated휴대폰 인증 여부
phone_number휴대폰 번호010-1234-5678
temporary_password임시 비밀번호 여부
tz_id타임존 IDAsia/Seoul
user_id사용자 로그인 IDjohndoe

10.4.1.6.3 - 1.0

scpcli iam-identity-center user create
--user_id <value>
--name <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--group_ids <value>]
[--manager <value>]
[--nation_id <value>]
[--password <value>]
[--phone_number <value>]
[--temporary_password <value>]

Description

create a user

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 로그인 IDjohndoe
name
required
string사용자 실명John Doe
instance_id
required
string인스턴스 IDssoins-12345
business_unit
optional
string사업부Business Unit A
department
optional
string부서Department X
description
optional
string사용자 설명Description of John Doe
email
optional
string사용자 이메일john.doe@example.com
employee_id
optional
string사번emp-12345
group_ids
optional
array사용자 속한 그룹 목록39520424-440c-41c0-9b9c-f22b2129f6f9
manager
optional
string관리자Alice Smith
nation_id
optional
string국가 ID+82
password
optional
string비밀번호-
phone_number
optional
string휴대폰 번호010-1234-5678
temporary_password
optional
boolean임시 비밀번호 여부-

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unit사업부Business Unit A
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
department부서Department X
description사용자 설명Description of John Doe
email사용자 이메일john.doe@example.com
email_authenticated이메일 인증 여부
employee_id사번emp-12345
groups그룹 목록
instance_id인스턴스 IDssoins-12345
last_login_at마지막 로그인 일시2024-12-19 01:09:05.000
last_password_update_at최근 비밀번호 변경 일시2025-11-24T08:14:51.694996
manager관리자Alice Smith
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name사용자 실명John Doe
nation_id국가 ID+82
password비밀번호
password_failed_count비밀번호 실패 횟수6
password_reuse_count비밀번호 재사용 제한 횟수6
phone_authenticated휴대폰 인증 여부
phone_number휴대폰 번호010-1234-5678
temporary_password임시 비밀번호 여부
tz_id타임존 IDAsia/Seoul
user_id사용자 로그인 IDjohndoe

10.4.1.7 - DeleteAccountAssignment

10.4.1.7.1 - 1.2

scpcli iam-identity-center account delete
--account_assignment_id <value>
--target_account_id <value>
--instance_id <value>
[--only_user_removed <value>]

Description

delete a specific account Assignment

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
account_assignment_id
required
string할당 IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
target_account_id
required
string할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
string인스턴스 IDssoins-12345
only_user_removed
optional
boolean직접 적용 제외 여부-

10.4.1.7.2 - 1.1

scpcli iam-identity-center account delete
--account_assignment_id <value>
--target_account_id <value>
--instance_id <value>
[--only_user_removed <value>]

Description

delete a specific account Assignment

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
account_assignment_id
required
string할당 IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
target_account_id
required
string할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
string인스턴스 IDssoins-12345
only_user_removed
optional
boolean직접 적용 제외 여부-

10.4.1.7.3 - 1.0

scpcli iam-identity-center account delete
--account_assignment_id <value>
--target_account_id <value>
--instance_id <value>
[--only_user_removed <value>]

Description

delete a specific account Assignment

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
account_assignment_id
required
string할당 IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
target_account_id
required
string할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
string인스턴스 IDssoins-12345
only_user_removed
optional
boolean직접 적용 제외 여부-

10.4.1.8 - DeleteBulkAccountAssignment

10.4.1.8.1 - 1.2

scpcli iam-identity-center account bulk delete
--target_account_id <value>
--instance_id <value>
[--account_assignment_ids <value>]
[--only_user_removed <value>]

Description

delete multiple account Assignment

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
target_account_id
required
string할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
string인스턴스 IDssoins-12345
account_assignment_ids
optional
array할당 IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
only_user_removed
optional
boolean직접 적용 제외 여부-

10.4.1.8.2 - 1.1

scpcli iam-identity-center account bulk delete
--target_account_id <value>
--instance_id <value>
[--account_assignment_ids <value>]
[--only_user_removed <value>]

Description

delete multiple account Assignment

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
target_account_id
required
string할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
string인스턴스 IDssoins-12345
account_assignment_ids
optional
array할당 IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
only_user_removed
optional
boolean직접 적용 제외 여부-

10.4.1.8.3 - 1.0

scpcli iam-identity-center account bulk delete
--target_account_id <value>
--instance_id <value>
[--account_assignment_ids <value>]
[--only_user_removed <value>]

Description

delete multiple account Assignment

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
target_account_id
required
string할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
string인스턴스 IDssoins-12345
account_assignment_ids
optional
array할당 IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
only_user_removed
optional
boolean직접 적용 제외 여부-

10.4.1.9 - DeleteBulkGroups

10.4.1.9.1 - 1.2

scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>

Description

delete groups

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
group_ids
required
array그룹 ID 목록group-12345

10.4.1.9.2 - 1.1

scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>

Description

delete groups

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
group_ids
required
array그룹 ID 목록group-12345

10.4.1.9.3 - 1.0

scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>

Description

delete groups

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
group_ids
required
array그룹 ID 목록group-12345

10.4.1.10 - DeleteBulkGroupUsers

10.4.1.10.1 - 1.2

scpcli iam-identity-center group user remove
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

remove users from the specific group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
array사용자 ID 목록user-12345
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.10.2 - 1.1

scpcli iam-identity-center group user remove
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

remove users from the specific group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
array사용자 ID 목록user-12345
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.10.3 - 1.0

scpcli iam-identity-center group user remove
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

remove users from the specific group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
array사용자 ID 목록user-12345
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.11 - DeleteBulkUsers

10.4.1.11.1 - 1.2

scpcli iam-identity-center user bulk delete
--user_uuids <value>
--instance_id <value>

Description

delete bulk users

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_uuids
required
array사용자 ID 목록user-12345
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.11.2 - 1.1

scpcli iam-identity-center user bulk delete
--user_uuids <value>
--instance_id <value>

Description

delete bulk users

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_uuids
required
array사용자 ID 목록user-12345
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.11.3 - 1.0

scpcli iam-identity-center user bulk delete
--user_uuids <value>
--instance_id <value>

Description

delete bulk users

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_uuids
required
array사용자 ID 목록user-12345
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.12 - DeleteGroup

10.4.1.12.1 - 1.2

scpcli iam-identity-center group delete
--group_id <value>
--instance_id <value>

Description

delete a specific group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.12.2 - 1.1

scpcli iam-identity-center group delete
--group_id <value>
--instance_id <value>

Description

delete a specific group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.12.3 - 1.0

scpcli iam-identity-center group delete
--group_id <value>
--instance_id <value>

Description

delete a specific group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.13 - DeleteInstance

10.4.1.13.1 - 1.2

scpcli iam-identity-center instance delete
--instance_id <value>

Description

delete a specific instance

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.13.2 - 1.1

scpcli iam-identity-center instance delete
--instance_id <value>

Description

delete a specific instance

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.13.3 - 1.0

scpcli iam-identity-center instance delete
--instance_id <value>

Description

delete a specific instance

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.14 - DeletePermissionSet

10.4.1.14.1 - 1.2

scpcli iam-identity-center permission set delete
--permission_set_id <value>
--instance_id <value>

Description

delete a specific permission set

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.14.2 - 1.1

scpcli iam-identity-center permission set delete
--permission_set_id <value>
--instance_id <value>

Description

delete a specific permission set

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.14.3 - 1.0

scpcli iam-identity-center permission set delete
--permission_set_id <value>
--instance_id <value>

Description

delete a specific permission set

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.15 - DeletePermissionSetPolicies

10.4.1.15.1 - 1.2

scpcli iam-identity-center permission set delete policies
--permission_set_id <value>
--policy_ids <value>
--instance_id <value>

Description

delete policies to a specific permission set

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
policy_ids
required
array-
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.15.2 - 1.1

scpcli iam-identity-center permission set delete policies
--permission_set_id <value>
--policy_ids <value>
--instance_id <value>

Description

delete policies to a specific permission set

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
policy_ids
required
array-
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.15.3 - 1.0

scpcli iam-identity-center permission set delete policies
--permission_set_id <value>
--policy_ids <value>
--instance_id <value>

Description

delete policies to a specific permission set

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
policy_ids
required
array-
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.16 - DeleteUser

10.4.1.16.1 - 1.2

scpcli iam-identity-center user delete
--user_uuid <value>
--instance_id <value>

Description

delete a specific user

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_uuid
required
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.16.2 - 1.1

scpcli iam-identity-center user delete
--user_uuid <value>
--instance_id <value>

Description

delete a specific user

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_uuid
required
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.16.3 - 1.0

scpcli iam-identity-center user delete
--user_uuid <value>
--instance_id <value>

Description

delete a specific user

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_uuid
required
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

10.4.1.17 - ListAccountAssignments

10.4.1.17.1 - 1.2

scpcli iam-identity-center list account assignment
--target_account_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--target_account_name <value>]
[--target_account_email <value>]
[--permission_set_id <value>]
[--principal_name <value>]
[--role_srn <value>]

Description

get account assignment list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
target_account_id
required
string할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
target_account_name
optional
string할당된 Account명Admin Account
target_account_email
optional
string할당된 계정 이메일target_account@example.com
permission_set_id
optional
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_name
optional
string주체 이름GROUP0407
role_srn
optional
string역할 SRNsrn:role:kr-j:1234:role/admin@example.com

Responses

NameDescriptionExample
instance_id인스턴스 IDssoins-12345
permission_sets
principal_id주체 ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_name주체 이름GROUP0407
principal_type주체 유형USER
role_srn권한 세트 설명Permissions for administrators
target_account_email할당된 계정 이메일target_account@example.com
target_account_id할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
target_account_name할당된 Account명Admin Account

10.4.1.17.2 - 1.1

scpcli iam-identity-center list account assignment
--target_account_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--target_account_name <value>]
[--target_account_email <value>]
[--permission_set_id <value>]
[--principal_name <value>]
[--role_srn <value>]

Description

get account assignment list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
target_account_id
required
string할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
target_account_name
optional
string할당된 Account명Admin Account
target_account_email
optional
string할당된 계정 이메일target_account@example.com
permission_set_id
optional
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_name
optional
string주체 이름GROUP0407
role_srn
optional
string역할 SRNsrn:role:kr-j:1234:role/admin@example.com

Responses

NameDescriptionExample
instance_id인스턴스 IDssoins-12345
permission_sets
principal_id주체 ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_name주체 이름GROUP0407
principal_type주체 유형USER
role_srn권한 세트 설명Permissions for administrators
target_account_email할당된 계정 이메일target_account@example.com
target_account_id할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
target_account_name할당된 Account명Admin Account

10.4.1.17.3 - 1.0

scpcli iam-identity-center list account assignment
--target_account_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--target_account_name <value>]
[--target_account_email <value>]
[--permission_set_id <value>]
[--principal_name <value>]
[--role_srn <value>]

Description

get account assignment list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
target_account_id
required
string할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
target_account_name
optional
string할당된 Account명Admin Account
target_account_email
optional
string할당된 계정 이메일target_account@example.com
permission_set_id
optional
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_name
optional
string주체 이름GROUP0407
role_srn
optional
string역할 SRNsrn:role:kr-j:1234:role/admin@example.com

Responses

NameDescriptionExample
instance_id인스턴스 IDssoins-12345
permission_sets
principal_id주체 ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_name주체 이름GROUP0407
principal_type주체 유형USER
role_srn권한 세트 설명Permissions for administrators
target_account_email할당된 계정 이메일target_account@example.com
target_account_id할당된 계정 ID3265ab469f0d406d83073da3e11e7a6c
target_account_name할당된 Account명Admin Account

10.4.1.18 - ListGroups

10.4.1.18.1 - 1.2

scpcli iam-identity-center group list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--excluded_user_uuid <value>]
[--excluded_account_id <value>]

Description

get groups list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string그룹 이름Admin_Group
excluded_user_uuid
optional
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.18.2 - 1.1

scpcli iam-identity-center group list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--excluded_user_uuid <value>]
[--excluded_account_id <value>]

Description

get groups list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string그룹 이름Admin_Group
excluded_user_uuid
optional
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.18.3 - 1.0

scpcli iam-identity-center group list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--excluded_user_uuid <value>]
[--excluded_account_id <value>]

Description

get groups list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string그룹 이름Admin_Group
excluded_user_uuid
optional
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.19 - ListGroupUsers

10.4.1.19.1 - 1.2

scpcli iam-identity-center group users list
--group_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]

Description

get group users list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
group_count사용자 속한 그룹 개수2
groups사용자 속한 그룹 목록[{‘created_at’: ‘2025-07-03T12:05:11’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘39520424-440c-41c0-9b9c-f22b2129f6f9’, ‘modified_at’: ‘2025-07-03T12:05:11’, ‘modified_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ’name’: ‘admin’}, {‘created_at’: ‘2025-07-03T12:05:36’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘80c53fe1-4e27-4cce-92be-151cf0f2873e’, ‘modified_at’: ‘2025-07-07T05:16:58’, ‘modified_by’: ‘941e76c4b9424cd9b0ac3a12d5f4335d’, ’name’: ’test-group’}]
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name사용자 실명John Doe
user_id사용자 로그인 IDjohndoe

10.4.1.19.2 - 1.1

scpcli iam-identity-center group users list
--group_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]

Description

get group users list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
group_count사용자 속한 그룹 개수2
groups사용자 속한 그룹 목록[{‘created_at’: ‘2025-07-03T12:05:11’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘39520424-440c-41c0-9b9c-f22b2129f6f9’, ‘modified_at’: ‘2025-07-03T12:05:11’, ‘modified_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ’name’: ‘admin’}, {‘created_at’: ‘2025-07-03T12:05:36’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘80c53fe1-4e27-4cce-92be-151cf0f2873e’, ‘modified_at’: ‘2025-07-07T05:16:58’, ‘modified_by’: ‘941e76c4b9424cd9b0ac3a12d5f4335d’, ’name’: ’test-group’}]
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name사용자 실명John Doe
user_id사용자 로그인 IDjohndoe

10.4.1.19.3 - 1.0

scpcli iam-identity-center group users list
--group_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]

Description

get group users list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
group_count사용자 속한 그룹 개수2
groups사용자 속한 그룹 목록[{‘created_at’: ‘2025-07-03T12:05:11’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘39520424-440c-41c0-9b9c-f22b2129f6f9’, ‘modified_at’: ‘2025-07-03T12:05:11’, ‘modified_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ’name’: ‘admin’}, {‘created_at’: ‘2025-07-03T12:05:36’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘80c53fe1-4e27-4cce-92be-151cf0f2873e’, ‘modified_at’: ‘2025-07-07T05:16:58’, ‘modified_by’: ‘941e76c4b9424cd9b0ac3a12d5f4335d’, ’name’: ’test-group’}]
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name사용자 실명John Doe
user_id사용자 로그인 IDjohndoe

10.4.1.20 - ListInstances

10.4.1.20.1 - 1.2

scpcli iam-identity-center instance list
[--size <value>]
[--page <value>]
[--sort <value>]

Description

get instances list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id인스턴스 IDssoins-12345
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
master_account_id관리자 계정 IDacc-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srn인스턴스 SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
state상태

10.4.1.20.2 - 1.1

scpcli iam-identity-center instance list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get instances list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string인스턴스 이름My Instance

Responses

NameDescriptionExample
id인스턴스 IDssoins-12345
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
master_account_id관리자 계정 IDacc-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srn인스턴스 SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
state상태

10.4.1.20.3 - 1.0

scpcli iam-identity-center instance list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get instances list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string인스턴스 이름My Instance

Responses

NameDescriptionExample
id인스턴스 IDssoins-12345
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
master_account_id관리자 계정 IDacc-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srn인스턴스 SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
state상태

10.4.1.21 - ListPermissionSetPolicies

10.4.1.21.1 - 1.2

scpcli iam-identity-center permission set get policies
--permission_set_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--category <value>]
[--name <value>]

Description

get policies to a specific permission set

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
category
optional
****정책 유형INLINE_POLICY
name
optional
stringPermission Set

Responses

NameDescriptionExample
id정책 ID37f2e31ff86b415698d7e8eeafab445d
category정책 유형INLINE_POLICY
contentsJSON Document
name기본 정책명PolicyName
permission_set_id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1

10.4.1.21.2 - 1.1

scpcli iam-identity-center permission set get policies
--permission_set_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--category <value>]
[--name <value>]

Description

get policies to a specific permission set

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
category
optional
****정책 유형INLINE_POLICY
name
optional
stringPermission Set

Responses

NameDescriptionExample
id정책 ID37f2e31ff86b415698d7e8eeafab445d
category정책 유형INLINE_POLICY
contentsJSON Document
name기본 정책명PolicyName
permission_set_id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1

10.4.1.21.3 - 1.0

scpcli iam-identity-center permission set get policies
--permission_set_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--category <value>]
[--name <value>]

Description

get policies to a specific permission set

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
category
optional
****정책 유형INLINE_POLICY
name
optional
stringPermission Set

Responses

NameDescriptionExample
id정책 ID37f2e31ff86b415698d7e8eeafab445d
category정책 유형INLINE_POLICY
contentsJSON Document
name기본 정책명PolicyName
permission_set_id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1

10.4.1.22 - ListPermissionSets

10.4.1.22.1 - 1.2

scpcli iam-identity-center permission set list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get permission sets list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string권한 세트 이름Permission Set

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
custom_policies고객 관리 정책
description권한 세트 설명Permissions for administrators
inline_policies인라인 정책
instance_id인스턴스 IDssoins-12345
managed_policies관리 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
session_duration최대 세션 지속 시간3600
srn권한 세트 SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
state상태

10.4.1.22.2 - 1.1

scpcli iam-identity-center permission set list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get permission sets list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string권한 세트 이름Permission Set

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
description권한 세트 설명Permissions for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
state상태

10.4.1.22.3 - 1.0

scpcli iam-identity-center permission set list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get permission sets list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string권한 세트 이름Permission Set

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
description권한 세트 설명Permissions for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
state상태

10.4.1.23 - ListUsers

10.4.1.23.1 - 1.2

scpcli iam-identity-center user list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
[--excluded_group_id <value>]
[--excluded_account_id <value>]

Description

get users list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
string사용자 로그인 IDjohndoe
excluded_group_id
optional
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
name사용자 실명John Doe
user_id사용자 로그인 IDjohndoe

10.4.1.23.2 - 1.1

scpcli iam-identity-center user list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
[--excluded_group_id <value>]
[--excluded_account_id <value>]

Description

get users list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
string사용자 로그인 IDjohndoe
excluded_group_id
optional
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
name사용자 실명John Doe
user_id사용자 로그인 IDjohndoe

10.4.1.23.3 - 1.0

scpcli iam-identity-center user list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
[--excluded_group_id <value>]
[--excluded_account_id <value>]

Description

get users list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
string사용자 로그인 IDjohndoe
excluded_group_id
optional
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
name사용자 실명John Doe
user_id사용자 로그인 IDjohndoe

10.4.1.24 - SetGroup

10.4.1.24.1 - 1.2

scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]

Description

set a specific group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345
description
optional
string그룹 설명Group for administrators
name
optional
string그룹 이름Admin_Group

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group

10.4.1.24.2 - 1.1

scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]

Description

set a specific group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345
description
optional
string그룹 설명Group for administrators
name
optional
string그룹 이름Admin_Group

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group

10.4.1.24.3 - 1.0

scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]

Description

set a specific group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345
description
optional
string그룹 설명Group for administrators
name
optional
string그룹 이름Admin_Group

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group

10.4.1.25 - SetPermissionSet

10.4.1.25.1 - 1.2

scpcli iam-identity-center permission set set
--permission_set_id <value>
--instance_id <value>
[--description <value>]
[--session_duration <value>]

Description

set a specific permission set

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345
description
optional
string인스턴스 설명My Instance Description
session_duration
optional
integer최대 세션 지속 시간3600

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
custom_policies고객 관리 정책
description권한 세트 설명Permissions for administrators
inline_policies인라인 정책
instance_id인스턴스 IDssoins-12345
managed_policies관리 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
session_duration최대 세션 지속 시간3600
srn권한 세트 SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
state상태

10.4.1.25.2 - 1.1

scpcli iam-identity-center permission set set
--permission_set_id <value>
--instance_id <value>
[--description <value>]
[--session_duration <value>]

Description

set a specific permission set

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345
description
optional
string인스턴스 설명My Instance Description
session_duration
optional
integer최대 세션 지속 시간3600

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
customer_policies고객 관리 정책
description권한 세트 설명Permissions for administrators
inline_policies인라인 정책
instance_id인스턴스 IDssoins-12345
managed_policies관리 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
session_duration최대 세션 지속 시간3600
srn권한 세트 SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
state상태

10.4.1.25.3 - 1.0

scpcli iam-identity-center permission set set
--permission_set_id <value>
--instance_id <value>
[--description <value>]
[--session_duration <value>]

Description

set a specific permission set

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345
description
optional
string인스턴스 설명My Instance Description
session_duration
optional
integer최대 세션 지속 시간3600

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
customer_policies고객 관리 정책
description권한 세트 설명Permissions for administrators
inline_policies인라인 정책
instance_id인스턴스 IDssoins-12345
managed_policies관리 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
session_duration최대 세션 지속 시간3600
srn권한 세트 SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
state상태

10.4.1.26 - SetPermissionSetPolicies

10.4.1.26.1 - 1.2

scpcli iam-identity-center permission set set policies
--permission_set_id <value>
--instance_id <value>
[--custom_policies <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

set policies to a specific permission set

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345
custom_policies
optional
array고객 관리 정책-
inline_policies
optional
array인라인 정책-
managed_policies
optional
array관리 정책-

10.4.1.26.2 - 1.1

scpcli iam-identity-center permission set set policies
--permission_set_id <value>
--instance_id <value>
[--customer_policies <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

set policies to a specific permission set

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345
customer_policies
optional
array고객 관리 정책-
inline_policies
optional
array인라인 정책-
managed_policies
optional
array관리 정책-

10.4.1.26.3 - 1.0

scpcli iam-identity-center permission set set policies
--permission_set_id <value>
--instance_id <value>
[--customer_policies <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

set policies to a specific permission set

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345
customer_policies
optional
array고객 관리 정책-
inline_policies
optional
array인라인 정책-
managed_policies
optional
array관리 정책-

10.4.1.27 - SetUser

10.4.1.27.1 - 1.2

scpcli iam-identity-center user set
--user_uuid <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--manager <value>]
[--name <value>]
[--nation_id <value>]
[--phone_number <value>]
[--tz_id <value>]

Description

set a specific user

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_uuid
required
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345
business_unit
optional
string사업부Business Unit A
department
optional
string부서Department X
description
optional
string사용자 설명Description of John Doe
email
optional
string사용자 이메일john.doe@example.com
employee_id
optional
string사번emp-12345
manager
optional
string관리자Alice Smith
name
optional
string사용자 실명John Doe
nation_id
optional
string국가 ID+82
phone_number
optional
string휴대폰 번호010-1234-5678
tz_id
optional
string타임존 IDAsia/Seoul

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unit사업부Business Unit A
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
department부서Department X
description사용자 설명Description of John Doe
email사용자 이메일john.doe@example.com
email_authenticated이메일 인증 여부
employee_id사번emp-12345
groups그룹 목록
instance_id인스턴스 IDssoins-12345
last_login_at마지막 로그인 일시2024-12-19 01:09:05.000
last_password_update_at최근 비밀번호 변경 일시2025-11-24T08:14:51.694996
manager관리자Alice Smith
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name사용자 실명John Doe
nation_id국가 ID+82
password비밀번호
password_failed_count비밀번호 실패 횟수6
password_reuse_count비밀번호 재사용 제한 횟수6
phone_authenticated휴대폰 인증 여부
phone_number휴대폰 번호010-1234-5678
temporary_password임시 비밀번호 여부
tz_id타임존 IDAsia/Seoul
user_id사용자 로그인 IDjohndoe

10.4.1.27.2 - 1.1

scpcli iam-identity-center user set
--user_uuid <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--manager <value>]
[--name <value>]
[--nation_id <value>]
[--phone_number <value>]
[--tz_id <value>]

Description

set a specific user

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_uuid
required
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345
business_unit
optional
string사업부Business Unit A
department
optional
string부서Department X
description
optional
string사용자 설명Description of John Doe
email
optional
string사용자 이메일john.doe@example.com
employee_id
optional
string사번emp-12345
manager
optional
string관리자Alice Smith
name
optional
string사용자 실명John Doe
nation_id
optional
string국가 ID+82
phone_number
optional
string휴대폰 번호010-1234-5678
tz_id
optional
string타임존 IDAsia/Seoul

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unit사업부Business Unit A
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
department부서Department X
description사용자 설명Description of John Doe
email사용자 이메일john.doe@example.com
email_authenticated이메일 인증 여부
employee_id사번emp-12345
groups그룹 목록
instance_id인스턴스 IDssoins-12345
last_login_at마지막 로그인 일시2024-12-19 01:09:05.000
last_password_update_at최근 비밀번호 변경 일시2025-11-24T08:14:51.694996
manager관리자Alice Smith
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name사용자 실명John Doe
nation_id국가 ID+82
password비밀번호
password_failed_count비밀번호 실패 횟수6
password_reuse_count비밀번호 재사용 제한 횟수6
phone_authenticated휴대폰 인증 여부
phone_number휴대폰 번호010-1234-5678
temporary_password임시 비밀번호 여부
tz_id타임존 IDAsia/Seoul
user_id사용자 로그인 IDjohndoe

10.4.1.27.3 - 1.0

scpcli iam-identity-center user set
--user_uuid <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--manager <value>]
[--name <value>]
[--nation_id <value>]
[--phone_number <value>]
[--tz_id <value>]

Description

set a specific user

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_uuid
required
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345
business_unit
optional
string사업부Business Unit A
department
optional
string부서Department X
description
optional
string사용자 설명Description of John Doe
email
optional
string사용자 이메일john.doe@example.com
employee_id
optional
string사번emp-12345
manager
optional
string관리자Alice Smith
name
optional
string사용자 실명John Doe
nation_id
optional
string국가 ID+82
phone_number
optional
string휴대폰 번호010-1234-5678
tz_id
optional
string타임존 IDAsia/Seoul

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unit사업부Business Unit A
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
department부서Department X
description사용자 설명Description of John Doe
email사용자 이메일john.doe@example.com
email_authenticated이메일 인증 여부
employee_id사번emp-12345
groups그룹 목록
instance_id인스턴스 IDssoins-12345
last_login_at마지막 로그인 일시2024-12-19 01:09:05.000
last_password_update_at최근 비밀번호 변경 일시2025-11-24T08:14:51.694996
manager관리자Alice Smith
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name사용자 실명John Doe
nation_id국가 ID+82
password비밀번호
password_failed_count비밀번호 실패 횟수6
password_reuse_count비밀번호 재사용 제한 횟수6
phone_authenticated휴대폰 인증 여부
phone_number휴대폰 번호010-1234-5678
temporary_password임시 비밀번호 여부
tz_id타임존 IDAsia/Seoul
user_id사용자 로그인 IDjohndoe

10.4.1.28 - ShowGroup

10.4.1.28.1 - 1.2

scpcli iam-identity-center group show
--group_id <value>
--instance_id <value>

Description

show a specific group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.28.2 - 1.1

scpcli iam-identity-center group show
--group_id <value>
--instance_id <value>

Description

show a specific group

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.28.3 - 1.0

scpcli iam-identity-center group show
--group_id <value>
--instance_id <value>

Description

show a specific group

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
string그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id그룹 ID138c2fc8c29a449dbfa8681f8f1d78e2
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
description그룹 설명Group for administrators
instance_id인스턴스 IDssoins-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name그룹 이름Admin_Group
user_count그룹에 속한 사용자 수1
users그룹에 속한 사용자 목록[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

10.4.1.29 - ShowInstance

10.4.1.29.1 - 1.2

scpcli iam-identity-center instance show
--instance_id <value>

Description

show a specific instance

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id인스턴스 IDssoins-12345
account_idAccount ID1234ab567cd64769e8f9g490hi304891
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
delegated_account_id위임된 관리자 계정 IDacc-2353
delegated_at위임 일시2023-10-15 14:30:00
delegated_by위임자 IDsef2w3c8c29a449dbfa8681f8f1d78e2
description인스턴스 설명My Instance Description
identity_store_config자격 증명 소스 설정{‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’}
identity_store_id자격 증명 소스 IDd-12345
identity_store_type자격 증명 소스 유형
last_sync_at마지막 동기화 날짜2025-08-06 10:30:00
last_sync_status마지막 동기화 상태[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’]
master_account_id관리자 계정 IDacc-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name인스턴스 이름My Instance
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
resource_name자원명resource-name-1
resource_type자원 유형 [instancepermission-set]
resource_type_display_name자원 유형명Virtual Server
serviceSERVICEvirtualserver
service_name서비스명Virtual Server
srn인스턴스 SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO 시작 URLhttps://login.e.samsungsdscloud.com/d-12345
state상태

10.4.1.29.2 - 1.1

scpcli iam-identity-center instance show
--instance_id <value>

Description

show a specific instance

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id인스턴스 IDssoins-12345
account_idAccount ID1234ab567cd64769e8f9g490hi304891
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
delegated_account_id위임된 관리자 계정 IDacc-2353
delegated_at위임 일시2023-10-15 14:30:00
delegated_by위임자 IDsef2w3c8c29a449dbfa8681f8f1d78e2
description인스턴스 설명My Instance Description
identity_store_config자격 증명 소스 설정{‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’}
identity_store_id자격 증명 소스 IDd-12345
identity_store_type자격 증명 소스 유형
last_sync_at마지막 동기화 날짜2025-08-06 10:30:00
last_sync_status마지막 동기화 상태[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’]
master_account_id관리자 계정 IDacc-12345
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name인스턴스 이름My Instance
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
resource_name자원명resource-name-1
resource_type자원 유형 [instancepermission-set]
resource_type_display_name자원 유형명Virtual Server
serviceSERVICEvirtualserver
service_name서비스명Virtual Server
srn인스턴스 SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO 시작 URLhttps://login.e.samsungsdscloud.com/d-12345
state상태

10.4.1.30 - ShowPermissionSet

10.4.1.30.1 - 1.2

scpcli iam-identity-center permission set show
--permission_set_id <value>
--instance_id <value>

Description

show a specific permission set

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
account_id
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
custom_policies고객 관리 정책
description권한 세트 설명Permissions for administrators
inline_policies인라인 정책
instance_id인스턴스 IDssoins-12345
managed_policies관리 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
resource_name
resource_type
resource_type_display_name
service
service_name
session_duration최대 세션 지속 시간3600
srn권한 세트 SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
state상태

10.4.1.30.2 - 1.1

scpcli iam-identity-center permission set show
--permission_set_id <value>
--instance_id <value>

Description

show a specific permission set

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
account_id
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
customer_policies고객 관리 정책
description권한 세트 설명Permissions for administrators
inline_policies인라인 정책
instance_id인스턴스 IDssoins-12345
managed_policies관리 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
resource_name
resource_type
resource_type_display_name
service
service_name
session_duration최대 세션 지속 시간3600
srn권한 세트 SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
state상태

10.4.1.30.3 - 1.0

scpcli iam-identity-center permission set show
--permission_set_id <value>
--instance_id <value>

Description

show a specific permission set

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
string권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id권한 세트 IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
account_id
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명
customer_policies고객 관리 정책
description권한 세트 설명Permissions for administrators
inline_policies인라인 정책
instance_id인스턴스 IDssoins-12345
managed_policies관리 정책
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명
name권한 세트 이름Permission Set
resource_name
resource_type
resource_type_display_name
service
service_name
session_duration최대 세션 지속 시간3600
srn권한 세트 SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
state상태

10.4.1.31 - ShowUser

10.4.1.31.1 - 1.2

scpcli iam-identity-center user show
--user_uuid <value>
--instance_id <value>

Description

show a specific user

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
user_uuid
required
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unit사업부Business Unit A
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
department부서Department X
description사용자 설명Description of John Doe
email사용자 이메일john.doe@example.com
email_authenticated이메일 인증 여부
employee_id사번emp-12345
groups그룹 목록
instance_id인스턴스 IDssoins-12345
last_login_at마지막 로그인 일시2024-12-19 01:09:05.000
last_password_update_at최근 비밀번호 변경 일시2025-11-24T08:14:51.694996
manager관리자Alice Smith
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name사용자 실명John Doe
nation_id국가 ID+82
password비밀번호
password_failed_count비밀번호 실패 횟수6
password_reuse_count비밀번호 재사용 제한 횟수6
phone_authenticated휴대폰 인증 여부
phone_number휴대폰 번호010-1234-5678
temporary_password임시 비밀번호 여부
tz_id타임존 IDAsia/Seoul
user_id사용자 로그인 IDjohndoe

10.4.1.31.2 - 1.1

scpcli iam-identity-center user show
--user_uuid <value>
--instance_id <value>

Description

show a specific user

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120260531

Parameters

NameTypeDescriptionExample
user_uuid
required
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unit사업부Business Unit A
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
department부서Department X
description사용자 설명Description of John Doe
email사용자 이메일john.doe@example.com
email_authenticated이메일 인증 여부
employee_id사번emp-12345
groups그룹 목록
instance_id인스턴스 IDssoins-12345
last_login_at마지막 로그인 일시2024-12-19 01:09:05.000
last_password_update_at최근 비밀번호 변경 일시2025-11-24T08:14:51.694996
manager관리자Alice Smith
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name사용자 실명John Doe
nation_id국가 ID+82
password비밀번호
password_failed_count비밀번호 실패 횟수6
password_reuse_count비밀번호 재사용 제한 횟수6
phone_authenticated휴대폰 인증 여부
phone_number휴대폰 번호010-1234-5678
temporary_password임시 비밀번호 여부
tz_id타임존 IDAsia/Seoul
user_id사용자 로그인 IDjohndoe

10.4.1.31.3 - 1.0

scpcli iam-identity-center user show
--user_uuid <value>
--instance_id <value>

Description

show a specific user

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
user_uuid
required
string사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
string인스턴스 IDssoins-12345

Responses

NameDescriptionExample
id사용자 ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unit사업부Business Unit A
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자 명John Doe
department부서Department X
description사용자 설명Description of John Doe
email사용자 이메일john.doe@example.com
email_authenticated이메일 인증 여부
employee_id사번emp-12345
groups그룹 목록
instance_id인스턴스 IDssoins-12345
last_login_at마지막 로그인 일시2024-12-19 01:09:05.000
last_password_update_at최근 비밀번호 변경 일시2025-11-24T08:14:51.694996
manager관리자Alice Smith
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
modifier_name수정자 명Smith
name사용자 실명John Doe
nation_id국가 ID+82
password비밀번호
password_failed_count비밀번호 실패 횟수6
password_reuse_count비밀번호 재사용 제한 횟수6
phone_authenticated휴대폰 인증 여부
phone_number휴대폰 번호010-1234-5678
temporary_password임시 비밀번호 여부
tz_id타임존 IDAsia/Seoul
user_id사용자 로그인 IDjohndoe

10.5 - Logging&Audit

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Logging&Audit 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20260223
1.1CURRENT-

10.5.1 - CLIs

10.5.1.1 - CreateTrail

10.5.1.1.1 - 1.1

scpcli loggingaudit trail create
--trail_save_type <value>
--trail_name <value>
--bucket_region <value>
--bucket_name <value>
--account_id <value>
[--log_archive_account_id <value>]
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--organization_trail_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--tag_create_requests <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--user_total_yn <value>]

Description

create a trail

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
trail_save_type
required
stringTrail save typeJSON
trail_name
required
stringTrail nameTestTrail01
bucket_region
required
stringBucket regionRegionOne
bucket_name
required
stringBucket nameTestBucket00
account_id
required
stringAccount IDACCOUNT_ID-ABCDEF1234
log_archive_account_id
optional
stringLog Archive Account ID. Only for Organization Trail.(organization_trail_yn = y)ACCOUNT_ID-ABCDEF1234
log_type_total_yn
optional
stringTarget log type total y/nN
log_verification_yn
optional
stringLog verification y/nN
organization_trail_yn
optional
stringOrganization trail y/nN
region_names
optional
arrayRegion name list-
region_total_yn
optional
stringTarget region total y/nY
resource_type_total_yn
optional
stringTarget resource type total y/nY
tag_create_requests
optional
arrayTag create requests{'key': '11', 'value': '22'}
target_log_types
optional
arrayTarget log type list-
target_resource_types
optional
arrayTarget resource type list-
target_users
optional
arrayTarget user list-
trail_description
optional
stringTrail descriptionThis is a test trail
user_total_yn
optional
stringTarget user total y/nY

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_archive_account_idLog Archive Account IDACCOUNT_ID-ABCDEF1234
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_trail_ynOrganization trail y/nY
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2025-11-07T09:00:00Z
trail_batch_first_start_atTrail batch first start date2025-10-28T10:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2025-11-07T09:00:00Z
trail_batch_success_atTrail batch success date2025-11-07T09:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

10.5.1.1.2 - 1.0

scpcli loggingaudit trail create
--trail_save_type <value>
--trail_name <value>
--bucket_region <value>
--bucket_name <value>
--account_id <value>
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--tag_create_requests <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--user_total_yn <value>]

Description

create a trail

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
trail_save_type
required
stringTrail save typeJSON
trail_name
required
stringTrail nameTestTrail01
bucket_region
required
stringBucket regionRegionOne
bucket_name
required
stringBucket nameTestBucket00
account_id
required
stringAccount IDACCOUNT_ID-ABCDEF1234
log_type_total_yn
optional
stringTarget log type total y/nN
log_verification_yn
optional
stringLog verification y/nN
region_names
optional
arrayRegion name list-
region_total_yn
optional
stringTarget region total y/nY
resource_type_total_yn
optional
stringTarget resource type total y/nY
tag_create_requests
optional
arrayTag create requests{'key': '11', 'value': '22'}
target_log_types
optional
arrayTarget log type list-
target_resource_types
optional
arrayTarget resource type list-
target_users
optional
arrayTarget user list-
trail_description
optional
stringTrail descriptionThis is a test trail
user_total_yn
optional
stringTarget user total y/nY

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2025-11-07T09:00:00Z
trail_batch_first_start_atTrail batch first start date2025-10-28T10:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2025-11-07T09:00:00Z
trail_batch_success_atTrail batch success date2025-11-07T09:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

10.5.1.2 - DeleteTrail

10.5.1.2.1 - 1.1

scpcli loggingaudit trail delete
--trail_id <value>

Description

delete a specific trail

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

10.5.1.2.2 - 1.0

scpcli loggingaudit trail delete
--trail_id <value>

Description

delete a specific trail

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

10.5.1.3 - DownloadLogs

10.5.1.3.1 - 1.1

scpcli loggingaudit log file download
--time_zone_info <value>
--start_at <value>
--file_type <value>
--end_at <value>
[--product_name <value>]
[--region <value>]
[--resource_name <value>]
[--resource_type <value>]
[--root_resource_id <value>]
[--status <value>]
[--user_name <value>]

Description

download log file

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
time_zone_info
required
stringTimezone infoAsia/Seoul
start_at
required
stringQuery start date2025-08-09T10:00:00Z
file_type
required
stringDownload file typeJSON
end_at
required
stringQuery finish date2025-11-07T10:00:00Z
product_name
optional
stringProduct name-
region
optional
stringRegion name-
resource_name
optional
stringResource name-
resource_type
optional
stringResource type-
root_resource_id
optional
stringRoot resource ID-
status
optional
stringTask result-
user_name
optional
stringUsername-

Responses

NameDescriptionExample
EventTopicEvent type
RegionNameRegion name
ResourceIdResource ID
ResourceNameResource name
ResourceTypeResource type
WorkInfoEvent name
WorkResultTask result
WorkTimeWork time
WorkerEmailWorker email
WorkerIDWorker ID
WorkerNameWorker name

10.5.1.3.2 - 1.0

scpcli loggingaudit log file download
--time_zone_info <value>
--start_at <value>
--file_type <value>
--end_at <value>
[--product_name <value>]
[--region <value>]
[--resource_name <value>]
[--resource_type <value>]
[--root_resource_id <value>]
[--status <value>]
[--user_name <value>]

Description

download log file

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
time_zone_info
required
stringTimezone infoAsia/Seoul
start_at
required
stringQuery start date2025-08-09T10:00:00Z
file_type
required
stringDownload file typeJSON
end_at
required
stringQuery finish date2025-11-07T10:00:00Z
product_name
optional
stringProduct name-
region
optional
stringRegion name-
resource_name
optional
stringResource name-
resource_type
optional
stringResource type-
root_resource_id
optional
stringRoot resource ID-
status
optional
stringTask result-
user_name
optional
stringUsername-

Responses

NameDescriptionExample
EventTopicEvent type
RegionNameRegion name
ResourceIdResource ID
ResourceNameResource name
ResourceTypeResource type
WorkInfoEvent name
WorkResultTask result
WorkTimeWork time
WorkerEmailWorker email
WorkerIDWorker ID
WorkerNameWorker name

10.5.1.4 - ListLogs

10.5.1.4.1 - 1.1

scpcli loggingaudit log list
--end_at <value>
--start_at <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--resource_id <value>]
[--resource_name <value>]
[--resource_type <value>]
[--product_name <value>]
[--product_type <value>]
[--status <value>]
[--event_type <value>]
[--user_id <value>]
[--user_name <value>]
[--region <value>]
[--root_resource_id <value>]
[--service_type <value>]

Description

get log list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
end_at
required
stringQuery finish date2025-11-07T10:00:00Z
start_at
required
stringQuery start date2025-08-09T10:00:00Z
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
resource_id
optional
stringResource ID-
resource_name
optional
stringResource name-
resource_type
optional
stringResource type-
product_name
optional
stringProduct name-
product_type
optional
stringProduct type-
status
optional
stringTask result-
event_type
optional
stringEvent type-
user_id
optional
stringUser ID-
user_name
optional
stringUsername-
region
optional
stringRegion name-
root_resource_id
optional
stringRoot resource ID-
service_type
optional
stringService type-

Responses

NameDescriptionExample
idLog IDID-A1B2C3D4E5F6G7H8I9J0
account_idAccount IDACCOUNT_ID-ABCDEF1234
event_nameEvent namescp-extension.event.create
event_typeEvent typescp-extension.event.create
product_nameProduct namescp-extension
product_typeProduct typescp-extension
regionRegion nameRegionOne
request_user_nameUsernameHong Gildong
resource_idResource IDRESOURCE_ID-ABCDEF1234
resource_nameResource nameRESOURCE_NAME-ABCDEF1234
resource_typeResource typescp-extension
role_nameUsernameTester
statusTask resultSuccess
timestampTimestamp2025-11-07T10:00:00Z
typeUser IDROLE
user_idUser IDUSER_ID-ABCDEF1234

10.5.1.4.2 - 1.0

scpcli loggingaudit log list
--end_at <value>
--start_at <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--resource_id <value>]
[--resource_name <value>]
[--resource_type <value>]
[--product_name <value>]
[--product_type <value>]
[--status <value>]
[--event_type <value>]
[--user_id <value>]
[--user_name <value>]
[--region <value>]
[--root_resource_id <value>]
[--service_type <value>]

Description

get log list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
end_at
required
stringQuery finish date2025-11-07T10:00:00Z
start_at
required
stringQuery start date2025-08-09T10:00:00Z
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
resource_id
optional
stringResource ID-
resource_name
optional
stringResource name-
resource_type
optional
stringResource type-
product_name
optional
stringProduct name-
product_type
optional
stringProduct type-
status
optional
stringTask result-
event_type
optional
stringEvent type-
user_id
optional
stringUser ID-
user_name
optional
stringUsername-
region
optional
stringRegion name-
root_resource_id
optional
stringRoot resource ID-
service_type
optional
stringService type-

Responses

NameDescriptionExample
idLog IDID-A1B2C3D4E5F6G7H8I9J0
account_idAccount IDACCOUNT_ID-ABCDEF1234
event_nameEvent namescp-extension.event.create
event_typeEvent typescp-extension.event.create
product_nameProduct namescp-extension
product_typeProduct typescp-extension
regionRegion nameRegionOne
request_user_nameUsernameHong Gildong
resource_idResource IDRESOURCE_ID-ABCDEF1234
resource_nameResource nameRESOURCE_NAME-ABCDEF1234
resource_typeResource typescp-extension
role_nameUsernameTester
statusTask resultSuccess
timestampTimestamp2025-11-07T10:00:00Z
typeUser IDROLE
user_idUser IDUSER_ID-ABCDEF1234

10.5.1.5 - ListTrails

10.5.1.5.1 - 1.1

scpcli loggingaudit trail list
[--size <value>]
[--page <value>]
[--sort <value>]
[--trail_name <value>]
[--bucket_name <value>]
[--state <value>]
[--resource_type <value>]

Description

get trails list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
trail_name
optional
stringTrail name-
bucket_name
optional
stringBucket name-
state
optional
stringTrail state-
resource_type
optional
stringResource type-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_archive_account_idLog Archive Account IDACCOUNT_ID-ABCDEF1234
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_trail_ynOrganization trail y/nY
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2025-11-07T09:00:00Z
trail_batch_first_start_atTrail batch first start date2025-10-28T10:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2025-11-07T09:00:00Z
trail_batch_success_atTrail batch success date2025-11-07T09:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

10.5.1.5.2 - 1.0

scpcli loggingaudit trail list
[--size <value>]
[--page <value>]
[--sort <value>]
[--trail_name <value>]
[--bucket_name <value>]
[--state <value>]
[--resource_type <value>]

Description

get trails list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
trail_name
optional
stringTrail name-
bucket_name
optional
stringBucket name-
state
optional
stringTrail state-
resource_type
optional
stringResource type-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2025-11-07T09:00:00Z
trail_batch_first_start_atTrail batch first start date2025-10-28T10:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2025-11-07T09:00:00Z
trail_batch_success_atTrail batch success date2025-11-07T09:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

10.5.1.6 - SetTrail

10.5.1.6.1 - 1.1

scpcli loggingaudit trail set
--trail_id <value>
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--organization_trail_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--trail_save_type <value>]
[--user_total_yn <value>]

Description

set a specific trail

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-
log_type_total_yn
optional
stringTarget log type total y/nN
log_verification_yn
optional
stringLog verification y/nN
organization_trail_yn
optional
stringOrganization trail y/nY
region_names
optional
arrayRegion name list-
region_total_yn
optional
stringTarget region total y/nY
resource_type_total_yn
optional
stringTarget resource type total y/nY
target_log_types
optional
arrayTarget log type list-
target_resource_types
optional
arrayTarget resource type list-
target_users
optional
arrayTarget user list-
trail_description
optional
stringTrail descriptionThis is a test trail
trail_save_type
optional
stringTrail save typeJSON
user_total_yn
optional
stringTarget user total y/nY

10.5.1.6.2 - 1.0

scpcli loggingaudit trail set
--trail_id <value>
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--trail_save_type <value>]
[--user_total_yn <value>]

Description

set a specific trail

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-
log_type_total_yn
optional
stringTarget log type total y/nN
log_verification_yn
optional
stringLog verification y/nN
region_names
optional
arrayRegion name list-
region_total_yn
optional
stringTarget region total y/nY
resource_type_total_yn
optional
stringTarget resource type total y/nY
target_log_types
optional
arrayTarget log type list-
target_resource_types
optional
arrayTarget resource type list-
target_users
optional
arrayTarget user list-
trail_description
optional
stringTrail descriptionThis is a test trail
trail_save_type
optional
stringTrail save typeJSON
user_total_yn
optional
stringTarget user total y/nY

10.5.1.7 - ShowLog

10.5.1.7.1 - 1.1

scpcli loggingaudit log show
--logging_id <value>

Description

show a specific log

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
logging_id
required
stringLog ID-

Responses

NameDescriptionExample
idLog IDID-A1B2C3D4E5F6G7H8I9J0
account_idAccount IDACCOUNT_ID-ABCDEF1234
detailsAudit detail contents(JSON String)
event_nameEvent namescp-extension.event.create
event_typeEvent typescp-extension.event.create
product_nameProduct namescp-extension
product_typeProduct typescp-extension
regionRegion nameRegionOne
request_user_nameUsernameHong Gildong
resource_idResource IDRESOURCE_ID-ABCDEF1234
resource_nameResource nameRESOURCE_NAME-ABCDEF1234
resource_typeResource typescp-extension
role_nameUsernameTester
statusTask resultSuccess
timestampTimestamp2025-11-07T10:00:00Z
typeUser IDROLE
user_idUser IDUSER_ID-ABCDEF1234

10.5.1.7.2 - 1.0

scpcli loggingaudit log show
--logging_id <value>

Description

show a specific log

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
logging_id
required
stringLog ID-

Responses

NameDescriptionExample
idLog IDID-A1B2C3D4E5F6G7H8I9J0
account_idAccount IDACCOUNT_ID-ABCDEF1234
detailsAudit detail contents(JSON String)
event_nameEvent namescp-extension.event.create
event_typeEvent typescp-extension.event.create
product_nameProduct namescp-extension
product_typeProduct typescp-extension
regionRegion nameRegionOne
request_user_nameUsernameHong Gildong
resource_idResource IDRESOURCE_ID-ABCDEF1234
resource_nameResource nameRESOURCE_NAME-ABCDEF1234
resource_typeResource typescp-extension
role_nameUsernameTester
statusTask resultSuccess
timestampTimestamp2025-11-07T10:00:00Z
typeUser IDROLE
user_idUser IDUSER_ID-ABCDEF1234

10.5.1.8 - ShowTrail

10.5.1.8.1 - 1.1

scpcli loggingaudit trail show
--trail_id <value>

Description

show a specific trail

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_archive_account_idLog Archive Account IDACCOUNT_ID-ABCDEF1234
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_trail_ynOrganization trail y/nY
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2025-11-07T09:00:00Z
trail_batch_first_start_atTrail batch first start date2025-10-28T10:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2025-11-07T09:00:00Z
trail_batch_success_atTrail batch success date2025-11-07T09:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

10.5.1.8.2 - 1.0

scpcli loggingaudit trail show
--trail_id <value>

Description

show a specific trail

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2025-11-07T09:00:00Z
trail_batch_first_start_atTrail batch first start date2025-10-28T10:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2025-11-07T09:00:00Z
trail_batch_success_atTrail batch success date2025-11-07T09:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

10.5.1.9 - StartTrail

10.5.1.9.1 - 1.1

scpcli loggingaudit trail start
--trail_id <value>

Description

start a specific trail

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_archive_account_idLog Archive Account IDACCOUNT_ID-ABCDEF1234
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_trail_ynOrganization trail y/nY
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2025-11-07T09:00:00Z
trail_batch_first_start_atTrail batch first start date2025-10-28T10:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2025-11-07T09:00:00Z
trail_batch_success_atTrail batch success date2025-11-07T09:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

10.5.1.9.2 - 1.0

scpcli loggingaudit trail start
--trail_id <value>

Description

start a specific trail

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2025-11-07T09:00:00Z
trail_batch_first_start_atTrail batch first start date2025-10-28T10:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2025-11-07T09:00:00Z
trail_batch_success_atTrail batch success date2025-11-07T09:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

10.5.1.10 - StopTrail

10.5.1.10.1 - 1.1

scpcli loggingaudit trail stop
--trail_id <value>

Description

stop a specific trail

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_archive_account_idLog Archive Account IDACCOUNT_ID-ABCDEF1234
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_trail_ynOrganization trail y/nY
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2025-11-07T09:00:00Z
trail_batch_first_start_atTrail batch first start date2025-10-28T10:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2025-11-07T09:00:00Z
trail_batch_success_atTrail batch success date2025-11-07T09:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

10.5.1.10.2 - 1.0

scpcli loggingaudit trail stop
--trail_id <value>

Description

stop a specific trail

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2025-11-07T09:00:00Z
trail_batch_first_start_atTrail batch first start date2025-10-28T10:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2025-11-07T09:00:00Z
trail_batch_success_atTrail batch success date2025-11-07T09:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

10.6 - Network Logging

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다. 본 가이드는 Network Logging 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

10.6.1 - CLIs

10.6.1.1 - Create Network Logging Storage

10.6.1.1.1 - 1.0

scpcli network-logging network-logging-storage create
--resource_type <value>
--bucket_name <value>

Description

Network Logging Storage 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
string리소스 타입-
bucket_name
required
string저장소 버킷 이름-

Responses

NameDescriptionExample
idNetwork Logging Storage ID
account_idAccount ID
bucket_name저장소 버킷 이름
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
resource_type리소스 타입

10.6.1.2 - Delete Network Logging Storage

10.6.1.2.1 - 1.0

scpcli network-logging network-logging-storage delete
--network_logging_storage_id <value>

Description

Network Logging Storage 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
network_logging_storage_id
required
stringNetwork Logging Storage ID-

10.6.1.3 - List Network Logging Configurations

10.6.1.3.1 - 1.0

scpcli network-logging network-logging-configuration list
--resource_type <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--resource_id <value>]
[--resource_name <value>]

Description

Network Logging Configuration 목록 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
****리소스 타입-
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
resource_id
optional
string리소스 ID-
resource_name
optional
string리소스 이름-

Responses

NameDescriptionExample
idNetwork Logging Configuration ID
account_idAccount ID
bucket_name저장소 버킷 이름
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
down_interface하향 인터페이스
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
resource_id리소스 ID
resource_name리소스 이름
resource_type리소스 타입
security_group_log_idSecurity Group 로그 ID
up_interface상향 인터페이스

10.6.1.4 - List Network Logging Storages

10.6.1.4.1 - 1.0

scpcli network-logging network-logging-storage list
--resource_type <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]

Description

Network Logging Storage 목록 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
****리소스 타입-
with_count
optional
stringwith counttrue
limit
optional
integer한도20
marker
optional
string마커607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idNetwork Logging Storage ID
account_idAccount ID
bucket_name저장소 버킷 이름
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
resource_type리소스 타입

10.7 - Organization

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Organization 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

10.7.1 - CLIs

10.7.1.1 - AcceptInvitation

10.7.1.1.1 - 1.1

scpcli organization invitation accept
--invitation_id <value>

Description

accept a specific invitation

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
invitation_id
required
string초대 ID138c2fc8c29a449dbfa8681f8f1d78e2

10.7.1.1.2 - 1.0

scpcli organization invitation accept
--invitation_id <value>

Description

accept a specific invitation

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
invitation_id
required
string초대 ID138c2fc8c29a449dbfa8681f8f1d78e2

10.7.1.2 - AttachPolicyBindings

10.7.1.2.1 - 1.1

scpcli organization policy attach
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]

Description

attach policy bindings

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
target_ids
required
array타겟 정보ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
policy_ids
required
array제어 정책 목록 IDf98e76d54c32b10a9z8y7x6w5v4u3
entity
required
string개체 유형POLICY
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
error_codeerror codeConflict
failed_caused실패 원인Account 482d111a302547fbbd11ee0141ea23bb is not found
failed_id실패 IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5

10.7.1.2.2 - 1.0

scpcli organization policy attach
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]

Description

attach policy bindings

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
target_ids
required
array타겟 정보ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
policy_ids
required
array제어 정책 목록 IDf98e76d54c32b10a9z8y7x6w5v4u3
entity
required
string개체 유형POLICY
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
error_codeerror codeConflict
failed_caused실패 원인Account 482d111a302547fbbd11ee0141ea23bb is not found
failed_id실패 IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5

10.7.1.3 - CancelInvitations

10.7.1.3.1 - 1.1

scpcli organization invitation cancel
--ids <value>
[--organization_id <value>]

Description

cancel invitations

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
ids
required
array초대 ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.3.2 - 1.0

scpcli organization invitation cancel
--ids <value>
[--organization_id <value>]

Description

cancel invitations

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
ids
required
array초대 ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.4 - CreateAccount

10.7.1.4.1 - 1.1

scpcli organization account create
--role_name <value>
--organization_id <value>
--name <value>
--login_id <value>

Description

create a account

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
role_name
required
string역할명OrganizationAccountAccessRole
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
required
string계정명score-account
login_id
required
string로그인 IDlog-archive@samsung.com

Responses

NameDescriptionExample
failed계정 생성 실패 정보
success계정 생성 성공 정보

10.7.1.4.2 - 1.0

scpcli organization account create
--role_name <value>
--organization_id <value>
--name <value>
--login_id <value>

Description

create a account

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
role_name
required
string역할명OrganizationAccountAccessRole
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
required
string계정명score-account
login_id
required
string로그인 IDlog-archive@samsung.com

Responses

NameDescriptionExample
failed계정 생성 실패 정보
success계정 생성 성공 정보

10.7.1.5 - CreateDelegationPolicy

10.7.1.5.1 - 1.1

scpcli organization delegation policy create
[--organization_id <value>]
[--statement <value>]
[--version <value>]

Description

create a delegation policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
statement
optional
array정책 문법'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
string정책 버전-

Responses

NameDescriptionExample
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
document위임 정책 문서{‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.5.2 - 1.0

scpcli organization delegation policy create
[--organization_id <value>]
[--statement <value>]
[--version <value>]

Description

create a delegation policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
statement
optional
array정책 문법'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
string정책 버전-

Responses

NameDescriptionExample
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
document위임 정책 문서{‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.6 - CreateInvitation

10.7.1.6.1 - 1.1

scpcli organization invitation create
--target_login_ids <value>
[--organization_id <value>]

Description

create an invitation

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
target_login_ids
required
array초대 수신자 계정 이메일 목록score-1@samsung.com
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
error_codeerror codeInvitation.AlreadySentError
failed_caused실패 사유Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found
failed_id조직 초대 실패 Login ID 목록[‘score-1@samsung.com’]

10.7.1.6.2 - 1.0

scpcli organization invitation create
--target_login_ids <value>
[--organization_id <value>]

Description

create an invitation

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
target_login_ids
required
array초대 수신자 계정 이메일 목록score-1@samsung.com
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
error_codeerror codeInvitation.AlreadySentError
failed_caused실패 사유Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found
failed_id조직 초대 실패 Login ID 목록[‘score-1@samsung.com’]

10.7.1.7 - CreateOrganization

10.7.1.7.1 - 1.1

scpcli organization organization create
--name <value>

Description

create a organization

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
string조직 이름My Organization

Responses

NameDescriptionExample
id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
delegation_account_id위임 계정124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_email관리자 계정 이메일admin@example.com
master_account_id관리자 계정 ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name조직 이름My Organization
root_unit_id루트 유닛 IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
srn조직 SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_yn통제 정책 사용 여부True

10.7.1.7.2 - 1.0

scpcli organization organization create
--name <value>

Description

create a organization

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
string조직 이름My Organization

Responses

NameDescriptionExample
id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
delegation_account_id위임 계정124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_email관리자 계정 이메일admin@example.com
master_account_id관리자 계정 ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name조직 이름My Organization
root_unit_id루트 유닛 IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
srn조직 SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_yn통제 정책 사용 여부True

10.7.1.8 - CreateOrganizationUnit

10.7.1.8.1 - 1.1

scpcli organization organization unit create
--name <value>
[--description <value>]
[--organization_id <value>]
[--parent_unit_id <value>]
[--policy_ids <value>]

Description

create an organization unit

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
string조직 단위명score-organization-unit
description
optional
string조직 단위 설명에스코어 조직 단위
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_id
optional
stringROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
policy_ids
optional
array제어 정책 목록 IDf98e76d54c32b10a9z8y7x6w5v4u3

Responses

NameDescriptionExample
organization_unit조직 단위 정보

10.7.1.8.2 - 1.0

scpcli organization organization unit create
--name <value>
[--description <value>]
[--organization_id <value>]
[--parent_unit_id <value>]
[--policy_ids <value>]

Description

create an organization unit

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
string조직 단위명score-organization-unit
description
optional
string조직 단위 설명에스코어 조직 단위
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_id
optional
stringROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
policy_ids
optional
array제어 정책 목록 IDf98e76d54c32b10a9z8y7x6w5v4u3

Responses

NameDescriptionExample
organization_unit조직 단위 정보

10.7.1.9 - CreateServiceControlPolicy

10.7.1.9.1 - 1.1

scpcli organization service control policy create
--organization_id <value>
--name <value>
--description <value>
[--type <value>]
[--statement <value>]
[--version <value>]

Description

create a service control policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
required
string서비스 제어 정책 이름MyPolicy
description
required
string정책 설명This is an example policy.
type
optional
string서비스 제어 정책 유형MANAGED
statement
optional
array정책 문법'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
string정책 버전-

Responses

NameDescriptionExample
id서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
category정책 카테고리SCP
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
description정책 설명This is an example policy.
document정책 문서{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name서비스 제어 정책 이름MyPolicy
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
service_name서비스명Organization
source정책 생성 주체ORGANIZATION
srn정책 SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2
state정책 상태ACTIVE
type서비스 제어 정책 유형MANAGED

10.7.1.9.2 - 1.0

scpcli organization service control policy create
--organization_id <value>
--name <value>
--description <value>
[--type <value>]
[--statement <value>]
[--version <value>]

Description

create a service control policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
required
string서비스 제어 정책 이름MyPolicy
description
required
string정책 설명This is an example policy.
type
optional
string서비스 제어 정책 유형MANAGED
statement
optional
array정책 문법'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
string정책 버전-

Responses

NameDescriptionExample
id서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
category정책 카테고리SCP
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
description정책 설명This is an example policy.
document정책 문서{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name서비스 제어 정책 이름MyPolicy
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
service_name서비스명Organization
source정책 생성 주체ORGANIZATION
srn정책 SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2
state정책 상태ACTIVE
type서비스 제어 정책 유형MANAGED

10.7.1.10 - DeclineInvitation

10.7.1.10.1 - 1.1

scpcli organization invitation decline
--invitation_id <value>

Description

decline a specific invitation

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
invitation_id
required
string초대 ID138c2fc8c29a449dbfa8681f8f1d78e2

10.7.1.10.2 - 1.0

scpcli organization invitation decline
--invitation_id <value>

Description

decline a specific invitation

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
invitation_id
required
string초대 ID138c2fc8c29a449dbfa8681f8f1d78e2

10.7.1.11 - DeleteDelegationPolicy

10.7.1.11.1 - 1.1

scpcli organization delegation policy delete
[--organization_id <value>]

Description

delete a specific delegation policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.11.2 - 1.0

scpcli organization delegation policy delete
[--organization_id <value>]

Description

delete a specific delegation policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.12 - DeleteOrganization

10.7.1.12.1 - 1.1

scpcli organization organization delete
--organization_id <value>

Description

delete a specific organization

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.12.2 - 1.0

scpcli organization organization delete
--organization_id <value>

Description

delete a specific organization

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.13 - DeleteOrganizationUnits

10.7.1.13.1 - 1.1

scpcli organization organization unit delete
--ids <value>
[--organization_id <value>]

Description

delete organization units

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
ids
required
array조직 단위 ID 목록ou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.13.2 - 1.0

scpcli organization organization unit delete
--ids <value>
[--organization_id <value>]

Description

delete organization units

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
ids
required
array조직 단위 ID 목록ou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.14 - DeleteServiceControlPolicies

10.7.1.14.1 - 1.1

scpcli organization service control policy delete
--organization_id <value>
--ids <value>

Description

delete service control policies

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
ids
required
array서비스 제어 정책 목록ID138c2fc8c29a449dbfa8681f8f1d78e2

10.7.1.14.2 - 1.0

scpcli organization service control policy delete
--organization_id <value>
--ids <value>

Description

delete service control policies

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
ids
required
array서비스 제어 정책 목록ID138c2fc8c29a449dbfa8681f8f1d78e2

10.7.1.15 - LeaveOrganization

10.7.1.15.1 - 1.1

scpcli organization organization leave
--organization_id <value>

Description

leave a specific organization

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.15.2 - 1.0

scpcli organization organization leave
--organization_id <value>

Description

leave a specific organization

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.16 - ListAccountInvitations

10.7.1.16.1 - 1.1

scpcli organization account invitation list

Description

get account invitation list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
expired_time초대 만료 일시2024-04-30T12:34:56.789Z
master_account_email관리자 계정 이메일admin@example.com
master_account_id관리자 계정명9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_login_id로그인 IDlog-archive@samsung.com
master_account_name관리자 계정명CoreKim
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
organization_name조직 이름My Organization
requested_time초대 요청 일시2024-04-17T12:34:56.789Z
state초대 상태INVITING
target_account_id초대 수신자 계정 ID338c2fc8c29a449dbfa8681f8f1d78e5

10.7.1.16.2 - 1.0

scpcli organization account invitation list

Description

get account invitation list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
expired_time초대 만료 일시2024-04-30T12:34:56.789Z
master_account_email관리자 계정 이메일admin@example.com
master_account_id관리자 계정명9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_login_id로그인 IDlog-archive@samsung.com
master_account_name관리자 계정명CoreKim
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
organization_name조직 이름My Organization
requested_time초대 요청 일시2024-04-17T12:34:56.789Z
state초대 상태INVITING
target_account_id초대 수신자 계정 ID338c2fc8c29a449dbfa8681f8f1d78e5

10.7.1.17 - ListAccounts

10.7.1.17.1 - 1.1

scpcli organization account list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--email <value>]
[--login_id <value>]
[--joined_start_date <value>]
[--joined_end_date <value>]
[--joined_method <value>]
[--exclude_policy_id <value>]
[--parent_unit_id <value>]
[--parent_unit_name <value>]
[--type <value>]

Description

get accounts list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
string조직 계정 IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
name
optional
string계정명score-account
email
optional
string계정 이메일score@samsung.com
login_id
optional
string로그인 IDlog-archive@samsung.com
joined_start_date
optional
string가입 조회 시작 일시2024-05-17T12:34:56.789Z
joined_end_date
optional
string가입 조회 종료 일시2024-05-17T12:34:56.789Z
joined_method
optional
****가입 방법INVITED
exclude_policy_id
optional
string제외할 정책 ID238c2fc8c29a449dbfa8681f8f1d78e2
parent_unit_id
optional
stringROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_name
optional
stringROOT 또는 부모 조직 단위명parent-unit-name
type
optional
****계정 유형MEMBER

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
email계정 이메일score@samsung.com
joined_method가입 방법INVITED
joined_time가입 일시2024-05-17T12:34:56.789Z
login_id로그인 IDlog-archive@samsung.com
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
name계정명score-account
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_idROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameROOT 또는 부모 조직 단위명parent-unit-name
state계정 상태ACTIVE
type계정 유형MEMBER

10.7.1.17.2 - 1.0

scpcli organization account list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--email <value>]
[--login_id <value>]
[--joined_start_date <value>]
[--joined_end_date <value>]
[--joined_method <value>]
[--exclude_policy_id <value>]
[--parent_unit_id <value>]
[--parent_unit_name <value>]
[--type <value>]

Description

get accounts list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
string조직 계정 IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
name
optional
string계정명score-account
email
optional
string계정 이메일score@samsung.com
login_id
optional
string로그인 IDlog-archive@samsung.com
joined_start_date
optional
string가입 조회 시작 일시2024-05-17T12:34:56.789Z
joined_end_date
optional
string가입 조회 종료 일시2024-05-17T12:34:56.789Z
joined_method
optional
****가입 방법INVITED
exclude_policy_id
optional
string제외할 정책 ID238c2fc8c29a449dbfa8681f8f1d78e2
parent_unit_id
optional
stringROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_name
optional
stringROOT 또는 부모 조직 단위명parent-unit-name
type
optional
****계정 유형MEMBER

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
email계정 이메일score@samsung.com
joined_method가입 방법INVITED
joined_time가입 일시2024-05-17T12:34:56.789Z
login_id로그인 IDlog-archive@samsung.com
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
name계정명score-account
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_idROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameROOT 또는 부모 조직 단위명parent-unit-name
state계정 상태ACTIVE
type계정 유형MEMBER

10.7.1.18 - ListOrganizationInvitations

10.7.1.18.1 - 1.1

scpcli organization organization invitation list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--account_id <value>]
[--account_name <value>]
[--account_email <value>]
[--state <value>]
[--login_id <value>]

Description

get organization invitation list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
account_id
optional
string관리자 계정명9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
account_name
optional
string관리자 계정명CoreKim
account_email
optional
string관리자 계정 이메일admin@example.com
state
optional
****초대 상태INVITING
login_id
optional
string로그인 IDlog-archive@samsung.com

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
account_email관리자 계정 이메일admin@example.com
account_name관리자 계정명CoreKim
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
login_id로그인 IDlog-archive@samsung.com
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
state초대 상태INVITING
target_account_id관리자 계정명9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r

10.7.1.18.2 - 1.0

scpcli organization organization invitation list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--account_id <value>]
[--account_name <value>]
[--account_email <value>]
[--state <value>]
[--login_id <value>]

Description

get organization invitation list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
account_id
optional
string관리자 계정명9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
account_name
optional
string관리자 계정명CoreKim
account_email
optional
string관리자 계정 이메일admin@example.com
state
optional
****초대 상태INVITING
login_id
optional
string로그인 IDlog-archive@samsung.com

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
account_email관리자 계정 이메일admin@example.com
account_name관리자 계정명CoreKim
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
login_id로그인 IDlog-archive@samsung.com
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
state초대 상태INVITING
target_account_id관리자 계정명9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r

10.7.1.19 - ListOrganizations

10.7.1.19.1 - 1.1

scpcli organization organization list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--master_account_id <value>]

Description

get organizations list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string조직 이름My Organization
master_account_id
optional
string조직 계정 IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0

Responses

NameDescriptionExample
id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
delegation_account_id위임 계정124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_id관리자 계정 ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
name조직 이름My Organization
root_unit_id루트 유닛 IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
use_scp_yn통제 정책 사용 여부True

10.7.1.19.2 - 1.0

scpcli organization organization list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--master_account_id <value>]

Description

get organizations list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string조직 이름My Organization
master_account_id
optional
string조직 계정 IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0

Responses

NameDescriptionExample
id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
delegation_account_id위임 계정124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_id관리자 계정 ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
name조직 이름My Organization
root_unit_id루트 유닛 IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
use_scp_yn통제 정책 사용 여부True

10.7.1.20 - ListOrganizationUnits

10.7.1.20.1 - 1.1

scpcli organization organization unit list
--parent_unit_id <value>
[--organization_id <value>]
[--name <value>]
[--exclude_policy_id <value>]

Description

get organization unit list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
parent_unit_id
required
stringROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
optional
string조직 단위명score-organization-unit
exclude_policy_id
optional
string제외할 정책 ID238c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
id조직 단위 ID 또는 조직 계정 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
created_at생성 일시2024-12-19 01:09:05.000
depth계층(0~5)1
email계정 이메일score@samsung.com
joined_method가입 방법INVITED
joined_time가입 일시2024-05-17T12:34:56.789Z
login_id로그인 IDlog-archive@samsung.com
name조직 단위명 또는 계정명score-organization-unit
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_idROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameROOT 또는 부모 조직 단위명parent-unit-name
type유형(ROOT 또는 조직 단위) 또는 계정 유형MEMBER

10.7.1.20.2 - 1.0

scpcli organization organization unit list
--parent_unit_id <value>
[--organization_id <value>]
[--name <value>]
[--exclude_policy_id <value>]

Description

get organization unit list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
parent_unit_id
required
stringROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
optional
string조직 단위명score-organization-unit
exclude_policy_id
optional
string제외할 정책 ID238c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
id조직 단위 ID 또는 조직 계정 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
created_at생성 일시2024-12-19 01:09:05.000
depth계층(0~5)1
email계정 이메일score@samsung.com
joined_method가입 방법INVITED
joined_time가입 일시2024-05-17T12:34:56.789Z
login_id로그인 IDlog-archive@samsung.com
name조직 단위명 또는 계정명score-organization-unit
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_idROOT 또는 부모 조직 단위 IDou-fc8c29a138d78e24bf1fa86812fc8b
type유형(ROOT 또는 조직 단위) 또는 계정 유형MEMBER

10.7.1.21 - ListParents

10.7.1.21.1 - 1.1

scpcli organization organization unit parent list
--unit_id <value>
[--organization_id <value>]

Description

get organization unit parent list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
unit_id
required
string조직 단위 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
id조직 단위 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
depth계층(0~5)1
description조직 단위 설명에스코어 조직 단위
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name조직 단위명score-organization-unit
parent_unit_id유형(ROOT 또는 조직 단위)ou-fc8c29a138d78e24bf1fa86812fc8b
service_name서비스명Organization
srn조직 단위 SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8
type유형(ROOT 또는 조직 단위)OU

10.7.1.21.2 - 1.0

scpcli organization organization unit parent list
--unit_id <value>
[--organization_id <value>]

Description

get organization unit parent list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
unit_id
required
string조직 단위 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
id조직 단위 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
depth계층(0~5)1
description조직 단위 설명에스코어 조직 단위
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name조직 단위명score-organization-unit
parent_unit_id유형(ROOT 또는 조직 단위)ou-fc8c29a138d78e24bf1fa86812fc8b
service_name서비스명Organization
srn조직 단위 SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8
type유형(ROOT 또는 조직 단위)OU

10.7.1.22 - ListPoliciesForTarget

10.7.1.22.1 - 1.1

scpcli organization target policy list
--target_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]

Description

list policies for target

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
target_id
required
string타겟 IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_category
optional
****정책 카테고리SCP
name
optional
string제어 정책 이름test-policy-name

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
link_types연결 유형{‘DIRECTED’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’, ’target_type’: ‘OU’}], ‘INHERITED’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’, ’target_type’: ‘ROOT’}]}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
policy_name제어 정책 이름test-policy-name
policy_type제어 정책 유형SYSTEM_MANAGED
source정책 생성 주체ORGANIZATION

10.7.1.22.2 - 1.0

scpcli organization target policy list
--target_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]

Description

list policies for target

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
target_id
required
string타겟 IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_category
optional
****정책 카테고리SCP
name
optional
string제어 정책 이름test-policy-name

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
link_types연결 유형{‘DIRECTED’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’, ’target_type’: ‘OU’}], ‘INHERITED’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’, ’target_type’: ‘ROOT’}]}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
policy_name제어 정책 이름test-policy-name
policy_type제어 정책 유형SYSTEM_MANAGED
source정책 생성 주체ORGANIZATION

10.7.1.23 - ListServiceControlPolicies

10.7.1.23.1 - 1.1

scpcli organization service control policy list
--organization_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--exclude_target_id <value>]

Description

get service control policies list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
string서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
name
optional
array서비스 제어 정책 이름M
type
optional
****서비스 제어 정책 유형MANAGED
exclude_target_id
optional
string제외 대상 ID112c2fc8c29a449dbfa8681f8f1d7442

Responses

NameDescriptionExample
id서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
category정책 카테고리SCP
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
description정책 설명This is an example policy.
document정책 문서{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name서비스 제어 정책 이름MyPolicy
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
source정책 생성 주체ORGANIZATION
state정책 상태ACTIVE
type서비스 제어 정책 유형MANAGED

10.7.1.23.2 - 1.0

scpcli organization service control policy list
--organization_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--exclude_target_id <value>]

Description

get service control policies list

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
string서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
name
optional
array서비스 제어 정책 이름M
type
optional
****서비스 제어 정책 유형MANAGED
exclude_target_id
optional
string제외 대상 ID112c2fc8c29a449dbfa8681f8f1d7442

Responses

NameDescriptionExample
id서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
category정책 카테고리SCP
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
description정책 설명This is an example policy.
document정책 문서{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name서비스 제어 정책 이름MyPolicy
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
source정책 생성 주체ORGANIZATION
state정책 상태ACTIVE
type서비스 제어 정책 유형MANAGED

10.7.1.24 - ListTargetsForPolicy

10.7.1.24.1 - 1.1

scpcli organization policy target list
--target_type <value>
--policy_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]

Description

list targets for policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
target_type
required
****타겟 유형OU
policy_id
required
string제어 정책 IDf98e76d54c32b10a9z8y7x6w5v4u3
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_category
optional
****정책 카테고리SCP
name
optional
string타겟명example-target

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
control_policies통제 정책 아이디 목록
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
target_name타겟명example-target

10.7.1.24.2 - 1.0

scpcli organization policy target list
--target_type <value>
--policy_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]

Description

list targets for policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
target_type
required
****타겟 유형OU
policy_id
required
string제어 정책 IDf98e76d54c32b10a9z8y7x6w5v4u3
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_category
optional
****정책 카테고리SCP
name
optional
string타겟명example-target

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
control_policies통제 정책 아이디 목록
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
target_name타겟명example-target

10.7.1.25 - MoveAccount

10.7.1.25.1 - 1.1

scpcli organization account move
--target_account_ids <value>
--parent_unit_id <value>
[--organization_id <value>]

Description

move a specific account to a different OU

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
target_account_ids
required
array타겟 계정 아이디 목록b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
parent_unit_id
required
stringROOT ID 또는 조직 단위 IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.25.2 - 1.0

scpcli organization account move
--target_account_ids <value>
--parent_unit_id <value>
[--organization_id <value>]

Description

move a specific account to a different OU

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
target_account_ids
required
array타겟 계정 아이디 목록b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
parent_unit_id
required
stringROOT ID 또는 조직 단위 IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.26 - RemoveAccounts

10.7.1.26.1 - 1.1

scpcli organization account remove
--target_account_ids <value>
[--organization_id <value>]

Description

Remove accounts from organization

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
target_account_ids
required
array타겟 계정 아이디 목록b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.26.2 - 1.0

scpcli organization account remove
--target_account_ids <value>
[--organization_id <value>]

Description

Remove accounts from organization

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
target_account_ids
required
array타겟 계정 아이디 목록b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.27 - RemovePolicyBindings

10.7.1.27.1 - 1.1

scpcli organization policy remove
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]

Description

remove policy bindings

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
target_ids
required
array타겟 정보ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
policy_ids
required
array제어 정책 목록 IDf98e76d54c32b10a9z8y7x6w5v4u3
entity
required
string개체 유형POLICY
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.27.2 - 1.0

scpcli organization policy remove
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]

Description

remove policy bindings

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
target_ids
required
array타겟 정보ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
policy_ids
required
array제어 정책 목록 IDf98e76d54c32b10a9z8y7x6w5v4u3
entity
required
string개체 유형POLICY
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.28 - SetDelegationPolicy

10.7.1.28.1 - 1.1

scpcli organization delegation policy set
[--organization_id <value>]
[--statement <value>]
[--version <value>]

Description

set a specific delegation policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
statement
optional
array정책 문법'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
string정책 버전-

10.7.1.28.2 - 1.0

scpcli organization delegation policy set
[--organization_id <value>]
[--statement <value>]
[--version <value>]

Description

set a specific delegation policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
statement
optional
array정책 문법'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
string정책 버전-

10.7.1.29 - SetOrganization

10.7.1.29.1 - 1.1

scpcli organization organization set
--organization_id <value>
[--delegation_account_id <value>]
[--name <value>]
[--organization_id <value>]
[--use_scp_yn <value>]

Description

set a specific organization

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
delegation_account_id
optional
string위임 계정124e7d6c5b4a3z2y1x0w9v8u7t6s5r
name
optional
string조직 이름My Organization
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_yn
optional
boolean통제 정책 사용 여부True

10.7.1.29.2 - 1.0

scpcli organization organization set
--organization_id <value>
[--delegation_account_id <value>]
[--name <value>]
[--organization_id <value>]
[--use_scp_yn <value>]

Description

set a specific organization

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
delegation_account_id
optional
string위임 계정124e7d6c5b4a3z2y1x0w9v8u7t6s5r
name
optional
string조직 이름My Organization
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_yn
optional
boolean통제 정책 사용 여부True

10.7.1.30 - SetOrganizationUnit

10.7.1.30.1 - 1.1

scpcli organization organization unit set
--unit_id <value>
[--description <value>]
[--name <value>]
[--organization_id <value>]

Description

set a specific organization unit

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
unit_id
required
string조직 단위 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
description
optional
string조직 단위 설명에스코어 조직 단위
name
optional
string조직 단위명score-organization-unit
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.30.2 - 1.0

scpcli organization organization unit set
--unit_id <value>
[--description <value>]
[--name <value>]
[--organization_id <value>]

Description

set a specific organization unit

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
unit_id
required
string조직 단위 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
description
optional
string조직 단위 설명에스코어 조직 단위
name
optional
string조직 단위명score-organization-unit
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.31 - SetServiceControlPolicy

10.7.1.31.1 - 1.1

scpcli organization service control policy set
--policy_id <value>
--organization_id <value>
[--description <value>]
[--name <value>]
[--statement <value>]
[--version <value>]

Description

set a specific service control policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
policy_id
required
string서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
description
optional
string정책 설명This is an example policy.
name
optional
string서비스 제어 정책 이름MyPolicy
statement
optional
array정책 문법'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
string정책 버전-

10.7.1.31.2 - 1.0

scpcli organization service control policy set
--policy_id <value>
--organization_id <value>
[--description <value>]
[--name <value>]
[--statement <value>]
[--version <value>]

Description

set a specific service control policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
policy_id
required
string서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
description
optional
string정책 설명This is an example policy.
name
optional
string서비스 제어 정책 이름MyPolicy
statement
optional
array정책 문법'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
string정책 버전-

10.7.1.32 - ShowAccount

10.7.1.32.1 - 1.1

scpcli organization account show
--account_id <value>
[--organization_id <value>]
[--lazy_policy <value>]

Description

show a specific account

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
account_id
required
string조직 계정 IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
lazy_policy
optional
boolean연결된 정책 조회 여부True

Responses

NameDescriptionExample
account조직 계정 상세 정보

10.7.1.32.2 - 1.0

scpcli organization account show
--account_id <value>
[--organization_id <value>]
[--lazy_policy <value>]

Description

show a specific account

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
account_id
required
string조직 계정 IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
lazy_policy
optional
boolean연결된 정책 조회 여부True

Responses

NameDescriptionExample
account조직 계정 상세 정보

10.7.1.33 - ShowDelegationPolicy

10.7.1.33.1 - 1.1

scpcli organization delegation policy show
[--organization_id <value>]

Description

show a specific delegation policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
document위임 정책 문서{‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.33.2 - 1.0

scpcli organization delegation policy show
[--organization_id <value>]

Description

show a specific delegation policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
document위임 정책 문서{‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

10.7.1.34 - ShowOrganization

10.7.1.34.1 - 1.1

scpcli organization organization show
--organization_id <value>

Description

show a specific organization

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
delegation_account_id위임 계정124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_email관리자 계정 이메일admin@example.com
master_account_id관리자 계정 ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name조직 이름My Organization
root_unit_id루트 유닛 IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
srn조직 SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_yn통제 정책 사용 여부True

10.7.1.34.2 - 1.0

scpcli organization organization show
--organization_id <value>

Description

show a specific organization

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
delegation_account_id위임 계정124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_email관리자 계정 이메일admin@example.com
master_account_id관리자 계정 ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name조직 이름My Organization
root_unit_id루트 유닛 IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
srn조직 SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_yn통제 정책 사용 여부True

10.7.1.35 - ShowOrganizationUnit

10.7.1.35.1 - 1.1

scpcli organization organization unit show
--unit_id <value>
[--organization_id <value>]

Description

show a specific organization unit

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
unit_id
required
string조직 단위 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
organization_unit조직 단위 정보

10.7.1.35.2 - 1.0

scpcli organization organization unit show
--unit_id <value>
[--organization_id <value>]

Description

show a specific organization unit

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
unit_id
required
string조직 단위 IDou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
organization_unit조직 단위 정보

10.7.1.36 - ShowServiceControlPolicy

10.7.1.36.1 - 1.1

scpcli organization service control policy show
--policy_id <value>
[--organization_id <value>]

Description

show a specific service control policy

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
policy_id
required
string서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
id서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
category정책 카테고리SCP
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
description정책 설명This is an example policy.
document정책 문서{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name서비스 제어 정책 이름MyPolicy
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
service_name서비스명Organization
source정책 생성 주체ORGANIZATION
srn정책 SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2
state정책 상태ACTIVE
type서비스 제어 정책 유형MANAGED

10.7.1.36.2 - 1.0

scpcli organization service control policy show
--policy_id <value>
[--organization_id <value>]

Description

show a specific service control policy

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
policy_id
required
string서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
optional
string조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
id서비스 제어 정책 ID138c2fc8c29a449dbfa8681f8f1d78e2
category정책 카테고리SCP
created_at생성 일시2024-12-19 01:09:05.000
created_by생성자c23fb561c689455993874fa5d5ed4a2f
creator_name생성자 성, 이름John Doe na
description정책 설명This is an example policy.
document정책 문서{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_at수정 일시2023-10-15 14:30:00
modified_by수정자c23fb561c689455993874fa5d5ed4a2f
modifier_name수정자 성, 이름Alice
name서비스 제어 정책 이름MyPolicy
organization_id조직 IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
service_name서비스명Organization
source정책 생성 주체ORGANIZATION
srn정책 SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2
state정책 상태ACTIVE
type서비스 제어 정책 유형MANAGED

10.8 - Quota Service

Overview

None

Version

VersionStatusSupported Until
1.0DEPRECATED20260223
1.1DEPRECATED20260223
1.2CURRENT-

10.8.1 - CLIs

10.8.1.1 - ListAccountQuota

10.8.1.1.1 - 1.2

scpcli quota account-quota list
[--size <value>]
[--page <value>]
[--sort <value>]
[--request_class <value>]
[--service <value>]
[--quota_item <value>]
[--description <value>]

Description

account quota 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
request_class
optional
stringRequest ClassAccount
service
optional
stringService NameIAM
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
description
optional
stringDescriptionVirtual Server disk max size

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account Inc.
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_at생성 시간2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
max_per_accountMax per Account Value1000
modified_at수정 시간2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

10.8.1.1.2 - 1.1

scpcli quota account-quota list
[--size <value>]
[--page <value>]
[--sort <value>]
[--request_class <value>]
[--service <value>]
[--quota_item <value>]
[--description <value>]

Description

account quota 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
request_class
optional
stringRequest ClassAccount
service
optional
stringService NameIAM
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
description
optional
stringDescriptionVirtual Server disk max size

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account Inc.
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_at생성 시간2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
max_per_accountMax per Account Value1000
modified_at수정 시간2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

10.8.1.1.3 - 1.0

scpcli quota account-quota list
[--size <value>]
[--page <value>]
[--sort <value>]
[--request_class <value>]
[--service <value>]
[--quota_item <value>]
[--description <value>]

Description

account quota 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
request_class
optional
stringRequest ClassAccount
service
optional
stringService NameIAM
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
description
optional
stringDescriptionVirtual Server disk max size

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account Inc.
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_at생성 시간2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
modified_at수정 시간2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

10.8.1.2 - ListQuotaRequests

10.8.1.2.1 - 1.2

scpcli quota quota-request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--service <value>]
[--quota_item <value>]
[--requester <value>]
[--request_class <value>]
[--requested_start_at <value>]
[--requested_end_at <value>]
[--applied_start_at <value>]
[--applied_end_at <value>]
[--state <value>]

Description

quota request 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
service
optional
stringService NameVirtual Server
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
requester
optional
stringRequester Informationcloud.kim
request_class
optional
stringRequest ClassAccount
requested_start_at
optional
stringStart date of the request2024-05-01
requested_end_at
optional
stringEnd date of the request2024-05-31
applied_start_at
optional
stringStart date of the application2024-05-01
applied_end_at
optional
stringEnd date of the application2024-05-31
state
optional
stringRequest StateBEFORE_APPROVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
free_rateFree Rate10
initial_valueInitial Value100
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
request_classRequest ClassAccount
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
serviceService NameVirtual Server
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

10.8.1.2.2 - 1.1

scpcli quota quota-request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--service <value>]
[--quota_item <value>]
[--requester <value>]
[--request_class <value>]
[--requested_start_at <value>]
[--requested_end_at <value>]
[--applied_start_at <value>]
[--applied_end_at <value>]
[--state <value>]

Description

quota request 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
service
optional
stringService NameVirtual Server
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
requester
optional
stringRequester Informationcloud.kim
request_class
optional
stringRequest ClassAccount
requested_start_at
optional
stringStart date of the request2024-05-01
requested_end_at
optional
stringEnd date of the request2024-05-31
applied_start_at
optional
stringStart date of the application2024-05-01
applied_end_at
optional
stringEnd date of the application2024-05-31
state
optional
stringRequest StateBEFORE_APPROVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
free_rateFree Rate10
initial_valueInitial Value100
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
request_classRequest ClassAccount
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
serviceService NameVirtual Server
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

10.8.1.2.3 - 1.0

scpcli quota quota-request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--service <value>]
[--quota_item <value>]
[--requester <value>]
[--request_class <value>]
[--requested_start_at <value>]
[--requested_end_at <value>]
[--applied_start_at <value>]
[--applied_end_at <value>]
[--state <value>]

Description

quota request 목록 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
service
optional
stringService NameVirtual Server
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
requester
optional
stringRequester Informationcloud.kim
request_class
optional
stringRequest ClassAccount
requested_start_at
optional
stringStart date of the request2024-05-01
requested_end_at
optional
stringEnd date of the request2024-05-31
applied_start_at
optional
stringStart date of the application2024-05-01
applied_end_at
optional
stringEnd date of the application2024-05-31
state
optional
stringRequest StateBEFORE_APPROVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
free_rateFree Rate10
initial_valueInitial Value100
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
request_classRequest ClassAccount
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
serviceService NameVirtual Server
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

10.8.1.3 - ShowAccountQuota

10.8.1.3.1 - 1.2

scpcli quota account-quota show
--account_quota_id <value>

Description

account quota 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
account_quota_id
required
stringAccount Quota ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account Inc.
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_at생성 시간2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
max_per_accountMax per Account Value1000
modified_at수정 시간2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

10.8.1.3.2 - 1.1

scpcli quota account-quota show
--account_quota_id <value>

Description

account quota 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260223

Parameters

NameTypeDescriptionExample
account_quota_id
required
stringAccount Quota ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account Inc.
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_at생성 시간2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
max_per_accountMax per Account Value1000
modified_at수정 시간2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

10.8.1.3.3 - 1.0

scpcli quota account-quota show
--account_quota_id <value>

Description

account quota 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
account_quota_id
required
stringAccount Quota ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account Inc.
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_at생성 시간2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
modified_at수정 시간2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

10.8.1.4 - ShowQuotaRequest

10.8.1.4.1 - 1.2

scpcli quota quota-request show
--request_id <value>

Description

quota request 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID0c2a06f2f06d42248a6bb88b1a78d4cc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_quota_idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
class_valueValue associated with the request classGlobal
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial Value100
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
reductionReductionFalse
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

10.8.1.4.2 - 1.1

scpcli quota quota-request show
--request_id <value>

Description

quota request 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.120260223

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID0c2a06f2f06d42248a6bb88b1a78d4cc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_quota_idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
class_valueValue associated with the request classGlobal
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial Value100
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
reductionReductionFalse
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

10.8.1.4.3 - 1.0

scpcli quota quota-request show
--request_id <value>

Description

quota request 상세 조회

상태 ACTIVE (DEPRECATED)

버전최소 지원 보장일
1.020260223

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID0c2a06f2f06d42248a6bb88b1a78d4cc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_quota_idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
class_valueValue associated with the request classGlobal
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial Value100
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
reductionReductionFalse
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

10.9 - Resource Manager

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Resourcemanager 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

10.9.1 - CLIs

10.9.1.1 - CreateResourceGroup

10.9.1.1.1 - 1.0

scpcli resourcemanager resource group create
--name <value>
--description <value>
[--region <value>]
[--resource_types <value>]
[--tags <value>]

Description

create a resource_group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
required
string리소스 그룹명resource-group-1
description
required
string리소스 그룹 설명resource group 1
region
optional
string리전kr-west1
resource_types
optional
array자원 유형 목록 (service:resource_type)[
tags
optional
array태그 목록'{"key": "tag-key", "value": "tag-value"}'

Responses

NameDescriptionExample
resource_group리소스 그룹

10.9.1.2 - DeleteComponentsTag

10.9.1.2.1 - 1.0

scpcli resourcemanager components tag key delete
--key <value>
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>

Description

delete a specific components tag

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
key
required
string태그 key (base64 encoded KEY)dGFnLWtleQ==
resource_identifier
required
string자원 IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
string자원 유형virtual-server
service
required
string서비스 명virtualserver
region
required
string리전kr-west1

10.9.1.3 - DeleteComponentsTags

10.9.1.3.1 - 1.0

scpcli resourcemanager components tag delete
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>

Description

delete components tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_identifier
required
string자원 IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
string자원 유형virtual-server
service
required
string서비스 명virtualserver
region
required
string리전kr-west1

10.9.1.4 - DeleteResourceGroup

10.9.1.4.1 - 1.0

scpcli resourcemanager resource group delete
--resource_group_id <value>

Description

delete a specific resource_group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_group_id
required
string리소스 그룹 ID1486t61d84b354fb9135cc467owe1346

10.9.1.5 - DeleteResourceGroups

10.9.1.5.1 - 1.0

scpcli resourcemanager resource group delete bulk
[--ids <value>]

Description

delete a specific resource_groups

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
ids
optional
array리소스 그룹 ID 목록[

10.9.1.6 - DeleteResourceTag

10.9.1.6.1 - 1.0

scpcli resourcemanager resource tag key delete
--key <value>
--srn <value>

Description

delete a specific resource tag

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
key
required
string태그 key (base64 encoded KEY)dGFnLWtleQ==
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==

10.9.1.7 - DeleteResourceTags

10.9.1.7.1 - 1.0

scpcli resourcemanager resource tag delete
--srn <value>

Description

delete resource tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==

10.9.1.8 - DeleteTags

10.9.1.8.1 - 1.0

scpcli resourcemanager tag delete
--tags <value>

Description

delete tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
tags
required
dict태그 키 목록{"srn:e::PROJECT-NTcEraJPrRhNGqldsJLTnf:kr-east1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m": ["key1", "key4"]}

10.9.1.9 - ListComponentsTags

10.9.1.9.1 - 1.0

scpcli resourcemanager components tag list
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--key <value>]
[--value <value>]

Description

get components tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_identifier
required
string자원 IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
string자원 유형virtual-server
service
required
string서비스 명virtualserver
region
required
string리전kr-west1
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
key
optional
string태그 keytag-key
value
optional
string태그 valuetag-value

Responses

NameDescriptionExample
content태그 목록
countcount20
pagepage0
sizesize20
sortsort[‘created_at:asc’]

10.9.1.10 - ListResourceGroupResources

10.9.1.10.1 - 1.0

scpcli resourcemanager resource group resource list
--resource_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

list a specific resource_group_resources

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_group_id
required
string리소스 그룹 ID1486t61d84b354fb9135cc467owe1346
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id어카운트ID1234ab567cd64769e8f9g490hi304891
created_at생성 일시2025-02-27T10:23:43Z
created_by생성자7123ke8439734e5789lj355b17ef5473
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
product_name상품/서비스Virtual Server
region리전kr-west1
resource_name자원명resource-name-1
resource_type자원 유형virtual-server
resource_type_display_name자원 유형명Virtual Server
serviceSERVICEvirtualserver
service_name서비스 명Virtual Server
srnSRNsrn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
state상태Success
tags태그 목록[{“key1”: “value1”}, {“key2”: “value2”}]

10.9.1.11 - ListResourceGroups

10.9.1.11.1 - 1.0

scpcli resourcemanager resource group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--region <value>]

Description

get resource_groups list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
string리소스 그룹 ID1486t61d84b354fb9135cc467owe1346
name
optional
string리소스 그룹명resource-group-1
region
optional
string리전kr-west1

Responses

NameDescriptionExample
id리소스 그룹 ID1486t61d84b354fb9135cc467owe1346
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
description리소스 그룹 설명resource group 1
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
name리소스 그룹명resource-group-1
region리전kr-west1
resource_types자원 유형 목록[“resourcemanager:resource-group”, “loggingaudit:trail”]
tags태그 목록[{“key”: “key1”, “value”: “value1”}, {“key”: “key2”, “value”: “value2”}]

10.9.1.12 - ListResources

10.9.1.12.1 - 1.0

scpcli resourcemanager resource list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--resource_name <value>]
[--service_name <value>]
[--resource_type <value>]
[--region <value>]

Description

get resources list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
string자원 IDz95fa561-11u3-4frw-962g-3b123123c496
resource_name
optional
string자원명resource-name-1
service_name
optional
string서비스 명Virtual Server
resource_type
optional
string자원 유형virtual-server
region
optional
string리전kr-west1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id어카운트ID1234ab567cd64769e8f9g490hi304891
created_at생성 일시2025-02-27T10:23:43Z
created_by생성자7123ke8439734e5789lj355b17ef5473
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
product_name상품/서비스Virtual Server
region리전kr-west1
resource_name자원명resource-name-1
resource_type자원 유형virtual-server
resource_type_display_name자원 유형명Virtual Server
serviceSERVICEvirtualserver
service_name서비스 명Virtual Server
srnSRNsrn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
state상태Success
tags태그 목록[{“key1”: “value1”}, {“key2”: “value2”}]

10.9.1.13 - ListResourceTags

10.9.1.13.1 - 1.0

scpcli resourcemanager resource tag list
--srn <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--key <value>]
[--value <value>]

Description

get resource tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
key
optional
string태그 keytag-key
value
optional
string태그 valuetag-value

Responses

NameDescriptionExample
content태그 목록
countcount20
pagepage0
sizesize20
sortsort[‘created_at:asc’]

10.9.1.14 - ListTagKeys

10.9.1.14.1 - 1.0

scpcli resourcemanager tag key list
[--key <value>]
[--region <value>]

Description

get tag key list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
key
optional
string태그 keytag-key
region
optional
string리전kr-west1

Responses

NameDescriptionExample
count개수6
keys태그 key 목록[“key1”, “key2”]

10.9.1.15 - ListTags

10.9.1.15.1 - 1.0

scpcli resourcemanager tag list
[--size <value>]
[--page <value>]
[--sort <value>]
[--account_id <value>]
[--key <value>]
[--value <value>]
[--resource_identifier <value>]
[--resource_type <value>]
[--service <value>]
[--offering <value>]
[--region <value>]

Description

get tag list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
account_id
optional
string어카운트 ID1234ab567cd64769e8f9g490hi304891
key
optional
string태그 keytag-key
value
optional
string태그 valuetag-value
resource_identifier
optional
string자원 IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
optional
string자원 유형virtual-server
service
optional
string서비스 명virtualserver
offering
optional
stringSCP 운영 단위dev2
region
optional
string리전kr-west1

Responses

NameDescriptionExample
key태그 keytag-key
srnSRNsrn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
value태그 valuetag-value

10.9.1.16 - ListTagValues

10.9.1.16.1 - 1.0

scpcli resourcemanager tag value list
[--key <value>]
[--region <value>]
[--value <value>]

Description

get tag value list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
key
optional
string태그 keytag-key
region
optional
string리전kr-west1
value
optional
string태그 valuetag-value

Responses

NameDescriptionExample
count개수6
values태그 value 목록[“value1”, “value2”]

10.9.1.17 - SetResourceGroup

10.9.1.17.1 - 1.0

scpcli resourcemanager resource group set
--resource_group_id <value>
--description <value>
[--resource_types <value>]
[--tags <value>]

Description

set resource_group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_group_id
required
string리소스 그룹 ID1486t61d84b354fb9135cc467owe1346
description
required
string리소스 그룹 설명resource group 1
resource_types
optional
array자원 유형 목록 (service:resource_type)[
tags
optional
array태그 목록'{"key": "tag-key", "value": "tag-value"}'

10.9.1.18 - ShowComponentsTag

10.9.1.18.1 - 1.0

scpcli resourcemanager components tag show
--key <value>
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>

Description

get a specific components tag

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
key
required
string태그 key (base64 encoded KEY)dGFnLWtleQ==
resource_identifier
required
string자원 IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
string자원 유형virtual-server
service
required
string서비스 명virtualserver
region
required
string리전kr-west1

Responses

NameDescriptionExample
content태그

10.9.1.19 - ShowResource

10.9.1.19.1 - 1.0

scpcli resourcemanager resource show
--srn <value>

Description

get a specific resource

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==

Responses

NameDescriptionExample
resource자원

10.9.1.20 - ShowResourceByComponents

10.9.1.20.1 - 1.0

scpcli resourcemanager resource show by components
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>

Description

get a specific resource

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_identifier
required
string자원 IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
string자원 유형virtual-server
service
required
string서비스 명virtualserver
region
required
string리전kr-west1

Responses

NameDescriptionExample
resource자원

10.9.1.21 - ShowResourceGroup

10.9.1.21.1 - 1.0

scpcli resourcemanager resource group show
--resource_group_id <value>

Description

show a specific resource_group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_group_id
required
string리소스 그룹 ID1486t61d84b354fb9135cc467owe1346

Responses

NameDescriptionExample
resource_group리소스 그룹

10.9.1.22 - ShowResourceTag

10.9.1.22.1 - 1.0

scpcli resourcemanager resource tag show
--key <value>
--srn <value>

Description

get a specific resource tag

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
key
required
string태그 key (base64 encoded KEY)dGFnLWtleQ==
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==

Responses

NameDescriptionExample
content태그

10.9.1.23 - UpdateComponentsTags

10.9.1.23.1 - 1.0

scpcli resourcemanager components tag set
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
--tags <value>

Description

update components tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
resource_identifier
required
string자원 IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
string자원 유형virtual-server
service
required
string서비스 명virtualserver
region
required
string리전kr-west1
tags
required
array태그 목록'{"key": "tag-key", "value": "tag-value"}'

10.9.1.24 - UpdateComponentsTagValue

10.9.1.24.1 - 1.0

scpcli resourcemanager components tag value set
--key <value>
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
--value <value>

Description

update components tag value

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
key
required
string태그 key (base64 encoded KEY)dGFnLWtleQ==
resource_identifier
required
string자원 IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
string자원 유형virtual-server
service
required
string서비스 명virtualserver
region
required
string리전kr-west1
value
required
stringSRNtag-value

10.9.1.25 - UpdateResourceTags

10.9.1.25.1 - 1.0

scpcli resourcemanager resource tag set
--srn <value>
--tags <value>

Description

update resource tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
tags
required
array태그 목록'{"key": "tag-key", "value": "tag-value"}'

10.9.1.26 - UpdateResourceTagValue

10.9.1.26.1 - 1.0

scpcli resourcemanager resource tag value set
--key <value>
--srn <value>
--value <value>

Description

update resource tag value

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
key
required
string태그 key (base64 encoded KEY)dGFnLWtleQ==
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
value
required
stringSRNtag-value

10.9.1.27 - UpdateTags

10.9.1.27.1 - 1.0

scpcli resourcemanager tag set
--tags <value>

Description

update tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
tags
required
dict태그 목록-

10.10 - ServiceWatch

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 ServiceWatch 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0SUPPORTED20260630
1.1CURRENT-

10.10.1 - CLIs

10.10.1.1 - CreateCustomLogEvents

10.10.1.1.1 - 1.1

scpcli servicewatch logeventcustom create
--resourcelogs <value>

Description

Create custom log events

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
resourcelogs
required
arrayResource Logs'{"resource": {"attributes": [{"key": "log_stream_value", "value": {"stringValue": "a1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "log_group_value", "value": {"stringValue": "b1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "account_id", "value": {"stringValue": "c1e2f3045678901a2b3c4d5e6f7a8b81"}}]}, "scopeLogs": [{"logRecords": [{"body": {"stringValue": "level=info otlp test log"}, "timeUnixNano": "1762336464000000000"}]}]}'

Responses

NameDescriptionExample
statusStatussuccess

10.10.1.2 - CreateCustomLogStream

10.10.1.2.1 - 1.1

scpcli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>

Description

Create a custom log stream

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
log_stream_name
required
stringLog stream nametestls01
log_group_name
required
stringLog group nametestlg01

Responses

NameDescriptionExample
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
log_group_valueLog group valuefa6169af200b4d5db229aff384b2a028
log_stream_valueLog stream value551513c5182b45beb22eadb634cdccfb
requests_per_second초당 로그 요청 내보내기500

10.10.1.3 - CreateCustomMetricMetas

10.10.1.3.1 - 1.1

scpcli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>

Description

Create Custom Metric Metas

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
namespace
required
stringNamespaceMyCustom/filestorage
metricmetas
required
array'{"descriptionEn": "filestorage volume total byte", "descriptionKo": "\ud30c\uc77c\uc2a4\ud1a0\ub9ac\uc9c0 \ucd1d \ubc14\uc774\ud2b8 \uc218", "dimensions": [["image_id"]], "metricName": "Custom_filestorage_volume_total_byte", "storageResolution": 60, "unit": "Bytes"}'

Responses

NameDescriptionExample
codeRESPONSE STATUS CODE of MetricSuccess
messageMessage about Updated Unit Info[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes

10.10.1.4 - CreateCustomMetrics

10.10.1.4.1 - 1.1

scpcli servicewatch metriccustom create
--resource_metrics <value>

Description

Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
resource_metrics
required
arrayThe resourceMetrics field holds a set of all metric data associated with a specific resource'{"resource": {"attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}]}, "scope_metrics": [{"metrics": [{"description": "The total number of bytes read successfully.", "gauge": {"data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}]}, "name": "node_disk_read_bytes_total", "sum": {"aggregation_temporality": "2", "data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}], "is_monotonic": true}, "unit": "Bytes"}], "scope": {"name": "ServiceWatch-Agent", "version": "1.0.0"}}]}'

Responses

NameDescriptionExample

10.10.1.5 - CreateDashboard

10.10.1.5.1 - 1.1

scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

10.10.1.5.2 - 1.0

scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

10.10.1.6 - DeleteBulkDashboards

10.10.1.6.1 - 1.1

scpcli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

10.10.1.6.2 - 1.0

scpcli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

10.10.1.7 - DownloadMetricDataImage

10.10.1.7.1 - 1.1

scpcli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]

Description

Download metric data image

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440
height
optional
integerChart Image Height(pixels)400
timezone
optional
string타임존UTC
title
optional
stringChart TitleVirtual Server Metric Chart
width
optional
integerChart Image Width(pixels)600

Responses

NameDescriptionExample

10.10.1.7.2 - 1.0

scpcli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]

Description

Download metric data image

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440
height
optional
integerChart Image Height(pixels)400
timezone
optional
string타임존UTC
title
optional
stringChart TitleVirtual Server Metric Chart
width
optional
integerChart Image Width(pixels)600

Responses

NameDescriptionExample

10.10.1.8 - ListDashboards

10.10.1.8.1 - 1.1

scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]

Description

Get list of dashboards

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortname:asc or modified_at:desc
name
optional
stringDashboard's nameMyProd
name_like
optional
stringWildcard Search for Dashboard NamesMyProd
favorite_enabled
optional
booleanWhether it is a favorite dashboardTrue

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
created_atCreated date time
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
nameDashboard’s nameProduction-Web-Servers
typeDashboard typeCustom

10.10.1.8.2 - 1.0

scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]

Description

Get list of dashboards

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortname:asc or modified_at:desc
name
optional
stringDashboard's nameMyProd
name_like
optional
stringWildcard Search for Dashboard NamesMyProd
favorite_enabled
optional
booleanWhether it is a favorite dashboardTrue

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
created_atCreated date time
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
nameDashboard’s nameProduction-Web-Servers
typeDashboard typeCustom

10.10.1.9 - ListMetricData

10.10.1.9.1 - 1.1

scpcli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>

Description

Get metric data list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440

Responses

NameDescriptionExample
display_nameMetric Display NameVirtual Server
status
valuesList of Metric Series Values[[1640995200, “45.5”]]

10.10.1.9.2 - 1.0

scpcli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>

Description

Get metric data list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440

Responses

NameDescriptionExample
display_nameMetric Display NameVirtual Server
status
valuesList of Metric Series Values[[1640995200, “45.5”]]

10.10.1.10 - ListMetricInfos

10.10.1.10.1 - 1.1

scpcli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]

Description

Get metric list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage/Core[Basic]
namespaces
optional
arrayList of Namespace'{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}'
resource_id
optional
stringResource ID10bf5d24-0f20-4066-bb0b-de2b1d6ff502
resource_name
optional
stringResource NameVirtualServer01
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'

Responses

NameDescriptionExample
idNamespace IDd583a229-9766-4eb8-96c4-ec389902ba3d
dimensions
nameNamespaceVirtual Server
service_name

10.10.1.10.2 - 1.0

scpcli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]

Description

Get metric list

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage/Core[Basic]
namespaces
optional
arrayList of Namespace'{"dimensions": "[\"resource_id\"]", "name": "Virtual Server"}'
resource_id
optional
stringResource ID10bf5d24-0f20-4066-bb0b-de2b1d6ff502
resource_name
optional
stringResource NameVirtualServer01
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'

Responses

NameDescriptionExample
idNamespace IDd583a229-9766-4eb8-96c4-ec389902ba3d
dimensions
nameNamespaceVirtual Server
service_name

10.10.1.11 - SetDashboard

10.10.1.11.1 - 1.1

scpcli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]

Description

Set dashboard

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b
name
optional
stringDashboard's nameRenamed-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

10.10.1.11.2 - 1.0

scpcli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]

Description

Set dashboard

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b
name
optional
stringDashboard's nameRenamed-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

10.10.1.12 - ShowAgentDownloadLink

10.10.1.12.1 - 1.1

scpcli servicewatch show agent download link

Description

Show link to agent download

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Responses

NameDescriptionExample
download_linkURL to download agentdownload_link = ‘https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip’

10.10.1.13 - ShowDashboard

10.10.1.13.1 - 1.1

scpcli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

10.10.1.13.2 - 1.0

scpcli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020260630

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

10.11 - Support

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Support 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

10.11.1 - CLIs

10.11.1.1 - Get Inquiry List

10.11.1.1.1 - 1.0

scpcli support inquiry list
[--size <value>]
[--page <value>]
[--sort <value>]
[--title <value>]
[--state <value>]
[--inquiry_type <value>]
[--region_id <value>]
[--created_at <value>]
[--filter_inquiry_codes <value>]
[--filter_states <value>]

Description

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
title
optional
stringtitleVM usage inquiry
state
optional
stringstateCLOSED
inquiry_type
optional
stringinquiry typeGeneral Inquiry - Account and connection inquiry
region_id
optional
stringregion idkr-west1
created_at
optional
stringcreated at2024-06-01T00:12:57.000000Z
filter_inquiry_codes
optional
stringfilter inquiry codesFL01,FL02
filter_states
optional
stringfilter statesTODO,INPROGRESS

Responses

NameDescriptionExample
ididsr-240530-00028-nuri
account_idaccount id2010571da2f7458e97c3b881b2362b72
closed_atclosed at2024-06-27T08:12:57.000000Z
contentscontentsVM usage inquiry
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
files
inquiry_codeinquiry codeG01
inquiry_typeinquiry typeGeneral Inquiry - Account and connection inquiry
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_idregion idkr-west1
resource_nameresource namelb1
service_categoryservice categoryNetworking
service_itemservice itemLoad Balancer
statestateCLOSED
titletitleVM usage inquiry

10.11.1.2 - Get Service Request List

10.11.1.2.1 - 1.0

scpcli support service request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--filter_operation_type_ids <value>]
[--filter_service_item_ids <value>]
[--filter_title <value>]
[--filter_states <value>]
[--from_created_at <value>]
[--to_created_at <value>]
[--operation_type <value>]
[--service_item_name <value>]
[--title <value>]
[--state <value>]

Description

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
filter_operation_type_ids
optional
string2010571da2f7458e97c3b881b2362b72,1h6q5kqt42f7458e97c3b881b2311utne8fea87728164808860ad81c6ce779b6
filter_service_item_ids
optional
stringservice item id listVIRTUAL_SERVER,LOAD_BALANCER
filter_title
optional
stringtitleVirtual Server operation related
filter_states
optional
stringfilter statesREQUESTING,CLOSED
from_created_at
optional
stringfrom created at2024-07-01T00:00:00Z
to_created_at
optional
stringto created at2024-07-05T23:59:59Z
operation_type
optional
stringoperation typePlacement Group Set Up Request
service_item_name
optional
stringservice itemLoad Balancer
title
optional
stringtitleVirtual Server operation related
state
optional
stringstateREQUESTING

Responses

NameDescriptionExample
idid007d8cc7d60c4b26bb5a833b06686db3
account_idaccount id2010571da2f7458e97c3b881b2362b72
account_nameaccount namedev_project
closed_atclosed at2024-06-27T08:12:57.000000Z
contentscontentsI need assistance with working with Virtual Server.
created_atcreated at2024-06-01T00:12:57.000000Z
created_bycreated bye3bff0c980dc41b2b6f3ac080b6d3ba0
created_by_namecreated by name and emailKimSamSung(test@samsung.com)
files
iops_resultiops resultProcessing completed.
iops_sr_idiops sr idSR0002834921
modified_atmodified at2024-06-11T00:12:57.000000Z
modified_bymodified bye3bff0c980dc41b2b6f3ac080b6d3ba0
operation_typeoperation typePlacement Group Set Up Request
regionregionkr-west1
service_category_nameservice categoryNetworking
service_item_nameservice itemLoad Balancer
statestateACTIVE
template_idtemplate_ide8fea87728164808860ad81c6ce779b6
titletitleVirtual Server operation related

10.11.1.3 - Show Inquiry

10.11.1.3.1 - 1.0

scpcli support inquiry show
--inquiry_id <value>

Description

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
inquiry_id
required
stringidsr-240530-00028-nuri

Responses

NameDescriptionExample
ididFile-008ccb7ff65244689dacd605fafec92f
file_namenametest.txt
sizesize298426

10.11.1.4 - Show Service Request

10.11.1.4.1 - 1.0

scpcli support service request show
--service_request_id <value>

Description

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
service_request_id
required
stringid007d8cc7d60c4b26bb5a833b06686db3

Responses

NameDescriptionExample
ididFile-008ccb7ff65244689dacd605fafec92f
file_namenametest.txt
sizesize298426

11 - Platform

11.1 - Product

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 PRODUCT 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다

Version

VersionStatusSupported Until
1.0CURRENT-

11.1.1 - CLIs

11.1.1.1 - List Product Categories

11.1.1.1.1 - 1.0

scpcli product product categories list
[--limit <value>]
[--page <value>]
[--display_name <value>]
[--display_name_ko <value>]
[--is_exposed_menu <value>]
[--created_by <value>]
[--modified_by <value>]
[--created_start_date <value>]
[--created_end_date <value>]
[--modified_start_date <value>]
[--modified_end_date <value>]
[--sort <value>]

Description

List product categories

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
limit
optional
integerLIMIT10
page
optional
integerPage1
display_name
optional
arrayProduct Category NameN
display_name_ko
optional
arrayProduct Category NameN
is_exposed_menu
optional
arrayProduct Category Menu Exposed StatusT
created_by
optional
stringCreated by김삼성
modified_by
optional
stringModified by김삼성
created_start_date
optional
stringCreated start date2024-01-01T00:00:00
created_end_date
optional
stringCreated end date2024-01-01T00:00:00
modified_start_date
optional
stringModified start date2024-01-01T00:00:00
modified_end_date
optional
stringModified end date2024-01-01T00:00:00
sort
optional
stringSortcreated_at:asc

Responses

NameDescriptionExample
category_idProduct Category IDNETWORKING
created_atCreated date2024-01-01T00:00:00
created_byCreated by5cada9f6afa049418c4f18c0c4859202
display_nameProduct Category NameNetworking
display_name_koProduct Category NameNetworking
icon_file_idIcon File IDc1d5c1f63bf24f73b32c37f6f7b50310
is_exposed_menuProduct Category Menu Exposed StatusTrue
modified_atModified date2024-01-01T00:00:00
modified_byModified by5cada9f6afa049418c4f18c0c4859202
seqSeq9
service_group_color_idService Group Colorffff00

11.1.1.2 - List Products

11.1.1.2.1 - 1.0

scpcli product product list
[--limit <value>]
[--page <value>]
[--product_category_id <value>]
[--product_id <value>]
[--display_name <value>]
[--display_name_ko <value>]
[--kind <value>]
[--created_start_date <value>]
[--created_end_date <value>]
[--modified_start_date <value>]
[--modified_end_date <value>]
[--sort <value>]

Description

List products.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
limit
optional
integerLIMIT10
page
optional
integerPage1
product_category_id
optional
arrayProduct Category IDN
product_id
optional
arrayProduct IDV
display_name
optional
arrayProduct nameV
display_name_ko
optional
arrayProduct nameV
kind
optional
arrayProduct KindP
created_start_date
optional
stringCreated start date2024-01-01T00:00:00
created_end_date
optional
stringCreated end date2024-01-01T00:00:00
modified_start_date
optional
stringModified start date2024-01-01T00:00:00
modified_end_date
optional
stringModified end date2024-01-01T00:00:00
sort
optional
stringSortcreated_at:asc

Responses

NameDescriptionExample
created_atCreated date2024-01-01T00:00:00
created_byCreated by5cada9f6afa049418c4f18c0c4859202
display_nameProduct nameVPC
display_name_koProduct nameVPC
kindProduct KindPRODUCT
modified_atModified date2024-01-01T00:00:00
modified_byModified by5cada9f6afa049418c4f18c0c4859202
product_category_idProduct Category IDNETWORKING
product_category_nameProduct Category NameNetworking
product_idProduct IDVPC

11.1.1.3 - Show Product

11.1.1.3.1 - 1.0

scpcli product product show
--product_id <value>

Description

Show product.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
product_id
required
stringProduct IDVPC

Responses

NameDescriptionExample
created_atCreated date2024-01-01T00:00:00
created_byCreated by5cada9f6afa049418c4f18c0c4859202
display_nameProduct nameVPC
display_name_koProduct nameVPC
kindProduct KindPRODUCT
modified_atModified date2024-01-01T00:00:00
modified_byModified by5cada9f6afa049418c4f18c0c4859202
product_category_idProduct Category IDNETWORKING
product_category_nameProduct Category NameNetworking
product_idProduct IDVPC

11.1.1.4 - Show Product category

11.1.1.4.1 - 1.0

scpcli product product category show
--category_id <value>

Description

Show product category.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
category_id
required
stringProduct Category IDNETWORKING

Responses

NameDescriptionExample
category_idProduct Category IDNETWORKING
created_atCreated date2024-01-01T00:00:00
created_byCreated by5cada9f6afa049418c4f18c0c4859202
display_nameProduct Category NameNetworking
display_name_koProduct Category NameNetworking
icon_file_idIcon File IDc1d5c1f63bf24f73b32c37f6f7b50310
is_exposed_menuProduct Category Menu Exposed StatusTrue
modified_atModified date2024-01-01T00:00:00
modified_byModified by5cada9f6afa049418c4f18c0c4859202
seqSeq9
service_group_color_idService Group Colorffff00

11.2 - STS

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 STS 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

11.2.1 - CLIs

11.2.1.1 - Acquire temporary role credential

11.2.1.1.1 - 1.0

scpcli sts sts assume role
--role_session_name <value>
--role_indicator <value>
[--duration_seconds <value>]

Description

Acquire temporary role credential

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
role_session_name
required
stringIdentifier for the assumed role session-
role_indicator
required
stringIdentifier of the role to assume. [offering:account_id:role_name]-
duration_seconds
optional
integerDuration of seconds of the role session-

Responses

NameDescriptionExample
assumed_role_userSRN and assumed role ID
credentialsTemporary security credentials

11.2.1.2 - Acquire temporary role credential from SAML Assertion

11.2.1.2.1 - 1.0

scpcli sts sts assume role with saml
--saml_assertion <value>
--role_indicator <value>
--principal_indicator <value>
[--duration_seconds <value>]

Description

Acquire temporary role credential from SAML Assertion

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
saml_assertion
required
stringBASE64 encoded SAML response-
role_indicator
required
stringIdentifier of the role to assume. [offering:account_id:role_name]-
principal_indicator
required
stringIdentifier of the SAML provider in IAM. [offering:account_id:provider_name]-
duration_seconds
optional
integerDuration of seconds of the role session-

Responses

NameDescriptionExample
assumed_role_userSRN and assumed role ID
audienceValue of Recipient attribute of SubjectConfirmationData element of SAML
credentialsTemporary security credentials
issuerValue of Issuer element of SAML
subjectValue of NameID element in the Subject element of SAML
subject_typeFormat of nameID

11.2.1.3 - Create new Signature based on Session Token

11.2.1.3.1 - 1.0

scpcli sts sts object store authorization
--x_amz_date <value>
--x_amz_content_sha256 <value>
--url <value>
--method <value>
[--region <value>]
[--service <value>]

Description

Create new Signature based on Session Token

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
x_amz_date
required
stringDate and time at which the request is signed-
x_amz_content_sha256
required
stringSHA256 hash of the request body-
url
required
stringThe URL of the request-
method
required
stringHTTP method used in the request-
region
optional
stringRegion where the request is made-
service
optional
stringService to which the request is made-

Responses

NameDescriptionExample
AuthorizationAuthorization header for object store authentication

12 - Financial Management

12.1 - BillingPlan

Overview

SCP에서 제공하는 BillingPlan 서비스를 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 BillingPlan 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

12.1.1 - CLIs

12.1.1.1 - Change Request Planned Compute

12.1.1.1.1 - 1.0

scpcli billingplan set planned compute
--planned_compute_id <value>
[--action <value>]
[--contract_type <value>]
[--server_type <value>]

Description

Change action request planned compute.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
planned_compute_id
required
stringPlanned Compute Id5f3688a192094ddeb0c94166a3e88935
action
optional
stringPlanned Compute change request action typeEXTEND_CHANGE
contract_type
optional
****Contract type is required in the case of EXTEND_APPLY or EXTEND_CHANGE01
server_type
optional
stringServer Type is required in the case of SERVER_TYPE_CHANGEs1v1m2

12.1.1.2 - Create Request Planned Computes

12.1.1.2.1 - 1.0

scpcli billingplan create planned computes
--contract_type <value>
--os_type <value>
--server_type <value>
--service_id <value>
[--service_name <value>]
[--tag <value>]

Description

Create request planned compute.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
contract_type
required
stringContract Type01
os_type
required
stringOS TypeOPEN_SOURCE
server_type
required
stringServer Types1v1m2
service_id
required
stringService IdVIRTUAL_SERVER
service_name
optional
stringService NameVirtual Server
tag
optional
arrayTag Form'{"key": "key1", "value": "value1"}'

Responses

NameDescriptionExample
idPlanned Compute Id5f3688a192094ddeb0c94166a3e88935
start_dateStart date (YYYY-MM-dd)2024-08-01
end_dateEnd date (YYYY-MM-dd)2024-08-01
contract_idContract IdC002612775
account_idAccount Id228cb9e4a7934f84853594c7f26f7a21
regionRegionkr-west1
service_idService IdVIRTUAL_SERVER
service_nameService NameVirtual Server
os_typeOS TypeOPEN_SOURCE
os_nameOS NameOpen Source
server_typeServer Types1v1m2
server_type_descriptionServer Type Description
srnSRNsrn:e::26affb52e16944038a0cd2cc26060e1c:kr1-west1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m
resource_typeResource Typeinstance
contract_typeContract Type1-year
next_contract_typeNext Contract Type1-year
first_contract_start_atStart date (YYYY-MM-dd)2024-08-01
next_start_dateNext Start date (YYYY-MM-dd)2024-08-01
next_end_dateNext End date (YYYY-MM-dd)2024-08-31
statePlanned Compute StateACTIVE
delete_ynDelete or notN
resource_nameResource Nametest-vm
created_atCreated date2024-08-01 00:00:00
created_byCreated byuser123
modified_atModified date2024-08-01 00:00:00
modified_byModified bykim

12.1.1.3 - Get Planned Compute

12.1.1.3.1 - 1.0

scpcli billingplan get planned computes
--planned_compute_id <value>

Description

Get planned compute.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
planned_compute_id
required
stringPlanned Compute Id5f3688a192094ddeb0c94166a3e88935

Responses

NameDescriptionExample
idPlanned Compute Id5f3688a192094ddeb0c94166a3e88935
start_dateStart date (YYYY-MM-dd)2024-08-01
end_dateEnd date (YYYY-MM-dd)2024-08-01
contract_idContract IdC002612775
account_idAccount Id228cb9e4a7934f84853594c7f26f7a21
regionRegionkr-west1
service_idService IdVIRTUAL_SERVER
service_nameService NameVirtual Server
os_typeOS TypeOPEN_SOURCE
os_nameOS NameOpen Source
server_typeServer Types1v1m2
server_type_descriptionServer Type Description
srnSRNsrn:e::26affb52e16944038a0cd2cc26060e1c:kr1-west1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m
resource_typeResource Typeinstance
contract_typeContract Type1-year
next_contract_typeNext Contract Type1-year
first_contract_start_atStart date (YYYY-MM-dd)2024-08-01
next_start_dateNext Start date (YYYY-MM-dd)2024-08-01
next_end_dateNext End date (YYYY-MM-dd)2024-08-31
statePlanned Compute StateACTIVE
delete_ynDelete or notN
resource_nameResource Nametest-vm
created_atCreated date2024-08-01 00:00:00
created_byCreated byuser123
modified_atModified date2024-08-01 00:00:00
modified_byModified bykim

12.1.1.4 - GetCancellationFee

12.1.1.4.1 - 1.0

scpcli billingplan get cancellation fee
--planned_compute_id <value>
[--region <value>]

Description

Get Cancellation Fee

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
planned_compute_id
required
arrayPlanned Compute Id5
region
optional
stringRegionkr-west1

Responses

NameDescriptionExample
codeCurrency codeKRW
symbolCurrency Symbol

12.1.1.5 - List Contract Type

12.1.1.5.1 - 1.0

scpcli billingplan list planned compute contract types
[--service_id <value>]
[--server_type <value>]

Description

Get Contract Type List.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
service_id
optional
stringService IdVIRTUAL_SERVER
server_type
optional
stringServer Types1v1m2

Responses

NameDescriptionExample
codeContract Code01
display_nameDisplay Name1-year

12.1.1.6 - List OS System

12.1.1.6.1 - 1.0

scpcli billingplan list os types
[--service_id <value>]

Description

Get Os System List.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
service_id
optional
stringService IdVIRTUAL_SERVER

Responses

NameDescriptionExample
os_type_idOS Type idOPEN_SOURCE
display_nameDisplay NameOpen Source
os_type_valueDisplay Nameopensource

12.1.1.7 - List Planned Compute Covered Resource

12.1.1.7.1 - 1.0

scpcli billingplan list planned compute instances
--end_date <value>
--start_date <value>
--server_type <value>
--os_type <value>
--service_id <value>

Description

Get Planned Compute Covered Resource List.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
end_date
required
stringEnd date (YYYY-MM-dd)2024-08-01
start_date
required
stringStart date (YYYY-MM-dd)2024-08-01
server_type
required
stringServer Types1v1m2
os_type
required
stringOS TypeOPEN_SOURCE
service_id
required
stringService IdVIRTUAL_SERVER

Responses

NameDescriptionExample
resource_nameResource Nametest-vm
contract_idContract IdC002612775
used_timeUsed time Hour10
unit_priceUnit Price
used_amountUsed amount
non_applied_amountNon Applied Amount
request_atRequest At2024-08-01 00:00:00

12.1.1.8 - ListServerType

12.1.1.8.1 - 1.0

scpcli billingplan list planned compute server types
[--service_id <value>]
[--current_server_type <value>]
[--os_type <value>]

Description

Get Server Type List

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
service_id
optional
stringService IdVIRTUAL_SERVER
current_server_type
optional
stringServer Types1v1m2
os_type
optional
stringOS TypeOPEN_SOURCE

Responses

NameDescriptionExample
server_typeServer Types1v1m2
server_type_descriptionServer Type Description
instance_typeInstance Types1
coreInstance Core1
memory_gbInstance Memory GB2
gpu_nameGpu Model Namea100
scale_up_ynScale up or not. If server_type > current_server_type, it’s represented as Y. if smaller N.Y

12.1.1.9 - ListServiceType

12.1.1.9.1 - 1.0

scpcli billingplan list planned compute service types

Description

Get Service Type List

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Responses

NameDescriptionExample
service_idService IdVIRTUAL_SERVER
display_nameDisplay NameVirtual Server

12.2 - Budget

Overview

SCP에서 제공하는 Budget 서비스를 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Budget 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

12.2.1 - CLIs

12.2.1.1 - CreateAccountBudget

12.2.1.1.1 - 1.0

scpcli budget account budget create
--unit <value>
--start_month <value>
--name <value>
--amount <value>
[--is_use_notification <value>]
[--notification_send_period <value>]
[--receivers <value>]
[--thresholds <value>]
[--is_use_prevention <value>]
[--threshold <value>]

Description

어카운트 예산 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
unit
required
stringBudget management unit (MONTHLY or OVERALL)MONTHLY
start_month
required
stringBudget start month (ex.YYYY-MM)2026-01
name
required
stringBudget nametest_budget
amount
required
integerBudget amount1000000
is_use_notification
optional
booleanNotification use stateTrue
notification_send_period
optional
stringThe notification frequency can be FIRST, DAILY, or NONE.FIRST
receivers
optional
arrayPrevention notification recipient email list.test_user1@test.com
thresholds
optional
arrayThresholds for receiving threshold exceed notification email: 70/80/90/100.80
is_use_prevention
optional
booleanAuto Generation prevent use stateTrue
threshold
optional
integerThreshold for receiving prevention notification email: 70/80/90/100.80

Responses

NameDescriptionExample
idBudget id240200fd2b02490ca63bb3965048b493
amountBudget amount1000000
created_atCreated datetime2025-11-01T00:00:00
created_byCreated userTEST
modified_atModified datetime2025-11-01T00:00:00
modified_byModified userTEST
nameBudget namemy_budget_ex
start_monthBudget start month (ex.YYYY-MM)2025-11
typeBudget typeCOST
unitBudget management unit (MONTHLY or OVERALL)MONTHLY

12.2.1.2 - DeleteAccountBudget

12.2.1.2.1 - 1.0

scpcli budget account budget delete
--budget_id <value>

Description

어커운트 예산 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
budget_id
required
stringBudget id240200fd2b02490ca63bb3965048b493

12.2.1.3 - ListAccountBudgets

12.2.1.3.1 - 1.0

scpcli budget account budget list
[--size <value>]
[--page <value>]
[--sort <value>]
[--search_name <value>]
[--budget_name <value>]

Description

어카운트 예산 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
search_name
optional
stringBudget namemy_budget_ex
budget_name
optional
stringBudget namemy_budget_ex

Responses

NameDescriptionExample
idBudget id240200fd2b02490ca63bb3965048b493
amountBudget amount1000000
created_atCreated datetime2025-11-01T00:00:00
created_byCreated userTEST
modified_atModified datetime2025-11-01T00:00:00
modified_byModified userTEST
nameBudget namemy_budget_ex
start_monthBudget start month (ex.YYYY-MM)2025-11
typeBudget typeCOST
unitBudget management unit (MONTHLY or OVERALL)MONTHLY

12.2.1.4 - SetAccountBudget

12.2.1.4.1 - 1.0

scpcli budget account budget set
--budget_id <value>
--unit <value>
--start_month <value>
--name <value>
--amount <value>
[--is_use_notification <value>]
[--notification_send_period <value>]
[--receivers <value>]
[--thresholds <value>]
[--is_use_prevention <value>]
[--threshold <value>]

Description

어카운트 예산 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
budget_id
required
stringBudget id240200fd2b02490ca63bb3965048b493
unit
required
stringBudget management unit (MONTHLY or OVERALL)MONTHLY
start_month
required
stringBudget start month (ex.YYYY-MM)2026-01
name
required
stringBudget nametest_budget
amount
required
integerBudget amount1000000
is_use_notification
optional
booleanNotification use stateTrue
notification_send_period
optional
stringThe notification frequency can be FIRST, DAILY, or NONE.FIRST
receivers
optional
arrayPrevention notification recipient email list.test_user1@test.com
thresholds
optional
arrayThresholds for receiving threshold exceed notification email: 70/80/90/100.80
is_use_prevention
optional
booleanAuto Generation prevent use stateTrue
threshold
optional
integerThreshold for receiving prevention notification email: 70/80/90/100.80

12.2.1.5 - ShowAccountBudget

12.2.1.5.1 - 1.0

scpcli budget account budget show
--budget_id <value>

Description

어카운트 예산 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
budget_id
required
stringBudget id240200fd2b02490ca63bb3965048b493

Responses

NameDescriptionExample
idBudget id240200fd2b02490ca63bb3965048b493
amountBudget amount1000000
created_atCreated datetime2025-11-01T00:00:00
created_byCreated userTEST
modified_atModified datetime2025-11-01T00:00:00
modified_byModified userTEST
nameBudget namemy_budget_ex
start_monthBudget start month (ex.YYYY-MM)2025-11
typeBudget typeCOST
unitBudget management unit (MONTHLY or OVERALL)MONTHLY

12.3 - CostExplorer

Overview

SCP에서 제공하는 CostExplorer 서비스를 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 CostExplorer 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

12.3.1 - CLIs

12.3.1.1 - GetPaymentMonthly

12.3.1.1.1 - 1.0

scpcli costexplorer payment monthly show
[--size <value>]
[--page <value>]

Description

Get payment monthly data.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integerSize10
page
optional
integerPage1

Responses

NameDescriptionExample
payer_account_idPayer Account Id228cb9e4a7934f84853594c7f26f7a21
payer_account_namePayer Account Nametest-account
payer_account_typePayer Account TypeMEMBER
bill_year_monthBill year Month2024-08
used_year_monthYear-Month (YYYY-mm)2024-08
payment_datePayment date2024-08-01
bill_currencyCurrencyKRW
payment_currencyCurrencyKRW
payment_stateBilling StatePAID
bill_amount
used_amount
unpaid_amount
paid_amount
accumulated_unpaid_amount
suspended_year_monthYear-Month (YYYY-mm)2024-08

12.3.1.2 - ListBills

12.3.1.2.1 - 1.0

scpcli costexplorer bill list
[--start_year_month <value>]
[--end_year_month <value>]
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--service_category <value>]
[--billing_item_id <value>]
[--resource_name <value>]
[--region <value>]
[--contract_id <value>]
[--order_status <value>]
[--bill_year_month <value>]
[--bill_state <value>]

Description

Get bill list.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
start_year_month
optional
stringStart year-month (YYYY-mm)2024-08
end_year_month
optional
stringEnd year-month (YYYY-mm)2024-08
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Id228cb9e4a7934f84853594c7f26f7a21
service_category
optional
stringService CategoryCOMPUTE
billing_item_id
optional
stringBilling Item IdVIRTUAL_SERVER
resource_name
optional
stringResource Nametest-vm
region
optional
stringRegionkr-west1
contract_id
optional
stringContract IdC002612775
order_status
optional
stringCCBS Order Status04
bill_year_month
optional
stringBill Date (YYYY-MM)2024-07
bill_state
optional
stringBilling StateUSED

Responses

NameDescriptionExample
idBill Id5f3688a192094ddeb0c94166a3e88935
amountsTotal Amounts{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
discount_amountsTotal Discount Amounts{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
assetAsset amount{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
operationOperation amount{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
optionOption amount{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
support_planSupport Plan{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
cancellation_fee해지 수수료{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
planned_computePlanned Compute{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
msp_discountMSP 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
new_business_discount신규 사업 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
sales_discount영업(기타) 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
sla_discountSLA{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
reseller_discount리셀러 할인{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_cost_savingsAccount Cost Savings{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
project_cost_savingsProject Cost Savings{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_creditAccount Credit{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
project_creditProject Credit{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
edpEDP{‘krw’: ‘500.000’, ‘usd’: ‘0.000’}
account_idAccount Id228cb9e4a7934f84853594c7f26f7a21
service_categoryService CategoryCOMPUTE
billing_item_idBilling Item IdVIRTUAL_SERVER
resource_idResource Id7f6741f3-d9f0-4262-9a5f-627e373567a7
resource_nameResource Nametest-vm
regionRegionkr-west1
contract_idContract IdC002612775
order_statusCCBS Order Status04
bill_year_monthBill year Month2024-07
bill_stateBilling StateUSED

12.3.1.3 - ListUsages

12.3.1.3.1 - 1.0

scpcli costexplorer usages list
[--start_date <value>]
[--end_date <value>]
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--service_category <value>]
[--billing_item_id <value>]
[--resource_name <value>]
[--region <value>]
[--contract_id <value>]
[--order_status <value>]

Description

Get usage list.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
start_date
optional
stringStart date (YYYY-MM-dd)2024-08-01
end_date
optional
stringEnd date (YYYY-MM-dd)2024-08-01
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Id228cb9e4a7934f84853594c7f26f7a21
service_category
optional
stringService CategoryCOMPUTE
billing_item_id
optional
stringBilling Item IdVIRTUAL_SERVER
resource_name
optional
stringResource Nametest-vm
region
optional
stringRegionkr-west1
contract_id
optional
stringContract IdC002612775
order_status
optional
stringCCBS Order Status04

Responses

NameDescriptionExample
idUsages Id5f3688a192094ddeb0c94166a3e88935
account_idAccount Id228cb9e4a7934f84853594c7f26f7a21
service_categoryService CategoryCOMPUTE
billing_item_idBilling Item IdVIRTUAL_SERVER
ccbs_product_codeCCBS Product CodePD00013862
resource_idResource Id7f6741f3-d9f0-4262-9a5f-627e373567a7
contract_idContract IdC002612775
order_statusCCBS Order Status04
usage_dateUsage date2024-08-01T00:00:00
amountsAmount{‘krw’: ‘500.0000000000’, ‘usd’: ‘0.0’}
status_codeUsage status code0

13 - DevOps Tools

13.1 - DevOps Service

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 DevOps Service 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

13.1.1 - CLIs

13.1.1.1 - Check Deletable DevOps Service

13.1.1.1.1 - 1.0

scpcli devopsservice devops service check deletable
--devops_service_id <value>

Description

check deletable a specific devops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
devops_service_id
required
stringDevOps Service ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
resultDevOps Service 확인 결과False

13.1.1.2 - Check Duplication DevOps Service

13.1.1.2.1 - 1.0

scpcli devopsservice devops service check duplication
[--tenant_code <value>]
[--tenant_name <value>]

Description

check duplication a specific devops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
tenant_code
optional
string테넌트 코드test-tenant
tenant_name
optional
string테넌트 명test-tenant

Responses

NameDescriptionExample
resultDevOps Service 확인 결과False

13.1.1.3 - Create DevOps Service

13.1.1.3.1 - 1.0

scpcli devopsservice devops service create
--tenant_name <value>
--tenant_code <value>
--members <value>
[--tags <value>]

Description

create a devops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
tenant_name
required
string테넌트 명-
tenant_code
required
string테넌트 코드-
members
required
array테넌트 멤버-
tags
optional
array태그 목록'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id어카운트 ID
console_urlDevOps Service Console URL
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
statusDevOps Service 상태
tenant_code테넌트 코드
tenant_name테넌트 명

13.1.1.4 - Delete DevOps Service

13.1.1.4.1 - 1.0

scpcli devopsservice devops service delete
--devops_service_id <value>

Description

delete a specific devops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
devops_service_id
required
stringDevOps Service ID138c2fc8c29a449dbfa8681f8f1d78e2

13.1.1.5 - List DevOps Services

13.1.1.5.1 - 1.0

scpcli devopsservice devops service list

Description

get devops service list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id어카운트 ID
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
statusDevOps Service 상태
tenant_code테넌트 코드
tenant_name테넌트 명

13.1.1.6 - Show DevOps Service

13.1.1.6.1 - 1.0

scpcli devopsservice devops service show
--devops_service_id <value>

Description

show a specific devops service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
devops_service_id
required
stringDevOps Service ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id어카운트 ID
console_urlDevOps Service Console URL
created_at생성 시간2024-05-17T00:23:17Z
created_by생성자90dddfc2b1e04edba54ba2b41539a9ac
modified_at수정 시간2024-05-17T00:23:17Z
modified_by수정자90dddfc2b1e04edba54ba2b41539a9ac
statusDevOps Service 상태
tenant_code테넌트 코드
tenant_name테넌트 명

14 - AI-ML

14.1 - AI&MLOps Platform

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 AI&MLOps Platform 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

14.1.1 - CLIs

14.1.1.1 - Check Cluster Version

14.1.1.1.1 - 1.0

scpcli aimlops-platform check cluster version
--cluster_id <value>
--cluster_version <value>

Description

Check AI&MLOps Platform Cluster Version.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
cluster_version
required
stringVersion1.28.1

Responses

NameDescriptionExample
resultResult

14.1.1.2 - Check Duplication AI&MLOps Platform Name

14.1.1.2.1 - 1.0

scpcli aimlops-platform check duplication
--release_name <value>

Description

Check Duplication AI&MLOps Platform Name. (false: no duplicate value, true: duplicate value)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
release_name
required
stringRelease Nameaiml-test

Responses

NameDescriptionExample
resultResult

14.1.1.3 - Create AI&MLOps Platform

14.1.1.3.1 - 1.0

scpcli aimlops-platform create aiml platform
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_os_version <value>
--image_os <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--release_name <value>
--image_id <value>
--ai_ml_ops_platform_type <value>
[--ai_ml_ops_platform_endpoint_type <value>]
[--cluster_id <value>]
[--initial_user_email <value>]
[--initial_user_password <value>]
[--storage_class_name <value>]
[--tags <value>]
[--cifs_volume_id <value>]
[--cloud_logging_enabled <value>]
[--lb_id <value>]
[--private_acl_ip_resource <value>]
[--public_acl_ip_address <value>]
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--kubernetes_version <value>]
[--max_node_count <value>]
[--min_node_count <value>]

Description

Create AI&MLOps Platform.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
volume_type_name
required
stringVolume Type NameSSD
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type IDs1v16m64
name
required
stringNodepool Namenodepool-test
keypair_name
required
stringKeypair Namekeypair
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
vpc_id
required
stringVPC ID10a599e031e749b7b260868f441e862b
volume_id
required
stringVolume ID10a599e031e749b7b260868f441e862b
subnet_id
required
stringSubnet ID10a599e031e749b7b260868f441e862b
security_group_id_list
required
arrayList Of Security Group ID10a599e031e749b7b260868f441e862b
kubernetes_engine_name
required
stringCluster Namecluster-test
k8s_version
required
stringKubernetes Versionv1.28.1
release_name
required
stringRelease Nameaiml-test
image_id
required
stringImage ID10a599e031e749b7b260868f441e862b
ai_ml_ops_platform_type
required
stringProduct TypeEnterprise
ai_ml_ops_platform_endpoint_type
optional
stringEndpoint Type-
cluster_id
optional
stringCluster ID10a599e031e749b7b260868f441e862b
initial_user_email
optional
stringInitial User Emailexample@gmail.com
initial_user_password
optional
stringInitial User Password147@53A69a
storage_class_name
optional
stringStorage Class Name-
tags
optional
arrayTags-
cifs_volume_id
optional
stringCifs Volume ID-
cloud_logging_enabled
optional
booleanCloud Logging Enabled-
lb_id
optional
stringLoad Balancer ID-
private_acl_ip_resource
optional
arrayPrivate Acl Ip Resource-
public_acl_ip_address
optional
stringPublic Acl Ip Address-
desired_node_count
optional
integerDesired Node Count2
is_auto_recovery
optional
booleanIs Auto RecoveryFalse
is_auto_scale
optional
booleanIs Auto ScaleFalse
kubernetes_version
optional
stringKubernetes Versionv1.28.1
max_node_count
optional
integerMax Node Count3
min_node_count
optional
integerMin Node Count2

Responses

NameDescriptionExample
project_idProject ID10a599e031e749b7b260868f441e862b
request_idRequest ID10a599e031e749b7b260868f441e862b
resource_idResource ID10a599e031e749b7b260868f441e862b

14.1.1.4 - Delete AI&MLOps Platform

14.1.1.4.1 - 1.0

scpcli aimlops-platform delete aiml platform
--release_id <value>
[--with_k8s <value>]

Description

Delete AI&MLOps Platform.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
release_id
required
stringRelease ID10a599e031e749b7b260868f441e862b
with_k8s
optional
booleanWith K8s Engine-

14.1.1.5 - Get AI&MLOps Platform details

14.1.1.5.1 - 1.0

scpcli aimlops-platform show aiml platform
--release_id <value>

Description

Get AI&MLOps Platform details.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
release_id
required
stringRelease ID10a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
ai_ml_ops_platform_domain_serviceDomain Service
ai_ml_ops_platform_endpoint_ip_addressEndpoint Ip Address
ai_ml_ops_platform_endpoint_portEndpoint Port
ai_ml_ops_platform_endpoint_typeEndpoint Type
ai_ml_ops_platform_typeProduct TypeEnterprise
cluster_idCluster ID10a599e031e749b7b260868f441e862b
cluster_nameCluster Namecluster-test
cluster_stateCluster StateRUNNING
created_byCreated By10a599e031e749b7b260868f441e862b
created_dtCreated Datetime2024-05-17T00:23:17Z
dashboard_stateDashboard State
image_idImage ID10a599e031e749b7b260868f441e862b
image_nameImage Name
initial_user_emailInitial User Email
modified_byModified By10a599e031e749b7b260868f441e862b
modified_dtModified Datetime2024-05-17T00:23:17Z
project_idProject ID10a599e031e749b7b260868f441e862b
project_nameProject Name
release_idRelease ID10a599e031e749b7b260868f441e862b
release_nameRelease Nameaiml-test
release_stateService StateDEPLOYED
storage_class_nameStorage Class Name
versionProduct Versionv1.7.1

14.1.1.6 - List AI&MLOps Platform

14.1.1.6.1 - 1.0

scpcli aimlops-platform list aiml platform
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--release_name <value>]
[--cluster_name <value>]
[--aimlopsplatform_version <value>]
[--kubeflow_type <value>]
[--status <value>]

Description

Get List of AI&MLOps Platform.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integerSize20
page
optional
integerPage0
sort
optional
stringSortcreated_dt:asc
created_by
optional
stringCreated By10a599e031e749b7b260868f441e862b
release_name
optional
stringRelease Nameaiml-test
cluster_name
optional
stringCluster Namecluster-test
aimlopsplatform_version
optional
stringVersionv1.7.1
kubeflow_type
optional
stringKubeflow TypeMini
status
optional
stringService StateDEPLOYED

Responses

NameDescriptionExample
cluster_idCluster ID10a599e031e749b7b260868f441e862b
cluster_nameCluster Namecluster-test
created_byCreated By10a599e031e749b7b260868f441e862b
created_dtCreated Datetime2024-05-17T00:23:17Z
kubeflow_typeProduct TypeEnterprise
modified_byModified By10a599e031e749b7b260868f441e862b
modified_dtModified Datetime2024-05-17T00:23:17Z
release_idRelease ID10a599e031e749b7b260868f441e862b
release_nameRelease Nameaiml-test
statusService StateDEPLOYED
versionProduct Versionv1.7.1

14.1.1.7 - List Images

14.1.1.7.1 - 1.0

scpcli aimlops-platform list image
[--size <value>]
[--page <value>]
[--sort <value>]
[--image_name <value>]

Description

Get List of AI&MLOps Platform Images.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integerSize20
page
optional
integerPage0
sort
optional
stringSortcreated_dt:asc
image_name
optional
stringImage Name-

Responses

NameDescriptionExample
base_imageBase Image
categoryCategory
created_byCreated By10a599e031e749b7b260868f441e862b
created_dtCreated Datetime2024-05-17T00:23:17Z
descriptionDescription
icon_fileIcon File
icon_file_nameIcon File Name
image_attrImage Attribute
image_idImage ID
image_nameImage Name
modified_byModified By10a599e031e749b7b260868f441e862b
modified_dtModified Datetime2024-05-17T00:23:17Z
os_typeOS Type
product_typeProduct TypeEnterprise
project_idProject ID10a599e031e749b7b260868f441e862b

14.1.1.8 - List Nodes

14.1.1.8.1 - 1.0

scpcli aimlops-platform list node
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get List of AI&MLOps Platform Nodes.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
size
optional
integerSize20
page
optional
integerPage0
sort
optional
stringSortcreated_dt:asc

Responses

NameDescriptionExample
ageage
cluster_idcluster_id
container_versioncontainer_version
created_atcreated_at
external_ip_addressexternal_ip_address
gpu_namegpu_name
ipip
kernel_versionkernel_version
kubernetes_versionkubernetes_version
namename
node_capacitiesnode_capacities
node_statusnode_status
number_of_allocated_podsnumber_of_allocated_pods
number_of_gpunumber_of_gpu
os_imageos_image
uiduid

14.1.1.9 - List StorageClasses

14.1.1.9.1 - 1.0

scpcli aimlops-platform list storageclasse
--cluster_id <value>

Description

Get List of AI&MLOps Platform StorageClasses.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
ageage
allow_volume_expansionallow_volume_expansion
cluster_idcluster_id
created_atcreated_at
default_classdefault_class
namename
provisionerprovisioner
pv_reclaim_policypv_reclaim_policy
uiduid
volume_binding_modevolume_binding_mode

14.1.1.10 - Update AI&MLOps Platform

14.1.1.10.1 - 1.0

scpcli aimlops-platform set aiml platform
--release_id <value>
[--ai_ml_ops_platform_endpoint_type <value>]
[--dns_id <value>]
[--domain_service_name <value>]
[--ip <value>]
[--operation_type <value>]
[--record_id <value>]
[--record_name <value>]

Description

Update AI&MLOps Platform.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
release_id
required
stringRelease ID10a599e031e749b7b260868f441e862b
ai_ml_ops_platform_endpoint_type
optional
stringEndpoint Type```Public
dns_id
optional
stringDNS IDacdd205d-b1d3-44e7-ab7a-429ca090e941
domain_service_name
optional
stringDomain Service Namesample.aimlopsplatform.com
ip
optional
stringIP192.168.3.197
operation_type
optional
stringOperation Type```CREATE
record_id
optional
stringRecord ID8af744b9-4893-4f98-881d-4df984de7162
record_name
optional
stringRecord Namesample

14.1.1.11 - Validate Cluster Namespace

14.1.1.11.1 - 1.0

scpcli aimlops-platform validate namespace
--cluster_id <value>

Description

Validate instability for AI&MLOps Platform. (whether already installed or not)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
resultResult

14.1.1.12 - Validate Cluster Resource Size

14.1.1.12.1 - 1.0

scpcli aimlops-platform validate cluster resource
--cluster_id <value>
--product_type <value>

Description

Validate whether Cluster Resource size is large enough or not for AI&MLOps Platform.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
product_type
required
stringProduct TypeEnterprise

Responses

NameDescriptionExample
resultResult

14.2 - Cloud ML

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Cloud ML 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

VersionStatusSupported Until

14.2.1 - CLIs

14.2.1.1 - CheckDuplicationNameAndDomainName

14.2.1.1.1 - 1.0

scpcli cloud-ml check duplication name and domain name
[--name <value>]
[--domain_name <value>]
[--accept <value>]
[--content_type <value>]

Description

check duplication name and domain name(Please use either the ’name’ or ‘domain_name’ query parameter.)

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
name
optional
stringname-
domain_name
optional
stringDomain Name-
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
resultResult

14.2.1.2 - CloudMLClusterCheckEstimate

14.2.1.2.1 - 1.0

scpcli cloud-ml cloud ml cluster estimate
--cluster_id <value>
[--use_copilot <value>]
[--accept <value>]
[--content_type <value>]

Description

cloud ml cluster estimate

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
use_copilot
optional
booleanUse Copilot-
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
analyticsAnalytics Estimate
applicationApplication Estimate
copilotCopilot Estimate

14.2.1.3 - CloudMLImages

14.2.1.3.1 - 1.0

scpcli cloud-ml cloud ml images
[--accept <value>]
[--content_type <value>]

Description

cloud ml images

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
copilot_enabledCopilot Enabled
display_versionDisplay Version
image_idImage ID
image_nameImage Name
k8s_versionK8s Version

14.2.1.4 - ClusterCheckReleasable

14.2.1.4.1 - 1.0

scpcli cloud-ml cluster check releasable
--cluster_id <value>
[--accept <value>]
[--content_type <value>]

Description

cluster check releasable

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
default_messageDefault Message
detail_messageDetail Message
error_codeError Code

14.2.1.5 - ClusterProduct

14.2.1.5.1 - 1.0

scpcli cloud-ml cluster product
--cluster_id <value>
[--accept <value>]
[--content_type <value>]

Description

cluster product

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
cloud_mlCloud ML
cloud_ml_commonCloud ML Common

14.2.1.6 - CreateCloudML

14.2.1.6.1 - 1.0

scpcli cloud-ml create cloud ml
--image_id <value>
--endpoint_type <value>
--domain_name <value>
--custom_registry_host <value>
--custom_registry_access_secret_key <value>
--custom_registry_access_key <value>
--cluster_id <value>
--cloud_ml_name <value>
--application_resource <value>
--analytics_resource <value>
[--copilot <value>]
[--custom_registry_access_project_id <value>]
[--custom_registry_access_region <value>]
[--description <value>]
[--product_group_id <value>]
[--tags <value>]
[--use_copilot <value>]
[--accept <value>]
[--content_type <value>]

Description

create cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID10a599e031e749b7b260868f441e862b
endpoint_type
required
stringEndpoint Type147@53A69a
domain_name
required
stringDomain Name147@53A69a
custom_registry_host
required
stringCustom Registry Host10a599e031e749b7b260868f441e862b
custom_registry_access_secret_key
required
stringCustom Registry Access Secret Key10a599e031e749b7b260868f441e862b
custom_registry_access_key
required
stringCustom Registry Access Key10a599e031e749b7b260868f441e862b
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
cloud_ml_name
required
stringCloud ML Nameaiml-test
application_resource
required
objectApplication Resource{'cpu': 0, 'memory': 0}
analytics_resource
required
objectAnalytics Resource{'cpu': 0, 'gpu': '', 'memory': 0}
copilot
optional
objectCopilot{'cpu': 0, 'gpu': '', 'memory': 0}
custom_registry_access_project_id
optional
stringCustom Registry Access Project ID10a599e031e749b7b260868f441e862b
custom_registry_access_region
optional
stringCustom Registry Access Region10a599e031e749b7b260868f441e862b
description
optional
stringDescription147@53A69a
product_group_id
optional
stringProduct Group ID10a599e031e749b7b260868f441e862b
tags
optional
arrayTags-
use_copilot
optional
booleanUse CopilotTrue
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
project_idProject ID10a599e031e749b7b260868f441e862b
request_idRequest ID10a599e031e749b7b260868f441e862b
resource_idResource ID10a599e031e749b7b260868f441e862b

14.2.1.7 - DeleteCloudML

14.2.1.7.1 - 1.0

scpcli cloud-ml delete cloud ml
--cloud_ml_id <value>
[--accept <value>]
[--content_type <value>]

Description

delete cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cloud_ml_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

14.2.1.8 - ShowCloudML

14.2.1.8.1 - 1.0

scpcli cloud-ml show cloud ml
--cloud_ml_id <value>
[--accept <value>]
[--content_type <value>]

Description

get cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cloud_ml_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
accept
optional
stringAccept-
content_type
optional
stringContent-Type-

Responses

NameDescriptionExample
cloud_ml_idCloud ML Id10a599e031e749b7b260868f441e862b
cloud_ml_nameCloud ML Nameaiml-test
cloud_ml_stateCloud ML StateDEPLOYED
cluster_idCluster ID10a599e031e749b7b260868f441e862b
cluster_nameCluster Namecluster-test
cluster_permissionCluster Permission{}
cluster_request_failedCluster Request FailFalse
copilot_enabledCopilot EnableFalse
created_byCreated By10a599e031e749b7b260868f441e862b
created_dtCreated Datetime2024-05-17T00:23:17Z
custom_registry_access_keyCustom Registry Access Keyaiml-test
custom_registry_hostCustom Registry Hostaiml-test
descriptionDescriptionaiml-test
display_versionDisplay Version22.04
domain_nameDomain Nameaiml-test
endpoint_ip_addressEndpoint Ip Addressaiml-test
endpoint_typeEndpoint Typeprivate
image_idImage ID10a599e031e749b7b260868f441e862b
image_nameImage Nameaiml-test
modified_byModified By10a599e031e749b7b260868f441e862b
modified_dtModified Datetime2024-05-17T00:23:17Z
namespace_nameNamepsace Nameaiml-test
product_group_idProduct Group ID10a599e031e749b7b260868f441e862b
project_idProject ID10a599e031e749b7b260868f441e862b
request_idRequest ID10a599e031e749b7b260868f441e862b
resource_limit_textResource Limit Textaiml-test
resource_request_textResource Request Textaiml-test
storage_class_nameStorage Class Nameaiml-test

14.2.1.9 - UpdateCloudML

14.2.1.9.1 - 1.0

scpcli cloud-ml update-cloud-ml
--cloud_ml_id <value>
--description <value>
[--accept <value>]
[--content_type <value>]

Description

update cloud ML

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

NameTypeDescriptionExample
cloud_ml_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
description
required
stringDescription147@53A69a
accept
optional
stringAccept-
content_type
optional
stringContent-Type-