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

Return to the regular view of this page.

CLI Reference

1 - Common

Overview


The SCP Command Line Interface (CLI) is an integrated tool for managing SCP’s resources.

You can use various platform services using CLI provided by SCP.

To see detailed commands and examples, please use the help command.

Installation


Download the CLI from the link.

windows

windows CLI Download

linux

linux CLI Download

Grant executable rights to the downloaded file.

chmod +x scp-cli

Prerequisites


Issuing Access Keys

To use the CLI functionality of the Samsung cloud platform, you must obtain an authentication key.

The issuance of authentication keys can be found in the upper left corner of the Samsung Cloud Platform Console at My Menu > My Info > Authentication Key > Create App Authentication Key.

Authentication keys consist of a pair of Access Key and Access Secret Key. Authentication keys are used to issue API authentication tokens.

  1. Log in to the Samsung Cloud Platform website.
  2. When accessing the My Menu > My Info > Access Key Management menu, click the Create Access Key button.
  3. After creating the period and usage, click OK to generate an authentication key.
  4. Check the issued Access Key and Access Secret Key from the access key list.
    • Access Secret Key can be found on the Authentication Key Details page.

Security Token Service (Optional)


Security Token Service allow users to access the system with authentication information that is only valid for a specific period. These credentials are typically used for the following purposes:

  • Enhanced Security: To minimize damage in case of a leak of long-term credentials (e.g., API keys, passwords).
  • Delegated Authority: To temporarily grant limited permissions to external users or systems.
  • Automatic Expiration: Credentials expire automatically after a set time, simplifying management

Components

Security Token Service includes the following information:

  1. Access Key: An identifier for authentication.
  2. Secret Key: Used to create an encrypted authentication signature.
  3. Session Token: A token for session identification and validation.

Creating Security Token Service

To use the Samsung Cloud Platform’s temporary security credentials feature, you must create a role.

Role creation can be managed in the Samsung Cloud Platform Console under [My Menu] > [My Info] > [Role]

  • Principal

    • When creating a role, you must define the principal that can assume the role.
    • The principal can be an account, user SRN, identity provider, etc., which is authorized to assume the role.
  • Policy

    • You must set a permissions policy that defines what actions the role can perform.
    • The policy should adhere to the Principle of Least Privilege, granting only the necessary permissions.
  1. Log in to the Samsung Cloud Platform Console.
  2. Navigate to My Menu > My Info > Role and click the Create Role button.
  3. Enter a role name and select the maximum session duration to set the validity period for assuming the role.
  4. Under Attach principal, click the Classification button to set the trust entity. You can click the Add button to set multiple trust entities.
  5. Under Attach Policy, find the desired policy from the policy list and click the checkbox on the left to select it.
  6. Click the Complete button to finish creating the role.

After this, you must generate a token for the role. This is done by executing the assume-role API, which returns an Access Key, Secret Key, and Session Token.

assume-role Usage Guide : assume-role usage

Execution Environment Setting Management


Configure the CLI’s running environment by defining it as a config file. The file must be created in the form of a file within the PC and in its location.

windows

C:\Users\{user name}\.scp\cli-config.json

linux

~/.scp/cli-config.json

The format of the configuration file supports JSON formats, setting them as follows.

{
        "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"
}

Check Setting Keys

keyDescriptionExample
auth_urlauth urlhttps://iam.s.samsungsdscloud.com/v1/endpoints
access_keyaccess keymy-access-key
access_secret_keyaccess secret keymy-access-secret-key
default_scp_regiondefault region namekr-west1
(Optional) session_tokensession token from security token servicesession_token

auth_url example

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 Command


Command Help

CLI commands are in the following format.

scp-cli [service] [resource] [actcion] [--option and parameters]
// e.g. ( The input/output results in the example are for illustration purposes and may differ from the actual ones. )
> scp-cli iam user create --user-name TestUser

The available commands are available through –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.

The “[Required]” mark in the option description is a mandatory option, and the “[Optional]” mark is a selection option.

API Versioning


The CLI supports micro-version style API versions, and you can check the API version for each service using commands.

By default, the latest version supported by the service will be used. Depending on the CLI version, the default API version may differ, which can lead to different output responses.

You can use a fixed version of the CLI by specifying the ––api-version argument.

Example CLI Command to Show API Versions

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

Example API Version CLI Output

+-------------+----------------------------+---------+-----------+---------------------------------------------------------+------------+
| 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 Version Status List

STATUSDescription
CURRENTThe latest recommended version (only one latest version is maintained)
SUPPORTEDVersion with no new features, only bug fixes available
PLANNEDPreview of upcoming versions (API calls not available, for documentation only)
DEPRECATEDVersion is deprecated; API version has 90 days or less remaining before it is no longer supported

interactive mode


You can use the CLI by running it in interactive mode.

scp-cli <global factor>

If the global factor needs to be set, enter it at execution time to set it and enter.

global factor : factors other than those of the commands used to perform the CLI. (ex. debug, microversion, etc.)

global factor use example

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

After execution, the following prompt appears, and you can enter the command directly to execute it.

(scp-cli)

Interactive Mode Usage Example

(scp-cli) iam policy list

To exit, exit interactive mode using Ctrl + D'.

2 - Compute

2.1 - Bare Metal Server

Overview

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

This guide provides a brief description of Bare Metal Server service and how to call 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

Assign Private NAT IP at Bare Metal Server.

State ACTIVE (CURRENT)

VersionSupported Until
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 stateACTIVE
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

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
public_ip_address_id
required
stringPublic IP 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

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
public_ip_address_id
required
stringPublic IP 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

Attach Local Subnet for Bare Metal Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_id
required
stringLocal Subnet IDab313c43291e4b678f4bacffe10768ae
local_subnet_ip
optional
stringPolicy Local 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

Attach Local Subnet for Bare Metal Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_id
required
stringLocal Subnet IDab313c43291e4b678f4bacffe10768ae
local_subnet_ip
optional
stringPolicy Local 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

Create Bare Metal Servers.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca
subnet_id
required
stringSubnet IDab313c43291e4b678f4bacffe10768ae
server_details
required
arrayDetailed settings for each server'{"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
stringRegion IDkr-west1
os_user_password
required
stringOS user passwordpassword
os_user_id
required
stringOS user IDuser001
image_id
required
stringImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
init_script
optional
stringInit scriptinit script
lock_enabled
optional
booleanUse LockTrue
placement_group_name
optional
stringPlacement Group Namepgtest
tags
optional
arrayTag'{"key": "key", "value": "value"}'
use_placement_group
optional
booleanUse Placement GroupFalse

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_idResource 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

Create Bare Metal Servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca
subnet_id
required
stringSubnet IDab313c43291e4b678f4bacffe10768ae
server_details
required
arrayDetailed settings for each server'{"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
stringRegion IDkr-west1
os_user_password
required
stringOS user passwordpassword
os_user_id
required
stringOS user IDuser001
image_id
required
stringImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
init_script
optional
stringInit scriptinit script
lock_enabled
optional
booleanUse LockTrue
placement_group_name
optional
stringPlacement Group Namepgtest
tags
optional
arrayTag'{"key": "key", "value": "value"}'
use_placement_group
optional
booleanUse Placement GroupFalse

Responses

NameDescriptionExample
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
request_idRequest IDreq-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_idResource 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

Delete Private NAT IP Bare Metal Server.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete Public NAT IP Bare Metal Server.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete Public NAT IP Bare Metal Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete Bare Metal Servers.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id_list
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

2.1.1.7.2 - 1.0

scpcli baremetal baremetal delete
--baremetal_id_list <value>

Description

Delete Bare Metal Servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id_list
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

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

Detach Local Subnet for Bare Metal Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_ip
required
stringPolicy Local Subnet IP192.168.0.1
local_subnet_id
required
stringLocal 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

Detach Local Subnet for Bare Metal Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
local_subnet_ip
required
stringPolicy Local Subnet IP192.168.0.1
local_subnet_id
required
stringLocal Subnet IDab313c43291e4b678f4bacffe10768ae

2.1.1.9 - List Baremetal Images

2.1.1.9.1 - 1.1

scpcli baremetal image list
--region_id <value>

Description

List Bare Metal Server Images.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
region_id
required
stringRegion IDkr-west1

Responses

NameDescriptionExample
idImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
created_atCreated at2024-07-11 08:56:59
nameImage nameRHEL 8.8 for BM
os_distroOS typeRHEL
scp_image_typeImage TypeSTANDARD
scp_os_versionOS version8.7

2.1.1.9.2 - 1.0

scpcli baremetal image list
--region_id <value>

Description

List Bare Metal Server Images.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
region_id
required
stringRegion IDkr-west1

Responses

NameDescriptionExample
idImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
created_atCreated at2024-07-11 08:56:59
nameImage nameRHEL 8.8 for BM
os_distroOS typeRHEL
scp_image_typeImage TypeSTANDARD
scp_os_versionOS version8.7

2.1.1.10 - List Baremetal Products

2.1.1.10.1 - 1.1

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

Description

List Bare Metal Server products.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
optional
stringImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm

Responses

NameDescriptionExample
idIDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
compute_class_type_nameCompute class type nameStandardMetal-2
compute_class_type_valueCompute class type values2_metal
cpu_nameCPU namecpu 16 vCore
cpu_unitCPU unitvCPU
cpu_valueCPU value64
created_atCreated At2024-05-17T00:23:17Z
descriptionDescriptionvCPU 16 │ Memory 128G │ Disk 480G
disk_unitDisk unitGB
disk_valueDisk value480
memory_nameMemory nameserver memory 128GB
memory_unitMemory unitGB
memory_valueMemory value128
modified_atModified At2024-05-17T00:23:17Z
nameNames2v16m128_metal
name_with_generationName with generations2v16m128_metal
os_disk_gbOS disk value480
stateStateAVAILABLE
typeTypeSCALE

2.1.1.10.2 - 1.0

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

Description

List Bare Metal Server products.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
image_id
optional
stringImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm

Responses

NameDescriptionExample
idIDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
attri_nameAttribute nameattri name
attri_valueAttribute valueattri value
compute_class_type_nameCompute class type nameStandardMetal-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 namecpu 16 vCore
cpu_unitCPU unitvCPU
cpu_valueCPU value64
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvCPU 16 │ Memory 128G │ Disk 480G
disk_nameDisk namedisk_name
disk_unitDisk unitGB
disk_valueDisk value480
infiniband_nameInfiniBand nameinfiniband_name
infiniband_unitInfiniBand unitinfiniband_unit
infiniband_valueInfiniband valueinfiniband_value
memory_nameMemory nameserver memory 128GB
memory_unitMemory unitGB
memory_valueMemory value128
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNames2v16m128_metal
name_with_generationName with generations2v16m128_metal
socket_nameSocket namesocket_name
socket_unitSocket unitsocket_unit
socket_valueSocket valuesocket_value
stateStateAVAILABLE
typeTypeSCALE

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

Get Bare Metal Servers list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
server_name
optional
stringBare Metal Server namebmserver-001
state
optional
stringBare Metal Server stateRUNNING
ip
optional
stringBare Metal Server IP address192.168.0.1
vpc_id
optional
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
image_idImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
image_versionImage versionRHEL 8.7 for BM
lock_enabledUse LockTrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
network_idSubnet IDab313c43291e4b678f4bacffe10768ae
os_typeOS typeWINDOWS
placement_group_namePlacement Group Namepgtest
policy_ipPolicy IP192.168.0.1
product_type_idBare Metal Server scale IDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
region_idRegion IDkr-west1
server_nameBare Metal Server namebmserver-001
server_typeBare Metal Server scale types1v8m32_metal
stateBare Metal Server stateRUNNING
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

Get Bare Metal Servers list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
server_name
optional
stringBare Metal Server namebmserver-001
state
optional
stringBare Metal Server stateRUNNING
ip
optional
stringBare Metal Server IP address192.168.0.1
vpc_id
optional
stringVPC IDe58348b1bc9148e5af86500fd4ef99ca

Responses

NameDescriptionExample
idBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac
account_idAccount IDf5c8e56a4d9b49a8bd89e14758a32d53
created_atCreated At2024-05-17T00:23:17Z
created_byCreated byef716e80-1fac-4faa-892d-0132fc7f5583
hyper_threading_useUse Hyper ThreadingTrue
image_idImage IDIMAGE-7XFMaJpLsapKvskFMjCtmm
image_versionImage versionRHEL 8.7 for BM
init_scriptInit scriptinit script
local_subnet_infoLocal Subnet info
lock_enabledUse LockTrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified byef716e80-1fac-4faa-892d-0132fc7f5583
network_idSubnet IDab313c43291e4b678f4bacffe10768ae
os_typeOS typeWINDOWS
placement_group_namePlacement Group Namepgtest
policy_ipPolicy IP192.168.0.1
policy_natPublic NAT IP192.168.0.1
policy_use_natUse Public NATTrue
product_type_idBare Metal Server scale IDPRODUCT-0iT9dNiLr4lVoYmjlY2Vgg
public_nat_statusPublic NAT statusACTIVE
region_idRegion IDkr-west1
root_accountRoot Accountrootaccount
server_nameBare Metal Server namebmserver-001
server_typeBare Metal Server scale types1v8m32_metal
stateBare Metal Server stateRUNNING
time_zoneTime ZoneAsia/Seoul
use_local_subnetUse Local SubnetTrue
vpc_idVPC IDe58348b1bc9148e5af86500fd4ef99ca

2.1.1.12 - Lock Baremetal

2.1.1.12.1 - 1.1

scpcli baremetal baremetal lock
--baremetal_id <value>

Description

Lock Bare Metal Server.

State ACTIVE (CURRENT)

VersionSupported Until
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

Lock Bare Metal Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Show Bare Metal Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
interface_nameInterface Nameens8f1,bond_serv.2
local_subnet_idLocal Subnet IDab313c43291e4b678f4bacffe10768ae
policy_local_subnet_ipPolicy Local Subnet IP192.168.0.1
stateLocalSubnet IP stateCREATING
vlan_idVlan Id500
vni_role_nameVNI Role NamemgmtJ4dzQBo

2.1.1.13.2 - 1.0

scpcli baremetal baremetal show
--baremetal_id <value>

Description

Show Bare Metal Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

Responses

NameDescriptionExample
interface_nameInterface Nameens8f1,bond_serv.2
local_subnet_idLocal Subnet IDab313c43291e4b678f4bacffe10768ae
policy_local_subnet_ipPolicy Local Subnet IP192.168.0.1
stateLocalSubnet IP stateCREATING
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

Start Bare Metal Servers.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bare_metal_server_ids
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

Responses

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

2.1.1.14.2 - 1.0

scpcli baremetal baremetal start
--bare_metal_server_ids <value>

Description

Start Bare Metal Servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bare_metal_server_ids
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

Responses

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

2.1.1.15 - Stop Baremetals

2.1.1.15.1 - 1.1

scpcli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Stop Bare Metal Servers.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bare_metal_server_ids
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

Responses

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

2.1.1.15.2 - 1.0

scpcli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Stop Bare Metal Servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bare_metal_server_ids
required
arrayBare Metal Server IDs20c507a036c447cdb3b19468d8ea62ac

Responses

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

2.1.1.16 - Unlock Baremetal

2.1.1.16.1 - 1.1

scpcli baremetal baremetal unlock
--baremetal_id <value>

Description

Unlock Bare Metal Server.

State ACTIVE (CURRENT)

VersionSupported Until
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

Unlock Bare Metal Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
baremetal_id
required
stringBare Metal Server ID20c507a036c447cdb3b19468d8ea62ac

2.2 - Cloud Functions

Overview

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

This guide provides a brief description of Cloud Function service and how to call 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

approve PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeAPPROVE

2.2.1.2 - Check Function Name Duplication

2.2.1.2.1 - 1.2

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

Description

check name duplication

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringNamesample-function-name

Responses

NameDescriptionExample
resultResultTrue

2.2.1.2.2 - 1.1

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

Description

check name duplication

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
name
required
stringNamesample-function-name

Responses

NameDescriptionExample
resultResultTrue

2.2.1.2.3 - 1.0

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

Description

check name duplication

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringNamesample-function-name

Responses

NameDescriptionExample
resultResultTrue

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

connect PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeRECONNECT

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

create a cloud function

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
runtime
required
stringRuntimeNode.js:20
name
required
stringNamesample-function-name
content
required
stringCode contentsample
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
messageDescriptionDescription
stateCloud function stateREADY

2.2.1.4.2 - 1.1

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

Description

create a cloud function

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
runtime
required
stringRuntimeNode.js:20
name
required
stringNamesample-function-name
content
required
stringCode contentsample
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
messageDescriptionDescription
stateCloud function stateREADY

2.2.1.4.3 - 1.0

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

Description

create a cloud function

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
runtime
required
stringRuntimeNode.js:20
name
required
stringNamesample-function-name
content
required
stringCode contentsample
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
messageDescriptionDescription
stateCloud function stateREADY

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

create cloud-function apigateway trigger

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway Stage Namesample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

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

create cloud-function apigateway trigger

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway Stage Namesample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

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

create cloud-function apigateway trigger

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
apigateway_stage_name
required
stringApigateway Stage Namesample
apigateway_api_id
required
stringApigateway API ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

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

create cloud-function cronjob trigger

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.2.1.6.2 - 1.1

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

Description

create cloud-function cronjob trigger

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.2.1.6.3 - 1.0

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

Description

create cloud-function cronjob trigger

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 0
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

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

create privateLink endpoint

State ACTIVE (CURRENT)

VersionSupported Until
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

delete a specific cloud function

State ACTIVE (CURRENT)

VersionSupported Until
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

delete a specific cloud function

State ACTIVE (DEPRECATED)

VersionSupported Until
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

delete a specific cloud function

State ACTIVE (DEPRECATED)

VersionSupported Until
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

delete a specific cloud function trigger

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
trigger_type
required
stringTrigger typeapigateway
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

delete a specific cloud function trigger

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
trigger_type
required
stringTrigger typeapigateway
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

delete a specific cloud function trigger

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
trigger_type
required
stringTrigger typeapigateway
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

delete privateLink endpoint

State ACTIVE (CURRENT)

VersionSupported Until
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

list cloud-function triggers

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
stringTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
stringTrigger typeapigateway

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

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

list cloud-function triggers

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
stringTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
stringTrigger typeapigateway

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

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

list cloud-function triggers

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
trigger_name
optional
stringTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_type
optional
stringTrigger typeapigateway

Responses

NameDescriptionExample
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

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

get cloud functions list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringNamesample-function-name
state
optional
arrayCloud function stateR
runtime
optional
arrayRuntimeN

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-05-22T06:21:17.580522
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser 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

get cloud functions list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringNamesample-function-name
state
optional
arrayCloud function stateR
runtime
optional
arrayRuntimeN

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-05-22T06:21:17.580522
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser 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

get cloud functions list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringNamesample-function-name
state
optional
arrayCloud function stateR
runtime
optional
arrayRuntimeN

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-05-22T06:21:17.580522
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.2.1.13 - List Runtimes

2.2.1.13.1 - 1.2

scpcli scf cloud-function runtime list

Description

list runtimes

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Responses

NameDescriptionExample
base_image_seqBase image sequence3
nameNamesample
versionVersion1.0.0

2.2.1.13.2 - 1.1

scpcli scf cloud-function runtime list

Description

list runtimes

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Responses

NameDescriptionExample
base_image_seqBase image sequence3
nameNamesample
versionVersion1.0.0

2.2.1.13.3 - 1.0

scpcli scf cloud-function runtime list

Description

list runtimes

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Responses

NameDescriptionExample
base_image_seqBase image sequence3
nameNamesample
versionVersion1.0.0

2.2.1.14 - List Sample Codes

2.2.1.14.1 - 1.2

scpcli scf cloud-function sample-codes show

Description

List sample codes

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Responses

NameDescriptionExample
contentCode contentsample
defaultDefaultFalse
descriptionDescriptionsample
nameNamesample
runtimeRuntimeNode.js:20
seqSequence3
versionVersionsample

2.2.1.14.2 - 1.1

scpcli scf cloud-function sample-codes show

Description

List sample codes

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Responses

NameDescriptionExample
contentCode contentsample
defaultDefaultFalse
descriptionDescriptionsample
nameNamesample
runtimeRuntimeNode.js:20
seqSequence3
versionVersionsample

2.2.1.14.3 - 1.0

scpcli scf cloud-function sample-codes show

Description

List sample codes

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Responses

NameDescriptionExample
contentCode contentsample
defaultDefaultFalse
descriptionDescriptionsample
nameNamesample
runtimeRuntimeNode.js:20
seqSequence3
versionVersionsample

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

request privatelink endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
endpoint_id
required
stringEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
type
required
stringTypeCANCEL

2.2.1.16 - Show Cloud Function

2.2.1.16.1 - 1.2

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

Description

show a specific cloud function

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.2.1.16.2 - 1.1

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

Description

show a specific cloud function

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser ID617b3d0e90c24a5fa1f65a3824861354

2.2.1.16.3 - 1.0

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

Description

show a specific cloud function

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
idCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
function_urlCloud function Urlhttps://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello
nameCloud Functions namesample
runtimeRuntimeNode.js:20
stateCloud function stateREADY
user_idUser 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

show a specific cloud_function code

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_nameClass Namecom.example.Handler
code_textCode TextZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_typeCode Typetext
file_nameFile Namesample
file_transfer_statusFile Transfer Statussample
file_upload_atFile Upload At2025-05-17 00:23:17
method_nameMethod NamehandleRequest
runtimeRuntimeNode.js:20

2.2.1.17.2 - 1.1

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

Description

show a specific cloud_function code

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_nameClass Namecom.example.Handler
code_textCode TextZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_typeCode Typetext
file_nameFile Namesample
file_transfer_statusFile Transfer Statussample
file_upload_atFile Upload At2025-05-17 00:23:17
method_nameMethod NamehandleRequest
runtimeRuntimeNode.js:20

2.2.1.17.3 - 1.0

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

Description

show a specific cloud_function code

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
class_nameClass Namecom.example.Handler
code_textCode TextZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==
code_typeCode Typetext
file_nameFile Namesample
file_transfer_statusFile Transfer Statussample
file_upload_atFile Upload At2025-05-17 00:23:17
method_nameMethod NamehandleRequest
runtimeRuntimeNode.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

show a specific cloud-function configuration

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
endpoint_aliasAliassample
endpoint_idEndpoint Id8c9f6c1c928a45b4bbd1e4da5531d656
service_idService Id8c9f6c1c928a45b4bbd1e4da5531d656
stateStateActive

2.2.1.18.2 - 1.1

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

Description

show a specific cloud-function configuration

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
keyKeysample
valueValuesample

2.2.1.18.3 - 1.0

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

Description

show a specific cloud-function configuration

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
keyKeysample
valueValuesample

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

show a specific cloud-function logs

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
logLog[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST
timeTime2025-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

show a specific cloud-function logs

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
logLog[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST
timeTime2025-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

show a specific cloud-function logs

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
logLog[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST
timeTime2025-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

show a specific cloud-function metrics

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
metric_dataMetric Data1.0033444816053512
timeTime16: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

show a specific cloud-function metrics

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
metric_dataMetric Data1.0033444816053512
timeTime16: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

show a specific cloud-function metrics

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
time
optional
integerTime3
start
optional
stringStart20250517
end
optional
stringEnd20250517

Responses

NameDescriptionExample
metric_dataMetric Data1.0033444816053512
timeTime16: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

show a specific cloud-function trigger

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sidTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.2.1.21.2 - 1.1

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

Description

show a specific cloud-function trigger

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sidTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

2.2.1.21.3 - 1.0

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

Description

show a specific cloud-function trigger

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1

Responses

NameDescriptionExample
aliasAlias$LATEST
scheduleSchedule* * * * 0
timezoneTimezoneAsia/Tokyo
trigger_idTrigger ID1
trigger_nameTrigger name8c9f6c1c928a45b4bbd1e4da5531d656
trigger_sidTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_account_idTrigger target account ID617b3d0e90c24a5fa1f65a3824861354
trigger_target_srnTrigger target SRNsrn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe
trigger_target_uuidTrigger target UUID8c9f6c1c928a45b4bbd1e4da5531d656
trigger_typeTrigger typeapigateway

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

update cloud-function code

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
stringCode contentprint("Hello World")

2.2.1.22.2 - 1.1

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

Description

update cloud-function code

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
stringCode contentprint("Hello World")

2.2.1.22.3 - 1.0

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

Description

update cloud-function code

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
content
required
stringCode contentprint("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

update a specific cloud_function code file

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
method_name
required
stringMethod NamehandleRequest
class_name
required
stringClass Namecom.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

update a specific cloud_function code file

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
method_name
required
stringMethod NamehandleRequest
class_name
required
stringClass Namecom.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

update cloud-function config

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integerTimeout100
min_scale
required
integerMin Scale1
memory
required
integerMemory256
max_scale
required
integerMax Scale5

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

update cloud-function config

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integerTimeout100
min_scale
required
integerMin Scale1
memory
required
integerMemory256
max_scale
required
integerMax Scale5

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

update cloud-function config

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
timeout
required
integerTimeout100
min_scale
required
integerMin Scale1
memory
required
integerMemory256
max_scale
required
integerMax Scale5

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

update cloud-function cronjob trigger

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 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

update cloud-function cronjob trigger

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 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

update cloud-function cronjob trigger

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
trigger_id
required
integerTrigger ID1
timezone
required
stringTimezoneAsia/Tokyo
schedule
required
stringSchedule* * * * 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

update cloud-function url

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL EnabledTrue
public_ip_acl_enabled
required
booleanPublic IP ACL EnabledTrue
allow_ips
optional
arrayAllow Ips-
auth_type
optional
stringAuth TypeNONE

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

update cloud-function url

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL EnabledTrue
public_ip_acl_enabled
required
booleanPublic IP ACL EnabledTrue
allow_ips
optional
arrayAllow Ips-
auth_type
optional
stringAuth TypeNONE

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

update cloud-function url

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
url_enabled
required
booleanURL EnabledTrue
public_ip_acl_enabled
required
booleanPublic IP ACL EnabledTrue
allow_ips
optional
arrayAllow Ips-
auth_type
optional
stringAuth TypeNONE

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

update cloud-function variables

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
arrayEnvironment Variables'{"key": "sample", "value": "sample"}'

2.2.1.27.2 - 1.1

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

Description

update cloud-function variables

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
arrayEnvironment Variables'{"key": "sample", "value": "sample"}'

2.2.1.27.3 - 1.0

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

Description

update cloud-function variables

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
variables
required
arrayEnvironment Variables'{"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

update PrivateLink Service

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
cloud_function_id
required
stringCloud Functions ID8c9f6c1c928a45b4bbd1e4da5531d656
privatelink_service_enabled
required
booleanPrivateLink Service EnabledTrue

2.3 - Virtual Server

Overview

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

This guide provides a brief description of Virtual Server service and how to call 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.

State ACTIVE (CURRENT)

VersionSupported Until
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
nameVolume namevolume01
volume_idVolume 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.

State ACTIVE (DEPRECATED)

VersionSupported Until
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
nameVolume namevolume01
volume_idVolume 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

Attach Virtual Server Security Group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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

Attach Volume to Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
delete_on_termination
optional
booleanDelete on terminationFalse

Responses

NameDescriptionExample
delete_on_terminationDelete on terminationFalse
deviceDevice name/dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume 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

Attach Volume to Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
delete_on_termination
optional
booleanDelete on terminationFalse

Responses

NameDescriptionExample
delete_on_terminationDelete on terminationFalse
deviceDevice name/dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume 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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
required
stringSnapshot namesnapshot-1
description
optional
stringDescriptiondescription
force
optional
booleanForceTrue
metadata
optional
****Snapshot metadata-

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataSnapshot metadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume 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.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
required
stringSnapshot namesnapshot-1
description
optional
stringDescriptiondescription
force
optional
booleanForceTrue
metadata
optional
****Snapshot metadata-

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataSnapshot metadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume 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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
stringVolume namevolume01

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_keyAuth keyf5972fdb456897eb
created_atCreated at
nameVolume namevolume01
volume_idVolume 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.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
stringVolume namevolume01

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
auth_keyAuth keyf5972fdb456897eb
created_atCreated at
nameVolume namevolume01
volume_idVolume 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

Create Auto-Scaling Group.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_ids
required
arraySubnet ID list-
server_name_prefix
required
stringServer name prefixserver-name-prefix
name
required
stringAuto-Scaling Group nameauto-scaling-group-name
min_server_count
required
integerMin server count1
max_server_count
required
integerMax server count2
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
desired_server_count_editable
required
booleanDesired server count editableTrue
desired_server_count
required
integerDesired server count1
drain_enabled
optional
booleanDrain enabledTrue
drain_timeout
optional
integerDrain timeout300
lb_server_groups
optional
arrayLB Server Group list'{"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 list[
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB Server Group port8080

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

Create Auto-Scaling Group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
subnet_ids
required
arraySubnet ID list-
server_name_prefix
required
stringServer name prefixserver-name-prefix
name
required
stringAuto-Scaling Group nameauto-scaling-group-name
min_server_count
required
integerMin server count1
max_server_count
required
integerMax server count2
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
desired_server_count_editable
required
booleanDesired server count editableTrue
desired_server_count
required
integerDesired server count1
drain_enabled
optional
booleanDrain enabledTrue
drain_timeout
optional
integerDrain timeout300
lb_server_groups
optional
arrayLB Server Group list'{"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 list[
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB Server Group port8080

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

Create Auto-Scaling Group notification.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
required
arrayUser ID list570907805e5447be84b618450ef52o0t
notification_events
required
arrayAuto-Scaling Group notification eventsSCALE_OUT

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification events[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_idUser 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

Create Auto-Scaling Group notification.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
required
arrayUser ID list570907805e5447be84b618450ef52o0t
notification_events
required
arrayAuto-Scaling Group notification eventsSCALE_OUT

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification events[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_idUser 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

Create Auto-Scaling Group policy.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
threshold
required
integerThreshold60
scale_value
required
integerScale value10
scale_type
required
stringScale typeSCALE_OUT
scale_method
required
stringScale methodAMOUNT
name
required
stringPolicy namepolicy-name
metric_type
required
stringMetric typeCPU
metric_method
required
stringMetric methodAVG
evaluation_minutes
required
integerEvaluation minutes1
cooldown_seconds
required
integerCooldown seconds300
comparison_operator
required
stringComparison operatorge

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes1
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold 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

Create Auto-Scaling Group policy.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
threshold
required
integerThreshold60
scale_value
required
integerScale value10
scale_type
required
stringScale typeSCALE_OUT
scale_method
required
stringScale methodAMOUNT
name
required
stringPolicy namepolicy-name
metric_type
required
stringMetric typeCPU
metric_method
required
stringMetric methodAVG
evaluation_minutes
required
integerEvaluation minutes1
cooldown_seconds
required
integerCooldown seconds300
comparison_operator
required
stringComparison operatorge

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes1
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold 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

Create Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
timezone
required
stringTimezoneAsia/Seoul
start_date
required
stringStart date2024-01-01
name
required
stringSchedule nameschedulename
minute
required
integerMinute0
hour
required
integerHour9
frequency
required
stringFrequencyWEEKLY
day_of_month
optional
stringDay of the month-1,1
day_of_week
optional
stringDay of the weekSU,SA
description
optional
stringDescriptiondescription
desired_server_count
optional
integerDesired server count1
end_date
optional
stringEnd date2025-01-01
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1
state
optional
stringSchedule stateACTIVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/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

Create Auto-Scaling Group schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
timezone
required
stringTimezoneAsia/Seoul
start_date
required
stringStart date2024-01-01
name
required
stringSchedule nameschedulename
minute
required
integerMinute0
hour
required
integerHour9
frequency
required
stringFrequencyWEEKLY
day_of_month
optional
stringDay of the month-1,1
day_of_week
optional
stringDay of the weekSU,SA
description
optional
stringDescriptiondescription
desired_server_count
optional
integerDesired server count1
end_date
optional
stringEnd date2025-01-01
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1
state
optional
stringSchedule stateACTIVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/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

Create Image.

State ACTIVE (CURRENT)

VersionSupported Until
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 distributionalma
name
required
stringImage nameimagename
container_format
optional
stringContainer formatbare
disk_format
optional
stringDisk formatqcow2
min_disk
optional
integerMinimum disk100
min_ram
optional
integerMinimum RAM0
protected
optional
booleanProtectedFalse
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
visibility
optional
stringVisibilityprivate

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumChecksum7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer formatbare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk formatqcow2
fileFile/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk100
min_ramMinimum RAM0
nameImage nameimagename
os_distroOS distributionalma
os_hash_algoOS hash algorithmsha512
os_hash_valueOS hash valuec6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS hiddenFalse
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account nameAccountName
owner_user_nameOwner user nameuser@samsung.com
protectedProtectedFalse
root_device_nameRoot device name/dev/vda
scp_image_typeImage typecustom
scp_k8s_versionK8S versionv1.28.7
scp_original_image_typeOriginal Image typestandard
scp_os_build_versionOS build version20250101
scp_os_versionOS version8.8
sizeSize2429747200
statusStatusactive
updated_atUpdated at2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size17179869184
visibilityVisibilityprivate
volumesVolumes[{“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

Create Image.

State ACTIVE (DEPRECATED)

VersionSupported Until
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 distributionalma
name
required
stringImage nameimagename
container_format
optional
stringContainer formatbare
disk_format
optional
stringDisk formatqcow2
min_disk
optional
integerMinimum disk100
min_ram
optional
integerMinimum RAM0
protected
optional
booleanProtectedFalse
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
visibility
optional
stringVisibilityprivate

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumChecksum7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer formatbare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk formatqcow2
fileFile/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk100
min_ramMinimum RAM0
nameImage nameimagename
os_distroOS distributionalma
os_hash_algoOS hash algorithmsha512
os_hash_valueOS hash valuec6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS hiddenFalse
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account nameAccountName
owner_user_nameOwner user nameuser@samsung.com
protectedProtectedFalse
root_device_nameRoot device name/dev/vda
scp_image_typeImage typecustom
scp_k8s_versionK8S versionv1.28.7
scp_original_image_typeOriginal Image typestandard
scp_os_build_versionOS build version20250101
scp_os_versionOS version8.8
sizeSize2429747200
statusStatusactive
updated_atUpdated at2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size17179869184
visibilityVisibilityprivate
volumesVolumes[{“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

Create Image member.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_id
required
stringMember IDa8f10467abfc4b87b64614ab36eb9ae4

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idMember IDa8f10467abfc4b87b64614ab36eb9ae4
statusMember statuspending
updated_atUpdated at2025-07-26T12:00:00Z

2.3.1.11.2 - 1.0

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

Description

Create Image member.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_id
required
stringMember IDa8f10467abfc4b87b64614ab36eb9ae4

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idMember IDa8f10467abfc4b87b64614ab36eb9ae4
statusMember statuspending
updated_atUpdated at2025-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

Create keypair.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringKeypair namekeypairname
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
nameKeypair namekeypairname
private_keyPrivate keyprivatekey
public_keyPublic Keypublickey
typeKeypair typessh

2.3.1.12.2 - 1.0

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

Description

Create keypair.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringKeypair namekeypairname
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
nameKeypair namekeypairname
private_keyPrivate keyprivatekey
public_keyPublic Keypublickey
typeKeypair typessh

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

Create Launch Configuration.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_type_id
required
stringServer type IDs1v1m2
name
required
stringLaunch Configuration namelaunch-configuration-name
keypair_name
required
stringKeypair namekeypairname
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
stringUser dataIyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
arrayVolumes'{"boot_index": 0, "size": 104, "type": "SSD"}'

Responses

NameDescriptionExample
boot_indexBoot index0
sizeVolume size104
typeVolume typeSSD

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

Create Launch Configuration.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_type_id
required
stringServer type IDs1v1m2
name
required
stringLaunch Configuration namelaunch-configuration-name
keypair_name
required
stringKeypair namekeypairname
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
stringUser dataIyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
arrayVolumes'{"boot_index": 0, "size": 104, "type": "SSD"}'

Responses

NameDescriptionExample
boot_indexBoot index0
sizeVolume size104
typeVolume typeSSD

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

Create server group.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
policy
required
stringServer Group policyanti-affinity
name
required
stringServer Group nameserver-group
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
membersServer Group members[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizePartition Size3
policyServer Group policyanti-affinity
user_idUser ID570907805e5447be84b618450ef52o0t

2.3.1.14.2 - 1.0

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

Description

Create server group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
policy
required
stringServer Group policyanti-affinity
name
required
stringServer Group nameserver-group
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
membersServer Group members[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizePartition Size3
policyServer Group policyanti-affinity
user_idUser 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

Create Server Interface.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ips
optional
arrayFixed Ip list'{"ip_address": "192.169.3.2"}'
port_id
optional
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
subnet_id
optional
stringSubnet ID78b2ee3f074145c580ab6abac4821f97

Responses

NameDescriptionExample
ip_addressIP address192.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

Create Server Interface.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ips
optional
arrayFixed Ip list'{"ip_address": "192.169.3.2"}'
port_id
optional
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
subnet_id
optional
stringSubnet ID78b2ee3f074145c580ab6abac4821f97

Responses

NameDescriptionExample
ip_addressIP address192.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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
publicip_id
required
stringPublic 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.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
publicip_id
required
stringPublic 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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_nat_ip_id
required
stringPrivate 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.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_nat_ip_id
required
stringPrivate 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

Create Server Volume.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID-
delete_on_termination
optional
booleanDelete on terminationFalse
device
optional
stringDevice name/dev/vda

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete on terminationFalse
deviceDevice name/dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume 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

Create Server Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID-
delete_on_termination
optional
booleanDelete on terminationFalse
device
optional
stringDevice name/dev/vda

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete on terminationFalse
deviceDevice name/dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume 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

Create Sharing Image.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample

2.3.1.19.2 - 1.0

scpcli virtualserver sharing image create
--image_id <value>

Description

Create Sharing Image.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
stringImage 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

Create Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_type_id
required
stringServer type IDs1v1m2
networks
required
arrayList of Network'{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}'
name
required
stringServer nameservername
keypair_name
required
stringKeypair namekeypairname
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
lock
optional
booleanLockedFalse
max_count
optional
integerMax count2
metadata
optional
objectMetadata-
partition_number
optional
integerPartition number1
product_category
optional
****Product categorycompute
product_offering
optional
****Product offeringvirtual_server
security_groups
optional
arraySecurity Groups[
server_group_id
optional
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
stringUser dataIyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
arrayVolumes'{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}'

Responses

NameDescriptionExample
idServer 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

Create Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_type_id
required
stringServer type IDs1v1m2
networks
required
arrayList of Network'{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}'
name
required
stringServer nameservername
keypair_name
required
stringKeypair namekeypairname
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
lock
optional
booleanLockedFalse
max_count
optional
integerMax count2
metadata
optional
objectMetadata-
partition_number
optional
integerPartition number1
product_category
optional
****Product categorycompute
product_offering
optional
****Product offeringvirtual_server
security_groups
optional
arraySecurity Groups[
server_group_id
optional
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
user_data
optional
stringUser dataIyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumes
optional
arrayVolumes'{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}'

Responses

NameDescriptionExample
idServer 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

Create Virtual Server Custom Image.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
image_name
required
stringImage nameimagename

Responses

NameDescriptionExample
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b

2.3.1.21.2 - 1.0

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

Description

Create Virtual Server Custom Image.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
image_name
required
stringImage nameimagename

Responses

NameDescriptionExample
image_idImage 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

Create Virtual Server Dump.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.22.2 - 1.0

scpcli virtualserver server dump create
--server_id <value>

Description

Create Virtual Server Dump.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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

Create a Volume.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
required
integerVolume size104
name
required
stringVolume namevolume01
snapshot_id
optional
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
volume_type
optional
stringVolume typeSSD

Responses

NameDescriptionExample
idServer 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

Create a Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
required
integerVolume size104
name
required
stringVolume namevolume01
snapshot_id
optional
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
tags
optional
arrayTags'{"key": "Key", "value": "Value"}'
volume_type
optional
stringVolume typeSSD

Responses

NameDescriptionExample
idServer 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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

2.3.1.24.2 - 1.0

scpcli virtualserver volume snapshot delete
--snapshot_id <value>

Description

Delete a snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot 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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete Auto-Scaling Group.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete Auto-Scaling Group.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete Auto-Scaling Group notification.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
notification_id
required
stringNotification 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

Delete Auto-Scaling Group notification.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
notification_id
required
stringNotification 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

Delete Auto-Scaling Group policy.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy 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

Delete Auto-Scaling Group policy.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy 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

Delete Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
schedule_id
required
stringSchedule 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

Delete Auto-Scaling Group schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
schedule_id
required
stringSchedule 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

Delete Image.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

2.3.1.30.2 - 1.0

scpcli virtualserver image delete
--image_id <value>

Description

Delete Image.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
stringImage 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

Delete Image member.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
member_id
required
stringMember IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

2.3.1.31.2 - 1.0

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

Description

Delete Image member.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
member_id
required
stringMember IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage 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

Delete keypair.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
keypair_name
required
stringKeypair namekeypairname

2.3.1.32.2 - 1.0

scpcli virtualserver keypair delete
--keypair_name <value>

Description

Delete keypair.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
keypair_name
required
stringKeypair namekeypairname

2.3.1.33 - Delete Launch Configuration

2.3.1.33.1 - 1.1

scpcli virtualserver launch configuration delete
--launch_configuration_id <value>

Description

Delete Launch Configuration.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete Launch Configuration.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete server group

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_group_id
required
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19

2.3.1.34.2 - 1.0

scpcli virtualserver server group delete
--server_group_id <value>

Description

Delete server group

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_group_id
required
stringServer Group 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

Delete Server Interface.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.35.2 - 1.0

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

Description

Delete Server Interface.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer 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

Delete Server Interface Nat.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer 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

Delete Server Interface Nat.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer 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

Delete Server Interface Private Nat.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer 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

Delete Server Interface Private Nat.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nat_id
required
stringNAT ID224b80106e6f41b38efe98ac9ddbf280
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer 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

Delete Server Volume.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.38.2 - 1.0

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

Description

Delete Server Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer 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

Delete Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

2.3.1.39.2 - 1.0

scpcli virtualserver server delete
--server_id <value>

Description

Delete Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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

Delete a Volume.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
cascade
optional
booleanWhether to delete snapshots togetherTrue

2.3.1.40.2 - 1.0

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

Description

Delete a Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
cascade
optional
booleanWhether to delete snapshots togetherTrue

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

Detach Virtual Server Security Group

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f
server_id
required
stringServer 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

Detach Volume from Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.42.2 - 1.0

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

Description

Detach Volume from Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume 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

Extend a Volume.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
size
required
integerVolume size104

2.3.1.43.2 - 1.0

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

Description

Extend a Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
size
required
integerVolume size104

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

Get region’s maximum partition size

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Responses

NameDescriptionExample
partition_size

2.3.1.44.2 - 1.0

scpcli virtualserver server group maximum partition size

Description

Get region’s maximum partition size

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Import Image file.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage 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

Import Image file.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
stringImage 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

List Auto-Scaling Group LB Server Groups.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group namelb-server-group-name
portLB Server Group port8080

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

List Auto-Scaling Group LB Server Groups.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group namelb-server-group-name
portLB Server Group port8080

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

List Auto-Scaling Group notifications.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
optional
arrayUser ID list570907805e5447be84b618450ef52o0t
notification_state
optional
stringAuto-Scaling Group notification stateACTIVE
notification_event
optional
stringAuto-Scaling Group notification eventSCALE_OUT
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification events[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_idUser 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

List Auto-Scaling Group notifications.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
user_ids
optional
arrayUser ID list570907805e5447be84b618450ef52o0t
notification_state
optional
stringAuto-Scaling Group notification stateACTIVE
notification_event
optional
stringAuto-Scaling Group notification eventSCALE_OUT
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification events[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_idUser 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

List Auto-Scaling Group policies.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
name
optional
stringPolicy namepolicy-name
metric_method
optional
****Metric methodAVG
metric_type
optional
stringMetric typeCPU
scale_type
optional
****Scale typeSCALE_OUT
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes1
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold 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

List Auto-Scaling Group policies.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
name
optional
stringPolicy namepolicy-name
metric_method
optional
****Metric methodAVG
metric_type
optional
stringMetric typeCPU
scale_type
optional
****Scale typeSCALE_OUT
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes1
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold 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

Get Auto-Scaling Group schedule list.

State ACTIVE (CURRENT)

VersionSupported Until
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
****FrequencyWEEKLY

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/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

Get Auto-Scaling Group schedule list.

State ACTIVE (DEPRECATED)

VersionSupported Until
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
****FrequencyWEEKLY

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/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

List Auto-Scaling Group Virtual Servers.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
addressesAddresses
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated at
created_byCreated by97e6b22c9a4143789ca522df7457a32f
disk_configDisk configMANUAL
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceIs MarketplaceFalse
keypair_nameKeypair namekeypairname
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
lb_linked_stateLoad Balancer linked stateATTACHED
lockedLockedFalse
metadataMetadata
modified_atModified at
nameServer nameservername
partition_numberPartition number1
planned_compute_os_typePlanned Compute OS typewindows
product_categoryProduct categorycompute
product_offeringProduct offeringvirtual_server
security_groupsSecurity Groups
server_group_idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
server_typeServer type
stateServer stateACTIVE
volumesVolumes
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

List Auto-Scaling Group Virtual Servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
addressesAddresses
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated at
created_byCreated by97e6b22c9a4143789ca522df7457a32f
disk_configDisk configMANUAL
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceIs MarketplaceFalse
keypair_nameKeypair namekeypairname
launch_configuration_idLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
lb_linked_stateLoad Balancer linked stateATTACHED
lockedLockedFalse
metadataMetadata
modified_atModified at
nameServer nameservername
partition_numberPartition number1
planned_compute_os_typePlanned Compute OS typewindows
product_categoryProduct categorycompute
product_offeringProduct offeringvirtual_server
security_groupsSecurity Groups
server_group_idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
server_typeServer type
stateServer stateACTIVE
volumesVolumes
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

List Auto-Scaling Groups.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
optional
stringAuto-Scaling Group nameauto-scaling-group-name
state
optional
stringAuto-Scaling Group stateIN_SERVICE
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_name
optional
stringLaunch Configuration namelaunch-configuration-name
lb_server_group_id
optional
stringLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
security_group_id
optional
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f
subnet_id
optional
stringSubnet ID78b2ee3f074145c580ab6abac4821f97
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
created_by
optional
stringCreated by97e6b22c9a4143789ca522df7457a32f
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At
Requires --long option
2024-05-17T00:23:17Z
created_byCreated By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editable
Requires --long option
True
drain_enabledDrain enabled
Requires --long option
True
drain_timeoutDrain timeout
Requires --long option
300
launch_configuration_idLaunch Configuration ID
Requires --long option
b5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list
Requires --long option
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At
Requires --long option
2024-05-17T00:23:17Z
modified_byModified By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list
Requires --long option
[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefix
Requires --long option
server-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
subnet_idsSubnet ID list
Requires --long option
vpc_idVPC ID
Requires --long option
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

List Auto-Scaling Groups.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
stringAuto-Scaling Group nameauto-scaling-group-name
state
optional
stringAuto-Scaling Group stateIN_SERVICE
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_name
optional
stringLaunch Configuration namelaunch-configuration-name
lb_server_group_id
optional
stringLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
security_group_id
optional
stringSecurity Group IDc09c3f05-03d9-443f-b27a-40e0f973c75f
subnet_id
optional
stringSubnet ID78b2ee3f074145c580ab6abac4821f97
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
created_by
optional
stringCreated by97e6b22c9a4143789ca522df7457a32f
offset
optional
integerIndex of where to start in the list0
limit
optional
integerPage size of items20
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At
Requires --long option
2024-05-17T00:23:17Z
created_byCreated By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
desired_server_countDesired server count1
desired_server_count_editableDesired server count editable
Requires --long option
True
drain_enabledDrain enabled
Requires --long option
True
drain_timeoutDrain timeout
Requires --long option
300
launch_configuration_idLaunch Configuration ID
Requires --long option
b5aea5a675fc4f6b9e0fcd1288354c5f
launch_configuration_nameLaunch Configuration namelaunch-configuration-name
lb_server_groupsLB Server Group list
Requires --long option
max_server_countMax server count2
min_server_countMin server count1
modified_atModified At
Requires --long option
2024-05-17T00:23:17Z
modified_byModified By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
nameAuto-Scaling Group nameauto-scaling-group-name
security_group_idsSecurity Group ID list
Requires --long option
[‘c09c3f05-03d9-443f-b27a-40e0f973c75f’]
server_name_prefixServer name prefix
Requires --long option
server-name-prefix
stateAuto-Scaling Group stateIN_SERVICE
subnet_idsSubnet ID list
Requires --long option
vpc_idVPC ID
Requires --long option
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

Get default config list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
optional
stringNamekey
category
optional
stringCategoryAUTO_SCALING_GROUP

Responses

NameDescriptionExample
configsConfigs(‘key’: ‘value’}
countcount20

2.3.1.52.2 - 1.0

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

Description

Get default config list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
stringNamekey
category
optional
stringCategoryAUTO_SCALING_GROUP

Responses

NameDescriptionExample
configsConfigs(‘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

List Image members.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idMember IDa8f10467abfc4b87b64614ab36eb9ae4
statusMember statuspending
updated_atUpdated at2025-07-26T12:00:00Z

2.3.1.53.2 - 1.0

scpcli virtualserver image member list
--image_id <value>

Description

List Image members.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idMember IDa8f10467abfc4b87b64614ab36eb9ae4
statusMember statuspending
updated_atUpdated at2025-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

List Images.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
scp_image_type
optional
stringImage typecustom
scp_original_image_type
optional
stringOriginal Image typestandard
name
optional
stringImage nameimagename
os_distro
optional
stringOS distributionalma
status
optional
stringStatusactive
visibility
optional
****Visibilityprivate
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumChecksum
Requires --long option
7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer format
Requires --long option
bare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk format
Requires --long option
qcow2
fileFile
Requires --long option
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk
Requires --long option
100
min_ramMinimum RAM
Requires --long option
0
nameImage nameimagename
os_distroOS distributionalma
os_hash_algoOS hash algorithm
Requires --long option
sha512
os_hash_valueOS hash value
Requires --long option
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS hidden
Requires --long option
False
ownerOwner account ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account name
Requires --long option
AccountName
owner_user_nameOwner user name
Requires --long option
user@samsung.com
protectedProtected
Requires --long option
False
root_device_nameRoot device name
Requires --long option
/dev/vda
scp_image_typeImage type
Requires --long option
custom
scp_k8s_versionK8S version
Requires --long option
v1.28.7
scp_original_image_typeOriginal Image type
Requires --long option
standard
scp_os_build_versionOS build version
Requires --long option
20250101
scp_os_versionOS version
Requires --long option
8.8
sizeSize
Requires --long option
2429747200
statusStatus
Requires --long option
active
updated_atUpdated at
Requires --long option
2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)
Requires --long option
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size
Requires --long option
17179869184
visibilityVisibilityprivate
volumesVolumes
Requires --long option
[{“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

List Images.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
scp_image_type
optional
stringImage typecustom
scp_original_image_type
optional
stringOriginal Image typestandard
name
optional
stringImage nameimagename
os_distro
optional
stringOS distributionalma
status
optional
stringStatusactive
visibility
optional
****Visibilityprivate
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumChecksum
Requires --long option
7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer format
Requires --long option
bare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk format
Requires --long option
qcow2
fileFile
Requires --long option
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk
Requires --long option
100
min_ramMinimum RAM
Requires --long option
0
nameImage nameimagename
os_distroOS distributionalma
os_hash_algoOS hash algorithm
Requires --long option
sha512
os_hash_valueOS hash value
Requires --long option
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS hidden
Requires --long option
False
ownerOwner account ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account name
Requires --long option
AccountName
owner_user_nameOwner user name
Requires --long option
user@samsung.com
protectedProtected
Requires --long option
False
root_device_nameRoot device name
Requires --long option
/dev/vda
scp_image_typeImage type
Requires --long option
custom
scp_k8s_versionK8S version
Requires --long option
v1.28.7
scp_original_image_typeOriginal Image type
Requires --long option
standard
scp_os_build_versionOS build version
Requires --long option
20250101
scp_os_versionOS version
Requires --long option
8.8
sizeSize
Requires --long option
2429747200
statusStatus
Requires --long option
active
updated_atUpdated at
Requires --long option
2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)
Requires --long option
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size
Requires --long option
17179869184
visibilityVisibilityprivate
volumesVolumes
Requires --long option
[{“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

Get keypair list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
public_keyPublic Key
Requires --long option
publickey
typeKeypair typessh

2.3.1.55.2 - 1.0

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

Description

Get keypair list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
public_keyPublic Key
Requires --long option
publickey
typeKeypair typessh

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

List Launch Configurations.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
optional
stringLaunch Configuration namelaunch-configuration-name
image_id
optional
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
offset
optional
integerIndex of where to start in the list-
limit
optional
integerPage size of items-
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
boot_disk_sizeSize of default volume
Requires --long option
104
created_atCreated At
Requires --long option
2024-05-17T00:23:17Z
created_byCreated By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
extra_disk_sizeSize of additional volume
Requires --long option
104
image_idImage ID
Requires --long option
70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair name
Requires --long option
keypairname
modified_atModified At
Requires --long option
2024-05-17T00:23:17Z
modified_byModified By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Key
Requires --long option
publickey
server_type_idServer type IDs1v1m2
stateLaunch Configuration state
Requires --long option
ACTIVE
user_dataUser data
Requires --long option
IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes

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

List Launch Configurations.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
stringLaunch Configuration namelaunch-configuration-name
image_id
optional
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
offset
optional
integerIndex of where to start in the list-
limit
optional
integerPage size of items-
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_countNumber of Auto-Scaling Group attached to Launch Configuration1
boot_disk_sizeSize of default volume
Requires --long option
104
created_atCreated At
Requires --long option
2024-05-17T00:23:17Z
created_byCreated By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
extra_disk_sizeSize of additional volume
Requires --long option
104
image_idImage ID
Requires --long option
70a599e0-31e7-49b7-b260-868f441e862b
image_nameImage nameimagename
keypair_nameKeypair name
Requires --long option
keypairname
modified_atModified At
Requires --long option
2024-05-17T00:23:17Z
modified_byModified By
Requires --long option
90dddfc2b1e04edba54ba2b41539a9ac
nameLaunch Configuration namelaunch-configuration-name
public_keyPublic Key
Requires --long option
publickey
server_type_idServer type IDs1v1m2
stateLaunch Configuration state
Requires --long option
ACTIVE
user_dataUser data
Requires --long option
IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==
volumesVolumes

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

List pending Images.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
scp_image_type
optional
stringImage typecustom
scp_original_image_type
optional
stringOriginal Image typestandard

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumChecksum
Requires --long option
7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer format
Requires --long option
bare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk format
Requires --long option
qcow2
fileFile
Requires --long option
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk
Requires --long option
100
min_ramMinimum RAM
Requires --long option
0
nameImage nameimagename
os_distroOS distributionalma
os_hash_algoOS hash algorithm
Requires --long option
sha512
os_hash_valueOS hash value
Requires --long option
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS hidden
Requires --long option
False
ownerOwner account ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account name
Requires --long option
AccountName
owner_user_nameOwner user name
Requires --long option
user@samsung.com
protectedProtected
Requires --long option
False
root_device_nameRoot device name
Requires --long option
/dev/vda
scp_image_typeImage type
Requires --long option
custom
scp_k8s_versionK8S version
Requires --long option
v1.28.7
scp_original_image_typeOriginal Image type
Requires --long option
standard
scp_os_build_versionOS build version
Requires --long option
20250101
scp_os_versionOS version
Requires --long option
8.8
sizeSize
Requires --long option
2429747200
statusStatus
Requires --long option
active
updated_atUpdated at
Requires --long option
2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)
Requires --long option
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size
Requires --long option
17179869184
visibilityVisibilityprivate
volumesVolumes
Requires --long option
[{“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

List pending Images.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
scp_image_type
optional
stringImage typecustom
scp_original_image_type
optional
stringOriginal Image typestandard

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumChecksum
Requires --long option
7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer format
Requires --long option
bare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk format
Requires --long option
qcow2
fileFile
Requires --long option
/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk
Requires --long option
100
min_ramMinimum RAM
Requires --long option
0
nameImage nameimagename
os_distroOS distributionalma
os_hash_algoOS hash algorithm
Requires --long option
sha512
os_hash_valueOS hash value
Requires --long option
c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS hidden
Requires --long option
False
ownerOwner account ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account name
Requires --long option
AccountName
owner_user_nameOwner user name
Requires --long option
user@samsung.com
protectedProtected
Requires --long option
False
root_device_nameRoot device name
Requires --long option
/dev/vda
scp_image_typeImage type
Requires --long option
custom
scp_k8s_versionK8S version
Requires --long option
v1.28.7
scp_original_image_typeOriginal Image type
Requires --long option
standard
scp_os_build_versionOS build version
Requires --long option
20250101
scp_os_versionOS version
Requires --long option
8.8
sizeSize
Requires --long option
2429747200
statusStatus
Requires --long option
active
updated_atUpdated at
Requires --long option
2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)
Requires --long option
https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size
Requires --long option
17179869184
visibilityVisibilityprivate
volumesVolumes
Requires --long option
[{“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

Get server group list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
membersServer Group members
Requires --long option
[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizePartition Size
Requires --long option
3
policyServer Group policyanti-affinity
user_idUser ID
Requires --long option
570907805e5447be84b618450ef52o0t

2.3.1.58.2 - 1.0

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

Description

Get server group list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
membersServer Group members
Requires --long option
[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizePartition Size
Requires --long option
3
policyServer Group policyanti-affinity
user_idUser ID
Requires --long option
570907805e5447be84b618450ef52o0t

2.3.1.59 - List Server Interfaces

2.3.1.59.1 - 1.1

scpcli virtualserver server interface list
--server_id <value>

Description

List Server Interfaces.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed Ip list
mac_addrMAC Addressfa:16:3e:c0:71:2b
port_idPort IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_idSubnet ID183c6c30df0c4fcbb16422aa2d64aa21

2.3.1.59.2 - 1.0

scpcli virtualserver server interface list
--server_id <value>

Description

List Server Interfaces.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed Ip list
mac_addrMAC Addressfa:16:3e:c0:71:2b
port_idPort IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_idSubnet ID183c6c30df0c4fcbb16422aa2d64aa21

2.3.1.60 - List Server Ips

2.3.1.60.1 - 1.1

scpcli virtualserver server ip list
--server_id <value>

Description

List Server Ips.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

2.3.1.60.2 - 1.0

scpcli virtualserver server ip list
--server_id <value>

Description

List Server Ips.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

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

Get server type list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
min_disk
optional
integerMinimum disk size0
min_ram
optional
integerMinimum ram size2048
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idServer type IDs1v1m2
descriptionDescriptiondescription
diskSize of root disk100
ephemeralSize of ephemeral disk0
extra_specsExtra specs
nameServer type names1v1m2
ramAmount of RAM2
swapSize of dedicated swap disk0
vcpusNumber of CPUs1

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

Get server type list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
min_disk
optional
integerMinimum disk size0
min_ram
optional
integerMinimum ram size2048
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idServer type IDs1v1m2
descriptionDescriptiondescription
diskSize of root disk100
ephemeralSize of ephemeral disk0
extra_specsExtra specs
nameServer type names1v1m2
ramAmount of RAM2
swapSize of dedicated swap disk0
vcpusNumber of CPUs1

2.3.1.62 - List Server Volumes

2.3.1.62.1 - 1.1

scpcli virtualserver server volume list
--server_id <value>

Description

List Server Volumes.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete on terminationFalse
deviceDevice name/dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.62.2 - 1.0

scpcli virtualserver server volume list
--server_id <value>

Description

List Server Volumes.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete on terminationFalse
deviceDevice name/dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume 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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
optional
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
with_count
optional
booleanWhether to show countTrue
name
optional
stringSnapshot namesnapshot-1

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataSnapshot metadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume 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.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
optional
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
with_count
optional
booleanWhether to show countTrue
name
optional
stringSnapshot namesnapshot-1

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataSnapshot metadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume 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

List Virtual Server Security Group.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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 namesecuritygroup
rulesSecurity group rules

2.3.1.64.2 - 1.0

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

Description

List Virtual Server Security Group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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 namesecuritygroup
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

List Virtual Servers.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
optional
stringServer nameservername
ip
optional
stringIP address192.169.3.2
state
optional
stringServer stateACTIVE
product_category
optional
****Product categorycompute
product_offering
optional
arrayProduct offering'v'
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
server_type_id
optional
stringServer type IDs1v1m2
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc
auto_scaling_group_id
optional
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
addressesAddresses
auto_scaling_group_idAuto-Scaling Group ID
Requires --long option
52613bd852b04b39adcb15a8364d856d
created_atCreated at
Requires --long option
created_byCreated by
Requires --long option
97e6b22c9a4143789ca522df7457a32f
disk_configDisk config
Requires --long option
MANUAL
image_idImage ID
Requires --long option
70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceIs Marketplace
Requires --long option
False
keypair_nameKeypair name
Requires --long option
keypairname
launch_configuration_idLaunch Configuration ID
Requires --long option
b5aea5a675fc4f6b9e0fcd1288354c5f
lockedLocked
Requires --long option
False
metadataMetadata
Requires --long option
modified_atModified at
Requires --long option
nameServer nameservername
partition_numberPartition number
Requires --long option
1
planned_compute_os_typePlanned Compute OS type
Requires --long option
windows
product_categoryProduct category
Requires --long option
compute
product_offeringProduct offering
Requires --long option
virtual_server
security_groupsSecurity Groups
Requires --long option
server_group_idServer Group ID
Requires --long option
616fb98f-46ca-475e-917e-2563e5a8cd19
server_typeServer type
stateServer stateACTIVE
volumesVolumes
Requires --long option
vpc_idVPC ID
Requires --long option
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

List Virtual Servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
stringServer nameservername
ip
optional
stringIP address192.169.3.2
state
optional
stringServer stateACTIVE
product_category
optional
****Product categorycompute
product_offering
optional
arrayProduct offering'v'
vpc_id
optional
stringVPC IDcc976b621087484ea5fd527f4b78708b
server_type_id
optional
stringServer type IDs1v1m2
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc
auto_scaling_group_id
optional
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
account_idAccount ID
Requires --long option
a8f10467abfc4b87b64614ab36eb9ae4
addressesAddresses
auto_scaling_group_idAuto-Scaling Group ID
Requires --long option
52613bd852b04b39adcb15a8364d856d
created_atCreated at
Requires --long option
created_byCreated by
Requires --long option
97e6b22c9a4143789ca522df7457a32f
disk_configDisk config
Requires --long option
MANUAL
image_idImage ID
Requires --long option
70a599e0-31e7-49b7-b260-868f441e862b
is_marketplaceIs Marketplace
Requires --long option
False
keypair_nameKeypair name
Requires --long option
keypairname
launch_configuration_idLaunch Configuration ID
Requires --long option
b5aea5a675fc4f6b9e0fcd1288354c5f
lockedLocked
Requires --long option
False
metadataMetadata
Requires --long option
modified_atModified at
Requires --long option
nameServer nameservername
partition_numberPartition number
Requires --long option
1
planned_compute_os_typePlanned Compute OS type
Requires --long option
windows
product_categoryProduct category
Requires --long option
compute
product_offeringProduct offering
Requires --long option
virtual_server
security_groupsSecurity Groups
Requires --long option
server_group_idServer Group ID
Requires --long option
616fb98f-46ca-475e-917e-2563e5a8cd19
server_typeServer type
stateServer stateACTIVE
volumesVolumes
Requires --long option
vpc_idVPC ID
Requires --long option
cc976b621087484ea5fd527f4b78708b

2.3.1.66 - List volume transfers

2.3.1.66.1 - 1.1

scpcli virtualserver volume transfer list

Description

List volume transfers.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
nameVolume namevolume01
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.66.2 - 1.0

scpcli virtualserver volume transfer list

Description

List volume transfers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
nameVolume namevolume01
volume_idVolume 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

List volume types and details

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

2.3.1.67.2 - 1.0

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

Description

List volume types and details

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerPage size of items20
offset
optional
integerIndex of where to start in the list0
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

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

List volumes and details.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
booleanWhether to show countTrue
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc
offset
optional
integerIndex of where to start in the list0
name
optional
stringVolume namevolume01
state
optional
stringVolume stateavailable
bootable
optional
booleanBootableFalse

Responses

NameDescriptionExample
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncrypted
Requires --long option
True
modified_atModified at
Requires --long option
2025-07-26T12:00:00Z
multiattachMultiattach
Requires --long option
False
nameVolume namevolume01
serversAttached servers
Requires --long option
sizeVolume size104
snapshot_idSnapshot ID
Requires --long option
cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID
Requires --long option
570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata
Requires --long option
volume_typeVolume typeSSD
volume_type_idVolume type ID
Requires --long option
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

List volumes and details.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
booleanWhether to show countTrue
limit
optional
integerPage size of items20
marker
optional
stringThe last item's ID from previous request2a9be312-5d4b-4bc8-b2ae-35100fa9241f
sort
optional
stringComma-separated list of sort keys and optional sort directions in the form of [:]created_at:desc
offset
optional
integerIndex of where to start in the list0
name
optional
stringVolume namevolume01
state
optional
stringVolume stateavailable
bootable
optional
booleanBootableFalse

Responses

NameDescriptionExample
idVolume ID3f500f00-ed80-4566-a057-e31760226f9a
bootableBootableFalse
created_atCreated at
encryptedEncrypted
Requires --long option
True
modified_atModified at
Requires --long option
2025-07-26T12:00:00Z
multiattachMultiattach
Requires --long option
False
nameVolume namevolume01
serversAttached servers
Requires --long option
sizeVolume size104
snapshot_idSnapshot ID
Requires --long option
cceed636-1f1e-4bb0-b85c-4e5b9e0bf790
stateVolume stateavailable
user_idUser ID
Requires --long option
570907805e5447be84b618450ef52o0t
volume_image_metadataVolume Image metadata
Requires --long option
volume_typeVolume typeSSD
volume_type_idVolume type ID
Requires --long option
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 Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.69.2 - 1.0

scpcli virtualserver server lock
--server_id <value>

Description

Lock Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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

Reboot Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
reboot_type
optional
****Reboot typeSOFT

Responses

NameDescriptionExample

2.3.1.70.2 - 1.0

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

Description

Reboot Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
reboot_type
optional
****Reboot typeSOFT

Responses

NameDescriptionExample

2.3.1.71 - Rebuild Virtual Server

2.3.1.71.1 - 1.1

scpcli virtualserver server rebuild
--server_id <value>

Description

Rebuild Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.71.2 - 1.0

scpcli virtualserver server rebuild
--server_id <value>

Description

Rebuild Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
snapshot_id
required
stringSnapshot 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.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
snapshot_id
required
stringSnapshot 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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataSnapshot metadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume 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.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790

Responses

NameDescriptionExample
idSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
created_atCreated at2025-07-22T09:00:00Z
descriptionDescriptiondescription
metadataSnapshot metadata
nameSnapshot namesnapshot-1
sizeVolume size104
statusVolume stateavailable
updated_atUpdated at2025-07-26T12:00:00Z
user_idUser ID570907805e5447be84b618450ef52o0t
volume_idVolume 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

Show Auto-Scaling Group.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB Server Group port8080

2.3.1.74.2 - 1.0

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

Description

Show Auto-Scaling Group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idLB Server Group IDd06e87d3-ca9a-461b-8e88-077a542a7335
portLB Server Group port8080

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

Show Auto-Scaling Group notification.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
notification_id
required
stringNotification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification events[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_idUser 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

Show Auto-Scaling Group notification.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
notification_id
required
stringNotification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
notification_eventsAuto-Scaling Group notification events[‘SCALE_OUT’, ‘SCALE_OUT_FAIL’]
notification_stateAuto-Scaling Group notification stateACTIVE
user_idUser 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

Show Auto-Scaling Group policy.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes1
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold unit%

2.3.1.76.2 - 1.0

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

Description

Show Auto-Scaling Group policy.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
auto_scaling_group_idAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operatorComparison operatorge
cooldown_secondsCooldown seconds300
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
evaluation_minutesEvaluation minutes1
metric_methodMetric methodAVG
metric_typeMetric typeCPU
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePolicy namepolicy-name
scale_methodScale methodAMOUNT
scale_typeScale typeSCALE_OUT
scale_valueScale value10
statePolicy stateACTIVE
thresholdThreshold60
threshold_unitThreshold 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

Show Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/Seoul

2.3.1.77.2 - 1.0

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

Description

Show Auto-Scaling Group schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
day_of_monthDay of the month-1,1
day_of_weekDay of the weekSU,SA
descriptionDescriptiondescription
desired_server_countDesired server count1
end_dateEnd date2025-01-01
frequencyFrequencyWEEKLY
hourHour9
max_server_countMax server count2
min_server_countMin server count1
minuteMinute0
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameschedulename
start_dateStart date2024-01-01
stateSchedule stateACTIVE
timezoneTimezoneAsia/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

Show a default Volume type’s details.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

2.3.1.78.2 - 1.0

scpcli virtualserver volume type default show

Description

Show a default Volume type’s details.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

2.3.1.79 - Show Image

2.3.1.79.1 - 1.1

scpcli virtualserver image show
--image_id <value>

Description

Show Image.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumChecksum7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer formatbare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk formatqcow2
fileFile/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk100
min_ramMinimum RAM0
nameImage nameimagename
os_distroOS distributionalma
os_hash_algoOS hash algorithmsha512
os_hash_valueOS hash valuec6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS hiddenFalse
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account nameAccountName
owner_user_nameOwner user nameuser@samsung.com
protectedProtectedFalse
root_device_nameRoot device name/dev/vda
scp_image_typeImage typecustom
scp_k8s_versionK8S versionv1.28.7
scp_original_image_typeOriginal Image typestandard
scp_os_build_versionOS build version20250101
scp_os_versionOS version8.8
sizeSize2429747200
statusStatusactive
updated_atUpdated at2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size17179869184
visibilityVisibilityprivate
volumesVolumes[{“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

Show Image.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
idImage ID70a599e0-31e7-49b7-b260-868f441e862b
checksumChecksum7538e0fcb56e0e272cfd89eb384d6613
container_formatContainer formatbare
created_atCreated at2025-07-22T09:00:00Z
disk_formatDisk formatqcow2
fileFile/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file
min_diskMinimum disk100
min_ramMinimum RAM0
nameImage nameimagename
os_distroOS distributionalma
os_hash_algoOS hash algorithmsha512
os_hash_valueOS hash valuec6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99
os_hiddenOS hiddenFalse
ownerOwner account IDa8f10467abfc4b87b64614ab36eb9ae4
owner_account_nameOwner account nameAccountName
owner_user_nameOwner user nameuser@samsung.com
protectedProtectedFalse
root_device_nameRoot device name/dev/vda
scp_image_typeImage typecustom
scp_k8s_versionK8S versionv1.28.7
scp_original_image_typeOriginal Image typestandard
scp_os_build_versionOS build version20250101
scp_os_versionOS version8.8
sizeSize2429747200
statusStatusactive
updated_atUpdated at2025-07-26T12:00:00Z
urlObject Storage URL for Image file (only qcow2 format allowed)https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2
virtual_sizeVirtual size17179869184
visibilityVisibilityprivate
volumesVolumes[{“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

Show Image member.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
member_id
required
stringMember IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idMember IDa8f10467abfc4b87b64614ab36eb9ae4
statusMember statuspending
updated_atUpdated at2025-07-26T12:00:00Z

2.3.1.80.2 - 1.0

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

Description

Show Image member.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
member_id
required
stringMember IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b

Responses

NameDescriptionExample
created_atCreated at2025-07-22T09:00:00Z
image_idImage ID70a599e0-31e7-49b7-b260-868f441e862b
member_idMember IDa8f10467abfc4b87b64614ab36eb9ae4
statusMember statuspending
updated_atUpdated at2025-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

Show keypair.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
keypair_name
required
stringKeypair namekeypairname

Responses

NameDescriptionExample
idKeypair ID1
created_atCreated at2025-07-22T09:00:00Z
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
public_keyPublic Keypublickey
typeKeypair typessh
user_idUser ID570907805e5447be84b618450ef52o0t

2.3.1.81.2 - 1.0

scpcli virtualserver keypair show
--keypair_name <value>

Description

Show keypair.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
keypair_name
required
stringKeypair namekeypairname

Responses

NameDescriptionExample
idKeypair ID1
created_atCreated at2025-07-22T09:00:00Z
fingerprintFingerprint7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd
nameKeypair namekeypairname
public_keyPublic Keypublickey
typeKeypair typessh
user_idUser 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

Show Launch Configuration.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

Responses

NameDescriptionExample
boot_indexBoot index0
sizeVolume size104
typeVolume typeSSD

2.3.1.82.2 - 1.0

scpcli virtualserver launch configuration show
--launch_configuration_id <value>

Description

Show Launch Configuration.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
launch_configuration_id
required
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f

Responses

NameDescriptionExample
boot_indexBoot index0
sizeVolume size104
typeVolume typeSSD

2.3.1.83 - Show Server Group

2.3.1.83.1 - 1.1

scpcli virtualserver server group show
--server_group_id <value>

Description

Show server group.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_group_id
required
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
membersServer Group members[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizePartition Size3
policyServer Group policyanti-affinity
user_idUser ID570907805e5447be84b618450ef52o0t

2.3.1.83.2 - 1.0

scpcli virtualserver server group show
--server_group_id <value>

Description

Show server group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_group_id
required
stringServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19

Responses

NameDescriptionExample
idServer Group ID616fb98f-46ca-475e-917e-2563e5a8cd19
account_idAccount IDa8f10467abfc4b87b64614ab36eb9ae4
membersServer Group members[‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’]
nameServer Group nameserver-group
partition_sizePartition Size3
policyServer Group policyanti-affinity
user_idUser 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

Show Server Interface.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed Ip list
mac_addrMAC Addressfa:16:3e:c0:71:2b
port_idPort IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_idSubnet ID183c6c30df0c4fcbb16422aa2d64aa21

2.3.1.84.2 - 1.0

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

Description

Show Server Interface.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
fixed_ipsFixed Ip list
mac_addrMAC Addressfa:16:3e:c0:71:2b
port_idPort IDf2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc
port_statePort StateACTIVE
private_static_natPrivate Static NAT
static_natPublic Static NAT
subnet_idSubnet 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

Show Server Ip.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID78b2ee3f074145c580ab6abac4821f97
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressIP address192.169.3.2
versionIP address version4

2.3.1.85.2 - 1.0

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

Description

Show Server Ip.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet ID78b2ee3f074145c580ab6abac4821f97
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressIP address192.169.3.2
versionIP address version4

2.3.1.86 - Show Server Quota Set

2.3.1.86.1 - 1.1

scpcli virtualserver quota set show

Description

Show server quota Set.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Responses

NameDescriptionExample
idQuota set IDfc7283354c6143a58629b59f4c3e16b2
coresCore quota
instancesInstance quota
keypairsKeypairs quota
metadata_itemsMetadata items quota
ramRAM quota
server_group_membersServer group members quota
server_groupsServer groups quota

2.3.1.86.2 - 1.0

scpcli virtualserver quota set show

Description

Show server quota Set.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Responses

NameDescriptionExample
idQuota set IDfc7283354c6143a58629b59f4c3e16b2
coresCore quota
instancesInstance quota
keypairsKeypairs quota
metadata_itemsMetadata items quota
ramRAM quota
server_group_membersServer group members quota
server_groupsServer groups quota

2.3.1.87 - Show Server Type

2.3.1.87.1 - 1.1

scpcli virtualserver server type show
--server_type_id <value>

Description

Show server type.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_type_id
required
stringServer type IDs1v1m2

Responses

NameDescriptionExample
idServer type IDs1v1m2
descriptionDescriptiondescription
diskSize of root disk100
ephemeralSize of ephemeral disk0
extra_specsExtra specs
nameServer type names1v1m2
ramAmount of RAM2
swapSize of dedicated swap disk0
vcpusNumber of CPUs1

2.3.1.87.2 - 1.0

scpcli virtualserver server type show
--server_type_id <value>

Description

Show server type.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_type_id
required
stringServer type IDs1v1m2

Responses

NameDescriptionExample
idServer type IDs1v1m2
descriptionDescriptiondescription
diskSize of root disk100
ephemeralSize of ephemeral disk0
extra_specsExtra specs
nameServer type names1v1m2
ramAmount of RAM2
swapSize of dedicated swap disk0
vcpusNumber of CPUs1

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

Show Server Volume.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete on terminationFalse
deviceDevice name/dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume ID3f500f00-ed80-4566-a057-e31760226f9a

2.3.1.88.2 - 1.0

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

Description

Show Server Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
idVolume Attachment ID3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c
delete_on_terminationDelete on terminationFalse
deviceDevice name/dev/vda
server_idServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_idVolume 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

Show Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

2.3.1.89.2 - 1.0

scpcli virtualserver server show
--server_id <value>

Description

Show Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample
ip_addressesIP addresses
subnet_nameSubnet namesubnetname

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

Show Virtual Server Console Log.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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

Show Virtual Server Console Log.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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

Show Virtual Server Password.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_key
optional
stringPrivate keyprivatekey

Responses

NameDescriptionExample
passwordServer passwordpassword

2.3.1.91.2 - 1.0

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

Description

Show Virtual Server Password.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
private_key
optional
stringPrivate keyprivatekey

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

Show volume quota set.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Responses

NameDescriptionExample
idQuota set IDfc7283354c6143a58629b59f4c3e16b2
per_volume_sizePer volume size quota
snapshotsSnapshot Quota
usagesUsage quota
volumesVolume Quota

2.3.1.92.2 - 1.0

scpcli virtualserver volume quota set show

Description

Show volume quota set.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Responses

NameDescriptionExample
idQuota set IDfc7283354c6143a58629b59f4c3e16b2
per_volume_sizePer volume size quota
snapshotsSnapshot Quota
usagesUsage quota
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

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

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
created_atCreated at
nameVolume namevolume01
volume_idVolume 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.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

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

Responses

NameDescriptionExample
idTransfer ID1ac231be-823b-4a4d-8ff0-aac503a7118a
created_atCreated at
nameVolume namevolume01
volume_idVolume 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

Show a Volume type’s details.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_type_id
required
stringVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

2.3.1.94.2 - 1.0

scpcli virtualserver volume type show
--volume_type_id <value>

Description

Show a Volume type’s details.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_type_id
required
stringVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207

Responses

NameDescriptionExample
idVolume type IDc643ac35-3aec-43e6-b97a-3d6f666c5207
descriptionVolume type descriptionVolume type description
extra_specsExtra specs
nameVolume type nameSSD

2.3.1.95 - Show Volume's details

2.3.1.95.1 - 1.1

scpcli virtualserver volume show
--volume_id <value>

Description

Show a Volume’s details.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a

Responses

NameDescriptionExample
idServer 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

Show a Volume’s details.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a

Responses

NameDescriptionExample
idServer 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

Start Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.96.2 - 1.0

scpcli virtualserver server start
--server_id <value>

Description

Start Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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

Stop Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.97.2 - 1.0

scpcli virtualserver server stop
--server_id <value>

Description

Stop Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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

Unlock Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f

Responses

NameDescriptionExample

2.3.1.98.2 - 1.0

scpcli virtualserver server unlock
--server_id <value>

Description

Unlock Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer 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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
name
required
stringSnapshot namesnapshot-1
description
optional
stringDescriptiondescription

2.3.1.99.2 - 1.0

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

Description

Update a snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot IDcceed636-1f1e-4bb0-b85c-4e5b9e0bf790
name
required
stringSnapshot namesnapshot-1
description
optional
stringDescriptiondescription

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

Update Auto-Scaling Group.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count_editable
optional
booleanDesired server count editableTrue
drain_enabled
optional
booleanDrain enabledTrue
drain_timeout
optional
integerDrain timeout300
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
security_group_ids
optional
arraySecurity Group ID list[

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

Update Auto-Scaling Group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count_editable
optional
booleanDesired server count editableTrue
drain_enabled
optional
booleanDrain enabledTrue
drain_timeout
optional
integerDrain timeout300
launch_configuration_id
optional
stringLaunch Configuration IDb5aea5a675fc4f6b9e0fcd1288354c5f
security_group_ids
optional
arraySecurity Group ID list[

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

Update Auto-Scaling Group LB Server Groups.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
lb_server_groups
required
arrayLB Server Group list'{"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

Update Auto-Scaling Group LB Server Groups.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
lb_server_groups
required
arrayLB Server Group list'{"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

Update Auto-Scaling Group notification.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
notification_id
required
stringNotification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
notification_events
optional
arrayAuto-Scaling Group notification eventsSCALE_OUT
notification_state
optional
stringAuto-Scaling Group notification stateACTIVE

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

Update Auto-Scaling Group notification.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
notification_id
required
stringNotification IDfa7fd191410744cd810a290c0b4d22b9
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
notification_events
optional
arrayAuto-Scaling Group notification eventsSCALE_OUT
notification_state
optional
stringAuto-Scaling Group notification stateACTIVE

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

Update Auto-Scaling Group policy.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator
optional
stringComparison operatorge
cooldown_seconds
optional
integerCooldown seconds300
evaluation_minutes
optional
integerEvaluation minutes1
metric_method
optional
stringMetric methodAVG
metric_type
optional
stringMetric typeCPU
name
optional
stringPolicy namepolicy-name
scale_method
optional
stringScale methodAMOUNT
scale_type
optional
stringScale typeSCALE_OUT
scale_value
optional
integerScale value10
state
optional
stringPolicy stateACTIVE
threshold
optional
integerThreshold60

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

Update Auto-Scaling Group policy.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID0761d76085f54363bab07909baf69841
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
comparison_operator
optional
stringComparison operatorge
cooldown_seconds
optional
integerCooldown seconds300
evaluation_minutes
optional
integerEvaluation minutes1
metric_method
optional
stringMetric methodAVG
metric_type
optional
stringMetric typeCPU
name
optional
stringPolicy namepolicy-name
scale_method
optional
stringScale methodAMOUNT
scale_type
optional
stringScale typeSCALE_OUT
scale_value
optional
integerScale value10
state
optional
stringPolicy stateACTIVE
threshold
optional
integerThreshold60

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

Update Auto-Scaling Group schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
day_of_month
optional
stringDay of the month-1,1
day_of_week
optional
stringDay of the weekSU,SA
description
optional
stringDescriptiondescription
desired_server_count
optional
integerDesired server count1
end_date
optional
stringEnd date2025-01-01
frequency
optional
****FrequencyWEEKLY
hour
optional
integerHour9
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1
minute
optional
integerMinute0
name
optional
stringSchedule nameschedulename
start_date
optional
stringStart date2024-01-01
state
optional
stringSchedule stateACTIVE
timezone
optional
stringTimezoneAsia/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

Update Auto-Scaling Group schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
schedule_id
required
stringSchedule ID43d4841abd404220af5f0904037aba71
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
day_of_month
optional
stringDay of the month-1,1
day_of_week
optional
stringDay of the weekSU,SA
description
optional
stringDescriptiondescription
desired_server_count
optional
integerDesired server count1
end_date
optional
stringEnd date2025-01-01
frequency
optional
****FrequencyWEEKLY
hour
optional
integerHour9
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1
minute
optional
integerMinute0
name
optional
stringSchedule nameschedulename
start_date
optional
stringStart date2024-01-01
state
optional
stringSchedule stateACTIVE
timezone
optional
stringTimezoneAsia/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

Update Auto-Scaling Group server count.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count
optional
integerDesired server count1
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1

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

Update Auto-Scaling Group server count.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auto_scaling_group_id
required
stringAuto-Scaling Group ID52613bd852b04b39adcb15a8364d856d
desired_server_count
optional
integerDesired server count1
max_server_count
optional
integerMax server count2
min_server_count
optional
integerMin server count1

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

Update Image.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
min_disk
optional
integerMinimum disk100
min_ram
optional
integerMinimum RAM0
protected
optional
booleanProtectedFalse
visibility
optional
stringVisibilityprivate

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

Update Image.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
min_disk
optional
integerMinimum disk100
min_ram
optional
integerMinimum RAM0
protected
optional
booleanProtectedFalse
visibility
optional
stringVisibilityprivate

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

Update Image member.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
member_id
required
stringMember IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
status
required
stringMember statuspending

2.3.1.107.2 - 1.0

scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>

Description

Update Image member.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
member_id
required
stringMember IDa8f10467abfc4b87b64614ab36eb9ae4
image_id
required
stringImage ID70a599e0-31e7-49b7-b260-868f441e862b
status
required
stringMember statuspending

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

Update Server Interface.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ip_address
optional
stringIP address192.169.3.2
subnet_id
optional
stringSubnet 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

Update Server Interface.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID91424c08-0b26-49fb-9808-ed042292ceef
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
fixed_ip_address
optional
stringIP address192.169.3.2
subnet_id
optional
stringSubnet 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

Update Server Volume.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
delete_on_termination
optional
booleanDelete on terminationFalse

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

Update Server Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
delete_on_termination
optional
booleanDelete on terminationFalse

2.3.1.110 - Update Virtual Server

2.3.1.110.1 - 1.1

scpcli virtualserver server set
--server_id <value>
--name <value>

Description

Update Virtual Server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
name
required
stringServer nameservername

2.3.1.110.2 - 1.0

scpcli virtualserver server set
--server_id <value>
--name <value>

Description

Update Virtual Server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
name
required
stringServer nameservername

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

Update Virtual Server type

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
server_type
required
stringServer types1v1m2

Responses

NameDescriptionExample

2.3.1.111.2 - 1.0

scpcli virtualserver server type set
--server_id <value>
--server_type <value>

Description

Update Virtual Server type

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
server_id
required
stringServer ID2a9be312-5d4b-4bc8-b2ae-35100fa9241f
server_type
required
stringServer types1v1m2

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

Update a Volume.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
stringVolume namevolume01

2.3.1.112.2 - 1.0

scpcli virtualserver volume set
--volume_id <value>
[--name <value>]

Description

Update a Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume ID3f500f00-ed80-4566-a057-e31760226f9a
name
optional
stringVolume namevolume01

3 - Storage

3.1 - Archive Storage

Overview

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

This guide provides a brief description of Archive Storage service and how to call 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

Cancel a specific archiving

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID3d036efe-f576-48b0-8375-6d3704a95b63
id
required
stringArchiving History IDEXE-8f35b491-a060-453b-b825-e78440ca46de

3.1.1.1.2 - 1.0

scpcli archivestorage archiving history cancel
--bucket_id <value>
--id <value>

Description

Cancel a specific archiving

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID3d036efe-f576-48b0-8375-6d3704a95b63
id
required
stringArchiving History IDEXE-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

Cancel a specific recovery

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
id
required
stringRecovery History IDEXE-9df439a5-9e6d-46a4-806e-1e9991520763

3.1.1.2.2 - 1.0

scpcli archivestorage recovery history cancel
--bucket_id <value>
--id <value>

Description

Cancel a specific recovery

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
id
required
stringRecovery History IDEXE-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

Create an archivingPolicy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_path
required
stringObject Path/
object_lifecycle
required
stringObject LifeCycle1
archiving_source_bucket_name
required
stringArchiving Source Bucket Nameobs-bucket-name

Responses

NameDescriptionExample
idArchiving Policy IDSCH-XXXXXXX
bucket_idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_sourceArchiving Source
object_lifecycleObject LifeCycle1
stateArchiving Policy StateACTIVE

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

Create an archivingPolicy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_path
required
stringObject Path/
object_lifecycle
required
stringObject LifeCycle1
archiving_source_bucket_name
required
stringArchiving Source Bucket Nameobs-bucket-name

Responses

NameDescriptionExample
idArchiving Policy IDSCH-XXXXXXX
bucket_idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_sourceArchiving Source
object_lifecycleObject LifeCycle1
stateArchiving Policy StateACTIVE

3.1.1.4 - CreateBucket

3.1.1.4.1 - 1.1

scpcli archivestorage bucket create
--name <value>
[--tags <value>]

Description

Create a bucket

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringBucket nameastest
tags
optional
arrayTag List'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

3.1.1.4.2 - 1.0

scpcli archivestorage bucket create
--name <value>
[--tags <value>]

Description

Create a bucket

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringBucket nameastest
tags
optional
arrayTag List'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idBucket ID138c2-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

Delete a specific bucket

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

3.1.1.5.2 - 1.0

scpcli archivestorage bucket delete
--bucket_id <value>

Description

Delete a specific bucket

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-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

Delete Bucket Objects

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
paths
required
arrayObject Path Listtest/

3.1.1.6.2 - 1.0

scpcli archivestorage bucket object delete
--bucket_id <value>
--paths <value>

Description

Delete Bucket Objects

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
paths
required
arrayObject Path Listtest/

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

Delete Bucket Object Versions

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
versions
required
arrayObject Version ListOc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
path
required
stringObject Pathhello/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

List archiving histories

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
start_at_to
required
stringStart at to2025-04-30T23:59:59+09:00
start_at_from
required
stringStart at from2025-04-01T00:00:00+09:00
bucket_id
required
stringBucket ID3d036efe-f576-48b0-8375-6d3704a95b63
state
optional
stringStateSUCCESS
limit
optional
integerLimit20
offset
optional
integerOffset0

Responses

NameDescriptionExample
idArchiving History IDEXE-8f35b491-a060-453b-b825-e78440ca46de
archiving_idArchiving IDSCH-02d48456-0f35-47e2-8056-b00e09366cac
stateStateSUCCESS
archiving_policy_idArchiving Policy IDSCH-02d48456-0f35-47e2-8056-b00e09366cac
start_atStart at2025-04-01T00:00:00+09:00
end_atEnd at2025-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

List archiving histories

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
start_at_to
required
stringStart at to2025-04-30T23:59:59+09:00
start_at_from
required
stringStart at from2025-04-01T00:00:00+09:00
bucket_id
required
stringBucket ID3d036efe-f576-48b0-8375-6d3704a95b63
state
optional
stringStateSUCCESS
limit
optional
integerLimit20
offset
optional
integerOffset0

Responses

NameDescriptionExample
idArchiving History IDEXE-8f35b491-a060-453b-b825-e78440ca46de
archiving_idArchiving IDSCH-02d48456-0f35-47e2-8056-b00e09366cac
stateStateSUCCESS
archiving_policy_idArchiving Policy IDSCH-02d48456-0f35-47e2-8056-b00e09366cac
start_atStart at2025-04-01T00:00:00+09:00
end_atEnd at2025-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

List archiving policies

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idArchiving Policy IDSCH-XXXXXXX
object_lifecycleObject LifeCycle1
object_pathObject Path/
stateArchiving Policy StateACTIVE

3.1.1.9.2 - 1.0

scpcli archivestorage archiving policy list
--bucket_id <value>

Description

List archiving policies

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idArchiving Policy IDSCH-XXXXXXX
object_lifecycleObject LifeCycle1
object_pathObject Path/
stateArchiving Policy StateACTIVE

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

List Bucket Objects

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
marker
optional
stringMarkerTODO.txt
object_path
optional
stringObject Path/
object_name
optional
stringObject Namehello/TODO.txt
object_type
optional
stringObject TypeFILE
limit
optional
integerLimit20

Responses

NameDescriptionExample
object_nameObject Namehello/TODO.txt
object_typeObject TypeFILE
object_sizeObject Size3581
modified_atModified AT2025-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

List Bucket Objects

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
marker
optional
stringMarkerTODO.txt
object_path
optional
stringObject Path/
object_name
optional
stringObject Namehello/TODO.txt
object_type
optional
stringObject TypeFILE
limit
optional
integerLimit20

Responses

NameDescriptionExample
object_nameObject Namehello/TODO.txt
object_typeObject TypeFILE
object_sizeObject Size3581
modified_atModified AT2025-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

List Bucket Object Versions

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_path
required
stringObject Pathhello/my_file.txt
offset
optional
integerOffset0
limit
optional
integerLimit20

Responses

NameDescriptionExample
object_pathObject Pathhello/my_file.txt
object_version_idObject Version IdOc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
latestIs Latest version of ObjectTrue
modified_atModified AT2025-04-09T05:54:46.244000+00:00
etagETag4f6094f1e0619a6504efcb5e69e63bec
sizeSize20

3.1.1.12 - ListBuckets

3.1.1.12.1 - 1.1

scpcli archivestorage bucket list
[--name <value>]
[--limit <value>]

Description

List Buckets

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
optional
stringBucket nameastest
limit
optional
integerLimit20

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
nameBucket nameastest

3.1.1.12.2 - 1.0

scpcli archivestorage bucket list
[--name <value>]
[--limit <value>]

Description

List Buckets

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
optional
stringBucket nameastest
limit
optional
integerLimit20

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
nameBucket nameastest

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

List recovery histories

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
start_at_to
required
stringStart at to2025-04-30T23:59:59+09:00
start_at_from
required
stringStart at from2025-04-01T00:00:00+09:00
bucket_id
required
stringBucket ID7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
state
optional
stringStateSUCCESS
limit
optional
integerLimit20
offset
optional
integerOffset0

Responses

NameDescriptionExample
idRecovery History IDEXE-9df439a5-9e6d-46a4-806e-1e9991520763
recovery_idRecovery IDARC-f9eab563-312b-4bbf-a4bf-d377448d66b5
stateStateSUCCESS
recovery_target_bucket_nameRecovery Target Bucket NAMEtest-obs-bucket
start_atStart at2025-04-01T00:00:00+09:00
end_atEnd at2025-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

List recovery histories

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
start_at_to
required
stringStart at to2025-04-30T23:59:59+09:00
start_at_from
required
stringStart at from2025-04-01T00:00:00+09:00
bucket_id
required
stringBucket ID7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
state
optional
stringStateSUCCESS
limit
optional
integerLimit20
offset
optional
integerOffset0

Responses

NameDescriptionExample
idRecovery History IDEXE-9df439a5-9e6d-46a4-806e-1e9991520763
recovery_idRecovery IDARC-f9eab563-312b-4bbf-a4bf-d377448d66b5
stateStateSUCCESS
recovery_target_bucket_nameRecovery Target Bucket NAMEtest-obs-bucket
start_atStart at2025-04-01T00:00:00+09:00
end_atEnd at2025-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

Recover Objects to objectstorage

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
overwrite
required
booleanOverwriteTrue
recovery_infos
required
arrayObject Recovery Info List'{"source_object_path": "/", "object_type": "FILE"}'
recovery_target_bucket_name
required
stringRecovery Target Bucket Nameobs-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

Recover Objects to objectstorage

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
overwrite
required
booleanOverwriteTrue
recovery_infos
required
arrayObject Recovery Info List'{"source_object_path": "/", "object_type": "FILE"}'
recovery_target_bucket_name
required
stringRecovery Target Bucket Nameobs-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

Recover Object Versions to objectstorage

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
overwrite
required
booleanOverwriteTrue
source_object_version
required
stringRecovery Source Object VersionOc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
source_object_path
required
stringRecovery Source Object Path/
recovery_target_bucket_name
required
stringRecovery Target Bucket Nameobs-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

Set archivingPolicy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
stringArchiving Policy IDSCH-XXXXXXX
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_lifecycle
required
stringObject LifeCycle1

3.1.1.16.2 - 1.0

scpcli archivestorage archiving policy set
--archiving_policy_id <value>
--bucket_id <value>
--object_lifecycle <value>

Description

Set archivingPolicy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
stringArchiving Policy IDSCH-XXXXXXX
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_lifecycle
required
stringObject LifeCycle1

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

Set archivingPolicy state

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
stringArchiving Policy IDSCH-XXXXXXX
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
state
required
stringArchiving Policy StateACTIVE

3.1.1.18 - SetBucketEncryption

3.1.1.18.1 - 1.1

scpcli archivestorage bucket encryption set
--bucket_id <value>
--enabled <value>

Description

Set a specific bucket encryption

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled
required
booleanEncryption EnabledTrue

3.1.1.18.2 - 1.0

scpcli archivestorage bucket encryption set
--bucket_id <value>
--enabled <value>

Description

Set a specific bucket encryption

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled
required
booleanEncryption EnabledTrue

3.1.1.19 - SetBucketVersioning

3.1.1.19.1 - 1.1

scpcli archivestorage bucket versioning set
--bucket_id <value>
--enabled <value>

Description

set a specific bucket versioning

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled
required
booleanVersioning EnabledTrue

3.1.1.20 - ShowArchivingHistory

3.1.1.20.1 - 1.1

scpcli archivestorage archiving history show
--bucket_id <value>
--id <value>

Description

Show an archiving history

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID3d036efe-f576-48b0-8375-6d3704a95b63
id
required
stringArchiving History IDEXE-8f35b491-a060-453b-b825-e78440ca46de

Responses

NameDescriptionExample
source_object_pathSource Object Pathexample_source_object_path/
usageUsage1024
total_object_countTotal Object Count100
archiving_object_countArchiving Object Count50
archiving_rateArchiving Rate100

3.1.1.20.2 - 1.0

scpcli archivestorage archiving history show
--bucket_id <value>
--id <value>

Description

Show an archiving history

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID3d036efe-f576-48b0-8375-6d3704a95b63
id
required
stringArchiving History IDEXE-8f35b491-a060-453b-b825-e78440ca46de

Responses

NameDescriptionExample
source_object_pathSource Object Pathexample_source_object_path/
usageUsage1024
total_object_countTotal Object Count100
archiving_object_countArchiving Object Count50
archiving_rateArchiving Rate100

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

Show an archivingPolicy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
stringArchiving Policy IDSCH-XXXXXXX
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idArchiving Policy IDSCH-XXXXXXX
bucket_idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_sourceArchiving Source
object_lifecycleObject LifeCycle1
stateArchiving Policy StateACTIVE

3.1.1.21.2 - 1.0

scpcli archivestorage archiving policy show
--archiving_policy_id <value>
--bucket_id <value>

Description

Show an archivingPolicy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
stringArchiving Policy IDSCH-XXXXXXX
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idArchiving Policy IDSCH-XXXXXXX
bucket_idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_sourceArchiving Source
object_lifecycleObject LifeCycle1
stateArchiving Policy StateACTIVE

3.1.1.22 - ShowBucket

3.1.1.22.1 - 1.1

scpcli archivestorage bucket show
--bucket_id <value>

Description

Show a specific bucket

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
nameBucket nameastest
stateBucket stateACTIVE
usageBucket usage10
archiving_source_bucket_nameArchiving source bucket nameobstest

3.1.1.22.2 - 1.0

scpcli archivestorage bucket show
--bucket_id <value>

Description

Show a specific bucket

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
nameBucket nameastest
stateBucket stateACTIVE
usageBucket usage10
archiving_source_bucket_nameArchiving source bucket nameobstest

3.1.1.23 - ShowBucketEncryption

3.1.1.23.1 - 1.1

scpcli archivestorage bucket encryption show
--bucket_id <value>

Description

Show a specific bucket encryption

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabledEncryption EnabledTrue

3.1.1.23.2 - 1.0

scpcli archivestorage bucket encryption show
--bucket_id <value>

Description

Show a specific bucket encryption

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabledEncryption EnabledTrue

3.1.1.24 - ShowBucketVersioning

3.1.1.24.1 - 1.1

scpcli archivestorage bucket versioning show
--bucket_id <value>

Description

show a specific bucket versioning

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabledVersion EnabledTrue

3.1.1.25 - ShowRecoveryHistory

3.1.1.25.1 - 1.1

scpcli archivestorage recovery history show
--bucket_id <value>
--id <value>

Description

Show a recovery history

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
id
required
stringRecovery History IDEXE-9df439a5-9e6d-46a4-806e-1e9991520763

Responses

NameDescriptionExample
source_object_pathSource Object Pathexample_source_object_path/
usageUsage1024
total_object_countTotal Object Count100
recovery_object_countRecovery Object Count50
recovery_rateRecovery Rate50

3.1.1.25.2 - 1.0

scpcli archivestorage recovery history show
--bucket_id <value>
--id <value>

Description

Show a recovery history

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
id
required
stringRecovery History IDEXE-9df439a5-9e6d-46a4-806e-1e9991520763

Responses

NameDescriptionExample
source_object_pathSource Object Pathexample_source_object_path/
usageUsage1024
total_object_countTotal Object Count100
recovery_object_countRecovery Object Count50
recovery_rateRecovery Rate50

3.2 - Backup

Overview

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

This guide provides a brief description of Backup service and how to call 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

Check Backup master connection state.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

3.2.1.1.2 - 1.0

scpcli backup backup agent connection state check
--backup_agent_id <value>

Description

Check Backup master connection state.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

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

Check for duplicate backup names.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_name
required
stringBackup namebackup-001

Responses

NameDescriptionExample
resultResultTrue

3.2.1.2.2 - 1.0

scpcli backup backup name duplicate check
--backup_name <value>

Description

Check for duplicate backup names.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_name
required
stringBackup namebackup-001

Responses

NameDescriptionExample
resultResultTrue

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

Check for duplicate restore server name.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
restore_server_name
required
stringRestore server namerestoretest1

Responses

NameDescriptionExample
resultResultTrue

3.2.1.3.2 - 1.0

scpcli backup backup restore server name duplicate check
--restore_server_name <value>

Description

Check for duplicate restore server name.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
restore_server_name
required
stringRestore server namerestoretest1

Responses

NameDescriptionExample
resultResultTrue

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

Check filesystem path duplication.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_path
required
stringFilesystem backup path/aaa

Responses

NameDescriptionExample
resultResultTrue

3.2.1.4.2 - 1.0

scpcli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Check filesystem path duplication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_path
required
stringFilesystem backup path/aaa

Responses

NameDescriptionExample
resultResultTrue

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

Create a Backup.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
server_category
required
stringBackup server category```VIRTUAL_SERVER
schedules
required
arraySchedules'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'
policy_type
required
stringBackup policy typeVM_IMAGE
policy_category
required
stringBackup policy categoryAGENTLESS
name
required
stringBackup namebackup-001
dr_enabled
optional
booleanWhether to use DR-
encrypt_enabled
optional
booleanWhether to use EncryptionTrue
filesystem_paths
optional
arrayList of filesystem backup path/aaa
region
optional
stringRegionkr-west1
retention_period
optional
stringBackup retention periodWEEK_2
server_guid
optional
stringBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

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

Create a Backup.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
server_category
required
stringBackup server category```VIRTUAL_SERVER
schedules
required
arraySchedules'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'
policy_type
required
stringBackup policy typeVM_IMAGE
policy_category
required
stringBackup policy categoryAGENTLESS
name
required
stringBackup namebackup-001
encrypt_enabled
optional
booleanWhether to use EncryptionTrue
filesystem_paths
optional
arrayList of filesystem backup path/aaa
region
optional
stringRegionkr-west1
retention_period
optional
stringBackup retention periodWEEK_2
server_guid
optional
stringBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

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

Create a Backup Agent.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

3.2.1.6.2 - 1.0

scpcli backup backup agent create
--server_uuid <value>
[--tags <value>]

Description

Create a Backup Agent.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

3.2.1.7 - Delete Backup

3.2.1.7.1 - 1.1

scpcli backup backup delete
--backup_id <value>

Description

Terminate the Backup.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

3.2.1.7.2 - 1.0

scpcli backup backup delete
--backup_id <value>

Description

Terminate the Backup.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Terminate the Backup Agent.

State ACTIVE (CURRENT)

VersionSupported Until
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

Terminate the Backup Agent.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete Backup restore target.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_ids
required
arrayBackup restore target ID listca1a8e76-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

Delete Backup restore target.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_ids
required
arrayBackup restore target ID listca1a8e76-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

List Agent Backup restore target servers.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_name
optional
stringBackup server nameserver-001
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_uuidBackup server 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

List Agent Backup restore target servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_name
optional
stringBackup server nameserver-001
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_uuidBackup server 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

List Backup Agents.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup Agent Nameagent_abcd12
server_backup_agent_ip
optional
stringServer's Backup Agent IP11.22.33.44
server_name
optional
stringBackup Agent target server nameserver-001

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_countBackup policy count3
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_nameBackup server nameserver-001
stateBackup Agent stateAVAILABLE

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

List Backup Agents.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup Agent Nameagent_abcd12
server_backup_agent_ip
optional
stringServer's Backup Agent IP11.22.33.44
server_name
optional
stringBackup Agent target server nameserver-001

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_countBackup policy count3
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_nameBackup server nameserver-001
stateBackup Agent stateAVAILABLE

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

List Backup histories.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
backup_job_state
optional
****Backup history stateSUCCESS
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_end_timeEnd time2024-10-31T14:59:59Z
backup_job_guidBackup job GUID3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_stateBackup history stateSUCCESS
backup_start_timeStart time2024-09-30T15:00:00Z
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_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

List Backup histories.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
backup_job_state
optional
****Backup history stateSUCCESS
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_end_timeEnd time2024-10-31T14:59:59Z
backup_job_guidBackup job GUID3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_stateBackup history stateSUCCESS
backup_start_timeStart time2024-09-30T15:00:00Z
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_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.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
from_region
optional
stringRegionkr-west1
from_availability_zone
optional
stringAvailability zone namekr-west1
to_region
optional
stringRegionkr-west1
to_availability_zone
optional
stringAvailability zone namekr-west1
backup_master_type
optional
****Backup Master typeAGENTLESS

Responses

NameDescriptionExample
from_availability_zoneAvailability zone namekr-west1
from_regionRegionkr-west1
to_availability_zoneAvailability zone namekr-west1
to_regionRegionkr-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.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
from_region
optional
stringRegionkr-west1
from_availability_zone
optional
stringAvailability zone namekr-west1
to_region
optional
stringRegionkr-west1
to_availability_zone
optional
stringAvailability zone namekr-west1

Responses

NameDescriptionExample
from_availability_zoneAvailability zone namekr-west1
from_regionRegionkr-west1
to_availability_zoneAvailability zone namekr-west1
to_regionRegionkr-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

List Backup restore histories.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc
restore_state
optional
****Restore stateCOMPLETED
start_time
optional
stringStart time2024-09-30T15:00:00Z
end_time
optional
stringEnd time2024-10-31T14:59:59Z

Responses

NameDescriptionExample
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_timeBackup time2024-10-28T05:38:48
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
restore_end_timeRestore completion time2024-10-28T05:52:47
restore_server_idRestored server ID26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_nameRestore server namerestoretest1
restore_start_timeRestore start time2024-10-28T05:52:47
restore_stateRestore stateCOMPLETED
schedule_nameSchedule nameINCREMENTAL_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

List Backup restore histories.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc
restore_state
optional
****Restore stateCOMPLETED
start_time
optional
stringStart time2024-09-30T15:00:00Z
end_time
optional
stringEnd time2024-10-31T14:59:59Z

Responses

NameDescriptionExample
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_timeBackup time2024-10-28T05:38:48
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
restore_end_timeRestore completion time2024-10-28T05:52:47
restore_server_idRestored server ID26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_nameRestore server namerestoretest1
restore_start_timeRestore start time2024-10-28T05:52:47
restore_stateRestore stateCOMPLETED
schedule_nameSchedule nameINCREMENTAL_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

List of subnets to select when restoring to a different location from the original server.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
region
required
stringRegion to restore serverkr-west1
vpc_id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
stringSubnet stateACTIVE

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateSubnet stateACTIVE
typeSubnet TypeGENERAL
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC namevpcName

3.2.1.15.2 - 1.0

scpcli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]

Description

List of subnets to select when restoring to a different location from the original server.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
region
required
stringRegion to restore serverkr-west1
vpc_id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
stringSubnet stateACTIVE

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateSubnet stateACTIVE
typeSubnet TypeGENERAL
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC namevpcName

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

List Backup restore targets.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_start_timeStart time2024-09-30T15:00:00Z
is_restore_availableWhether restore availabletrue
restore_target_idRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_periodBackup retention periodWEEK_2
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
usage_gbBackup size(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

List Backup restore targets.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_start_timeStart time2024-09-30T15:00:00Z
is_restore_availableWhether restore availabletrue
restore_target_idRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_periodBackup retention periodWEEK_2
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
usage_gbBackup size(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

List Backup schedules.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
frequencySchedule frequency typeDAILY
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
start_daySchedule start dayMON
start_timeSchedule start time14:00:00
start_weekSchedule start weekWEEK_1
stateBackup Schedule stateAVAILABLE
typeSchedule typeFULL

3.2.1.17.2 - 1.0

scpcli backup backup schedule list
--backup_id <value>

Description

List Backup schedules.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
frequencySchedule frequency typeDAILY
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
start_daySchedule start dayMON
start_timeSchedule start time14:00:00
start_weekSchedule start weekWEEK_1
stateBackup Schedule stateAVAILABLE
typeSchedule typeFULL

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

List Backup targets.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_category
required
****Backup server category```VIRTUAL_SERVER
server_name
optional
stringBackup server nameserver-001
region
optional
stringRegionkr-west1
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_guidBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_typeBackup server types1v1m2
server_uuidBackup server 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

List Backup targets.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
server_category
required
****Backup server category```VIRTUAL_SERVER
server_name
optional
stringBackup server nameserver-001
region
optional
stringRegionkr-west1
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_guidBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_typeBackup server types1v1m2
server_uuidBackup server 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

List Backups.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup namebackup-001
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
policy_typeBackup policy typeVM_IMAGE
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_nameBackup server nameserver-001
stateBackup stateAVAILABLE

3.2.1.19.2 - 1.0

scpcli backup backup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_name <value>]

Description

List Backups.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup namebackup-001
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
policy_typeBackup policy typeVM_IMAGE
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_nameBackup server nameserver-001
stateBackup stateAVAILABLE

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

List targets of Backup Agent.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
server_category
required
stringBackup server categoryBAREMETAL_SERVER
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringSort-
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_nameBackup Agent target server nameserver-001
server_stateBackup server stateRUNNING
server_uuidBackup Agent target server 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

List targets of Backup Agent.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
server_category
required
stringBackup server categoryBAREMETAL_SERVER
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringSort-
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_nameBackup Agent target server nameserver-001
server_stateBackup server stateRUNNING
server_uuidBackup Agent target server 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

Perform Manual Backup immediately.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

3.2.1.21.2 - 1.0

scpcli backup backup manual backup create
--backup_id <value>

Description

Perform Manual Backup immediately.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

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

Restore the Backup.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_uuid
required
stringRestored server ID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_paths
required
arrayList of filesystem backup path'{"destination": "/data", "source": "/data"}'
overwrite
optional
booleanOverwriteTrue

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

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

Restore the Backup.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_uuid
required
stringRestored server ID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_paths
required
arrayList of filesystem backup path'{"destination": "/data", "source": "/data"}'
overwrite
optional
booleanOverwriteTrue

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

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

Restore the Backup.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_type_id
required
stringServer type ids1v1m2
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_name
required
stringRestore server namerestoretest1
networks
optional
arrayNetwork info for restore'{"subnet_id": "023c57b14f11483689338d085e061492"}'
restore_region
optional
stringRegion to restore serverkr-west1
security_groups
optional
arraySecurity Group ID list023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

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

Restore the Backup.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_type_id
required
stringServer type ids1v1m2
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_name
required
stringRestore server namerestoretest1
networks
optional
arrayNetwork info for restore'{"subnet_id": "023c57b14f11483689338d085e061492"}'
restore_region
optional
stringRegion to restore serverkr-west1
security_groups
optional
arraySecurity Group ID list023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

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

Set Backup schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
schedules
required
arrayBackup schedule list'{"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

Set Backup schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
schedules
required
arrayBackup schedule list'{"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

Set Filesystem path.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_filesystem_paths
required
arrayList of filesystem backup path/aaa

3.2.1.25.2 - 1.0

scpcli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>

Description

Set Filesystem path.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_filesystem_paths
required
arrayList of filesystem backup path/aaa

3.2.1.26 - Show Backup

3.2.1.26.1 - 1.1

scpcli backup backup show
--backup_id <value>

Description

Show the detail of Backup.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_idBackup Agent IDBACKUP_AGENT-abcd
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dr_enabledWhether to use DR
dr_regionDR Regionkr-west1
encrypt_enabledWhether to use EncryptionFalse
filesystem_pathsList of filesystem backup path[’/aaa’, ‘/bbb’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
origin_backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
policy_categoryBackup policy categoryAGENTLESS
policy_typeBackup policy typeVM_IMAGE
regionRegionkr-west1
replica_backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_categoryBackup server categoryVIRTUAL_SERVER
server_nameBackup server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_regionRegionkr-west1
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup stateAVAILABLE

3.2.1.26.2 - 1.0

scpcli backup backup show
--backup_id <value>

Description

Show the detail of Backup.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_idBackup Agent IDBACKUP_AGENT-abcd
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
encrypt_enabledWhether to use EncryptionFalse
filesystem_pathsList of filesystem backup path[’/aaa’, ‘/bbb’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
policy_categoryBackup policy categoryAGENTLESS
policy_typeBackup policy typeVM_IMAGE
regionRegionkr-west1
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_categoryBackup server categoryVIRTUAL_SERVER
server_nameBackup server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_regionRegionkr-west1
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup stateAVAILABLE

3.2.1.27 - Show Backup Agent

3.2.1.27.1 - 1.1

scpcli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

State ACTIVE (CURRENT)

VersionSupported Until
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 namebackupmastertest
backup_policy_countBackup policy count3
connection_check_timeBackup Agent connection check time2024-11-11T09:13:48Z
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
install_file_pathInstall file pathhttp://linux-agent
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_categoryBackup server categoryVIRTUAL_SERVER
server_gateway_ipServer Gateway IP22.33.44.55
server_nameBackup Agent target server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_uuidBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup Agent stateAVAILABLE

3.2.1.27.2 - 1.0

scpcli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

State ACTIVE (DEPRECATED)

VersionSupported Until
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 namebackupmastertest
backup_policy_countBackup policy count3
connection_check_timeBackup Agent connection check time2024-11-11T09:13:48Z
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
install_file_pathInstall file pathhttp://linux-agent
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_categoryBackup server categoryVIRTUAL_SERVER
server_gateway_ipServer Gateway IP22.33.44.55
server_nameBackup Agent target server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_uuidBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup Agent stateAVAILABLE

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

Show Backup Agent Install File Path.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
os_type
required
stringOS type-

Responses

NameDescriptionExample
install_file_pathInstall file pathhttp://linux-agent

3.2.1.28.2 - 1.0

scpcli backup backup agent install file path show
--os_type <value>

Description

Show Backup Agent Install File Path.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
os_type
required
stringOS type-

Responses

NameDescriptionExample
install_file_pathInstall file pathhttp://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

Update Replication use.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
dr_enabled
required
booleanWhether to use DRFalse

3.2.1.29.2 - 1.0

scpcli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

Update Replication use.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
dr_enabled
required
booleanWhether to use DRFalse

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

Update the retention period.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_period
required
stringBackup retention periodWEEK_2

3.2.1.30.2 - 1.0

scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

Update the retention period.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_period
required
stringBackup retention periodWEEK_2

3.3 - Block Storage(BM)

Overview

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

This guide provides a brief description of Block Storage(BM) service and how to call 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

Add Volume Group Member on Volume Group.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group 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

Add Volume Group Member on Volume Group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group 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

Add Volume Group Member on Volume Group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group 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

Attach Volume to servers.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
object_idObject id83c3c73d457345e3829ee6d5557c0016
object_typeObject type

3.3.1.2.2 - 1.1

scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

Attach Volume to servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
resultVolume detail

3.3.1.2.3 - 1.0

scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

Attach Volume to servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
resultVolume detail

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

Create Volume.

State ACTIVE (CURRENT)

VersionSupported Until
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
stringVolume namebs-01
disk_type
required
stringDisk type-
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
size_gb
required
integerVolume capacity(GB)10
name
required
stringVolume namebs-01
disk_type
required
stringDisk type-
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size_gb
required
integerVolume capacity(GB)10
name
required
stringVolume namebs-01
disk_type
required
stringDisk type-
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume Group

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
stringVolume group namevg-01
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.4.2 - 1.1

scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]

Description

Create Volume Group

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
stringVolume group namevg-01
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.4.3 - 1.0

scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]

Description

Create Volume Group

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
stringVolume group namevg-01
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume Group Recovery.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
block_storage_name_prefix
required
stringBlock Storage name prefixprefix-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume Group Recovery.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
block_storage_name_prefix
required
stringBlock Storage name prefixprefix-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume Group Replication.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
replication_volume_name_prefix
required
stringReplication volume name prefixdr
region
required
stringRegionkr-west1
name
required
stringReplication volume group namereplica-vg-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume Group Replication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
replication_volume_name_prefix
required
stringReplication volume name prefixdr
region
required
stringRegionkr-west1
name
required
stringReplication volume group namereplica-vg-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume Group Replication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
replication_volume_name_prefix
required
stringReplication volume name prefixdr
region
required
stringRegionkr-west1
name
required
stringReplication volume group namereplica-vg-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume Group Snapshot

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.3.1.7.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

Create Volume Group Snapshot

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.3.1.7.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

Create Volume Group Snapshot

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_idVolume group 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

Create Volume Group Snapshot Schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_group_idVolume group 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

Create Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_group_idVolume group 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

Create Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_group_idVolume group 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

Create Volume Recovery.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
name
required
stringRecovery volume namerecovery-volume

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.9.2 - 1.1

scpcli baremetal-blockstorage volume recovery create
--volume_id <value>
--snapshot_id <value>
--name <value>

Description

Create Volume Recovery.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
name
required
stringRecovery volume namerecovery-volume

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume Replication.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
region
required
stringRegionkr-west1
name
required
stringReplication volume namereplica-bs-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.10.2 - 1.1

scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>

Description

Create Volume Replication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
region
required
stringRegionkr-west1
name
required
stringReplication volume namereplica-bs-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.3.1.10.3 - 1.0

scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>

Description

Create Volume Replication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
region
required
stringRegionkr-west1
name
required
stringReplication volume namereplica-bs-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource 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

Create Volume snapshot.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.11.2 - 1.1

scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

Create Volume snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.11.3 - 1.0

scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

Create Volume snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_idVolume 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

Create Volume snapshot rate.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

Responses

NameDescriptionExample
is_snapshot_activatedWhether to activate snapshotTrue
snapshot_rateSnapshot rate100
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.12.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>

Description

Create Volume snapshot rate.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

Responses

NameDescriptionExample
is_snapshot_activatedWhether to activate snapshotTrue
snapshot_rateSnapshot rate100
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.12.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>

Description

Create Volume snapshot rate.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

Responses

NameDescriptionExample
is_snapshot_activatedWhether to activate snapshotTrue
snapshot_rateSnapshot rate100
volume_idVolume 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

Create Volume snapshot schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_idVolume 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

Create Volume snapshot schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_idVolume 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

Create Volume snapshot schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.14 - Delete Volume

3.3.1.14.1 - 1.2

scpcli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.14.2 - 1.1

scpcli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.14.3 - 1.0

scpcli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume 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

Delete Volume Group Replication.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.3.1.15.2 - 1.1

scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

Delete Volume Group Replication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.3.1.15.3 - 1.0

scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

Delete Volume Group Replication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group 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

Delete Volume Group snapshot.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.3.1.16.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>

Description

Delete Volume Group snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.3.1.16.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>

Description

Delete Volume Group snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group 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

Delete Volume Group Snapshot Schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.3.1.17.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.3.1.17.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group 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

Delete Volume Replication.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.18.2 - 1.1

scpcli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

Delete Volume Replication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.18.3 - 1.0

scpcli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

Delete Volume Replication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume 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

Delete Volume snapshot.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.19.2 - 1.1

scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete Volume snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.19.3 - 1.0

scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete Volume snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume 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

Delete Volume snapshot rate.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.20.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

Delete Volume snapshot rate.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.20.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

Delete Volume snapshot rate.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume 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

Delete Volume snapshot schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.21.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

Delete Volume snapshot schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.21.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

Delete Volume snapshot schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume 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

Detach Volume from servers.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of object id to detach-

3.3.1.22.2 - 1.1

scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

Detach Volume from servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of object id to detach-

3.3.1.22.3 - 1.0

scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

Detach Volume from servers.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of object id to detach-

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

Get a list of Volume Group snapshots.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___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

Get a list of Volume Group snapshots.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___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

Get a list of Volume Group snapshots.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___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

Get a list of Volume Groups.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idVolume group idc9ecae8b973b425c81c3817893cd8063
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
created_atCreated at2024-08-01T07:06:23.315Z
created_byCreated bysamsung-cloud-platform1@samsung.com
modified_atModified at2024-08-01T07:06:25.315Z
modified_byModified bysamsung-cloud-platform2@samsung.com
nameVolume group namevg-01
num_of_block_storagesNumber of volumes2
purposeVolume group purposeORG
stateCurrent state

3.3.1.24.2 - 1.1

scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]

Description

Get a list of Volume Groups.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idVolume group idc9ecae8b973b425c81c3817893cd8063
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
created_atCreated at2024-08-01T07:06:23.315Z
created_byCreated bysamsung-cloud-platform1@samsung.com
modified_atModified at2024-08-01T07:06:25.315Z
modified_byModified bysamsung-cloud-platform2@samsung.com
nameVolume group namevg-01
num_of_block_storagesNumber of volumes2
purposeVolume group purposeORG
stateCurrent state

3.3.1.24.3 - 1.0

scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]

Description

Get a list of Volume Groups.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idVolume group idc9ecae8b973b425c81c3817893cd8063
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
created_atCreated at2024-08-01T07:06:23.315Z
created_byCreated bysamsung-cloud-platform1@samsung.com
modified_atModified at2024-08-01T07:06:25.315Z
modified_byModified bysamsung-cloud-platform2@samsung.com
nameVolume group namevg-01
num_of_block_storagesNumber of volumes2
purposeVolume group purposeORG
stateCurrent 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

Get a list of Volume snapshots.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mbSnapshot size(MB)0

3.3.1.25.2 - 1.1

scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

Get a list of Volume snapshots.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mbSnapshot size(MB)0

3.3.1.25.3 - 1.0

scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

Get a list of Volume snapshots.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mbSnapshot size(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

Get a list of Volumes.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}]
created_atCreated at
created_byCreated bysamsung-cloud-platform1@samsung.com
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified bysamsung-cloud-platform2@samsung.com
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume 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

Get a list of Volumes.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}]
created_atCreated at
created_byCreated bysamsung-cloud-platform1@samsung.com
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified bysamsung-cloud-platform2@samsung.com
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume 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

Get a list of Volumes.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}]
created_atCreated at
created_byCreated bysamsung-cloud-platform1@samsung.com
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified bysamsung-cloud-platform2@samsung.com
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume 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

Remove Volume Group Member on Volume Group.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group 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

Remove Volume Group Member on Volume Group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group 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

Remove Volume Group Member on Volume Group.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group 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

Restore Volume Group snapshot.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.3.1.28.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>

Description

Restore Volume Group snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.3.1.28.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>

Description

Restore Volume Group snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group 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

Restore Volume from snapshot.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.29.2 - 1.1

scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

Restore Volume from snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.3.1.29.3 - 1.0

scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

Restore Volume from snapshot.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume 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

Set Volume Group Replication Cycle.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
cycle
required
stringReplication cycle-

3.3.1.30.2 - 1.1

scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>

Description

Set Volume Group Replication Cycle.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
cycle
required
stringReplication cycle-

3.3.1.30.3 - 1.0

scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>

Description

Set Volume Group Replication Cycle.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
cycle
required
stringReplication cycle-

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

Set Volume Group Replication Policy.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
policy
required
stringPolicy-

3.3.1.31.2 - 1.1

scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>

Description

Set Volume Group Replication Policy.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
policy
required
stringPolicy-

3.3.1.31.3 - 1.0

scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>

Description

Set Volume Group Replication Policy.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
policy
required
stringPolicy-

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

Set Volume Group Snapshot Schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
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

Set Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
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

Set Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
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

Change volume QoS

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume 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

Set Volume Replication Cycle.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
cycle
required
stringReplication cycle5MIN

3.3.1.34.2 - 1.1

scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

Set Volume Replication Cycle.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
cycle
required
stringReplication cycle5MIN

3.3.1.34.3 - 1.0

scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

Set Volume Replication Cycle.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
cycle
required
stringReplication cycle5MIN

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

Set Volume Replication Policy.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
policy
required
stringPolicy-

3.3.1.35.2 - 1.1

scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

Set Volume Replication Policy.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
policy
required
stringPolicy-

3.3.1.35.3 - 1.0

scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

Set Volume Replication Policy.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
policy
required
stringPolicy-

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

Set Volume snapshot rate.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

3.3.1.36.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>

Description

Set Volume snapshot rate.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

3.3.1.36.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>

Description

Set Volume snapshot rate.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

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

Set Volume snapshot schedule.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
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

Set Volume snapshot schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
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

Set Volume snapshot schedule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
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

Show Volume.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume detail

3.3.1.38.2 - 1.1

scpcli baremetal-blockstorage volume show
--volume_id <value>

Description

Show Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume detail

3.3.1.38.3 - 1.0

scpcli baremetal-blockstorage volume show
--volume_id <value>

Description

Show Volume.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume detail

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

Show Volume Group

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group detail

3.3.1.39.2 - 1.1

scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

Show Volume Group

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group detail

3.3.1.39.3 - 1.0

scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

Show Volume Group

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group detail

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

Show Volume Group Replication

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group replication detail

3.3.1.40.2 - 1.1

scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

Show Volume Group Replication

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group replication detail

3.3.1.40.3 - 1.0

scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

Show Volume Group Replication

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group replication detail

3.3.1.41 - Show Volume Replication

3.3.1.41.1 - 1.2

scpcli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume replication detail

3.3.1.41.2 - 1.1

scpcli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume replication detail

3.3.1.41.3 - 1.0

scpcli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume replication detail

3.4 - File Storage

Overview

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

This guide provides a brief description of File Storage service and how to call 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

Create snapshot

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namemy_volume.2024-10-01_14215
stateSnapshot Stateavailable
sizeSnapshot Size100
created_atCreated At2024-07-30T04:54:33.219373
volume_idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.1.2 - 1.0

scpcli filestorage volume snapshot create
--volume_id <value>

Description

Create snapshot

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namemy_volume.2024-10-01_14215
stateSnapshot Stateavailable
sizeSnapshot Size100
created_atCreated At2024-07-30T04:54:33.219373
volume_idVolume IDbfdbabf2-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

Create snapshot schedule

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
hour
required
stringHour of the snapshot schedule23
frequency
required
stringFrequency of the snapshotWEEKLY
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
snapshot_retention_count
optional
integerRetention count10
day_of_week
optional
stringDay of week of the snapshot scheduleMON

Responses

NameDescriptionExample
frequencyFrequency of the snapshotWEEKLY
day_of_weekDay of week of the snapshot scheduleMON
hourHour of the snapshot schedule23

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

Create snapshot schedule

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
hour
required
stringHour of the snapshot schedule23
frequency
required
stringFrequency of the snapshotWEEKLY
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
snapshot_retention_count
optional
integerRetention count10
day_of_week
optional
stringDay of week of the snapshot scheduleMON

Responses

NameDescriptionExample
frequencyFrequency of the snapshotWEEKLY
day_of_weekDay of week of the snapshot scheduleMON
hourHour of the snapshot schedule23

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

Create volume

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
type_name
required
stringVolume Type NameHDD
protocol
required
stringProtocolNFS
name
required
stringVolume Namemy_volume
snapshot_id
optional
stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
cifs_password
optional
stringCIFS Passwordcifspwd0!!
tags
optional
array'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
protocolProtocolNFS
snapshot_idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
type_nameVolume Type NameHDD
volume_idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_nameVolume Namemy_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

Create volume

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
type_name
required
stringVolume Type NameHDD
protocol
required
stringProtocolNFS
name
required
stringVolume Namemy_volume
snapshot_id
optional
stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
cifs_password
optional
stringCIFS Passwordcifspwd0!!
tags
optional
array'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
protocolProtocolNFS
snapshot_idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
type_nameVolume Type NameHDD
volume_idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_nameVolume Namemy_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

Create Volume Replication

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
replication_type
required
stringReplication Typereplication
volume_id
required
stringSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
region
required
stringTarget Regionkr-west1
replication_frequency
required
stringFrequency5min
name
required
stringTarget Volume Namemy_volume
cifs_password
optional
stringCIFS Passwordcifspwd0!!
backup_retention_count
optional
integerBackup Retention Count2

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_statusReplication Statuscreating
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
protocolProtocolNFS
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-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

Create Volume Replication

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
replication_type
required
stringReplication Typereplication
volume_id
required
stringSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
region
required
stringTarget Regionkr-west1
replication_frequency
required
stringFrequency5min
name
required
stringTarget Volume Namemy_volume
cifs_password
optional
stringCIFS Passwordcifspwd0!!
backup_retention_count
optional
integerBackup Retention Count2

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_statusReplication Statuscreating
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
protocolProtocolNFS
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-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

Delete snapshots

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.5.2 - 1.0

scpcli filestorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete snapshots

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required
stringVolume IDbfdbabf2-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

Delete snapshot schedule

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
stringSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
stringVolume IDbfdbabf2-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

Delete snapshot schedule

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
stringSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.7 - DeleteVolume

3.4.1.7.1 - 1.1

scpcli filestorage volume delete
--volume_id <value>

Description

Delete volume

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.7.2 - 1.0

scpcli filestorage volume delete
--volume_id <value>

Description

Delete volume

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-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

Delete Volume Replication

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
replication_id
required
stringReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.8.2 - 1.0

scpcli filestorage volume replication delete
--replication_id <value>
--volume_id <value>

Description

Delete Volume Replication

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
replication_id
required
stringReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
stringVolume IDbfdbabf2-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

List access rules

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
access_rule_stateAccess Rule Stateactive
object_typeObject TypeVM
object_idObject ID43fq3347-02q4-4aa8-ccf9-affe4917bb6f

3.4.1.9.2 - 1.0

scpcli filestorage volume access rule list
--volume_id <value>

Description

List access rules

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
access_rule_stateAccess Rule Stateactive
object_typeObject TypeVM
object_idObject ID43fq3347-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

List snapshots

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namemy_volume.2024-10-01_14215
stateSnapshot Stateavailable
sizeSnapshot Size100
created_atCreated At2024-07-30T04:54:33.219373

3.4.1.10.2 - 1.0

scpcli filestorage volume snapshot list
--volume_id <value>

Description

List snapshots

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namemy_volume.2024-10-01_14215
stateSnapshot Stateavailable
sizeSnapshot Size100
created_atCreated At2024-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

List snapshot schedule

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
frequencyFrequency of the snapshotWEEKLY
day_of_weekDay of week of the snapshot scheduleMON
hourHour of the snapshot schedule23

3.4.1.11.2 - 1.0

scpcli filestorage volume snapshot schedule list
--volume_id <value>

Description

List snapshot schedule

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
frequencyFrequency of the snapshotWEEKLY
day_of_weekDay of week of the snapshot scheduleMON
hourHour of the snapshot schedule23

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

List Volume Replication Region

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
replication_type
required
stringReplication Typereplication
source_region_name
required
stringRegionkr-west1
type_name
optional
stringVolume Type NameHDD

Responses

NameDescriptionExample
regionsReplication Region List[‘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

List Volume Replication Region

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
replication_type
required
stringReplication Typereplication
source_region_name
required
stringRegionkr-west1
type_name
optional
stringVolume Type NameHDD

Responses

NameDescriptionExample
regionsReplication Region List[‘kr-west1’]

3.4.1.13 - ListVolumeReplications

3.4.1.13.1 - 1.1

scpcli filestorage volume replication list
--volume_id <value>

Description

List Volume Replications

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequencyFrequency5min
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
source_volume_access_levelSource Access Levelro
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-west1
replication_volume_access_levelTarget Access Levelro
replication_typeReplication Typereplication

3.4.1.13.2 - 1.0

scpcli filestorage volume replication list
--volume_id <value>

Description

List Volume Replications

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequencyFrequency5min
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
source_volume_access_levelSource Access Levelro
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-west1
replication_volume_access_levelTarget Access Levelro
replication_typeReplication Typereplication

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

List volumes

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
offset
optional
integeroffset-
limit
optional
integerlimit-
name
optional
stringVolume Namemy_volume
type_name
optional
stringVolume Type NameHDD
sort
optional
stringsort-

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
protocolProtocolNFS
stateVolume Stateavailable
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
created_atCreated At2024-07-30T04:54:33.219373
type_idVolume Type IDjef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_nameVolume Type NameHDD
purposePurposereplication

3.4.1.14.2 - 1.0

scpcli filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--type_name <value>]
[--sort <value>]

Description

List volumes

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
offset
optional
integeroffset-
limit
optional
integerlimit-
name
optional
stringVolume Namemy_volume
type_name
optional
stringVolume Type NameHDD
sort
optional
stringsort-

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
protocolProtocolNFS
stateVolume Stateavailable
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
created_atCreated At2024-07-30T04:54:33.219373
type_idVolume Type IDjef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_nameVolume Type NameHDD
purposePurposereplication

3.4.1.15 - RestoreSnapshot

3.4.1.15.1 - 1.1

scpcli filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>

Description

Restore snapshot

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

3.4.1.15.2 - 1.0

scpcli filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>

Description

Restore snapshot

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required
stringVolume IDbfdbabf2-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

Set access rule for volume

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
action
required
stringAccess Rule Actionadd
object_type
required
stringObject TypeVM
object_id
required
stringObject ID43fq3347-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

Set access rule for volume

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
action
required
stringAccess Rule Actionadd
object_type
required
stringObject TypeVM
object_id
required
stringObject ID43fq3347-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

Set snapshot schedule

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
stringSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
hour
required
stringHour of the snapshot schedule23
frequency
required
stringFrequency of the snapshotWEEKLY
snapshot_retention_count
optional
integerRetention count10
day_of_week
optional
stringDay of week of the snapshot scheduleMON

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

Set snapshot schedule

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
stringSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
hour
required
stringHour of the snapshot schedule23
frequency
required
stringFrequency of the snapshotWEEKLY
snapshot_retention_count
optional
integerRetention count10
day_of_week
optional
stringDay of week of the snapshot scheduleMON

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

Set volume

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
file_unit_recovery_enabled
required
booleanVolume File Unit Recovery EnabledTrue

3.4.1.18.2 - 1.0

scpcli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>

Description

Set volume

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
file_unit_recovery_enabled
required
booleanVolume File Unit Recovery EnabledTrue

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

Set Volume Replication

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
replication_id
required
stringReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_update_type
required
stringReplication Update Typepolicy
replication_policy
optional
****Policyuse
replication_frequency
optional
****Frequency5min
backup_retention_count
optional
integerBackup Retention Count2

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

Set Volume Replication

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
replication_id
required
stringReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_update_type
required
stringReplication Update Typepolicy
replication_policy
optional
****Policyuse
replication_frequency
optional
****Frequency5min
backup_retention_count
optional
integerBackup Retention Count2

3.4.1.20 - ShowVolume

3.4.1.20.1 - 1.1

scpcli filestorage volume show
--volume_id <value>

Description

Show volume

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
protocolProtocolNFS
stateVolume Stateavailable
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
created_atCreated At2024-07-30T04:54:33.219373
type_idVolume Type IDjef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_nameVolume Type NameHDD
purposePurposereplication
pathVolume Mount Pathxxx.xx.xxx:/xxxxxxxx
usageVolume Usage100000
encryption_enabledVolume Encryption EnabledTrue
file_unit_recovery_enabledVolume File Unit Recovery EnabledTrue
cifs_idCIFS IDcifsid
endpoint_pathVolume Endpoint Pathxxx.xx.xxx.xxx

3.4.1.20.2 - 1.0

scpcli filestorage volume show
--volume_id <value>

Description

Show volume

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
protocolProtocolNFS
stateVolume Stateavailable
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
created_atCreated At2024-07-30T04:54:33.219373
type_idVolume Type IDjef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_nameVolume Type NameHDD
purposePurposereplication
pathVolume Mount Pathxxx.xx.xxx:/xxxxxxxx
usageVolume Usage100000
encryption_enabledVolume Encryption EnabledTrue
file_unit_recovery_enabledVolume File Unit Recovery EnabledTrue
cifs_idCIFS IDcifsid
endpoint_pathVolume Endpoint Pathxxx.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

Show Volume Replication

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
replication_id
required
stringReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequencyFrequency5min
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
source_volume_access_levelSource Access Levelro
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-west1
replication_volume_access_levelTarget Access Levelro
replication_typeReplication Typereplication
source_volume_nameSource Volume Namemy_volume
replication_policyPolicyuse
replication_statusReplication Statuscreating
replication_volume_nameTarget Volume Namemy_volume
backup_retention_countBackup Retention Count2

3.4.1.21.2 - 1.0

scpcli filestorage volume replication show
--replication_id <value>
--volume_id <value>

Description

Show Volume Replication

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
replication_id
required
stringReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequencyFrequency5min
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
source_volume_access_levelSource Access Levelro
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-west1
replication_volume_access_levelTarget Access Levelro
replication_typeReplication Typereplication
source_volume_nameSource Volume Namemy_volume
replication_policyPolicyuse
replication_statusReplication Statuscreating
replication_volume_nameTarget Volume Namemy_volume
backup_retention_countBackup Retention Count2

3.5 - Parallel File Storage

Overview

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

This guide provides a brief description of Parallel File Storage service and how to call 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

Create snapshot

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
snapshotSnapshot

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

Create volume

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
capacity_tb
required
integerVolume Capacity100
name
required
stringVolume Namemy_volume
tags
optional
array'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
stateVolume Stateavailable
created_atCreated At2024-07-30T04:54:33.219373
capacity_tbVolume Capacity100
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c

3.5.1.3 - DeleteSnapshot

3.5.1.3.1 - 1.0

scpcli parallel-filestorage snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete snapshot

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required
stringVolume IDbfdbabf2-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

Delete volume

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-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

List access rule

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
object_idObject ID43fq3347-02q4-4aa8-ccf9-affe4917bb6f
object_typeObject TypeGPU_NODE
object_nameObject Nameobjectname
object_stateObject StateRUNNING
access_stateAccess Stateall
access_ip_list

3.5.1.6 - ListSnapshots

3.5.1.6.1 - 1.0

scpcli parallel-filestorage snapshot list
--volume_id <value>

Description

List snapshots

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namesnapshot.2025-10-30_121212
sizeSnapshot Size100
stateSnapshot Stateavailable
created_atCreated At2024-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

List volumes

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
offset
optional
integeroffset-
limit
optional
integerlimit-
name
optional
stringVolume Namemy_volume
sort
optional
stringsort-

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
stateVolume Stateavailable
created_atCreated At2024-07-30T04:54:33.219373
capacity_tbVolume Capacity100
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c

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

Set access rule

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-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

Set volume capacity

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
capacity_tb
required
integerVolume Capacity100

3.5.1.10 - ShowVolume

3.5.1.10.1 - 1.0

scpcli parallel-filestorage volume show
--volume_id <value>

Description

Show volume

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
stateVolume Stateavailable
created_atCreated At2024-07-30T04:54:33.219373
capacity_tbVolume Capacity100
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
mount_pathVolume Mount Pathxxx.xx.xxx:/xxxxxxxx

4 - Container

4.1 - Container Registry

Overview

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

This guide provides a brief description of Container Registry service and how to call 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

check registry name duplication

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringRegistry namesample

Responses

NameDescriptionExample
resultName duplicatedTrue

4.1.1.1.2 - 1.0

scpcli scr registry name-duplication show
--name <value>

Description

check registry name duplication

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
name
required
stringRegistry namesample

Responses

NameDescriptionExample
resultName duplicatedTrue

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

check repository name duplication

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringRepository namesample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
resultName duplicatedTrue

4.1.1.2.2 - 1.0

scpcli scr repository name-duplication show
--name <value>
--registry_id <value>

Description

check repository name duplication

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
name
required
stringRepository namesample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
resultName duplicatedTrue

4.1.1.3 - Check Tags Vulnerability

4.1.1.3.1 - 1.1

scpcli scr tags scan set
--tags_id <value>

Description

check tags vulnerability

State ACTIVE (CURRENT)

VersionSupported Until
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

check tags vulnerability

State ACTIVE (SUPPORTED)

VersionSupported Until
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

create registry

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
public_visible_enabled
required
booleanPublic visible enabledTrue
public_acl_resources
required
arrayPublic ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_resources
required
arrayPrivate ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate ACL enabledTrue
name
required
stringRegistry namesample
public_acl_enabled
optional
booleanPublic ACL enabledTrue
public_endpoint_enabled
optional
booleanPublic endpoint enabledTrue
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
messageDescriptionCarpe diem.
stateRegistry stateRunning

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

create registry

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
public_visible_enabled
required
booleanPublic visible enabledTrue
public_acl_resources
required
arrayPublic ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_resources
required
arrayPrivate ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate ACL enabledTrue
name
required
stringRegistry namesample
public_acl_enabled
optional
booleanPublic ACL enabledTrue
public_endpoint_enabled
optional
booleanPublic endpoint enabledTrue
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
messageDescriptionCarpe diem.
stateRegistry stateRunning

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

create repository

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
locked
required
booleanLockedTrue
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
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 policy enabledTrue
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
name
required
stringRepository namesample
description
required
stringDescriptionCarpe diem.
tags
optional
arrayTag List'{"key": "", "value": ""}'
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

Responses

NameDescriptionExample
idRepository IDe5611ca6c1484df480668c5adce8b078
messageDescriptionCarpe diem.
stateRepository stateActive

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

create repository

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
locked
required
booleanLockedTrue
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle policy enabledTrue
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
name
required
stringRepository namesample
description
required
stringDescriptionCarpe diem.
tags
optional
arrayTag List'{"key": "", "value": ""}'
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

Responses

NameDescriptionExample
idRepository IDe5611ca6c1484df480668c5adce8b078
messageDescriptionCarpe diem.
stateRepository stateActive

4.1.1.6 - Delete Image

4.1.1.6.1 - 1.1

scpcli scr image delete
--image_id <value>

Description

delete image

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

4.1.1.6.2 - 1.0

scpcli scr image delete
--image_id <value>

Description

delete image

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

4.1.1.7 - Delete Registry

4.1.1.7.1 - 1.1

scpcli scr registry delete
--registry_id <value>

Description

delete registry

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

4.1.1.7.2 - 1.0

scpcli scr registry delete
--registry_id <value>

Description

delete registry

State ACTIVE (SUPPORTED)

VersionSupported Until
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

delete repository

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

4.1.1.8.2 - 1.0

scpcli scr repository delete
--repository_id <value>

Description

delete repository

State ACTIVE (SUPPORTED)

VersionSupported Until
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

delete tags

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
tag_names
required
arrayTag names[

4.1.1.9.2 - 1.0

scpcli scr tag delete
--tags_id <value>
--tag_names <value>

Description

delete tags

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
tag_names
required
arrayTag names[

4.1.1.10 - Delete Tagses

4.1.1.10.1 - 1.1

scpcli scr tags delete
--tags_ids <value>

Description

delete tagses

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
tags_ids
required
arrayTags IDs[

4.1.1.10.2 - 1.0

scpcli scr tags delete
--tags_ids <value>

Description

delete tagses

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
tags_ids
required
arrayTags IDs[

4.1.1.11 - Download Manifest

4.1.1.11.1 - 1.1

scpcli scr tags manifest show
--tags_id <value>

Description

download manifest file

State ACTIVE (CURRENT)

VersionSupported Until
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

download manifest file

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Responses

NameDescriptionExample
idResource ID558496f6c49d43459e61e191fb3c08fe
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
nameRegistry namesample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
typeResource typecontainer-registry

4.1.1.12.2 - 1.0

scpcli scr registry connectable-resource list

Description

get connectable domains

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Responses

NameDescriptionExample
idResource ID558496f6c49d43459e61e191fb3c08fe
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
nameRegistry namesample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
typeResource typecontainer-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

get images

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringImage namesample

Responses

NameDescriptionExample
idImage ID5b5ed4f2881a440583536fc1a8c39a28
created_atCreated at2024-08-15T13:05:09.701645823+09:00
modified_atModified at2024-08-16T16:06:09.701645823+09:00
nameImage namesample
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 count20
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
stateImage stateActive

4.1.1.13.2 - 1.0

scpcli scr repository image list
--repository_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]

Description

get images

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringImage namesample

Responses

NameDescriptionExample
idImage ID5b5ed4f2881a440583536fc1a8c39a28
created_atCreated at2024-08-15T13:05:09.701645823+09:00
modified_atModified at2024-08-16T16:06:09.701645823+09:00
nameImage namesample
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 count20
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
stateImage stateActive

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

get registries

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRegistry namesample
state
optional
stringRegistry stateRunning

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_nameBucket name4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry namesample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_visible_enabledPublic visible enabledTrue
stateRegistry stateRunning

4.1.1.14.2 - 1.0

scpcli scr registry list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]

Description

get registries

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRegistry namesample
state
optional
stringRegistry stateRunning

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_nameBucket name4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry namesample
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_visible_enabledPublic visible enabledTrue
stateRegistry stateRunning

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

get repositories

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRepository namesample

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRepository namesample
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
stateRepository stateActive

4.1.1.15.2 - 1.0

scpcli scr registry repository list
--registry_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]

Description

get repositories

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
name
optional
stringRepository namesample

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRepository namesample
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
stateRepository stateActive

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

get tagses

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
stringList of tags in reference["sample"]

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
hash_digestHash digest
last_scanned_atLast scanned at2024-08-15T13:05:09.701645823+09:00
lock_policyLock Policy
modified_atModified at2024-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_neededNeed for retrying vulnerability inspectionTrue
reference_tagsList of tags in reference[“sample”]
referenced_byReference necessity
scan_stateScanning stateScanning state
scan_summary
sizeSize10
stateTags stateActive

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

get tagses

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
stringList of tags in reference["sample"]

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
hash_digestHash digest
last_scanned_atLast scanned at2024-08-15T13:05:09.701645823+09:00
lock_policyLock Policy
modified_atModified at2024-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_neededNeed for retrying vulnerability inspectionTrue
reference_tagsList of tags in reference[“sample”]
referenced_byReference necessity
scan_stateScanning stateScanning state
scan_summary
sizeSize10
stateTags stateActive

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

Run Image Lifecycle Policy Preview

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample

4.1.1.17.2 - 1.0

scpcli scr image lifecycle-policy-preview run
--image_id <value>

Description

Run Image Lifecycle Policy Preview

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample

4.1.1.18 - Show Image

4.1.1.18.1 - 1.1

scpcli scr image show
--image_id <value>

Description

get image

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionCarpe diem.
lifecycle_policyLifecycle policy
lock_policyLock Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameImage namesample
pull_countPull count100
pull_policyPull policy
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
scan_policyScan policy
stateImage stateActive

4.1.1.18.2 - 1.0

scpcli scr image show
--image_id <value>

Description

get image

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionCarpe diem.
lifecycle_policyLifecycle policy
lock_policyLock Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameImage namesample
pull_countPull count100
pull_policyPull policy
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
scan_policyScan policy
stateImage stateActive

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

show image lifecycle policy preview

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
stringList of tags in reference["sample"]

Responses

NameDescriptionExample
created_atCreated at2024-08-15T13:05:09.701645823+09:00
hash_digestHash digest
reference_tagsList of tags in reference[“sample”]
stateTags stateActive

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

show image lifecycle policy preview

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
reference_tags
optional
stringList of tags in reference["sample"]

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
hash_digestHash digest
last_scanned_atLast scanned at2024-08-15T13:05:09.701645823+09:00
lock_policyLock Policy
modified_atModified at2024-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_neededNeed for retrying vulnerability inspectionTrue
reference_tagsList of tags in reference[“sample”]
referenced_byReference necessity
scan_stateScanning stateScanning state
scan_summary
sizeSize10
stateTags stateActive

4.1.1.20 - Show Registry

4.1.1.20.1 - 1.1

scpcli scr registry show
--registry_id <value>

Description

get registry

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_idBucket IDrpqtmqgec3174541bbf77eecf2cd3585
bucket_nameBucket name4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
bucket_usageBucket Usage
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry namesample
private_acl_enabledPrivate ACL enabledTrue
private_acl_resourcesPrivate ACL resources
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_acl_enabledPublic ACL enabledTrue
public_acl_resourcesPublic ACL resources
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_endpoint_enabledPublic endpoint enabledTrue
public_visible_enabledPublic visible enabledTrue
stateRegistry stateRunning

4.1.1.20.2 - 1.0

scpcli scr registry show
--registry_id <value>

Description

get registry

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
bucket_idBucket IDrpqtmqgec3174541bbf77eecf2cd3585
bucket_nameBucket name4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup
bucket_usageBucket Usage
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRegistry namesample
private_acl_enabledPrivate ACL enabledTrue
private_acl_resourcesPrivate ACL resources
private_domainPrivate Endpoint URLsample.scr.private.{region}.{environment}.samsungsdscloud.com
public_acl_enabledPublic ACL enabledTrue
public_acl_resourcesPublic ACL resources
public_domainPublic Endpoint URLsample.scr.{region}.{environment}.samsungsdscloud.com
public_endpoint_enabledPublic endpoint enabledTrue
public_visible_enabledPublic visible enabledTrue
stateRegistry stateRunning

4.1.1.21 - Show Repository

4.1.1.21.1 - 1.1

scpcli scr repository show
--repository_id <value>

Description

get repository

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionCarpe diem.
lifecycle_policyLifecycle policy
lock_policyLock Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRepository namesample
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 policy
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
scan_policyScan policy
stateRepository stateActive

4.1.1.21.2 - 1.0

scpcli scr repository show
--repository_id <value>

Description

get repository

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionCarpe diem.
lifecycle_policyLifecycle policy
lock_policyLock Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameRepository namesample
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 policy
registry_idRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
scan_policyScan policy
stateRepository stateActive

4.1.1.22 - Show Tags

4.1.1.22.1 - 1.1

scpcli scr tags show
--tags_id <value>

Description

get tags

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
created_atCreated at2024-08-15T13:05:09.701645823+09:00
hash_digestHash digest
image_idImage ID5b5ed4f2881a440583536fc1a8c39a28
lock_policyLock Policy
manifestManifest
manifest_media_typeManifest media type
modified_atModified at2024-08-16T16:06:09.701645823+09:00
reference_tagsList of tags in reference[“sample”]
registry_id
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
stateTags stateActive

4.1.1.22.2 - 1.0

scpcli scr tags show
--tags_id <value>

Description

get tags

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0

Responses

NameDescriptionExample
idTags IDb48210c7a226460fa15b6e3e221b30b0
created_atCreated at2024-08-15T13:05:09.701645823+09:00
hash_digestHash digest
image_idImage ID5b5ed4f2881a440583536fc1a8c39a28
lock_policyLock Policy
manifestManifest
manifest_media_typeManifest media type
modified_atModified at2024-08-16T16:06:09.701645823+09:00
reference_tagsList of tags in reference[“sample”]
registry_id
repository_idRepository IDe5611ca6c1484df480668c5adce8b078
stateTags stateActive

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

get tags packages

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS or languageJava
package_name
optional
stringPackage namecom.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20

Responses

NameDescriptionExample
categoryCategoryLanguage
os_languageOS or languageJava
package_namePackage namecom.example.sample
scan_summary
typePipeline typeos-pkg(binary)
versionPipeline version0.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

get tags packages

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS or languageJava
package_name
optional
stringPackage namecom.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20

Responses

NameDescriptionExample
categoryCategoryLanguage
os_languageOS or languageJava
package_namePackage namecom.example.sample
scan_summary
typePipeline typeos-pkg(binary)
versionPipeline version0.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

get tags secrets

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
file_name
optional
stringSecret file name/certs/sample-key1.key

Responses

NameDescriptionExample
categoryCategoryLanguage
file_nameSecret file name/certs/sample-key1.key
matchSecret match—–BEGIN SAMPLE KEY—–*********************…
rule_idRule IDprivate-key
severitySeverityHigh
start_lineSecret start line1
targetTarget/certs/sample-key1.key
titleSecret titleAsymmetric Private Key
vulnerability_classVulnerability classsecret

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

get tags secrets

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
file_name
optional
stringSecret file name/certs/sample-key1.key

Responses

NameDescriptionExample
categoryCategoryLanguage
file_nameSecret file name/certs/sample-key1.key
matchSecret match—–BEGIN SAMPLE KEY—–*********************…
rule_idRule IDprivate-key
severitySeverityHigh
start_lineSecret start line1
targetTarget/certs/sample-key1.key
titleSecret titleAsymmetric Private Key
vulnerability_classVulnerability classsecret

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

get tags vulnerabilities

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS or languageJava
package_name
optional
stringPackage namecom.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
update_version_available
optional
booleanUpdated versionTrue
severity
optional
arraySeverityH
category
optional
stringCategoryLanguage

Responses

NameDescriptionExample
attack_complexityAttack complexity
attack_vectorAttack vector
availabilityAvailability
confidentialityConfidentiality
integrityIntegrity
privileges_requiredNecessary authority
scopeAttack scope
user_interactionDegree of user participation

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

get tags vulnerabilities

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
os_language
optional
stringOS or languageJava
package_name
optional
stringPackage namecom.example.sample
sort
optional
stringsortname:asc
page
optional
integerpage0
size
optional
integersize20
update_version_available
optional
booleanUpdated versionTrue
severity
optional
arraySeverityH
category
optional
stringCategoryLanguage

Responses

NameDescriptionExample
attack_complexityAttack complexity
attack_vectorAttack vector
availabilityAvailability
confidentialityConfidentiality
integrityIntegrity
privileges_requiredNecessary authority
scopeAttack scope
user_interactionDegree of user participation

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

update image description

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
description
required
stringDescriptionCarpe diem.

4.1.1.26.2 - 1.0

scpcli scr image description set
--image_id <value>
--description <value>

Description

update image description

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
description
required
stringDescriptionCarpe 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

update image lifecycle-policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
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 policy enabledTrue

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

update image lifecycle-policy

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle policy enabledTrue

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

update image lock-policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
locked
required
booleanLockedTrue

4.1.1.28.2 - 1.0

scpcli scr image lock-policy set
--image_id <value>
--locked <value>

Description

update image lock-policy

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage 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

update image pull-policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

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

update image pull-policy

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

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

update image scan-policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue

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

update image scan-policy

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
image_id
required
stringImage ID5b5ed4f2881a440583536fc1a8c39a28
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue

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

update private acl

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
private_acl_resources
required
arrayPrivate ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate ACL enabledTrue

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

update private acl

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
private_acl_resources
required
arrayPrivate ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
private_acl_enabled
required
booleanPrivate ACL enabledTrue

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

update public acl

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_acl_resources
required
arrayPublic ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
public_acl_enabled
required
booleanPublic ACL enabledTrue

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

update public acl

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_acl_resources
required
arrayPublic ACL resources'{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}'
public_acl_enabled
required
booleanPublic ACL enabledTrue

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

update public endpoint enabled

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_endpoint_enabled
required
booleanPublic endpoint enabledTrue

4.1.1.33.2 - 1.0

scpcli scr registry public-endpoint-enabled set
--registry_id <value>
--public_endpoint_enabled <value>

Description

update public endpoint enabled

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
registry_id
required
stringRegistry IDrpqtmqgec3174541bbf77eecf2cd3585
public_endpoint_enabled
required
booleanPublic endpoint enabledTrue

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

update repository description

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
description
required
stringDescriptionCarpe diem.

4.1.1.34.2 - 1.0

scpcli scr repository description set
--repository_id <value>
--description <value>

Description

update repository description

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
description
required
stringDescriptionCarpe 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

update repository lifecycle-policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
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 policy enabledTrue

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

update repository lifecycle-policy

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
untagged_rule_enabled
required
booleanUntagged rule enabledTrue
untagged_rule_duration
required
integerUntagged rule duration90
outdated_rule_enabled
required
booleanTagged rule enabledTrue
outdated_rule_duration
required
integerTagged rule duration90
lifecycle_policy_enabled
required
booleanLifecycle policy enabledTrue

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

update repository lock-policy

State ACTIVE (CURRENT)

VersionSupported Until
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

update repository lock-policy

State ACTIVE (SUPPORTED)

VersionSupported Until
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

update repository pull-policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

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

update repository pull-policy

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
vulnerable_image_pull_prevented
required
booleanVulnerable image pull preventedTrue
unscanned_image_pull_prevented
required
booleanUnscanned image pull preventedTrue
unmodified_excepted
required
booleanUnmodified exceptionTrue
critical_limit
optional
integerCritical limit20
high_limit
optional
integerHigh limit20

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

update repository scan-policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue

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

update repository scan-policy

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
repository_id
required
stringRepository IDe5611ca6c1484df480668c5adce8b078
severity_limit
required
stringSeverity limitHigh
secret_excepted
required
booleanSecret exceptionTrue
scan_policy_enabled
required
booleanScan policy enabledTrue
language_excepted
required
booleanLanguage exceptionTrue
fixed_version_excepted
required
booleanFixed version exceptionTrue
auto_scan_enabled
required
booleanAuto scan enabledTrue

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

update tags lock

State ACTIVE (CURRENT)

VersionSupported Until
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

update tags lock

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260630

Parameters

NameTypeDescriptionExample
tags_id
required
stringTags IDb48210c7a226460fa15b6e3e221b30b0
locked
required
booleanLockedTrue

4.2 - Kubernetes

Overview

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

This guide provides a brief description of Kubernetes service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
volume_id
required
stringVolume ID['bfdbabf2-04d9-4e8b-a205-020f8e6da438']
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
service_watch_logging_enabled
required
booleanService Watch Enabledtrue
security_group_id_list
required
arraySecurity Group ID Listbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
name
required
stringCluster Namesample-cluster
kubernetes_version
required
stringCluster Versionv1.29.8
cloud_logging_enabled
required
booleanCloud Logging Enabledtrue
private_endpoint_access_control_resources
optional
arrayPrivate Endpoint Access Control Resources'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'
public_endpoint_access_control_ip
optional
stringPublic Endpoint Access Control IP192.168.0.0
tags
optional
arrayTag list'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
request_idRequest ID80a599e031e749b7b260868f441e862b
resource_idResource 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
volume_id
required
stringVolume ID['bfdbabf2-04d9-4e8b-a205-020f8e6da438']
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
security_group_id_list
required
arraySecurity Group ID Listbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
name
required
stringCluster Namesample-cluster
kubernetes_version
required
stringCluster Versionv1.29.8
cloud_logging_enabled
required
booleanCloud Logging Enabledtrue
private_endpoint_access_control_resources
optional
arrayPrivate Endpoint Access Control Resources'{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}'
public_endpoint_access_control_ip
optional
stringPublic Endpoint Access Control IP192.168.0.0
tags
optional
arrayTag list'{"key": "Key", "value": "Value"}'

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
request_idRequest ID80a599e031e749b7b260868f441e862b
resource_idResource 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig Type (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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig Type (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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
pod_max_pids
required
integerNode Pool Pod Max pids constraint4096
max_pods
required
integerNode Pool max pod number110
image_gc_low_threshold
required
integerNode Pool image GC low threshold percent80
image_gc_high_threshold
required
integerNode Pool image GC high threshold percent85
container_log_max_size
required
integerNode Pool container log max size10
container_log_max_files
required
integerNode Pool container log max files5
volume_type_name
required
stringVolume Type NameSSD
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type ID10a599e031e749b7b260868f441e862b
name
required
stringNodepool Namesample-nodepool
kubernetes_version
required
stringKubernetes Versionv1.29.8
keypair_name
required
stringKeypair Nametest_keypair
is_auto_scale
required
booleanIs Auto Scaletrue
is_auto_recovery
required
booleanIs Auto Recoverytrue
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
stringCustom Image ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
arrayNode Pool Labels'{"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
stringServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
taints
optional
arrayNode Pool Taints'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'
allowed_unsafe_sysctls
optional
stringNode Pool Allowed unsafe sysctlskernel.msg*,net.ipv4.route.min_pmtu

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settingsNode Pool Advanced Settings
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsNode Pool Labels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_group_idServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_typeServer Type
statusNode Pool StatusRunning
taintsNode Pool Taints
volume_sizeVolume Size104
volume_typeVolume 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
volume_type_name
required
stringVolume Type NameSSD
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type ID10a599e031e749b7b260868f441e862b
name
required
stringNodepool Namesample-nodepool
kubernetes_version
required
stringKubernetes Versionv1.29.8
keypair_name
required
stringKeypair Nametest_keypair
is_auto_scale
required
booleanIs Auto Scaletrue
is_auto_recovery
required
booleanIs Auto Recoverytrue
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
stringCustom Image ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
arrayNode Pool Labels'{"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
arrayNode Pool Taints'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsNode Pool Labels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_typeServer Type
statusNode Pool StatusRunning
taintsNode Pool Taints
volume_sizeVolume Size104
volume_typeVolume 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b

4.2.1.4.2 - 1.0

scpcli ske cluster delete
--cluster_id <value>

Description

delete a specific cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

4.2.1.5.2 - 1.0

scpcli ske nodepool delete
--nodepool_id <value>

Description

delete a nodepool

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster Namesample-cluster
status
optional
arrayCluster StatusR
kubernetes_version
optional
arrayCluster Versionv
subnet_id
optional
stringCluster Subnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idCluster ID70a599e031e749b7b260868f441e862b
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-03-31T00:23:17Z
kubernetes_versionCluster Versionv1.29.8
modified_atModified At2025-03-31T00:23:17Z
nameCluster Namesample-cluster
node_countCluster Node Count5
statusCluster StatusRUNNING
subnet_idCluster 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringCluster Namesample-cluster
status
optional
arrayCluster StatusR
kubernetes_version
optional
arrayCluster Versionv
subnet_id
optional
stringCluster Subnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idCluster ID70a599e031e749b7b260868f441e862b
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
created_atCreated At2025-03-31T00:23:17Z
kubernetes_versionCluster Versionv1.29.8
modified_atModified At2025-03-31T00:23:17Z
nameCluster Namesample-cluster
node_countCluster Node Count5
statusCluster StatusRUNNING
subnet_idCluster 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
node_name
optional
stringNode Nameske-aug-rhel-0805-1-84d799f767-8dr2p

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
kubernetes_versionKubernetes Versionv1.29.8
nameNode Nameske-aug-rhel-0805-1-84d799f767-8dr2p
statusNode StatusRUNNING

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
node_name
optional
stringNode Nameske-aug-rhel-0805-1-84d799f767-8dr2p

Responses

NameDescriptionExample
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
kubernetes_versionKubernetes Versionv1.29.8
nameNode Nameske-aug-rhel-0805-1-84d799f767-8dr2p
statusNode StatusRUNNING

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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
nodepool_name
optional
stringNodepool Namesample-nodepool

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabledIs Auto Recovery
auto_scale_enabledIs Auto Scale
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
kubernetes_versionKubernetes Versionv1.29.8
nameNodepool Namesample-nodepool
server_typeServer Type
statusNode Pool StatusRunning
volume_typeVolume 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
nodepool_name
optional
stringNodepool Namesample-nodepool

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabledIs Auto Recovery
auto_scale_enabledIs Auto Scale
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
kubernetes_versionKubernetes Versionv1.29.8
nameNodepool Namesample-nodepool
server_typeServer Type
statusNode Pool StatusRunning
volume_typeVolume 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
cloud_logging_enabled
required
booleanCloud Logging Enabledtrue

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
cloud_logging_enabled
required
booleanCloud Logging Enabledtrue

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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
public_endpoint_access_control_ip
required
stringPublic Endpoint Access Control 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
public_endpoint_access_control_ip
required
stringPublic Endpoint Access Control 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
security_group_id_list
required
arraySecurity Group ID Listb

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
security_group_id_list
required
arraySecurity Group ID Listb

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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
service_watch_logging_enabled
required
booleanService Watch Enabledtrue

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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubernetes_version
required
stringKubernetes Versionv1.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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubernetes_version
required
stringKubernetes Versionv1.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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
desired_node_count
optional
integerDesired Node Count2
is_auto_recovery
optional
booleanIs Auto Recoverytrue
is_auto_scale
optional
booleanIs Auto Scaletrue
max_node_count
optional
integerMax Node Count5
min_node_count
optional
integerMin Node Count1

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
desired_node_count
optional
integerDesired Node Count2
is_auto_recovery
optional
booleanIs Auto Recoverytrue
is_auto_scale
optional
booleanIs Auto Scaletrue
max_node_count
optional
integerMax Node Count5
min_node_count
optional
integerMin Node Count1

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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
os_version
required
stringImage OS Version22.04

4.2.1.18.2 - 1.0

scpcli ske nodepool upgrade set
--nodepool_id <value>

Description

upgrade a nodepool

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool 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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
cloud_logging_enabledCloud Logging Enabledtrue
cluster_namespaceCluster Namespacesample-cluster-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
kubernetes_versionCluster Versionv1.29.8
managed_security_groupManaged Security Group
max_node_countCluster Max Node Count5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster Namesample-cluster
node_countCluster Node Count5
private_endpoint_access_control_resourcesPrivate Endpoint Access Control Resources
private_endpoint_urlPrivate Kubeconfig Download YnN
private_kubeconfig_download_ynPrivate Endpoint URLhttps://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
public_endpoint_access_control_ipPublic Endpoint Access Control IP192.168.0.0
public_endpoint_urlPublic Endpoint URLhttps://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
public_kubeconfig_download_ynPublic Kubeconfig Download YnN
security_group_listConnected Security Group List
service_watch_logging_enabledService Watch Enabledtrue
statusCluster StatusRUNNING
subnetSubnet of Cluster
volumeConnected File Storage
vpcVPC of Cluster

4.2.1.19.2 - 1.0

scpcli ske cluster show
--cluster_id <value>

Description

show a cluster

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
cloud_logging_enabledCloud Logging Enabledtrue
cluster_namespaceCluster Namespacesample-cluster-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
kubernetes_versionCluster Versionv1.29.8
managed_security_groupManaged Security Group
max_node_countCluster Max Node Count5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCluster Namesample-cluster
node_countCluster Node Count5
private_endpoint_access_control_resourcesPrivate Endpoint Access Control Resources
private_endpoint_urlPrivate Kubeconfig Download YnN
private_kubeconfig_download_ynPrivate Endpoint URLhttps://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443
public_endpoint_access_control_ipPublic Endpoint Access Control IP192.168.0.0
public_endpoint_urlPublic Endpoint URLhttps://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443
public_kubeconfig_download_ynPublic Kubeconfig Download YnN
security_group_listConnected Security Group List
statusCluster StatusRUNNING
subnetSubnet of Cluster
volumeConnected File Storage
vpcVPC of Cluster

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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig Type (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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
kubeconfig_type
required
****Kubeconfig Type (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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settingsNode Pool Advanced Settings
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsNode Pool Labels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_group_idServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_typeServer Type
statusNode Pool StatusRunning
taintsNode Pool Taints
volume_sizeVolume Size104
volume_typeVolume Type

4.2.1.21.2 - 1.0

scpcli ske nodepool show
--nodepool_id <value>

Description

show a nodepool

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nodepool_id
required
stringNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsNode Pool Labels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_typeServer Type
statusNode Pool StatusRunning
taintsNode Pool Taints
volume_sizeVolume Size104
volume_typeVolume Type

5 - Networking

5.1 - Direct Connect

Overview

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

This guide provides a brief description of Direct Connect service and how to call 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

Create direct connect.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
name
required
stringDirect Connect Name-
bandwidth
required
integerPort Bandwidth-
description
optional
stringDirect Connect Description-
firewall_enabled
optional
booleanFirewall Use-
firewall_loggable
optional
booleanFirewall Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idDirect Connect ID
account_idAccount ID
bandwidthPort Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Description
firewall_idFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect Name
stateState
vpc_idVPC Id
vpc_nameVPC Name

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

Create a routing rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect ID-
destination_type
required
stringDestination Type-
destination_cidr
required
stringDestination CIDR-
description
optional
stringDescription-
destination_resource_id
optional
stringDestination Resource ID-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destination_cidrDestination CIDR
destination_resource_idDestination Resource ID
destination_resource_nameDestination Resource Name
destination_typeDestination Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule Owner ID
owner_typeRouting Rule Owner Type
stateState

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

Delete direct connect.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete a routing rule.

State ACTIVE (CURRENT)

VersionSupported Until
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

Get direct connect list.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringDirect Connect ID-
name
optional
stringDirect Connect Name-
state
optional
****State-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-

Responses

NameDescriptionExample
idDirect Connect ID
account_idAccount ID
bandwidthPort Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Description
firewall_idFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect Name
stateState
vpc_idVPC Id
vpc_nameVPC Name

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

Get routing rule list.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect ID-
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID-
destination_type
optional
****Destination Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destination_cidrDestination CIDR
destination_resource_idDestination Resource ID
destination_resource_nameDestination Resource Name
destination_typeDestination Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule Owner ID
owner_typeRouting Rule Owner Type
stateState

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

Set direct connect.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect ID-
description
required
stringDirect Connect Description-

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

Show direct connect.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect ID-

Responses

NameDescriptionExample
idDirect Connect ID
account_idAccount ID
bandwidthPort Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Description
firewall_idFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect Name
stateState
vpc_idVPC Id
vpc_nameVPC Name

5.2 - DNS

Overview

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

This guide provides a brief description of DNS service and how to call CLI. The output is formatted as a JSON string

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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

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

This guide provides a brief description of Firewall service and how to call CLI. The output is formatted as a JSON string

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

Create firewall rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
status
required
stringFirewall Rule Status-
source_address
required
arraySource Address192.168.1.1
service
required
arrayService Port'{"service_type": "TCP", "service_value": "443"}'
direction
required
stringFirewall Rule Direction-
destination_address
required
arrayDestination Address10.0.0.1
action
required
stringFirewall Rule Action-
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
description
optional
stringFirewall Rule DescriptionFirewall rule description example
order_direction
optional
stringOrder Direction-
order_rule_id
optional
stringOrder Rule ID043aa63459da466faad71fe4fe587031

Responses

NameDescriptionExample
idFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall Rule Action
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall Rule DescriptionFirewall rule description example
destination_addressDestination Address[‘10.0.0.1’, ‘10.0.0.2’]
destination_interfaceDestination Interface NameIFW1-v1001dn
directionFirewall Rule Direction
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall Rule Nameb156740b6335468d8354eb9ef8eddf5a
sequenceFirewall Rule Sequence100
serviceService Port
source_addressSource Address[‘192.168.1.1’, ‘192.168.1.2’]
source_interfaceSource Interface NameIFW1-v2501up
stateFirewall Rule State
statusFirewall Rule Status
vendor_rule_idVendor Rule 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

Delete firewall rule.

State ACTIVE (CURRENT)

VersionSupported Until
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

Get firewall rule list.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
src_ip
optional
stringSource IP192.168.1.1
dst_ip
optional
stringDestination IP192.168.1.1
description
optional
stringFirewall Rule DescriptionFirewall rule description example
state
optional
arrayFirewall Rule State-
status
optional
****Firewall Rule Status-
fetch_all
optional
booleanFirewall Rule Fetch ALL-

Responses

NameDescriptionExample
idFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall Rule Action
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall Rule DescriptionFirewall rule description example
destination_addressDestination Address[‘10.0.0.1’, ‘10.0.0.2’]
destination_interfaceDestination Interface NameIFW1-v1001dn
directionFirewall Rule Direction
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall Rule Nameb156740b6335468d8354eb9ef8eddf5a
sequenceFirewall Rule Sequence100
serviceService Port
source_addressSource Address[‘192.168.1.1’, ‘192.168.1.2’]
source_interfaceSource Interface NameIFW1-v2501up
stateFirewall Rule State
statusFirewall Rule Status
vendor_rule_idVendor Rule 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

Get firewall list.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringFirewall NameFW_IGW_secuVPC
vpc_name
optional
stringVPC NamesecuVPC
product_type
optional
arrayFirewall Product Type-
state
optional
arrayFirewall State-

Responses

NameDescriptionExample
idFirewall IDb156740b6335468d8354eb9ef8eddf5a
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
flavor_nameFirewall Size NameSMALL
flavor_rule_quotaFirewall Rule Quota100
fw_resource_idFw Resource ID005fd1d30dea11f08a2c56773bef875b
loggableLogging UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall NameFW_IGW_secuVPC
pre_product_idPre Product ID76479b7ffee1431198d9beb4502cda08
product_typeFirewall Product Type
stateFirewall State
statusFirewall Status
total_rule_countTotal Rule Count8
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NamesecuVPC

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

Set firewall.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
flavor_name
optional
stringFirewall Size Name-
loggable
optional
booleanLogging UseFalse

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

Set firewall rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
source_address
required
arraySource Address192.168.1.1
service
required
arrayService Port'{"service_type": "TCP", "service_value": "443"}'
direction
required
stringFirewall Rule Direction-
destination_address
required
arrayDestination Address10.0.0.1
action
required
stringFirewall Rule Action-
description
optional
stringFirewall Rule DescriptionFirewall rule description example

5.3.1.7 - Show Firewall

5.3.1.7.1 - 1.0

scpcli firewall firewall show
--firewall_id <value>

Description

Show firewall.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idFirewall IDb156740b6335468d8354eb9ef8eddf5a
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
flavor_nameFirewall Size NameSMALL
flavor_rule_quotaFirewall Rule Quota100
fw_resource_idFw Resource ID005fd1d30dea11f08a2c56773bef875b
loggableLogging UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall NameFW_IGW_secuVPC
pre_product_idPre Product ID76479b7ffee1431198d9beb4502cda08
product_typeFirewall Product Type
stateFirewall State
statusFirewall Status
total_rule_countTotal Rule Count8
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NamesecuVPC

5.3.1.8 - Show Firewall Rule

5.3.1.8.1 - 1.0

scpcli firewall firewall-rule show
--firewall_rule_id <value>

Description

Show firewall rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall Rule Action
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall Rule DescriptionFirewall rule description example
destination_addressDestination Address[‘10.0.0.1’, ‘10.0.0.2’]
destination_interfaceDestination Interface NameIFW1-v1001dn
directionFirewall Rule Direction
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall Rule Nameb156740b6335468d8354eb9ef8eddf5a
sequenceFirewall Rule Sequence100
serviceService Port
source_addressSource Address[‘192.168.1.1’, ‘192.168.1.2’]
source_interfaceSource Interface NameIFW1-v2501up
stateFirewall Rule State
statusFirewall Rule Status
vendor_rule_idVendor Rule ID72

5.4 - Global CDN

Overview

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

This guide provides a brief description of Global CDN service and how to call CLI. The output is formatted as a JSON string

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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-
description
required
stringDescription-

5.5 - GSLB

Overview

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

This guide provides a brief description of GSLB service and how to call CLI. The output is formatted as a JSON string

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

The GSLB Create.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
protocol
required
stringThe GSLB Health Check Protocol.-
resources
required
array'{"description": "", "destination": "", "region": "", "weight": 0}'
name
required
stringThe Name of the gslb.-
env_usage
required
stringThe GSLB Environment Usage.-
algorithm
required
stringThe GSLB Algorithm.-
description
optional
stringDescription-
tags
optional
arrayTag List'{"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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
health_check
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

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

The GSLB Create.

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
protocol
required
stringThe GSLB Health Check Protocol.-
resources
required
array'{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}'
name
required
stringThe Name of the gslb.-
env_usage
required
stringThe GSLB Environment Usage.-
algorithm
required
stringThe GSLB Algorithm.-
description
optional
stringDescription-
tags
optional
arrayTag List'{"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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
health_check
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

5.5.1.2 - DeleteGslb

5.5.1.2.1 - 1.1

scpcli gslb gslb delete
--gslb_id <value>

Description

The GSLB Delete.

State ACTIVE (CURRENT)

VersionSupported Until
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

The GSLB Delete.

State ACTIVE (SUPPORTED)

VersionSupported Until
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

The GSLB Resource List.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destinationThe GSLB Resource Destination.
health_check_statusThe GSLB Resource Health Check Status.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
regionThe GSLB Resource Region.
statusThe GSLB Resource Status.
weightThe GSLB Resource Weight.

5.5.1.3.2 - 1.0

scpcli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

The GSLB Resource List.

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destinationThe GSLB Resource Destination.
disabledThe GSLB Resource disabled.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
regionThe GSLB Resource Region.
weightThe GSLB Resource Weight.

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

The GSLB List.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
state
optional
stringThe GSLB State.-
name
optional
stringThe Name of the gslb.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

5.5.1.4.2 - 1.0

scpcli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]

Description

The GSLB List.

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
state
optional
stringThe GSLB State.-
name
optional
stringThe Name of the gslb.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

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

The GSLB Regional Resource List.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
region
optional
stringThe GSLB Resource Region.-
status
optional
stringThe GSLB Resource Status.-
name
optional
stringThe Name of the gslb.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
linked_regional_resource_countThe GSLB Linked Resource Count Per Region.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
regionThe GSLB Resource Region.
statusThe GSLB Resource Status.

5.5.1.6 - SetGslb

5.5.1.6.1 - 1.1

scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]

Description

The GSLB Set.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
algorithm
optional
stringThe GSLB Algorithm.-
description
optional
stringDescription-

5.5.1.6.2 - 1.0

scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]

Description

The GSLB Set.

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
algorithm
optional
stringThe GSLB Algorithm.-
description
optional
stringDescription-

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

Set GSLB Health Checks.

State ACTIVE (CURRENT)

VersionSupported Until
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

Set GSLB Health Checks.

State ACTIVE (SUPPORTED)

VersionSupported Until
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

Set GSLB Regional Routing.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
status
required
stringThe GSLB Resource Status.-
region
required
stringThe GSLB Resource Region.-

5.5.1.9 - SetGslbResources

5.5.1.9.1 - 1.1

scpcli gslb gslb-resource update
--gslb_id <value>
--resources <value>

Description

Set GSLB Resources.

State ACTIVE (CURRENT)

VersionSupported Until
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

Set GSLB Resources.

State ACTIVE (SUPPORTED)

VersionSupported Until
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

The GSLB Show.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
health_check
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

5.5.1.10.2 - 1.0

scpcli gslb gslb show
--gslb_id <value>

Description

The GSLB Show.

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
health_check
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

5.6 - Load Balancer

Overview

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

This guide provides a brief description of LOADBALANCER service and how to call CLI. The output is formatted as a JSON string

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

Add Lb Server Group Member bulk

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
lb_server_group_idID of Lb Server Group
member_ipIP of Member
member_portProtocol port of Member
member_stateMember State of Member
member_weightWeight of Member
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of Member
object_idObject ID of Member
object_typeObject Type of Member
stateState of Member
subnet_idID of Subnet
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

Add Lb Server Group Member bulk

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
lb_server_group_idID of Lb Server Group
member_ipIP of Member
member_portProtocol port of Member
member_stateMember State of Member
member_weightWeight of Member
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of Member
object_idObject ID of Member
object_typeObject Type of Member
stateState of Member
subnet_idID of Subnet
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

Create LB Health Check

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
stringLB Health Check ProtocolTCP
name
required
stringLB Health Check nameServerGroup01
description
optional
stringDescriptionthis is an lb server group
health_check_count
optional
integerLB Health Check count3
health_check_interval
optional
integerLB Health Check interval5
health_check_port
optional
integerLB Health Check port80
health_check_timeout
optional
integerLB Health Check timeout5
health_check_url
optional
stringLB Health Check URL/test
http_method
optional
****LB Health Check HTTP MethodGET
request_data
optional
stringLB Health Check Request datausername=admin&password=1234
response_code
optional
stringLB Health Check Response code200
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
health_check_countLB Health Check count3
health_check_intervalLB Health Check interval5
health_check_portLB Health Check port80
health_check_timeoutLB Health Check timeout5
health_check_typeLB Health Check typeDEFAULT
health_check_urlLB Health Check URL/test
http_methodLB Health Check HTTP MethodGET
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
request_dataLB Health Check Request datausername=admin&password=1234
response_codeLB Health Check Response code200
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

Create LB Health Check

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
stringLB Health Check ProtocolTCP
name
required
stringLB Health Check nameServerGroup01
description
optional
stringDescriptionthis is an lb server group
health_check_count
optional
integerLB Health Check count3
health_check_interval
optional
integerLB Health Check interval5
health_check_port
optional
integerLB Health Check port80
health_check_timeout
optional
integerLB Health Check timeout5
health_check_url
optional
stringLB Health Check URL/test
http_method
optional
****LB Health Check HTTP MethodGET
request_data
optional
stringLB Health Check Request datausername=admin&password=1234
response_code
optional
stringLB Health Check Response code200
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
health_check_countLB Health Check count3
health_check_intervalLB Health Check interval5
health_check_portLB Health Check port80
health_check_timeoutLB Health Check timeout5
health_check_typeLB Health Check typeDEFAULT
health_check_urlLB Health Check URL/test
http_methodLB Health Check HTTP MethodGET
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
request_dataLB Health Check Request datausername=admin&password=1234
response_codeLB Health Check Response code200
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

create LB listener

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
service_port
required
integerThe port of the listener.-
routing_action
required
stringThe routing action of the listener.-
protocol
required
stringprotocol-
name
required
stringThe name of the listener.-
loadbalancer_id
required
stringThe ID of the load balancer.-
condition_type
optional
****The condition type of the listener.-
description
optional
stringdescription-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
stringThe persistence of the listener.-
response_timeout
optional
integerThe response timeout of the listener.-
server_group_id
optional
stringThe ID of the server group.-
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
arrayThe URL handler of the listener.-
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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
https_redirectionThe https redirection of the listener.
insert_client_ipWhether the client IP should be inserted.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
persistenceThe persistence of the listener.
protocolThe protocol of the listener.
response_timeoutThe response timeout of the listener.
routing_actionThe routing action of the listener.
server_group_idThe ID of the server group.
server_group_nameThe Name of the server group.
service_portThe port of the listener.
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateThe ssl certificate of the listener.
stateThe State of the listener.
support_http2Whether the HTTP 2.0 is supported
url_handlerThe URL handler of the listener.
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

create LB listener

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
service_port
required
integerThe port of the listener.-
routing_action
required
stringThe routing action of the listener.-
protocol
required
stringprotocol-
name
required
stringThe name of the listener.-
loadbalancer_id
required
stringThe ID of the load balancer.-
condition_type
optional
****The condition type of the listener.-
description
optional
stringdescription-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
stringThe persistence of the listener.-
response_timeout
optional
integerThe response timeout of the listener.-
server_group_id
optional
stringThe ID of the server group.-
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
arrayThe URL handler of the listener.-
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
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
https_redirectionThe https redirection of the listener.
insert_client_ipWhether the client IP should be inserted.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
persistenceThe persistence of the listener.
protocolThe protocol of the listener.
response_timeoutThe response timeout of the listener.
routing_actionThe routing action of the listener.
server_group_idThe ID of the server group.
server_group_nameThe Name of the server group.
service_portThe port of the listener.
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateThe ssl certificate of the listener.
stateThe State of the listener.
support_http2Whether the HTTP 2.0 is supported
url_handlerThe URL handler of the listener.
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

Create LB Server Group

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
stringProtocolTCP
name
required
stringLB Health Check nameServerGroup01
lb_method
required
stringLB MethodROUND_ROBIN
description
optional
stringDescriptionthis is an lb server group
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_methodLB MethodROUND_ROBIN
lb_nameLoad Balancer nameTest-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
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

Create LB Server Group

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
stringProtocolTCP
name
required
stringLB Health Check nameServerGroup01
lb_method
required
stringLB MethodROUND_ROBIN
description
optional
stringDescriptionthis is an lb server group
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_methodLB MethodROUND_ROBIN
lb_nameLoad Balancer nameTest-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
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

create Load Balancer

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
subnet_id
required
stringSubnet ID-
name
required
stringname-
layer_type
required
stringLayer type-
description
optional
stringdescription-
firewall_enabled
optional
booleanFirewall enabled-
firewall_logging_enabled
optional
booleanFirewall logging enabled-
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
stringThe service IP of the load balancer.-
source_nat_ip
optional
stringSource NAT IP-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID
account_idThe account ID of the load balancer.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
layer_typeLayer type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
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

create Load Balancer

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
subnet_id
required
stringSubnet ID-
name
required
stringname-
layer_type
required
stringLayer type-
description
optional
stringdescription-
firewall_enabled
optional
booleanFirewall enabled-
firewall_logging_enabled
optional
booleanFirewall logging enabled-
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
stringThe service IP of the load balancer.-
source_nat_ip
optional
stringSource NAT IP-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID
account_idThe account ID of the load balancer.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
layer_typeLayer type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
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

create Load Balancer Public NAT IP

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
publicip_id
required
stringpublicip_id-

Responses

NameDescriptionExample
idID
account_idaccount_id
action_typeaction_type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
external_ip_addressexternal_ip_address
internal_ip_addressinternal_ip_address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
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

create Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
publicip_id
required
stringpublicip_id-

Responses

NameDescriptionExample
idID
account_idaccount_id
action_typeaction_type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
external_ip_addressexternal_ip_address
internal_ip_addressinternal_ip_address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
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

Delete LB Health Check

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

5.6.1.7.2 - 1.1

scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

Delete LB Health Check

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

5.6.1.8 - DeleteLbListener

5.6.1.8.1 - 1.2

scpcli loadbalancer lb-listener delete
--listener_id <value>

Description

delete LB listener

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

5.6.1.8.2 - 1.1

scpcli loadbalancer lb-listener delete
--listener_id <value>

Description

delete LB listener

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

5.6.1.9 - DeleteLBServerGroup

5.6.1.9.1 - 1.2

scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

Delete LB Server Group

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

5.6.1.9.2 - 1.1

scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

Delete LB Server Group

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

5.6.1.10 - DeleteLoadbalancer

5.6.1.10.1 - 1.2

scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

delete Load Balancer

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

5.6.1.10.2 - 1.1

scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

delete Load Balancer

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

5.6.1.11 - DeleteLoadbalancerPublicNatIp

5.6.1.11.1 - 1.2

scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Public NAT IP

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

5.6.1.11.2 - 1.1

scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

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

List LB Health Checks

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Health Check nameTest-LbMonitor-01
protocol
optional
arrayLB Health Check Protocol'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
health_check_typeLB Health Check typeDEFAULT
lb_server_group_countLB Server Group count2
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
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

List LB Health Checks

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Health Check nameTest-LbMonitor-01
protocol
optional
arrayLB Health Check Protocol'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
health_check_typeLB Health Check typeDEFAULT
lb_server_group_countLB Server Group count2
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
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

get LB listener list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
loadbalancer_id
optional
stringThe ID of the load balancer.-
state
optional
stringThe State of the listener.-
name
optional
stringThe Name of the listener.-
service_port
optional
integerThe Port of the listener.-
protocol
optional
arrayProtocol'TCP'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
protocolThe protocol of the listener.
service_portThe port of the listener.
stateThe State of the listener.

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

get LB listener list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
loadbalancer_id
optional
stringThe ID of the load balancer.-
state
optional
stringThe State of the listener.-
name
optional
stringThe Name of the listener.-
service_port
optional
integerThe Port of the listener.-
protocol
optional
arrayProtocol'TCP'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
protocolThe protocol of the listener.
service_portThe port of the listener.
stateThe State of the listener.

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

Get Lb Server Group Member List

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringName of Member-
member_ip
optional
stringIP of Member-
member_port
optional
integerProtocol port of Member-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
health_stateHealth State of Member
lb_server_group_idID of Lb Server Group
member_ipIP of Member
member_portProtocol port of Member
member_stateMember State of Member
member_weightWeight of Member
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of Member
object_idObject ID of Member
object_typeObject Type of Member
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

Get Lb Server Group Member List

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringName of Member-
member_ip
optional
stringIP of Member-
member_port
optional
integerProtocol port of Member-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
health_stateHealth State of Member
lb_server_group_idID of Lb Server Group
member_ipIP of Member
member_portProtocol port of Member
member_stateMember State of Member
member_weightWeight of Member
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of Member
object_idObject ID of Member
object_typeObject Type of Member
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

Get LB Server Group list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Server Group nameServerGroup01
protocol
optional
arrayProtocol'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_id
optional
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_method
optional
arrayLB Method'R'

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_nameLoad Balancer nameTest-LB-01
lb_server_group_member_countLB Server Group Member count2
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
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

Get LB Server Group list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Server Group nameServerGroup01
protocol
optional
arrayProtocol'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_id
optional
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_method
optional
arrayLB Method'R'

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_nameLoad Balancer nameTest-LB-01
lb_server_group_member_countLB Server Group Member count2
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

5.6.1.16 - ListLoadbalancerCertificates

5.6.1.16.1 - 1.2

scpcli loadbalancer loadbalancer-certificate list

Description

get Load Balancer certificate list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
cert_kind
cn
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
state

5.6.1.16.2 - 1.1

scpcli loadbalancer loadbalancer-certificate list

Description

get Load Balancer certificate list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
cert_kind
cn
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

get Load Balancer list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringThe name of the load balancer.-
state
optional
****The state of the load balancer.-
service_ip
optional
stringThe service IP of the load balancer.-
subnet_id
optional
stringSubnet ID-
layer_type
optional
****Layer type-
vpc_id
optional
stringVPC ID-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
firewall_idFirewall ID
layer_typeLayer type
listener_countThe number of listeners.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the load balancer.
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
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

get Load Balancer list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringThe name of the load balancer.-
state
optional
****The state of the load balancer.-
service_ip
optional
stringThe service IP of the load balancer.-
subnet_id
optional
stringSubnet ID-
layer_type
optional
****Layer type-
vpc_id
optional
stringVPC ID-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
firewall_idFirewall ID
layer_typeLayer type
listener_countThe number of listeners.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the load balancer.
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
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

Remove Lb Server Group Member

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-

5.6.1.18.2 - 1.1

scpcli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>

Description

Remove Lb Server Group Member

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
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

Set LB Health Check

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e
description
optional
stringDescriptionthis is an lb server group
health_check_count
optional
integerLB Health Check count3
health_check_interval
optional
integerLB Health Check interval5
health_check_port
optional
integerLB Health Check port80
health_check_timeout
optional
integerLB Health Check timeout5
health_check_url
optional
stringLB Health Check URL/test
http_method
optional
****LB Health Check HTTP MethodGET
protocol
optional
****LB Health Check ProtocolTCP
request_data
optional
stringLB Health Check Request datausername=admin&password=1234
response_code
optional
stringLB Health Check Response code200

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

Set LB Health Check

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e
description
optional
stringDescriptionthis is an lb server group
health_check_count
optional
integerLB Health Check count3
health_check_interval
optional
integerLB Health Check interval5
health_check_port
optional
integerLB Health Check port80
health_check_timeout
optional
integerLB Health Check timeout5
health_check_url
optional
stringLB Health Check URL/test
http_method
optional
****LB Health Check HTTP MethodGET
protocol
optional
****LB Health Check ProtocolTCP
request_data
optional
stringLB Health Check Request datausername=admin&password=1234
response_code
optional
stringLB Health Check Response code200

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

set loadbalancer listener

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-
condition_type
optional
****The condition type of the listener.-
description
optional
stringdescription-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
stringThe persistence of the listener.-
response_timeout
optional
integerThe response timeout of the listener.-
server_group_id
optional
stringThe ID of the server group.-
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
arrayThe URL handler of the listener.-
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
stringprotocol-
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

set loadbalancer listener

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-
condition_type
optional
****The condition type of the listener.-
description
optional
stringdescription-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
stringThe persistence of the listener.-
response_timeout
optional
integerThe response timeout of the listener.-
server_group_id
optional
stringThe ID of the server group.-
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
arrayThe URL handler of the listener.-
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
stringprotocol-
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

Set LB Server Group

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
description
optional
stringDescriptionthis is an lb server group
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_method
optional
****LB MethodROUND_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

Set LB Server Group

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
description
optional
stringDescriptionthis is an lb server group
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_method
optional
****LB MethodROUND_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

Set Lb Server Group Member

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-
member_port
optional
integerProtocol port of Member80
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

Set Lb Server Group Member

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-
member_port
optional
integerProtocol port of Member80
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

Set Load Balancer

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
description
required
stringdescription-

5.6.1.25 - ShowLBHealthCheck

5.6.1.25.1 - 1.2

scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

Get LB Health Check

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
health_check_countLB Health Check count3
health_check_intervalLB Health Check interval5
health_check_portLB Health Check port80
health_check_timeoutLB Health Check timeout5
health_check_typeLB Health Check typeDEFAULT
health_check_urlLB Health Check URL/test
http_methodLB Health Check HTTP MethodGET
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
request_dataLB Health Check Request datausername=admin&password=1234
response_codeLB Health Check Response code200
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

Get LB Health Check

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
health_check_countLB Health Check count3
health_check_intervalLB Health Check interval5
health_check_portLB Health Check port80
health_check_timeoutLB Health Check timeout5
health_check_typeLB Health Check typeDEFAULT
health_check_urlLB Health Check URL/test
http_methodLB Health Check HTTP MethodGET
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
request_dataLB Health Check Request datausername=admin&password=1234
response_codeLB Health Check Response code200
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

show LB listener

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
https_redirectionThe https redirection of the listener.
insert_client_ipWhether the client IP should be inserted.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
persistenceThe persistence of the listener.
protocolThe protocol of the listener.
response_timeoutThe response timeout of the listener.
routing_actionThe routing action of the listener.
server_group_idThe ID of the server group.
server_group_nameThe Name of the server group.
service_portThe port of the listener.
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateThe ssl certificate of the listener.
stateThe State of the listener.
support_http2Whether the HTTP 2.0 is supported
url_handlerThe URL handler of the listener.
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

show LB listener

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
https_redirectionThe https redirection of the listener.
insert_client_ipWhether the client IP should be inserted.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
persistenceThe persistence of the listener.
protocolThe protocol of the listener.
response_timeoutThe response timeout of the listener.
routing_actionThe routing action of the listener.
server_group_idThe ID of the server group.
server_group_nameThe Name of the server group.
service_portThe port of the listener.
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateThe ssl certificate of the listener.
stateThe State of the listener.
support_http2Whether the HTTP 2.0 is supported
url_handlerThe URL handler of the listener.
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

Show LB Server Group

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_methodLB MethodROUND_ROBIN
lb_nameLoad Balancer nameTest-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
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

Show LB Server Group

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_methodLB MethodROUND_ROBIN
lb_nameLoad Balancer nameTest-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
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

Show Lb Server Group Member

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-

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

Show Lb Server Group Member

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-

Responses

NameDescriptionExample
member

5.6.1.29 - ShowLoadbalancer

5.6.1.29.1 - 1.2

scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

show Load Balancer

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
idID
account_idThe account ID of the load balancer.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
firewall_idFirewall ID
health_check_ipHealth check IP
layer_typeLayer type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
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

show Load Balancer

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
idID
account_idThe account ID of the load balancer.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
firewall_idFirewall ID
health_check_ipHealth check IP
layer_typeLayer type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
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

show Load Balancer certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
lb_certificate_id
required
stringThe ID of the certificate-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idThe project ID of the certificate
cert_bodyThe body of the certificate
cert_chainThe chain of the certificate
cert_kind
cn
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
organizationThe organization of the certificate
private_keyThe private key of the certificate
state

5.6.1.30.2 - 1.1

scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

show Load Balancer certificate

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
lb_certificate_id
required
stringThe ID of the certificate-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idThe project ID of the certificate
cert_bodyThe body of the certificate
cert_chainThe chain of the certificate
cert_kind
cn
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
organizationThe organization of the certificate
private_keyThe private key of the certificate
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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260331

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
external_ip_addressStatic Nat External Ip Address
publicip_idPublicip ID
stateStatic Nat State

5.7 - Security Group

Overview

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

This guide provides a brief description of Security Group service and how to call CLI. The output is formatted as a JSON string

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

Create Security Group.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
name
required
stringSecurity Group Name-
description
optional
stringSecurity Group Description-
loggable
optional
booleanSecurity Group Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSecurity Group ID
account_idSecurity Group Account ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Description
loggableSecurity Group Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group Name
rule_countSecurity Group Rule Count
stateSecurity Group State

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

Create Security Group rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-
direction
required
stringSecurity Group Rule Direction (Ingress, Egress)-
description
optional
stringSecurity Group Rule Description-
ethertype
optional
stringSecurity Group Rule Ethertype (IPV4, IPV6)-
port_range_max
optional
integerSecurity Group Rule Port Range Max-
port_range_min
optional
integerSecurity Group Rule Port Range Min-
protocol
optional
stringSecurity Group Rule Protocol-
remote_group_id
optional
stringSecurity Group Rule Remote Group ID-
remote_ip_prefix
optional
stringSecurity Group Rule Remote IP Address-

Responses

NameDescriptionExample
idSecurity Group Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule Description
directionSecurity Group Rule Direction (Ingress, Egress)
ethertypeSecurity Group Rule Ethertype (IPV4, IPV6)
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Port Range Max
port_range_minSecurity Group Rule Port Range Min
protocolSecurity Group Rule Protocol
remote_group_idSecurity Group Rule Remote Group ID
remote_group_nameSecurity Group Rule Remote Group Name
remote_ip_prefixSecurity Group Rule Remote IP Address
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

Delete Security Group.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete Security Group rule.

State ACTIVE (CURRENT)

VersionSupported Until
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

Get Security Group rule list.

State ACTIVE (CURRENT)

VersionSupported Until
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 Remote IP Address-
remote_group_id
optional
stringSecurity Group Rule Remote Group ID-
description
optional
stringSecurity Group Rule Description-
direction
optional
stringSecurity Group Rule Direction (Ingress, Egress)-
service
optional
stringSecurity Group Rule Service-

Responses

NameDescriptionExample
idSecurity Group Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule Description
directionSecurity Group Rule Direction (Ingress, Egress)
ethertypeSecurity Group Rule Ethertype (IPV4, IPV6)
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Port Range Max
port_range_minSecurity Group Rule Port Range Min
protocolSecurity Group Rule Protocol
remote_group_idSecurity Group Rule Remote Group ID
remote_group_nameSecurity Group Rule Remote Group Name
remote_ip_prefixSecurity Group Rule Remote IP Address
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

Get Security Group list.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSecurity Group ID-
name
optional
stringSecurity Group Name-

Responses

NameDescriptionExample
idSecurity Group ID
account_idSecurity Group Account ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Description
loggableSecurity Group Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group Name
rule_countSecurity Group Rule Count
stateSecurity Group State

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

Set Security Group.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-
description
optional
stringSecurity Group Description-
loggable
optional
booleanSecurity Group Loggable-

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

Show Security Group.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-

Responses

NameDescriptionExample
idSecurity Group ID
account_idSecurity Group Account ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Description
loggableSecurity Group Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group Name
rule_countSecurity Group Rule Count
stateSecurity Group State

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

Show Security Group rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
security_group_rule_id
required
stringSecurity Group Rule ID-
fields
optional
arrayField Name-

Responses

NameDescriptionExample
idSecurity Group Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule Description
directionSecurity Group Rule Direction (Ingress, Egress)
ethertypeSecurity Group Rule Ethertype (IPV4, IPV6)
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Port Range Max
port_range_minSecurity Group Rule Port Range Min
protocolSecurity Group Rule Protocol
remote_group_idSecurity Group Rule Remote Group ID
remote_group_nameSecurity Group Rule Remote Group Name
remote_ip_prefixSecurity Group Rule Remote IP Address
security_group_idSecurity Group ID

5.8 - VPC

Overview

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

This guide provides a brief description of VPC service and how to call CLI. The output is formatted as a JSON string

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

Approval VPC Peering.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
type
required
stringApproval Type-

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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

Create Internet Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
type
required
stringInternet Gateway Type-
description
optional
stringDescription-
firewall_enabled
optional
booleanFirewall Enable-
firewall_loggable
optional
booleanFirewall Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

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

Create Internet Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
type
required
stringInternet Gateway Type-
description
optional
stringDescription-
firewall_enabled
optional
booleanFirewall Enable-
firewall_loggable
optional
booleanFirewall Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

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

Create NAT Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR-
publicip_id
required
stringPublicIP ID-
description
optional
stringNAT Gateway Description-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

5.8.1.5.2 - 1.0

scpcli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]

Description

Create NAT Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR-
publicip_id
required
stringPublicIP ID-
description
optional
stringNAT Gateway Description-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

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

Create port.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPort Name-
description
optional
stringDescription-
fixed_ip_address
optional
stringFixed IP-
security_groups
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"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

Create port.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPort Name-
description
optional
stringDescription-
fixed_ip_address
optional
stringFixed IP-
security_groups
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"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

Create Private NAT.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringPrivate NAT Name-
direct_connect_id
required
stringDirect Connect ID-
cidr
required
stringPrivate NAT IP range-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

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

Create Private NAT.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringPrivate NAT Name-
direct_connect_id
required
stringDirect Connect ID-
cidr
required
stringPrivate NAT IP range-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

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

Create Private NAT IP.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
ip_address
required
stringPrivate NAT IP Address-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

5.8.1.8.2 - 1.0

scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
ip_address
required
stringPrivate NAT IP Address-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

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

Create PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPrivateLink Endpoint Name-
endpoint_ip_address
required
stringEndpoint IP Address-
description
optional
stringDescription-
privatelink_service_id
optional
stringPrivateLink Service ID-
security_group_ids
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressEndpoint IP Address
endpoint_ip_port_idEndpoint IP Port ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint Name
privatelink_service_idPrivateLink Service ID
security_group_idsSecurity Group List
statePrivateLink Endpoint State
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

Create PrivateLink Service.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
service_ip_address
required
stringService IP Address-
name
required
stringPrivateLink Service Name-
connected_resource_type
required
stringConnected Resource Type-
approval_type
required
stringPrivateLink Service Approval Type-
connected_resource_id
optional
stringConnected Resource ID-
connected_resource_ip_address
optional
stringConnected Resource IP Address-
description
optional
stringDescription-
high_speed_transfer
optional
booleanHigh Speed Data Transfer Use-
security_group_ids
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Service ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
connected_resource_idConnected Resource ID
connected_resource_ip_addressConnected Resource IP Address
connected_resource_nameConnected Resource Name
connected_resource_typeConnected Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
high_speed_transferHigh Speed Data Transfer Use
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service Name
security_group_idsSecurity Group List
service_ip_addressService IP Address
service_ip_port_idService IP Port ID
statePrivateLink Service State
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

Create PublicIP.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP Type-
description
optional
stringPublicIP Description-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

5.8.1.11.2 - 1.0

scpcli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]

Description

Create PublicIP.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP Type-
description
optional
stringPublicIP Description-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

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

Create subnet.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet Type-
name
required
stringSubnet NamesubnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
allocation_pools
optional
arrayAllocation Pools[
description
optional
stringDescriptionSubnet Description
dns_nameservers
optional
arrayDNS Name Servers[
host_routes
optional
arrayHost Routes[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

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

Create subnet.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet Type-
name
required
stringSubnet NamesubnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
allocation_pools
optional
arrayAllocation Pools[
description
optional
stringDescriptionSubnet Description
dns_nameservers
optional
arrayDNS Name Servers[
host_routes
optional
arrayHost Routes[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

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

Create Transit Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway Name-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

5.8.1.13.2 - 1.0

scpcli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]

Description

Create Transit Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway Name-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

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

Create Transit Gateway Rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.-
destination_type
required
stringDestination Type-
destination_cidr
required
stringDestination CIDR-
description
optional
stringDescription-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destination_cidrDestination CIDR
destination_resource_idDestination Resource ID
destination_resource_nameDestination Resource Name
destination_typeDestination Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_resource_idSource Resource ID
source_resource_nameSource Resource Name
source_typeSource Type
stateState
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.

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

Create Transit Gateway Rule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.-
destination_type
required
stringDestination Type-
destination_cidr
required
stringDestination CIDR-
description
optional
stringDescription-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destination_cidrDestination CIDR
destination_resource_idDestination Resource ID
destination_resource_nameDestination Resource Name
destination_typeDestination Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_resource_idSource Resource ID
source_resource_nameSource Resource Name
source_typeSource Type
stateState
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.

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

Create Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idTransit Gateway VPC Connection ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateState
transit_gateway_idTransit Gateway ID
vpc_idVPC Id
vpc_nameVPC Name

5.8.1.15.2 - 1.0

scpcli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Create Transit Gateway VPC Connection.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idTransit Gateway VPC Connection ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateState
transit_gateway_idTransit Gateway ID
vpc_idVPC Id
vpc_nameVPC Name

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

Create VPC.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringVPC NamevpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
stringDescriptionVPC Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

5.8.1.16.2 - 1.0

scpcli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create VPC.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringVPC NamevpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
stringDescriptionVPC Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

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

Create VPC Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
subnet_id
required
stringSubnet Id-
resource_type
required
stringVPC Endpoint Resource Type-
resource_key
required
stringVPC Endpoint Resource Key-
resource_info
required
stringVPC Endpoint Resource Key Info-
name
required
stringVPC Endpoint Name-
endpoint_ip_address
required
stringVPC Endpoint IP Address-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

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

Create VPC Endpoint.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
subnet_id
required
stringSubnet Id-
resource_type
required
stringVPC Endpoint Resource Type-
resource_key
required
stringVPC Endpoint Resource Key-
resource_info
required
stringVPC Endpoint Resource Key Info-
name
required
stringVPC Endpoint Name-
endpoint_ip_address
required
stringVPC Endpoint IP Address-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

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

Create VPC Peering.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID-
name
required
stringVPC Peering Name-
approver_vpc_id
required
stringApprover VPC ID-
approver_vpc_account_id
required
stringApprover VPC Account ID-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

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

Create VPC Peering.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID-
name
required
stringVPC Peering Name-
approver_vpc_id
required
stringApprover VPC ID-
approver_vpc_account_id
required
stringApprover VPC Account ID-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

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

Create a VPC Peering Rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
destination_vpc_type
required
stringDestination VPC Type-
destination_cidr
required
stringDestination CIDR-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
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

Create a VPC Peering Rule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
destination_vpc_type
required
stringDestination VPC Type-
destination_cidr
required
stringDestination CIDR-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
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

Delete Internet Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete Internet Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete NAT Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-

5.8.1.21.2 - 1.0

scpcli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-

5.8.1.22 - Delete Port

5.8.1.22.1 - 1.1

scpcli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-

5.8.1.22.2 - 1.0

scpcli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete Private NAT.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete Private NAT.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete Private NAT IP.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete Private NAT IP.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete PrivateLink Service.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete PublicIP.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete PublicIP.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete subnet.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

5.8.1.28.2 - 1.0

scpcli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete Transit Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete Transit Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete Transit Gateway Rule.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete Transit Gateway Rule.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection 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

Delete Transit Gateway VPC Connection.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection 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

Delete VPC.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

5.8.1.32.2 - 1.0

scpcli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete VPC Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete VPC Endpoint.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete VPC Peering.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete VPC Peering.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete a VPC Peering Rule.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete a VPC Peering Rule.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Get Connected PrivateLink Endpoint List.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
privatelink_service_idPrivateLink Service ID
statePrivateLink Endpoint State

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

Get Internet Gateway list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID-
name
optional
stringInternet Gateway Name-
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

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

Get Internet Gateway list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID-
name
optional
stringInternet Gateway Name-
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

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

Get NAT Gateway list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway Name-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
subnet_id
optional
stringSubnet Id-
subnet_name
optional
stringSubnet Name-
nat_gateway_ip_address
optional
stringNAT Gateway IP Address-
state
optional
****NAT Gateway State-

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

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

Get NAT Gateway list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway Name-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
subnet_id
optional
stringSubnet Id-
subnet_name
optional
stringSubnet Name-
nat_gateway_ip_address
optional
stringNAT Gateway IP Address-
state
optional
****NAT Gateway State-

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

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

Get port list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort Name-
subnet_id
optional
stringSubnet Id-
subnet_name
optional
stringSubnet Name-
id
optional
stringPort ID-
attached_resource_id
optional
stringConnected resource ID-
fixed_ip_address
optional
stringFixed IP-
mac_address
optional
stringMAC Address-
state
optional
stringState-
security_groups
optional
stringSecurity Group List-

Responses

NameDescriptionExample
idPort ID
account_idAccount ID
attached_resource_idConnected resource ID
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescription
fixed_ip_addressFixed IP
mac_addressMAC Address
modified_atModified date
namePort Name
stateState
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

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

Get port list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort Name-
subnet_id
optional
stringSubnet Id-
subnet_name
optional
stringSubnet Name-
id
optional
stringPort ID-
attached_resource_id
optional
stringConnected resource ID-
fixed_ip_address
optional
stringFixed IP-
mac_address
optional
stringMAC Address-
state
optional
stringState-
security_groups
optional
stringSecurity Group List-

Responses

NameDescriptionExample
idPort ID
account_idAccount ID
attached_resource_idConnected resource ID
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescription
fixed_ip_addressFixed IP
mac_addressMAC Address
modified_atModified date
namePort Name
stateState
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

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

Get Private NAT list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT Name-
cidr
optional
stringPrivate NAT IP range-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
direct_connect_id
optional
stringDirect Connect ID-
direct_connect_name
optional
stringDirect Connect Name-
state
optional
****Private NAT State-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

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

Get Private NAT list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT Name-
cidr
optional
stringPrivate NAT IP range-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
direct_connect_id
optional
stringDirect Connect ID-
direct_connect_name
optional
stringDirect Connect Name-
state
optional
****Private NAT State-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

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

Get Private NAT IP list.

State ACTIVE (CURRENT)

VersionSupported Until
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 Address-
state
optional
****Private NAT IP State-
attached_resource_type
optional
****Private NAT IP Attached Resource Type-
attached_resource_id
optional
stringPrivate NAT IP Attached Resource ID-
attached_resource_name
optional
stringPrivate NAT IP Attached Resource Name-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

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

Get Private NAT IP list.

State ACTIVE (DEPRECATED)

VersionSupported Until
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 Address-
state
optional
****Private NAT IP State-
attached_resource_type
optional
****Private NAT IP Attached Resource Type-
attached_resource_id
optional
stringPrivate NAT IP Attached Resource ID-
attached_resource_name
optional
stringPrivate NAT IP Attached Resource Name-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

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

Get PrivateLink Endpoint List.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Endpoint ID-
name
optional
stringPrivateLink Endpoint Name-
vpc_id
optional
stringVPC Id-
subnet_id
optional
stringSubnet Id-
privatelink_service_id
optional
stringPrivateLink Service ID-
endpoint_ip_address
optional
stringEndpoint IP Address-
state
optional
****PrivateLink Endpoint State-

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
endpoint_ip_addressEndpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint Name
privatelink_service_idPrivateLink Service ID
statePrivateLink Endpoint State
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

Get PrivateLink Service List.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Service ID-
name
optional
stringPrivateLink Service Name-
vpc_id
optional
stringVPC Id-
subnet_id
optional
stringSubnet Id-
service_ip_address
optional
stringService IP Address-
connected_resource_id
optional
stringConnected Resource ID-
connected_resource_type
optional
stringConnected Resource Type-
connected_resource_name
optional
stringConnected Resource Name-
connected_resource_ip_address
optional
stringConnected Resource IP Address-
state
optional
****PrivateLink Service State-

Responses

NameDescriptionExample
idPrivateLink Service ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
connected_resource_idConnected Resource ID
connected_resource_ip_addressConnected Resource IP Address
connected_resource_nameConnected Resource Name
connected_resource_typeConnected Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service Name
service_ip_addressService IP Address
statePrivateLink Service State
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

Get PublicIP list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address-
state
optional
stringPublicIP State-
attached_resource_type
optional
stringPublicIP Attached Resource Type-
attached_resource_id
optional
stringPublicIP Attached Resource ID-
attached_resource_name
optional
stringPublicIP Attached Resource Name-
vpc_id
optional
stringVPC Id-
type
optional
****PublicIP Type-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

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

Get PublicIP list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address-
state
optional
stringPublicIP State-
attached_resource_type
optional
stringPublicIP Attached Resource Type-
attached_resource_id
optional
stringPublicIP Attached Resource ID-
attached_resource_name
optional
stringPublicIP Attached Resource Name-
vpc_id
optional
stringVPC Id-
type
optional
****PublicIP Type-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

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

Get subnet list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet Id023c57b14f11483689338d085e061492
name
optional
stringSubnet NamesubnetName
type
optional
****Subnet Type-
state
optional
****State-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

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

Get subnet list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet Id023c57b14f11483689338d085e061492
name
optional
stringSubnet NamesubnetName
type
optional
****Subnet Type-
state
optional
****State-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

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

Get Transit Gateway Rule list.

State ACTIVE (CURRENT)

VersionSupported Until
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
stringVPC ID Connected to Transit Gateway.-
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.-
source_type
optional
****Source Type-
destination_type
optional
****Destination Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destination_cidrDestination CIDR
destination_resource_idDestination Resource ID
destination_resource_nameDestination Resource Name
destination_typeDestination Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_resource_idSource Resource ID
source_resource_nameSource Resource Name
source_typeSource Type
stateState
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.

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

Get Transit Gateway Rule list.

State ACTIVE (DEPRECATED)

VersionSupported Until
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
stringVPC ID Connected to Transit Gateway.-
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.-
source_type
optional
****Source Type-
destination_type
optional
****Destination Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destination_cidrDestination CIDR
destination_resource_idDestination Resource ID
destination_resource_nameDestination Resource Name
destination_typeDestination Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_resource_idSource Resource ID
source_resource_nameSource Resource Name
source_typeSource Type
stateState
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.

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

Get Transit Gateway VPC Connection list.

State ACTIVE (CURRENT)

VersionSupported Until
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 Connection ID-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
state
optional
****State-

Responses

NameDescriptionExample
idTransit Gateway VPC Connection ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateState
transit_gateway_idTransit Gateway ID
vpc_idVPC Id
vpc_nameVPC Name

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

Get Transit Gateway VPC Connection list.

State ACTIVE (DEPRECATED)

VersionSupported Until
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 Connection ID-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
state
optional
****State-

Responses

NameDescriptionExample
idTransit Gateway VPC Connection ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateState
transit_gateway_idTransit Gateway ID
vpc_idVPC Id
vpc_nameVPC Name

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

Get Transit Gateway list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway ID-
name
optional
stringTransit Gateway Name-
state
optional
****State-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

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

Get Transit Gateway list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway ID-
name
optional
stringTransit Gateway Name-
state
optional
****State-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

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

Get VPC Endpoint list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID-
name
optional
stringVPC Endpoint Name-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
subnet_id
optional
stringSubnet Id-
resource_key
optional
stringVPC Endpoint Resource Key-
resource_type
optional
****VPC Endpoint Resource Type-
endpoint_ip_address
optional
stringVPC Endpoint IP Address-
state
optional
****VPC Endpoint State-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

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

Get VPC Endpoint list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID-
name
optional
stringVPC Endpoint Name-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
subnet_id
optional
stringSubnet Id-
resource_key
optional
stringVPC Endpoint Resource Key-
resource_type
optional
****VPC Endpoint Resource Type-
endpoint_ip_address
optional
stringVPC Endpoint IP Address-
state
optional
****VPC Endpoint State-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

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

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource Type-
vpc_id
optional
stringVPC ID(required if resource_type is DNS)-

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource Type-
vpc_id
optional
stringVPC ID(required if resource_type is DNS)-

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type

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

Get VPC Peering list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID-
name
optional
stringVPC Peering Name-
requester_vpc_id
optional
stringRequester VPC ID-
requester_vpc_name
optional
stringRequester VPC Name-
approver_vpc_id
optional
stringApprover VPC ID-
approver_vpc_name
optional
stringApprover VPC Name-
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

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

Get VPC Peering list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID-
name
optional
stringVPC Peering Name-
requester_vpc_id
optional
stringRequester VPC ID-
requester_vpc_name
optional
stringRequester VPC Name-
approver_vpc_id
optional
stringApprover VPC ID-
approver_vpc_name
optional
stringApprover VPC Name-
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

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

Get VPC Peering Rule list.

State ACTIVE (CURRENT)

VersionSupported Until
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 Rule ID-
name
optional
stringVPC Peering Name-
source_vpc_id
optional
stringSource VPC ID-
source_vpc_type
optional
****Source VPC Type-
destination_vpc_id
optional
stringDestination VPC ID-
destination_vpc_type
optional
****Destination VPC Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
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

Get VPC Peering Rule list.

State ACTIVE (DEPRECATED)

VersionSupported Until
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 Rule ID-
name
optional
stringVPC Peering Name-
source_vpc_id
optional
stringSource VPC ID-
source_vpc_type
optional
****Source VPC Type-
destination_vpc_id
optional
stringDestination VPC ID-
destination_vpc_type
optional
****Destination VPC Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
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

Get VPC list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC NamevpcName
state
optional
****State-
cidr
optional
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

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

Get VPC list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC NamevpcName
state
optional
****State-
cidr
optional
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

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

State ACTIVE (CURRENT)

VersionSupported Until
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

Set Internet Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-
description
optional
stringDescription-
loggable
optional
booleanNAT Loggable-

5.8.1.55.2 - 1.0

scpcli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Internet Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-
description
optional
stringDescription-
loggable
optional
booleanNAT Loggable-

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

Set NAT Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-
description
optional
stringNAT Gateway Description-

5.8.1.56.2 - 1.0

scpcli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

Set NAT Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-
description
optional
stringNAT Gateway Description-

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

Set port.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-
description
optional
stringDescription-
security_groups
optional
arraySecurity Group List-

5.8.1.57.2 - 1.0

scpcli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Set port.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-
description
optional
stringDescription-
security_groups
optional
arraySecurity Group List-

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

Set Private NAT.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
description
optional
stringDescription-

5.8.1.58.2 - 1.0

scpcli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Set Private NAT.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
description
optional
stringDescription-

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

Set PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-
description
optional
stringDescription-

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

Set PrivateLink Service.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID-
description
optional
stringDescription-

5.8.1.61 - Set PublicIP

5.8.1.61.1 - 1.1

scpcli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-
description
required
stringPublicIP Description-

5.8.1.61.2 - 1.0

scpcli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-
description
required
stringPublicIP Description-

5.8.1.62 - Set Subnet

5.8.1.62.1 - 1.1

scpcli vpc subnet set
--subnet_id <value>
--description <value>

Description

Set subnet.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet Description

5.8.1.62.2 - 1.0

scpcli vpc subnet set
--subnet_id <value>
--description <value>

Description

Set subnet.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet 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

Set Transit Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
description
optional
stringDescription-

5.8.1.63.2 - 1.0

scpcli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Set Transit Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
description
optional
stringDescription-

5.8.1.64 - Set VPC

5.8.1.64.1 - 1.1

scpcli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

5.8.1.64.2 - 1.0

scpcli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

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

Set VPC Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-
description
optional
stringDescription-

5.8.1.65.2 - 1.0

scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-
description
optional
stringDescription-

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

Set VPC Peering.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
description
optional
stringDescription-

5.8.1.66.2 - 1.0

scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
description
optional
stringDescription-

5.8.1.67 - Show Internet Gateway

5.8.1.67.1 - 1.1

scpcli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

5.8.1.67.2 - 1.0

scpcli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

5.8.1.68 - Show NAT Gateway

5.8.1.68.1 - 1.1

scpcli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

5.8.1.68.2 - 1.0

scpcli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

5.8.1.69 - Show Port

5.8.1.69.1 - 1.1

scpcli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (CURRENT)

VersionSupported Until
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

Show port.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Show Private NAT.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

5.8.1.70.2 - 1.0

scpcli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

5.8.1.71 - Show PrivateLink Endpoint

5.8.1.71.1 - 1.1

scpcli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>

Description

Show PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressEndpoint IP Address
endpoint_ip_port_idEndpoint IP Port ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint Name
privatelink_service_idPrivateLink Service ID
security_group_idsSecurity Group List
statePrivateLink Endpoint State
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

Show PrivateLink Service.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID-

Responses

NameDescriptionExample
idPrivateLink Service ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
connected_resource_idConnected Resource ID
connected_resource_ip_addressConnected Resource IP Address
connected_resource_nameConnected Resource Name
connected_resource_typeConnected Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
high_speed_transferHigh Speed Data Transfer Use
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service Name
security_group_idsSecurity Group List
service_ip_addressService IP Address
service_ip_port_idService IP Port ID
statePrivateLink Service State
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

Show PublicIP.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

5.8.1.73.2 - 1.0

scpcli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

5.8.1.74 - Show Subnet

5.8.1.74.1 - 1.1

scpcli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

5.8.1.74.2 - 1.0

scpcli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

5.8.1.75 - Show Transit Gateway

5.8.1.75.1 - 1.1

scpcli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

5.8.1.75.2 - 1.0

scpcli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

5.8.1.76 - Show VPC

5.8.1.76.1 - 1.1

scpcli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

5.8.1.76.2 - 1.0

scpcli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

5.8.1.77 - Show VPC Endpoint

5.8.1.77.1 - 1.1

scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

5.8.1.77.2 - 1.0

scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

5.8.1.78 - Show VPC Peering

5.8.1.78.1 - 1.1

scpcli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

5.8.1.78.2 - 1.0

scpcli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

5.9 - VPN

Overview

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

This guide provides a brief description of VPN service and how to call CLI. The output is formatted as a JSON string

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

Create VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
name
required
stringVPN Gateway NameExampleVpnGW1
ip_type
required
stringVPN Gateway IP TypePUBLIC
ip_id
required
stringVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_address
required
stringVPN Gateway IP Address123.0.0.1
description
optional
stringDescriptionExample Description for VPN Gateway
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

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

Create VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
name
required
stringVPN Gateway NameExampleVpnGW1
ip_type
required
stringVPN Gateway IP TypePUBLIC
ip_id
required
stringVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_address
required
stringVPN Gateway IP Address123.0.0.1
description
optional
stringDescriptionExample Description for VPN Gateway
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

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

Create VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
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 Listnull-md5
phase2_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
perfect_forward_secrecy
required
stringVPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
pre_shared_key
required
stringVPN Tunnel ISAKMP Authentication : Pre-shared KeyPreSharedKey1
phase1_life_time
required
integerVPN Tunnel ISAKMP Lifetime (sec)86400
phase1_encryptions
required
arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
peer_gateway_ip
required
stringVPN Tunnel Peer Gateway IP Address123.0.0.2
ike_version
required
integerVPN Tunnel IKE Version2
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 NameExampleVpnTunnel1
description
optional
stringDescriptionExample Description for VPN Tunnel
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.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

Create VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
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 Listnull-md5
phase2_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
perfect_forward_secrecy
required
stringVPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
pre_shared_key
required
stringVPN Tunnel ISAKMP Authentication : Pre-shared KeyPreSharedKey1
phase1_life_time
required
integerVPN Tunnel ISAKMP Lifetime (sec)86400
phase1_encryptions
required
arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
peer_gateway_ip
required
stringVPN Tunnel Peer Gateway IP Address123.0.0.2
ike_version
required
integerVPN Tunnel IKE Version2
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 NameExampleVpnTunnel1
description
optional
stringDescriptionExample Description for VPN Tunnel
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.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

Delete VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Get VPN gateway list.

State ACTIVE (CURRENT)

VersionSupported Until
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 Address123.0.0.1
vpc_id
optional
stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_name
optional
stringVPC NameExampleVPC1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

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

Get VPN gateway list.

State ACTIVE (DEPRECATED)

VersionSupported Until
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 Address123.0.0.1
vpc_id
optional
stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_name
optional
stringVPC NameExampleVPC1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

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

Get VPN tunnel list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringVPN Tunnel NameExampleVpnTunnel1
vpn_gateway_id
optional
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_name
optional
stringVPN Gateway NameExampleVpnGW1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.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

Get VPN tunnel list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringVPN Tunnel NameExampleVpnTunnel1
vpn_gateway_id
optional
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_name
optional
stringVPN Gateway NameExampleVpnGW1
peer_gateway_ip
optional
stringVPN Tunnel Peer Gateway IP Address123.0.0.2
remote_subnet
optional
stringVPN Tunnel IPSec Remote Subnet10.1.0.0/16

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.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

Set VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
description
optional
stringDescriptionExample Description for VPN Gateway

5.9.1.7.2 - 1.0

scpcli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]

Description

Set VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
description
optional
stringDescriptionExample 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

Set VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1
description
optional
stringDescriptionExample Description for VPN Tunnel
dpd_retry_interval
optional
integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
ike_version
optional
integerVPN Tunnel IKE Version2
peer_gateway_ip
optional
stringVPN Tunnel Peer Gateway IP Address123.0.0.2
phase1_diffie_hellman_groups
optional
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
phase1_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_life_time
optional
integerVPN Tunnel ISAKMP Lifetime (sec)86400
pre_shared_key
optional
stringVPN Tunnel ISAKMP Authentication : 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 List30
phase2_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal Listnull-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

Set VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1
description
optional
stringDescriptionExample Description for VPN Tunnel
dpd_retry_interval
optional
integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
ike_version
optional
integerVPN Tunnel IKE Version2
peer_gateway_ip
optional
stringVPN Tunnel Peer Gateway IP Address123.0.0.2
phase1_diffie_hellman_groups
optional
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
phase1_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_life_time
optional
integerVPN Tunnel ISAKMP Lifetime (sec)86400
pre_shared_key
optional
stringVPN Tunnel ISAKMP Authentication : 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 List30
phase2_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal Listnull-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

Show VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

5.9.1.9.2 - 1.0

scpcli vpn vpn-gateway show
--vpn_gateway_id <value>

Description

Show VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

5.9.1.10 - Show VPN Tunnel

5.9.1.10.1 - 1.1

scpcli vpn vpn-tunnel show
--vpn_tunnel_id <value>

Description

Show VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
statusVPN Tunnel StatusUP
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.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

Show VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
statusVPN Tunnel StatusUP
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

6 - Database

6.1 - CacheStore(DBaaS)

Overview

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

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

Version

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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-
commands
required
arrayApply command information'{"id": "", "name": "", "new_value": ""}'

6.2 - EPAS(DBaaS)

Overview

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

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

Version

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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

6.3 - MariaDB(DBaaS)

Overview

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

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

Version

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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

6.4 - Microsoft SQL Server(DBaaS)

Overview

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

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

Version

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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID109a585ae67b4e8482fdafc8a4a5be74

6.5 - MySQL(DBaaS)

Overview

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

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

Version

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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

6.6 - PostgreSQL(DBaaS)

Overview

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

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

Version

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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringDB cluster id-

7 - Data Analytics

7.1 - Data Flow

Overview

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

This guide provides a brief description of Data Flow service and how to call 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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (SUPPORTED)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (SUPPORTED)

VersionSupported Until
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)

State ACTIVE (CURRENT)

VersionSupported Until
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)

State ACTIVE (SUPPORTED)

VersionSupported Until
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)

State ACTIVE (CURRENT)

VersionSupported Until
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)

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

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

This guide provides a brief description of Data Ops service and how to call 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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (SUPPORTED)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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}

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

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

This guide provides a brief description of Event Streams service and how to call 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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

7.4 - Quick Query

Overview

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

This guide provides a brief description of Quick Query service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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)

State ACTIVE (CURRENT)

VersionSupported Until
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)

State ACTIVE (SUPPORTED)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

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

This guide provides a brief description of Search Engine service and how to call 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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ha_enabledHA availability
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

7.6 - Vertica(DBaaS)

Overview

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

This guide provides a brief description of Vertica(DBaaS) service and how to call 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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
database_nameDatabase Name
instance_countInstance Count
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID-

8 - Application Service

8.1 - API Gateway

Overview

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

This guide provides a brief description of API Gateway service and how to call 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

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink Endpoint Action TypeCANCEL
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

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink Endpoint Action TypeCANCEL
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

Create access control

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

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

Create access control

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

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

Create access control

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

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

Create api

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringNametest-api
description
optional
stringDescriptiondescription
endpoint_type
optional
stringEndpoint Type-
id
optional
stringApi ID-
tags
optional
arrayTag List'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptionDescription
nameNametest-api

8.1.1.4.2 - 1.1

scpcli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]

Description

Create api

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
name
required
stringNametest-api
description
optional
stringDescriptiondescription
id
optional
stringApi ID-
tags
optional
arrayTag List'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptionDescription
nameNametest-api

8.1.1.4.3 - 1.0

scpcli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]

Description

Create api

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringNametest-api
description
optional
stringDescriptiondescription
id
optional
stringApi ID-
tags
optional
arrayTag List'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptionDescription
nameNametest-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

Create api deployment

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
stringStage Typenew
description
optional
stringDescriptiondescription
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription

8.1.1.5.2 - 1.1

scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

Create api deployment

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
stringStage Typenew
description
optional
stringDescriptiondescription
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription

8.1.1.5.3 - 1.0

scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

Create api deployment

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
stringStage Typenew
description
optional
stringDescriptiondescription
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription

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

Create api key

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
name
required
stringNameapi-key-name
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date
descriptionDescriptiondescription
keyKeykey
nameNameapi-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

Create api key

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
name
required
stringNameapi-key-name
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date
descriptionDescriptiondescription
keyKeykey
nameNameapi-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

Create auth

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAuth NAMEToken01
expiration_period
required
integerExpiration Period90
connected_stages
required
arrayConnected Stagesdev,stg

Responses

NameDescriptionExample
access_tokenAccess 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

Create auth

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAuth NAMEToken01
expiration_period
required
integerExpiration Period90
connected_stages
required
arrayConnected Stagesdev,stg

Responses

NameDescriptionExample
access_tokenAccess 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

Create auth

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAuth NAMEToken01
expiration_period
required
integerExpiration Period90
connected_stages
required
arrayConnected Stagesdev,stg

Responses

NameDescriptionExample
access_tokenAccess 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

Create method

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
stringMethod TypeGET
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
optional
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
objectMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
objectMethod Request Headers{'test1' : True}

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
privatelink_endpoint_idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod 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

Create method

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
stringMethod TypeGET
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
optional
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
objectMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
objectMethod Request Headers{'test1' : True}

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod 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

Create method

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
stringMethod TypeGET
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
optional
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
objectMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
objectMethod Request Headers{'test1' : True}

Responses

NameDescriptionExample
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod 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

Create PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
name
required
stringPrivateLink Endpoint Nameendpoint
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptiondescription
namePrivateLink Endpoint Nameendpoint
privatelink_service_idPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink Endpoint StatusCANCELED

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

Create resource

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
parent_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
stringPath Parttest

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath

8.1.1.10.2 - 1.1

scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

Create resource

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
parent_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
stringPath Parttest

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath

8.1.1.10.3 - 1.0

scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

Create resource

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
parent_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
stringPath Parttest

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath

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

Create stage

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringNametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

8.1.1.11.2 - 1.1

scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

Create stage

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringNametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

8.1.1.11.3 - 1.0

scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

Create stage

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringNametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
ip_restriction_enabledIP Restriction EnabledFalse
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-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

Create usage plan

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
stringUsage Plan Rateday
name
required
stringNameusage-plan-name
limit
required
integerUsage Plan Limit10
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Keys[]
created_atCreation Date
created_by_idCreated by27bb070b564349f8a31cc60734cc36a5
created_by_nameCreated byusername
descriptionDescriptiondescription
limitUsage Plan Limit10
modified_atModified at
modified_by_idModified by27bb070b564349f8a31cc60734cc36a5
modified_by_nameModified byusername
nameNameusage-plan-name
rateUsage Plan Rateday

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

Create usage plan

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
stringUsage Plan Rateday
name
required
stringNameusage-plan-name
limit
required
integerUsage Plan Limit10
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Keys[]
created_atCreation Date
created_by_idCreated by27bb070b564349f8a31cc60734cc36a5
created_by_nameCreated byusername
descriptionDescriptiondescription
limitUsage Plan Limit10
modified_atModified at
modified_by_idModified by27bb070b564349f8a31cc60734cc36a5
modified_by_nameModified byusername
nameNameusage-plan-name
rateUsage Plan Rateday

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

Delete access control

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control 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

Delete access control

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control 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

Delete access control

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control 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

Delete api key

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
stringUsage Plan 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

Delete api key

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
stringUsage Plan 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

Delete api

State ACTIVE (CURRENT)

VersionSupported Until
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

Delete api

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete api

State ACTIVE (DEPRECATED)

VersionSupported Until
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

Delete auth

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth 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

Delete auth

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth 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

Delete auth

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth 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

Delete method

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource 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

Delete method

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource 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

Delete method

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource 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

Delete PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint 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

Delete resource

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource 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

Delete resource

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource 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

Delete resource

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource 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

Delete stage

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

8.1.1.20.2 - 1.1

scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

Delete stage

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

8.1.1.20.3 - 1.0

scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

Delete stage

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-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

Delete usage plan

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan 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

Delete usage plan

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan 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

Get access controls list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

8.1.1.22.2 - 1.1

scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get access controls list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

8.1.1.22.3 - 1.0

scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get access controls list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

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

Get api deployments list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
stringName27bb070b564349f8a31cc60734cc36a5
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_dateDeployment Date2024-05-17T00:23:17Z
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
statusStatusActive

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

Get api deployments list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
stringName27bb070b564349f8a31cc60734cc36a5
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_dateDeployment Date2024-05-17T00:23:17Z
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
statusStatusActive

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

Get api deployments list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
stringName27bb070b564349f8a31cc60734cc36a5
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_dateDeployment Date2024-05-17T00:23:17Z
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
statusStatusActive

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

Get api key list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNameapi-key-name

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date
descriptionDescriptiondescription
keyKeykey
nameNameapi-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

Get api key list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNameapi-key-name

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date
descriptionDescriptiondescription
keyKeykey
nameNameapi-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

Get apis list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNametest-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

8.1.1.25.2 - 1.1

scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get apis list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNametest-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

8.1.1.25.3 - 1.0

scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get apis list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNametest-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

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

Get auths list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

8.1.1.26.2 - 1.1

scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get auths list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

8.1.1.26.3 - 1.0

scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get auths list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

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

Get connected privatelink endpoints

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
statusPrivateLink Endpoint StatusActive

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

Get methods list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
privatelink_endpoint_idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod 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

Get methods list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod 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

Get methods list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod 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

Get PrivateLink Endpoints list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivateLink Endpoint Nameendpoint

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
namePrivateLink Endpoint Nameendpoint
privatelink_service_idPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink Endpoint StatusCANCELED

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

Get reports list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
end_date
required
stringEnd Date2025-07-30
start_date
required
stringStart Date2025-07-01
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
call_countCall Count10
dateDate
error_4xx_countError 4xx Count10
error_5xx_countError 5xx Count10
integration_latencyIntegration Latency10
latencyLatency10

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

Get reports list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
end_date
required
stringEnd Date2025-07-30
start_date
required
stringStart Date2025-07-01
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
call_countCall Count10
dateDate
error_4xx_countError 4xx Count10
error_5xx_countError 5xx Count10
integration_latencyIntegration Latency10
latencyLatency10

8.1.1.31 - List Resources

8.1.1.31.1 - 1.2

scpcli application-apigateway resource list
--api_id <value>

Description

Get resources list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

8.1.1.31.2 - 1.1

scpcli application-apigateway resource list
--api_id <value>

Description

Get resources list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

8.1.1.31.3 - 1.0

scpcli application-apigateway resource list
--api_id <value>

Description

Get resources list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

8.1.1.32 - List Stages

8.1.1.32.1 - 1.2

scpcli application-apigateway stage list
--api_id <value>

Description

Get stages list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
api_summaryAPI Summary[{‘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 EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

8.1.1.32.2 - 1.1

scpcli application-apigateway stage list
--api_id <value>

Description

Get stages list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
api_summaryAPI Summary[{‘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 EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

8.1.1.32.3 - 1.0

scpcli application-apigateway stage list
--api_id <value>

Description

Get stages list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_summaryAPI Summary[{‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/’}, {‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/test’}]
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
ip_restriction_enabledIP Restriction EnabledFalse
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-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

Get usage plans list

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNameusage-plan-name

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
connected_api_keysConnected API Keys[‘key1’, ‘key2’]
created_atCreation Date
descriptionDescriptiondescription
limitUsage Plan Limit10
nameNameusage-plan-name
rateUsage Plan Rateday

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

Get usage plans list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNameusage-plan-name

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
connected_api_keysConnected API Keys[‘key1’, ‘key2’]
created_atCreation Date
descriptionDescriptiondescription
limitUsage Plan Limit10
nameNameusage-plan-name
rateUsage Plan Rateday

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

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink Endpoint Action TypeCANCEL

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

Set access control

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

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

Set access control

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

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

Set access control

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

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

Set api description

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
stringDescriptiondescription

8.1.1.36.2 - 1.1

scpcli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

Set api description

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
stringDescriptiondescription

8.1.1.36.3 - 1.0

scpcli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

Set api description

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
stringDescriptiondescription

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

Set api key

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

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

Set api key

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

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

Set auth

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg

8.1.1.38.2 - 1.1

scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

Set auth

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg

8.1.1.38.3 - 1.0

scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

Set auth

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,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

Set method

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dictMethod Request Headers{'test1' : True}
query_strings
required
dictMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
required
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink Endpoint 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

Set method

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dictMethod Request Headers{'test1' : True}
query_strings
required
dictMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
required
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink Endpoint 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

Set method

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dictMethod Request Headers{'test1' : True}
query_strings
required
dictMethod Query Strings{'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

Set PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

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

Set stage active deployment

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
deployment_id
required
stringDeployment 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

Set stage active deployment

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
deployment_id
required
stringDeployment 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

Set stage active deployment

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
deployment_id
required
stringDeployment 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

Set stage configuration

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
jwt_enabled
required
booleanJWT EnabledFalse
cors_enabled
required
booleanCors EnabledFalse
allow_credentials
optional
booleanAllow CredentialsTrue
allow_headers
optional
arrayAllow HeadersContent-Type
allow_methods
optional
arrayAllow Methods'{}'
allow_origins
optional
arrayAllow Origins*
connected_api_keys
optional
arrayConnected API Keyskey1
description
optional
stringDescriptiondescription
expose_headers
optional
arrayExpose Headerstest1
max_age
optional
integerMax Age3600
usage_plan_id
optional
stringUsage Plan 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

Set stage configuration

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
jwt_enabled
required
booleanJWT EnabledFalse
cors_enabled
required
booleanCors EnabledFalse
allow_credentials
optional
booleanAllow CredentialsTrue
allow_headers
optional
arrayAllow HeadersContent-Type
allow_methods
optional
arrayAllow Methods'{}'
allow_origins
optional
arrayAllow Origins*
connected_api_keys
optional
arrayConnected API Keyskey1
description
optional
stringDescriptiondescription
expose_headers
optional
arrayExpose Headerstest1
max_age
optional
integerMax Age3600
usage_plan_id
optional
stringUsage Plan 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

Set stage configuration(Modifying ip_restriction_enabled is no longer supported)

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
jwt_enabled
required
booleanJWT EnabledFalse
ip_restriction_enabled
required
booleanIP Restriction EnabledFalse
cors_enabled
required
booleanCors EnabledFalse
allow_credentials
optional
booleanAllow CredentialsTrue
allow_headers
optional
arrayAllow HeadersContent-Type
allow_methods
optional
arrayAllow Methods'{}'
allow_origins
optional
arrayAllow Origins*
expose_headers
optional
arrayExpose Headerstest1
max_age
optional
integerMax Age3600

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

Set usage plan description

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

8.1.1.43.2 - 1.1

scpcli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

Set usage plan description

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

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

Set usage plan quota

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
stringUsage Plan Rateday
limit
required
integerUsage Plan Limit10

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

Set usage plan quota

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
stringUsage Plan Rateday
limit
required
integerUsage Plan Limit10

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

Show access control

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

8.1.1.45.2 - 1.1

scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

Show access control

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

8.1.1.45.3 - 1.0

scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

Show access control

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

8.1.1.46 - Show Api

8.1.1.46.1 - 1.2

scpcli application-apigateway api show
--api_id <value>

Description

Show api

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

8.1.1.46.2 - 1.1

scpcli application-apigateway api show
--api_id <value>

Description

Show api

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

8.1.1.46.3 - 1.0

scpcli application-apigateway api show
--api_id <value>

Description

Show api

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

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

Show auth

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

8.1.1.47.2 - 1.1

scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

Show auth

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

8.1.1.47.3 - 1.0

scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

Show auth

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

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

Show method

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
privatelink_endpoint_idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod 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

Show method

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod 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

Show method

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod 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

Show PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptiondescription
namePrivateLink Endpoint Nameendpoint
privatelink_service_idPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink Endpoint StatusCANCELED

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

Show resource

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

8.1.1.50.2 - 1.1

scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

Show resource

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

8.1.1.50.3 - 1.0

scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

Show resource

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

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

Show stage

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

8.1.1.51.2 - 1.1

scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

Show stage

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

8.1.1.51.3 - 1.0

scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

Show stage

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
ip_restriction_enabledIP Restriction EnabledFalse
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-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

Show usage plan

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Keys[]
created_atCreation Date
created_by_idCreated by27bb070b564349f8a31cc60734cc36a5
created_by_nameCreated byusername
descriptionDescriptiondescription
limitUsage Plan Limit10
modified_atModified at
modified_by_idModified by27bb070b564349f8a31cc60734cc36a5
modified_by_nameModified byusername
nameNameusage-plan-name
rateUsage Plan Rateday

8.1.1.52.2 - 1.1

scpcli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>

Description

Show usage plan

State ACTIVE (DEPRECATED)

VersionSupported Until
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Keys[]
created_atCreation Date
created_by_idCreated by27bb070b564349f8a31cc60734cc36a5
created_by_nameCreated byusername
descriptionDescriptiondescription
limitUsage Plan Limit10
modified_atModified at
modified_by_idModified by27bb070b564349f8a31cc60734cc36a5
modified_by_nameModified byusername
nameNameusage-plan-name
rateUsage Plan Rateday

8.2 - Queue Service

Overview

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

This guide provides a brief description of Queue Service service and how to call 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

check queue name duplication

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
name
required
stringQueue nametest-queue.fifo

Responses

NameDescriptionExample
resultResultTrue

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

create a queue

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS nametest-kms
message_size
required
integerMessage size256
message_retention_period_unit
required
stringPeriod unitminute
message_retention_period
required
integerMessage retention period40
data_key_reuse_period
optional
integerData key reuse period40
data_key_reuse_period_unit
optional
****Period unitminute
description
optional
stringDescriptionQueue description
tags
optional
arrayTag List'{"key": "key1", "value": "value1"}'

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
messagesDescriptionCreate Queue
stateQueue stateACTIVE

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

delete an acl policy

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
arrayAccess Allowed IP List0.0.0.0

8.2.1.4 - Delete Queue

8.2.1.4.1 - 1.0

scpcli queueservice queue delete
--queue_id <value>

Description

delete a specific queue

State ACTIVE (CURRENT)

VersionSupported Until
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

list queue

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringQueue nametest-queue.fifo

Responses

NameDescriptionExample
idQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
account_idAccount ID8c9f6c1c928a45b4bbd1e4da5531d656
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
encryptionEncryption
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameQueue nametest-queue.fifo
number_wait_messagesNumber of waiting messages10
stateQueue stateACTIVE
typeQueue TypeFIFO

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

update an acl policy

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
ip_address
required
arrayAccess Allowed IP List0.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

show a specific queue

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656

Responses

NameDescriptionExample
ip_addressIP address192.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

update queue config

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
name
required
stringKMS nametest-kms
id
required
stringKMS ID8c9f6c1c928a45b4bbd1e4da5531d656
message_size
required
integerMessage size256
message_retention_period_unit
required
stringPeriod unitminute
message_retention_period
required
integerMessage retention period40
data_key_reuse_period
optional
integerData key reuse period40
data_key_reuse_period_unit
optional
****Period unitminute

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

update queue description

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
queue_id
required
stringQueue ID8c9f6c1c928a45b4bbd1e4da5531d656
description
required
stringDescriptionQueue description

9 - Security

9.1 - Certificate Manager

Overview

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

This guide provides a brief description of Certificate Manager service and how to call CLI. The output is formatted as a JSON string

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

Check duplication name

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringCertificate Name-

Responses

NameDescriptionExample
resultTrue, False CheckTrue

9.1.1.1.2 - 1.0

scpcli certificatemanager certificate check
--name <value>

Description

Check duplication name

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
name
required
stringCertificate Name-

Responses

NameDescriptionExample
resultTrue, False CheckTrue

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

Create a Certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Seoul
region
required
stringName of regionwest1
private_key
required
stringPrivate key<encoded private key data>
name
required
stringCertificate Nametest-certificate
cert_body
required
stringCertificate body<encoded certificate body data>
cert_chain
optional
stringCertificate chain<encoded certificate chain data>
recipients
optional
arrayExpired certificates Recipients'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typePRD
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
recipientsExpired certificates Recipients[{‘region’: ‘’, ‘user_id’: ‘sdaFDQSDADZ2488e195c0e97d9b9eb’, ‘user_name’: ‘kildong.hong’}]
stateCertificate StateVALID
tagsTag List’
user_nameUser Namekildong@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

Create a Certificate

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Seoul
region
required
stringName of regionwest1
private_key
required
stringPrivate key<encoded private key data>
name
required
stringCertificate Nametest-certificate
cert_body
required
stringCertificate body<encoded certificate body data>
cert_chain
optional
stringCertificate chain<encoded certificate chain data>
recipients
optional
arrayExpired certificates Recipients'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typePRD
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
recipientsExpired certificates Recipients[{‘region’: ‘’, ‘user_id’: ‘sdaFDQSDADZ2488e195c0e97d9b9eb’, ‘user_name’: ‘kildong.hong’}]
stateCertificate StateVALID
tagsTag List’
user_nameUser Namekildong@samsung.com

9.1.1.3 - Delete a certificate

9.1.1.3.1 - 1.1

scpcli certificatemanager certificate delete
--certificate_id <value>

Description

Delete a Certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

9.1.1.3.2 - 1.0

scpcli certificatemanager certificate delete
--certificate_id <value>

Description

Delete a Certificate

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

9.1.1.4 - Detail a certificate

9.1.1.4.1 - 1.1

scpcli certificatemanager certificate detail
--certificate_id <value>

Description

Detail a Certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typeDEV
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
stateCertificate StateVALID
user_nameUser Name2048

9.1.1.4.2 - 1.0

scpcli certificatemanager certificate detail
--certificate_id <value>

Description

Detail a Certificate

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typeDEV
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
stateCertificate StateVALID
user_nameUser Name2048

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

List Certificates

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanIs it my certificate-
name
optional
stringCertificate Nametest-certificate
cn
optional
stringCertificate Common Nametest.go.kr
state
optional
arrayCertificate StateV

Responses

NameDescriptionExample
idCertificate ID
cert_kindCertificate typePRD
cnCertificate Common Nametest.go.kr
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
stateCertificate StateVALID

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

List Certificates

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanIs it my certificate-
name
optional
stringCertificate Nametest-certificate
cn
optional
stringCertificate Common Nametest.go.kr
state
optional
arrayCertificate StateV

Responses

NameDescriptionExample
idCertificate ID
cert_kindCertificate typePRD
cnCertificate Common Nametest.go.kr
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
stateCertificate StateVALID

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

Self-sign a Certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Seoul
region
required
stringName of regionwest1
organization
required
stringCertificate Organization NamesamsungSDS
not_before_dt
required
stringCertificate Start Date20250101
not_after_dt
required
stringCertificate Expire Date20251212
name
required
stringCertificate Nametest-certificate
cn
required
stringCertificate Common Nametest.go.kr
recipients
optional
arrayExpired certificates Recipients'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typeDEV
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
stateCertificate StateVALID
user_nameUser Name2048

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

Self-sign a Certificate

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Seoul
region
required
stringName of regionwest1
organization
required
stringCertificate Organization NamesamsungSDS
not_before_dt
required
stringCertificate Start Date20250101
not_after_dt
required
stringCertificate Expire Date20251212
name
required
stringCertificate Nametest-certificate
cn
required
stringCertificate Common Nametest.go.kr
recipients
optional
arrayExpired certificates Recipients'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typeDEV
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
stateCertificate StateVALID
user_nameUser Name2048

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

Validate a Certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
private_key
required
stringPrivate key<encoded private key data>
cert_body
required
stringCertificate body<encoded certificate body data>
cert_chain
optional
stringCertificate chain<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

Validate a Certificate

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
private_key
required
stringPrivate key<encoded private key data>
is_need_cert_chain
required
booleanIs needed Certificate chainTrue
cert_body
required
stringCertificate body<encoded certificate body data>
cert_chain
optional
stringCertificate chain<encoded certificate chain data>

Responses

NameDescriptionExample
resultTrue, False CheckTrue

9.2 - Config Inspection

Overview

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

This guide provides a brief description of Config Inspection and how to call CLI. The output is formatted as a JSON string

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

Create Diagnosis Object

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
use_diagnosis_check_type_ssi
required
stringChecklist SSI usagey
use_diagnosis_check_type_bp
required
stringChecklist Best Practice Usey
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
stringId of auth key9b72a9856e494e67afc69atd3631fe38
plan_type
required
stringplan TypeSTANDARD
diagnosis_type
required
stringdiagnosis TypeConsole
diagnosis_name
required
stringName of diagnosisSample Diagnosis Name
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
diagnosis_account_id
required
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
csp_type
required
stringType of cloud service providerSCP
account_id
required
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
tags
optional
arrayTag List'{"key": "", "value": ""}'
auth_key_created_at
optional
stringcreated date of authkey2022-01-01 12:00:00
auth_key_expired_at
optional
stringexpired date of authkey2023-01-01 12:00:00

Responses

NameDescriptionExample
diagnosis_idId of diagnosisSample Diagnosis Name
resultTrue, False CheckTrue

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

Create Diagnosis Object

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
use_diagnosis_check_type_ssi
required
stringChecklist SSI usagey
use_diagnosis_check_type_bp
required
stringChecklist Best Practice Usey
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
stringId of auth key9b72a9856e494e67afc69atd3631fe38
plan_type
required
stringplan TypeSTANDARD
diagnosis_type
required
stringdiagnosis TypeConsole
diagnosis_name
required
stringName of diagnosisSample Diagnosis Name
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
diagnosis_account_id
required
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
csp_type
required
stringType of cloud service providerSCP
account_id
required
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
tags
optional
arrayTag List'{"key": "", "value": ""}'
auth_key_created_at
optional
stringcreated date of authkey2022-01-01 12:00:00
auth_key_expired_at
optional
stringexpired date of authkey2023-01-01 12:00:00

Responses

NameDescriptionExample
resultTrue, False CheckTrue

9.2.1.2 - Delete Config Inspection

9.2.1.2.1 - 1.1

scpcli configinspection ci delete
--diagnosis_id <value>

Description

Delete Config Inspection Product

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

9.2.1.2.2 - 1.0

scpcli configinspection ci delete
--diagnosis_id <value>

Description

Delete Config Inspection Product

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample 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

Request diagnosis

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
tenant_id
required
stringTenant ID1234567890
secret_key
required
stringSecret KeySAMPLE KEY
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
access_key
required
stringAccess KeySAMPLE KEY

Responses

NameDescriptionExample
resultTrue, False CheckTrue

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

Request diagnosis

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
tenant_id
required
stringTenant ID1234567890
secret_key
required
stringSecret KeySAMPLE KEY
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
access_key
required
stringAccess KeySAMPLE KEY

Responses

NameDescriptionExample
resultTrue, False CheckTrue

9.2.1.4 - Get Diagnosis Object Detail

9.2.1.4.1 - 1.1

scpcli configinspection ci detail
--diagnosis_id <value>

Description

Get Diagnosis Object Detail

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

Responses

NameDescriptionExample
auth_key_created_atcreated date of authkey2022-01-01T12:00:00Z
auth_key_expired_atexpired date of authkey2022-01-01T12:00:00Z
auth_key_idId of auth key9b72a9856e494e67afc69atd3631fe38
auth_key_statestate of auth keyACTIVATED
user_iduser Id4f5d60e9e08b48d0a0881e21ab14e266

9.2.1.4.2 - 1.0

scpcli configinspection ci detail
--diagnosis_id <value>

Description

Get Diagnosis Object Detail

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

Responses

NameDescriptionExample
auth_key_created_atcreated date of authkey2022-01-01T12:00:00Z
auth_key_expired_atexpired date of authkey2022-01-01T12:00:00Z
auth_key_idId of auth key9b72a9856e494e67afc69atd3631fe38
auth_key_statestate of auth keyACTIVATED
user_iduser 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

get Diagnosis Result Detail

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
diagnosis_request_sequence
required
stringSequence of diagnosis requestSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
action_guidemeasure guide description원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.
changediS Change result manageTrue
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_criteriadecision standard description【 Security Group 규칙 】
① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다.
diagnosis_itemsub category description2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다.
diagnosis_layerinspector item category description2.NETWORK
diagnosis_methodinspector method descriptionSecurity Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다.
diagnosis_resultverify result state03
result_contentsresult 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

get Diagnosis Result Detail

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_request_sequence
required
stringSequence of diagnosis requestSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
action_guidemeasure guide description원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.
changediS Change result manageTrue
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_criteriadecision standard description【 Security Group 규칙 】
① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다.
diagnosis_itemsub category description2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다.
diagnosis_layerinspector item category description2.NETWORK
diagnosis_methodinspector method descriptionSecurity Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다.
diagnosis_resultverify result state03
result_contentsresult 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

get config inspection list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanmy Config InspectionFalse
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisMy Diagnosis
csp_type
optional
stringType of cloud service providerSCP
diagnosis_account_id
optional
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
recent_diagnosis_state
optional
arrayrecent Diagnosis StateC
start_date
optional
stringstart Date2022-01-01 12:00:00
end_date
optional
stringend Date2022-01-02 12:00:00

Responses

NameDescriptionExample
created_atCreated date2022-01-01T12:00:00Z
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_typediagnosis TypeConsole
error_stateError type of recent diagnosisCONNECTION_FAIL
plan_typeplan TypeSTANDARD
recent_diagnosis_atrecent Diagnosis Date2022-01-01T12:00:00Z
recent_diagnosis_staterecent Diagnosis StateCompleted

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

get config inspection list

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanmy Config InspectionFalse
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisMy Diagnosis
csp_type
optional
stringType of cloud service providerSCP
diagnosis_account_id
optional
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
recent_diagnosis_state
optional
arrayrecent Diagnosis StateC
start_date
optional
stringstart Date2022-01-01 12:00:00
end_date
optional
stringend Date2022-01-02 12:00:00

Responses

NameDescriptionExample
created_atCreated date2022-01-01T12:00:00Z
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_typediagnosis TypeConsole
error_stateError type of recent diagnosisCONNECTION_FAIL
plan_typeplan TypeSTANDARD
recent_diagnosis_atrecent Diagnosis Date2022-01-01T12:00:00Z
recent_diagnosis_staterecent Diagnosis StateCompleted

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

get Diagnosis Result List

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisSample Diagnosis Name
start_date
optional
stringstart Date2022-01-01
end_date
optional
stringend Date2022-12-31
csp_type
optional
stringType of cloud service providerSCP
diagnosis_state
optional
stringStatus of diagnosisCompleted
user_id
optional
stringuser Id76b563a009584b1380715c00703a02ff

Responses

NameDescriptionExample
count_checkcheck count10
count_errorerror count0
count_failfail count3
count_nana count2
count_passpass count5
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_request_sequenceSequence of diagnosis request1234567890
diagnosis_resultdiagnosis ResultSUCCESS
diagnosis_total_countdiagnosis Total Count10
proceed_dateproceed Date2022-01-01T12:00:00Z
totaltotal count10

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

get Diagnosis Result List

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisSample Diagnosis Name
start_date
optional
stringstart Date2022-01-01
end_date
optional
stringend Date2022-12-31
csp_type
optional
stringType of cloud service providerSCP
diagnosis_state
optional
stringStatus of diagnosisCompleted
user_id
optional
stringuser Id76b563a009584b1380715c00703a02ff

Responses

NameDescriptionExample
count_checkcheck count10
count_errorerror count0
count_failfail count3
count_nana count2
count_passpass count5
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_request_sequenceSequence of diagnosis request1234567890
diagnosis_resultdiagnosis ResultSUCCESS
diagnosis_total_countdiagnosis Total Count10
proceed_dateproceed Date2022-01-01T12:00:00Z
totaltotal count10

9.3 - Key Management Service

Overview

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

This guide provides a brief description of Key Management Service(KMS) and how to call CLI. The output is formatted as a JSON string

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

Change rotate info.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
rotate_cycle
required
integerRotation cycle7
auto_rotate
required
stringAuto rotate Y or NY

9.3.1.1.2 - 1.0

scpcli kms kms change rotate info
--key_id <value>
--rotate_cycle <value>
--auto_rotate <value>

Description

Change rotate info.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
rotate_cycle
required
integerRotation cycle7
auto_rotate
required
stringAuto rotate Y or 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

Change state of key.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
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

Change state of key.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
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

Check duplication of key name.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringName of keytestkey

Responses

NameDescriptionExample
isDuplicateNameTrue

9.3.1.3.2 - 1.0

scpcli kms kms check duplicate name
--name <value>

Description

Check duplication of key name.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringName of keytestkey

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

Generates a new key and the value encrypted with key(Purpose: encryption/decryption).

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
key_type
required
stringKey type( plaintext or wrapped )plaintext

Responses

NameDescriptionExample
ciphertextEncrypted data keyvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1
plaintextData key(base64 encoded)oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

9.3.1.4.2 - 1.0

scpcli kms kms datakey
--key_id <value>
--key_type <value>

Description

Generates a new key and the value encrypted with key(Purpose: encryption/decryption).

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
key_type
required
stringKey type( plaintext or wrapped )plaintext

Responses

NameDescriptionExample
ciphertextEncrypted data keyvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1
plaintextData key(base64 encoded)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

Create key.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
rotate_cycle
required
integerRotation cycle7
purpose
required
stringPurpose of keyrsa-2048
name
required
stringName of keytestkey
description
required
stringDescription of Keydescription1
auto_rotate
required
stringAuto rotate Y or NY
key_type
optional
stringbasic or advancedadvanced
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

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

Create key.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
rotate_cycle
required
integerRotation cycle7
purpose
required
stringPurpose of keyrsa-2048
name
required
stringName of keytestkey
description
required
stringDescription of Keydescription1
auto_rotate
required
stringAuto rotate Y or NY
key_type
optional
stringbasic or advancedadvanced
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

9.3.1.6 - Decrypt Data

9.3.1.6.1 - 1.1

scpcli kms kms decrypt
--key_id <value>
--ciphertext <value>

Description

Decrypts the provided ciphertext using key(Purpose: encryption/decryption).

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
plaintextDecrypted data(base64 encoded)dGhlIHF1aWNrIGJyb3duIGZveAo=

9.3.1.6.2 - 1.0

scpcli kms kms decrypt
--key_id <value>
--ciphertext <value>

Description

Decrypts the provided ciphertext using key(Purpose: encryption/decryption).

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
plaintextDecrypted data(base64 encoded)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

Delete a key now or later.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
is_directly
optional
booleanDelete immediatelyTrue

9.3.1.7.2 - 1.0

scpcli kms kms delete
--key_id <value>
[--is_directly <value>]

Description

Delete a key now or later.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
is_directly
optional
booleanDelete immediatelyTrue

9.3.1.8 - Encrypt Data

9.3.1.8.1 - 1.1

scpcli kms kms encrypt
--key_id <value>
--plaintext <value>

Description

Encrypts the provided plaintext(base64 encoded) using key(Purpose: encryption/decryption)

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
plaintext
required
stringData(base64 encoded) to encryptdGhlIHF1aWNrIGJyb3duIGZveAo=

Responses

NameDescriptionExample
ciphertextEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1

9.3.1.8.2 - 1.0

scpcli kms kms encrypt
--key_id <value>
--plaintext <value>

Description

Encrypts the provided plaintext(base64 encoded) using key(Purpose: encryption/decryption)

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
plaintext
required
stringData(base64 encoded) to encryptdGhlIHF1aWNrIGJyb3duIGZveAo=

Responses

NameDescriptionExample
ciphertextEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1

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

List keys.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringName of keytestkey

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

9.3.1.9.2 - 1.0

scpcli kms kms list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

List keys.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringName of keytestkey

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

9.3.1.10 - List Users

9.3.1.10.1 - 1.1

scpcli kms kms list users
--key_id <value>

Description

Get List of users who use key.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
user_idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
user_nameUser Namekimsamsung

9.3.1.10.2 - 1.0

scpcli kms kms list users
--key_id <value>

Description

Get List of users who use key.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
user_idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
user_nameUser Namekimsamsung

9.3.1.11 - Make hmac

9.3.1.11.1 - 1.1

scpcli kms kms generate hmac
--key_id <value>
--input <value>

Description

Generates a HMAC using key(Purpose: create/verification).

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
hmacHMAC datavault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

9.3.1.11.2 - 1.0

scpcli kms kms generate hmac
--key_id <value>
--input <value>

Description

Generates a HMAC using key(Purpose: create/verification).

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
hmacHMAC datavault: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

Rewraps the provided ciphertext using the latest version of key(Purpose: encryption/decryption).

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
ciphertextRewrapped data by KMSvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1

9.3.1.12.2 - 1.0

scpcli kms kms rewrap
--key_id <value>
--ciphertext <value>

Description

Rewraps the provided ciphertext using the latest version of key(Purpose: encryption/decryption).

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
ciphertextRewrapped data by KMSvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1

9.3.1.13 - Rotate Key

9.3.1.13.1 - 1.1

scpcli kms kms rotate
--key_id <value>

Description

Rotate key.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

9.3.1.13.2 - 1.0

scpcli kms kms rotate
--key_id <value>

Description

Rotate key.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

9.3.1.14 - Show Key

9.3.1.14.1 - 1.1

scpcli kms kms show
--key_id <value>

Description

Show key.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

9.3.1.14.2 - 1.0

scpcli kms kms show
--key_id <value>

Description

Show key.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

9.3.1.15 - Sign Data

9.3.1.15.1 - 1.1

scpcli kms kms sign
--key_id <value>
--input <value>

Description

Returns the cryptographic signature of the given data using key(Purpose: signature/verification).

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for SignaturedGVzdCBpbnB1dA==

Responses

NameDescriptionExample
key_versionVersion of KMS key1
signatureSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

9.3.1.15.2 - 1.0

scpcli kms kms sign
--key_id <value>
--input <value>

Description

Returns the cryptographic signature of the given data using key(Purpose: signature/verification).

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for SignaturedGVzdCBpbnB1dA==

Responses

NameDescriptionExample
key_versionVersion of KMS key1
signatureSignature datavault: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

Update description.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
description
required
stringDescription of Key-

9.3.1.16.2 - 1.0

scpcli kms kms update description
--key_id <value>
--description <value>

Description

Update description.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
description
required
stringDescription of Key-

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

Returns whether the provided signature is valid for the given data from either the sign data using key(Purpose: signature/verification).

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
signature
required
stringSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
validVerify resultTrue

9.3.1.17.2 - 1.0

scpcli kms kms verify
--key_id <value>
--signature <value>
--input <value>

Description

Returns whether the provided signature is valid for the given data from either the sign data using key(Purpose: signature/verification).

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
signature
required
stringSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
validVerify resultTrue

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

Returns whether the INPUT value is VALID or not using key(Purpose: create/verification).

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==
hmac
required
stringSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

Responses

NameDescriptionExample
validVerify resultTrue

9.3.1.18.2 - 1.0

scpcli kms kms verify hmac
--key_id <value>
--input <value>
--hmac <value>

Description

Returns whether the INPUT value is VALID or not using key(Purpose: create/verification).

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==
hmac
required
stringSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

Responses

NameDescriptionExample
validVerify resultTrue

9.4 - Secret Vault

Overview

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

This guide provides a brief description of Secret Vault and how to call CLI. The output is formatted as a JSON string

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

Create Secret Vault.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
vault_token_ttl_ndays
required
integerTTL of vault token720
temporary_key_ttl_nhours
required
integerTemporary key valid hours3
name
required
stringSecret Vault Idname
acl_cidr
required
stringAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
access_key_id
required
stringId of access keyb754b12b39da4ce29a40c5e324650bd0
description
optional
stringDescriptiondescription
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key_idId of access key0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeType of access keyTemporary
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescriptiondescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keyvaultkey
temporary_key_ttl_nhoursTemporary key valid hours36
user_nameUser nameusername
vault_token_expired_atVault Token expired date2025-02-25 03:07:17.000
vault_token_idId of vault tokenaace85da-965e-d95a-b4ed-8d32b5d6079
vault_token_secret_valueSecret of vault token6171392c-5fd9-43db-9e15-e14af0068f96
vault_token_ttl_ndaysTTL of vault token10
vaultkey_stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_typeType of vault keySCP Open API Key
waiting_time_ndaysDays remaining until deletion10

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

Change Secret Vault state to ‘To be terminated’.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_vault_id
required
stringSecret Vault Id3265ab469f0d406d83073da3e11e7a6c
waiting_time_ndays
required
integerDays remaining until deletion7

9.4.1.3 - List Secret Vaults

9.4.1.3.1 - 1.0

scpcli secretvault sv list

Description

List Secret Vaults.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key_idId of access key0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeType of access keyTemporary
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescriptiondescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keyvaultkey
temporary_key_ttl_nhoursTemporary key valid hours36
user_nameUser nameusername
vault_token_expired_atVault Token expired date2025-02-25 03:07:17.000
vault_token_idId of vault token[AES] SZtB6RasvLypCv4soJlQO3ZmYpUPjFblz7pstjBeTQJXcz/d5KB9TUR3gMY08mga4fxWaF6IfUzTMBh6j/CAaw==
vault_token_secret_valueSecret of vault token[AES] 91/kdnK4NDfs2HGWgNH/EYNnqD7OcM1unXWs0ZAuaFttIqgP8xMUx0dOaRfD6kOD7uuujFxF2nzx35D9Gz9nwQ==
vault_token_ttl_ndaysTTL of vault token10
vaultkey_stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_typeType of vault keySCP Open API Key
waiting_time_ndaysDays remaining until deletion10

9.4.1.4 - Show Secret Vault

9.4.1.4.1 - 1.0

scpcli secretvault sv show
--secret_vault_id <value>

Description

Show Secret Vault.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_vault_id
required
stringSecret Vault Id3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_keyAccess key[‘0e3*****************************’]
access_key_idId of access key0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeType of access key[‘Temporary’, ‘Permanent’]
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of Keydescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of key[‘vaultkey’]
temp_key_expired_atTemporary key expired date2025-02-25 03:07:17.000
temporary_key_ttl_nhoursTemporary key valid hours[‘36’]
vault_token_expired_atVault Token expired date2025-02-25 03:07:17.000
vault_token_idId of vault tokenaace85da-965e-d95a-b4ed-8d32b5d6079
vault_token_secret_valueSecret of vault token6171392c-5fd9-43db-9e15-e14af0068f96
vault_token_ttl_ndaysTTL of vault token[‘10’]
vaultkey_stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_typeType of vault key[‘SCP Open API Key’]
waiting_time_ndaysDays remaining until deletion10

9.5 - Secrets Manager

Overview

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

This guide provides a brief description of Secrets Manager and how to call CLI. The output is formatted as a JSON string

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

Create secret.

State ACTIVE (CURRENT)

VersionSupported Until
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 Namename
kms_id
required
stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required
stringAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
description
optional
stringDescription of secretdescription
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of secretdescription
kms_idResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
kms_nameResource name of KMS keykmsname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keymy-secret-name
recent_searched_atDate of recent search2025-02-25 03:07:17.000
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeType of secretGeneral

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

Delete secret.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
waiting_time_ndays
required
integerDays remaining until deletion7

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

Generate random password.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
exclude_characters
optional
stringCharacters to exclude when generating passwordabcdefg
exclude_lowercase
optional
booleanOption to exclude lowercase lettersfalse
exclude_numbers
optional
booleanOption to exclude numbersfalse
exclude_punctuation
optional
booleanOption to exclude punctuationfalse
exclude_uppercase
optional
booleanOption to exclude uppercase lettersfalse
include_space
optional
booleanOption to include spacesfalse
password_length
optional
integerLength of the password to generate32
require_each_included_type
optional
booleanRequire all included character typestrue

Responses

NameDescriptionExample
random_passwordGenerate 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

List secrets.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringSecret Namename
state
optional
arraySecret StateA

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of secretdescription
kms_idResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
kms_nameResource name of KMS keykmsname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keymy-secret-name
recent_searched_atDate of recent search2025-02-25 03:07:17.000
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeType of secretGeneral

9.5.1.5 - List Versions of Secret

9.5.1.5.1 - 1.0

scpcli secretsmanager secret list version
--secret_id <value>

Description

List versions of secrets.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c

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

Cancel process of deleting secret.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c

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

Edit the IP CIDR value for access control when retrieving the value of a Secret.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required
stringAccess control list of secret in CIDR192.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

Set description of secret.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
description
required
stringDescription of secretdescription

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

Modify the KMS ID used to encrypt the secret value.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
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

Labels are added, moved, or removed from a version. If only the move_to_version_id value is used, the label is added. If only the remove_from_version_id value is used, the label is removed. If both values are used, the label is moved from remove_from_version_id to move_to_version_id.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
label
required
stringLabel of secret version. Not allow duplication.My Custom Label
move_to_version_id
optional
stringSecret Version ID3265ab469f0d406d83073da3e11e7a6c
remove_from_version_id
optional
stringSecret Version ID3265ab469f0d406d83073da3e11e7a6c

9.5.1.11 - Show Secret Detail

9.5.1.11.1 - 1.0

scpcli secretsmanager secret show
--secret_id <value>

Description

Show secret detail.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of secretdescription
kms_idResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
kms_nameResource name of KMS keykmsname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keymy-secret-name
recent_searched_atDate of recent search2025-02-25 03:07:17.000
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeType of secretGeneral

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

Show secret value.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
label
optional
stringLabel of secret version. Not allow duplication.CURRENT
version_id
optional
stringSecret Version IDe7b638507d9f4feeb6032a22b7640bf7

Responses

NameDescriptionExample
secret_valueThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{“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

Update secret value.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
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

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

This guide provides a brief description of CloudControl service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

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

This guide provides a brief description of IAM service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
policy_ids
required
arrayPolicy ID List37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
policy_ids
required
arrayPolicy ID List37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
policy_ids
required
arrayPolicy ID List37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 ID-
policy_ids
optional
arrayUser Policy Bindings-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 ID-
policy_ids
optional
arrayUser Policy Bindings-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
string사용자 ID-
policy_ids
optional
arrayUser Policy Bindings-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
policy_ids
required
arrayPolicy ID List-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
policy_ids
required
arrayPolicy ID List-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
string역할 ID-
policy_ids
required
arrayPolicy ID List-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
idp_cert_end유효기간
idp_file_name메타데이터 파일 이름
idp_file_size메타데이터 파일 크기
idp_issuer_url발행자 URL
idp_sso_urlSSO 서비스 위치
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
idp_cert_end유효기간
idp_file_name메타데이터 파일 이름
idp_file_size메타데이터 파일 크기
idp_issuer_url발행자 URL
idp_sso_urlSSO 서비스 위치
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
idp_cert_end유효기간
idp_file_name메타데이터 파일 이름
idp_file_size메타데이터 파일 크기
idp_issuer_url발행자 URL
idp_sso_urlSSO 서비스 위치
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idProject Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
saml_provider_id
required
string자격증명공급자 ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
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_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
saml_provider_id
required
string자격증명공급자 ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
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_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
saml_provider_id
required
string자격증명공급자 ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
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_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess key expiration timestamp9999-12-31T23:59:59Z
is_enabled활성화 여부true
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionUser Description
dst_offsetDST Offset
emailUser Email
email_authenticatedemail 인증 여부
first_name사용자 이름
groupsgroup names
last_login_at마지막 로그인
last_name사용자 성
last_password_update_at마지막 비밀번호 수정시간
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionUser Description
dst_offsetDST Offset
emailUser Email
email_authenticatedemail 인증 여부
first_name사용자 이름
groupsgroup names
last_login_at마지막 로그인
last_name사용자 성
last_password_update_at마지막 비밀번호 수정시간
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionUser Description
dst_offsetDST Offset
emailUser Email
email_authenticatedemail 인증 여부
first_name사용자 이름
groupsgroup names
last_login_at마지막 로그인
last_name사용자 성
last_password_update_at마지막 비밀번호 수정시간
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_name생성자
description자격증명공급자 설명
federation_type자격증명공급자 유형
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_email생성자 Emailsamsung.kim@samsung.com
creator_name생성자 성, 이름Kim Samsung
default_version_idPolicy Default Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_name도메인 이름scp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
srn
required
string삼성 리소스 자원명c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

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

This guide provides a brief description of IAM service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance 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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_typePrincipal TypeUSER
target_account_idAssigned Account 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance 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_idAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_idAssigned Account 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance 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_idAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_idAssigned Account 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameAdmin_Group
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
user_uuids
optional
arrayList of User IDs to be added to the group138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameAdmin_Group
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
user_uuids
optional
arrayList of User IDs to be added to the group138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameAdmin_Group
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
user_uuids
optional
arrayList of User IDs to be added to the group138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringInstance NameMy Instance
description
optional
stringInstance DescriptionMy Instance Description
identity_store_type
optional
stringIdentity Store Type-
bind_credential
optional
stringBind Passwordpassword
bind_dn
optional
stringBind DNCN=Administrator,CN=Users,DC=test,DC=add
connection_url
optional
stringLDAP Server URLldaps://test.subdomain.company.com:123
rdn_ldap_attribute
optional
stringRDN LDAP Attributecn
user_object_classes
optional
stringUser Object Classesperson, organizationalPerson, user
username_ldap_attribute
optional
stringUsername LDAP AttributesAMAccountName
users_dn
optional
stringUsers DNOU=Employees,OU=Accounts,DC=sub,DC=org

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delegated_account_idDelegated Account IDacc-2353
delegated_atDelegation Date2023-10-15 14:30:00
delegated_byDelegated Bysef2w3c8c29a449dbfa8681f8f1d78e2
descriptionInstance DescriptionMy Instance Description
identity_store_configIdentity 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_idIdentity Store IDd-12345
identity_store_typeIdentity Store Type
last_sync_atLast Sync Date2025-08-06 10:30:00
last_sync_statusLast Sync Status[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’]
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInstance NameMy Instance
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO Start URLhttps://login.e.samsungsdscloud.com/d-12345
stateState

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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
name
required
stringInstance NameMy Instance
description
optional
stringInstance DescriptionMy Instance Description
identity_store_type
optional
stringIdentity Store Type-
bind_credential
optional
stringBind Passwordpassword
bind_dn
optional
stringBind DNCN=Administrator,CN=Users,DC=test,DC=add
connection_url
optional
stringLDAP Server URLldaps://test.subdomain.company.com:123
rdn_ldap_attribute
optional
stringRDN LDAP Attributecn
user_object_classes
optional
stringUser Object Classesperson, organizationalPerson, user
username_ldap_attribute
optional
stringUsername LDAP AttributesAMAccountName
users_dn
optional
stringUsers DNOU=Employees,OU=Accounts,DC=sub,DC=org

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delegated_account_idDelegated Account IDacc-2353
delegated_atDelegation Date2023-10-15 14:30:00
delegated_byDelegated Bysef2w3c8c29a449dbfa8681f8f1d78e2
descriptionInstance DescriptionMy Instance Description
identity_store_configIdentity 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_idIdentity Store IDd-12345
identity_store_typeIdentity Store Type
last_sync_atLast Sync Date2025-08-06 10:30:00
last_sync_statusLast Sync Status[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’]
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInstance NameMy Instance
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO Start URLhttps://login.e.samsungsdscloud.com/d-12345
stateState

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
session_duration
required
integerMaximum Session Duration3600
name
required
stringInstance NameMy Instance
instance_id
required
stringInstance IDssoins-12345
custom_policies
optional
arrayCustomer Managed Policy-
description
optional
stringInstance DescriptionMy Instance Description
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy'{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}'

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
session_duration
required
integerMaximum Session Duration3600
name
required
stringInstance NameMy Instance
instance_id
required
stringInstance IDssoins-12345
customer_policies
optional
arrayCustomer Managed Policy-
description
optional
stringInstance DescriptionMy Instance Description
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy'{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}'

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
session_duration
required
integerMaximum Session Duration3600
name
required
stringInstance NameMy Instance
instance_id
required
stringInstance IDssoins-12345
customer_policies
optional
arrayCustomer Managed Policy-
description
optional
stringInstance DescriptionMy Instance Description
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy'{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}'

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser Login IDjohndoe
name
required
stringReal NameJohn Doe
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
group_ids
optional
arrayList of Groups the User Belongs To39520424-440c-41c0-9b9c-f22b2129f6f9
manager
optional
stringManagerAlice Smith
nation_id
optional
stringNationality ID+82
password
optional
stringPassword-
phone_number
optional
stringPhone Number010-1234-5678
temporary_password
optional
booleanTemporary Password Status-

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2025-11-24T08:14:51.694996
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser Login IDjohndoe
name
required
stringReal NameJohn Doe
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
group_ids
optional
arrayList of Groups the User Belongs To39520424-440c-41c0-9b9c-f22b2129f6f9
manager
optional
stringManagerAlice Smith
nation_id
optional
stringNationality ID+82
password
optional
stringPassword-
phone_number
optional
stringPhone Number010-1234-5678
temporary_password
optional
booleanTemporary Password Status-

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2025-11-24T08:14:51.694996
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser Login IDjohndoe
name
required
stringReal NameJohn Doe
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
group_ids
optional
arrayList of Groups the User Belongs To39520424-440c-41c0-9b9c-f22b2129f6f9
manager
optional
stringManagerAlice Smith
nation_id
optional
stringNationality ID+82
password
optional
stringPassword-
phone_number
optional
stringPhone Number010-1234-5678
temporary_password
optional
booleanTemporary Password Status-

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2025-11-24T08:14:51.694996
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
account_assignment_id
required
stringAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
only_user_removed
optional
booleanExclude Directly Applied Only-

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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
account_assignment_id
required
stringAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
only_user_removed
optional
booleanExclude Directly Applied Only-

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
account_assignment_id
required
stringAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
only_user_removed
optional
booleanExclude Directly Applied Only-

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
account_assignment_ids
optional
arrayAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
only_user_removed
optional
booleanExclude Directly Applied Only-

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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
account_assignment_ids
optional
arrayAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
only_user_removed
optional
booleanExclude Directly Applied Only-

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
account_assignment_ids
optional
arrayAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
only_user_removed
optional
booleanExclude Directly Applied Only-

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
group_ids
required
arrayList of Group IDsgroup-12345

10.4.1.9.2 - 1.1

scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>

Description

delete groups

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
group_ids
required
arrayList of Group IDsgroup-12345

10.4.1.9.3 - 1.0

scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>

Description

delete groups

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
group_ids
required
arrayList of Group IDsgroup-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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

10.4.1.13.2 - 1.1

scpcli iam-identity-center instance delete
--instance_id <value>

Description

delete a specific instance

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

10.4.1.13.3 - 1.0

scpcli iam-identity-center instance delete
--instance_id <value>

Description

delete a specific instance

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
policy_ids
required
array-
instance_id
required
stringInstance 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
policy_ids
required
array-
instance_id
required
stringInstance 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
policy_ids
required
array-
instance_id
required
stringInstance 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
target_account_name
optional
stringAssigned Account NameAdmin Account
target_account_email
optional
stringAssigned Account Emailtarget_account@example.com
permission_set_id
optional
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_name
optional
stringPrincipal NameGROUP0407
role_srn
optional
stringRole SRNsrn:role:kr-j:1234:role/admin@example.com

Responses

NameDescriptionExample
instance_idInstance IDssoins-12345
permission_sets
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_namePrincipal NameGROUP0407
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_emailAssigned Account Emailtarget_account@example.com
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
target_account_nameAssigned Account NameAdmin 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
target_account_name
optional
stringAssigned Account NameAdmin Account
target_account_email
optional
stringAssigned Account Emailtarget_account@example.com
permission_set_id
optional
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_name
optional
stringPrincipal NameGROUP0407
role_srn
optional
stringRole SRNsrn:role:kr-j:1234:role/admin@example.com

Responses

NameDescriptionExample
instance_idInstance IDssoins-12345
permission_sets
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_namePrincipal NameGROUP0407
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_emailAssigned Account Emailtarget_account@example.com
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
target_account_nameAssigned Account NameAdmin 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
target_account_name
optional
stringAssigned Account NameAdmin Account
target_account_email
optional
stringAssigned Account Emailtarget_account@example.com
permission_set_id
optional
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_name
optional
stringPrincipal NameGROUP0407
role_srn
optional
stringRole SRNsrn:role:kr-j:1234:role/admin@example.com

Responses

NameDescriptionExample
instance_idInstance IDssoins-12345
permission_sets
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_namePrincipal NameGROUP0407
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_emailAssigned Account Emailtarget_account@example.com
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
target_account_nameAssigned Account NameAdmin 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameAdmin_Group
excluded_user_uuid
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameAdmin_Group
excluded_user_uuid
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameAdmin_Group
excluded_user_uuid
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
group_countNumber of Groups the User Belongs To2
groupsList of Groups the User Belongs To[{‘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_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameReal NameJohn Doe
user_idUser Login 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
group_countNumber of Groups the User Belongs To2
groupsList of Groups the User Belongs To[{‘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_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameReal NameJohn Doe
user_idUser Login 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
group_countNumber of Groups the User Belongs To2
groupsList of Groups the User Belongs To[{‘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_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameReal NameJohn Doe
user_idUser Login 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
stateState

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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringInstance NameMy Instance

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
stateState

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringInstance NameMy Instance

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
stateState

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
category
optional
****Policy TypeINLINE_POLICY
name
optional
stringPermission Set

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
categoryPolicy TypeINLINE_POLICY
contentsJSON Document
namePolicy NamePolicyName
permission_set_idPermission Set 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
category
optional
****Policy TypeINLINE_POLICY
name
optional
stringPermission Set

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
categoryPolicy TypeINLINE_POLICY
contentsJSON Document
namePolicy NamePolicyName
permission_set_idPermission Set 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
category
optional
****Policy TypeINLINE_POLICY
name
optional
stringPermission Set

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
categoryPolicy TypeINLINE_POLICY
contentsJSON Document
namePolicy NamePolicyName
permission_set_idPermission Set 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPermission Set NamePermission Set

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPermission Set NamePermission Set

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
descriptionPermission Set DescriptionPermissions for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
stateState

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPermission Set NamePermission Set

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
descriptionPermission Set DescriptionPermissions for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
stateState

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser Login IDjohndoe
excluded_group_id
optional
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
nameReal NameJohn Doe
user_idUser Login 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser Login IDjohndoe
excluded_group_id
optional
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
nameReal NameJohn Doe
user_idUser Login 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser Login IDjohndoe
excluded_group_id
optional
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
nameReal NameJohn Doe
user_idUser Login 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
name
optional
stringGroup NameAdmin_Group

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
name
optional
stringGroup NameAdmin_Group

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
name
optional
stringGroup NameAdmin_Group

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
description
optional
stringInstance DescriptionMy Instance Description
session_duration
optional
integerMaximum Session Duration3600

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
description
optional
stringInstance DescriptionMy Instance Description
session_duration
optional
integerMaximum Session Duration3600

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
description
optional
stringInstance DescriptionMy Instance Description
session_duration
optional
integerMaximum Session Duration3600

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
custom_policies
optional
arrayCustomer Managed Policy-
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy-

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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
customer_policies
optional
arrayCustomer Managed Policy-
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy-

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
customer_policies
optional
arrayCustomer Managed Policy-
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy-

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
manager
optional
stringManagerAlice Smith
name
optional
stringReal NameJohn Doe
nation_id
optional
stringNationality ID+82
phone_number
optional
stringPhone Number010-1234-5678
tz_id
optional
stringTimezone IDAsia/Seoul

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2025-11-24T08:14:51.694996
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
manager
optional
stringManagerAlice Smith
name
optional
stringReal NameJohn Doe
nation_id
optional
stringNationality ID+82
phone_number
optional
stringPhone Number010-1234-5678
tz_id
optional
stringTimezone IDAsia/Seoul

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2025-11-24T08:14:51.694996
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
manager
optional
stringManagerAlice Smith
name
optional
stringReal NameJohn Doe
nation_id
optional
stringNationality ID+82
phone_number
optional
stringPhone Number010-1234-5678
tz_id
optional
stringTimezone IDAsia/Seoul

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2025-11-24T08:14:51.694996
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login 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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idInstance IDssoins-12345
account_idAccount ID1234ab567cd64769e8f9g490hi304891
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
delegated_account_idDelegated Account IDacc-2353
delegated_atDelegation Date2023-10-15 14:30:00
delegated_byDelegated Bysef2w3c8c29a449dbfa8681f8f1d78e2
descriptionInstance DescriptionMy Instance Description
identity_store_configIdentity 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_idIdentity Store IDd-12345
identity_store_typeIdentity Store Type
last_sync_atLast Sync Date2025-08-06 10:30:00
last_sync_statusLast Sync Status[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’]
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameInstance NameMy Instance
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
resource_nameResource Nameresource-name-1
resource_typeResource Type [instancepermission-set]
resource_type_display_nameResource Type Display NameVirtual Server
serviceServicevirtualserver
service_nameService NameVirtual Server
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO Start URLhttps://login.e.samsungsdscloud.com/d-12345
stateState

10.4.1.29.2 - 1.1

scpcli iam-identity-center instance show
--instance_id <value>

Description

show a specific instance

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idInstance IDssoins-12345
account_idAccount ID1234ab567cd64769e8f9g490hi304891
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
delegated_account_idDelegated Account IDacc-2353
delegated_atDelegation Date2023-10-15 14:30:00
delegated_byDelegated Bysef2w3c8c29a449dbfa8681f8f1d78e2
descriptionInstance DescriptionMy Instance Description
identity_store_configIdentity 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_idIdentity Store IDd-12345
identity_store_typeIdentity Store Type
last_sync_atLast Sync Date2025-08-06 10:30:00
last_sync_statusLast Sync Status[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’]
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameInstance NameMy Instance
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
resource_nameResource Nameresource-name-1
resource_typeResource Type [instancepermission-set]
resource_type_display_nameResource Type Display NameVirtual Server
serviceServicevirtualserver
service_nameService NameVirtual Server
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO Start URLhttps://login.e.samsungsdscloud.com/d-12345
stateState

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
account_id
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
resource_name
resource_type
resource_type_display_name
service
service_name
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
account_id
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
resource_name
resource_type
resource_type_display_name
service
service_name
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
account_id
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
resource_name
resource_type
resource_type_display_name
service
service_name
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

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

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2025-11-24T08:14:51.694996
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login 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

State ACTIVE (SUPPORTED)

VersionSupported Until
1.120260531

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2025-11-24T08:14:51.694996
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login 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

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020260223

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2025-11-24T08:14:51.694996
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

10.5 - Logging&Audit

Overview

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

This guide provides a brief description of Logging&Audit service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

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

This guide provides a brief description of Network Logging service and how to call CLI. The output is formatted as a JSON string

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

Create Network Logging Storage.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
stringResource Type-
bucket_name
required
stringStorage Bucket Name-

Responses

NameDescriptionExample
idNetwork Logging Storage ID
account_idAccount ID
bucket_nameStorage Bucket Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
resource_typeResource 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

Delete Network Logging Storage.

State ACTIVE (CURRENT)

VersionSupported Until
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

Get Network Logging Configuration list.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
****Resource Type-
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
resource_id
optional
stringResource ID-
resource_name
optional
stringResource Name-

Responses

NameDescriptionExample
idNetwork Logging Configuration ID
account_idAccount ID
bucket_nameStorage Bucket Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
down_interfaceDownlink Interface
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
resource_idResource ID
resource_nameResource Name
resource_typeResource Type
security_group_log_idSecurity Group Log ID
up_interfaceUplink 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

Get Network Logging Storage list.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
****Resource Type-
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idNetwork Logging Storage ID
account_idAccount ID
bucket_nameStorage Bucket Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
resource_typeResource Type

10.7 - Organization

Overview

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

This guide provides a brief description of Organization service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (DEPRECATED)

VersionSupported Until
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

get account quota list

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-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_atModified At2024-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

get account quota list

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-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_atModified At2024-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

get account quota list

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-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_atModified At2024-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

get quota requests list

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

get quota requests list

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

get quota requests list

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

show a specific account quota

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-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_atModified At2024-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

show a specific account quota

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-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_atModified At2024-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

show a specific account quota

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-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_atModified At2024-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

show a specific quota request

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

show a specific quota request

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

show a specific quota request

State ACTIVE (DEPRECATED)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

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

This guide provides a brief description of Resourcemanager service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
description리소스 그룹 설명resource group 1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
tags
required
dict태그 목록-

10.10 - ServiceWatch

Overview

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

This guide provides a brief description of ServiceWatch service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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_secondExport log requests per second500

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

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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
stringTimezoneUTC
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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
stringTimezoneUTC
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (SUPPORTED)

VersionSupported Until
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

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

This guide provides a brief description of Support service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
service_request_id
required
stringid007d8cc7d60c4b26bb5a833b06686db3

Responses

NameDescriptionExample
ididFile-008ccb7ff65244689dacd605fafec92f
file_namenametest.txt
sizesize298426

11 - Platform

11.1 - Product

Overview

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

This guide provides a brief description of PRODUCT service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

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

This guide provides a brief description of IAM service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

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

This guide provides a brief description of BillingPlan service and how to call 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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Responses

NameDescriptionExample
service_idService IdVIRTUAL_SERVER
display_nameDisplay NameVirtual Server

12.2 - Budget

Overview

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

This guide provides a brief description of Budget service and how to call 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

create a account budget

State ACTIVE (CURRENT)

VersionSupported Until
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

delete a specific account budget

State ACTIVE (CURRENT)

VersionSupported Until
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

get account budgets list

State ACTIVE (CURRENT)

VersionSupported Until
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

set a specific account budget

State ACTIVE (CURRENT)

VersionSupported Until
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

show a specific account budget

State ACTIVE (CURRENT)

VersionSupported Until
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

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

This guide provides a brief description of CostExplorer service and how to call 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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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

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

This guide provides a brief description of DevOps Service service and how to call 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

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
devops_service_id
required
stringDevOps Service ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
resultDevOps Service Check ResultFalse

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

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
tenant_code
optional
stringTenant Codetest-tenant
tenant_name
optional
stringTenant Nametest-tenant

Responses

NameDescriptionExample
resultDevOps Service Check ResultFalse

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

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
tenant_name
required
stringTenant Name-
tenant_code
required
stringTenant Code-
members
required
arrayTenant Members-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
console_urlDevOps Service Console URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statusDevOps Service Status
tenant_codeTenant Code
tenant_nameTenant 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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statusDevOps Service Status
tenant_codeTenant Code
tenant_nameTenant 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

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
devops_service_id
required
stringDevOps Service ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
console_urlDevOps Service Console URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statusDevOps Service Status
tenant_codeTenant Code
tenant_nameTenant Name

14 - AI-ML

14.1 - AI&MLOps Platform

Overview

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

This guide provides a brief description of AI&MLOps Platform service and how to call 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.

State ACTIVE (CURRENT)

VersionSupported Until
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)

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
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)

State ACTIVE (CURRENT)

VersionSupported Until
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.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cluster_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
product_type
required
stringProduct TypeEnterprise

Responses

NameDescriptionExample
resultResult

14.2 - Cloud ML

Overview

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

This guide provides a brief description of Cloud ML service and how to call 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.)

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
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

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
cloud_ml_id
required
stringCluster ID10a599e031e749b7b260868f441e862b
description
required
stringDescription147@53A69a
accept
optional
stringAccept-
content_type
optional
stringContent-Type-