이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
Compute
- 1: Bare Metal Server
- 1.1: APIs
- 1.1.1: Assign Baremetal Private NAT IP
- 1.1.1.1: 1.1
- 1.1.2: Assign Baremetal Public NAT IP
- 1.1.3: Attach Baremetal Local Subnet
- 1.1.4: Create Baremetals
- 1.1.5: Delete Baremetal Private NAT IP
- 1.1.5.1: 1.1
- 1.1.6: Delete Baremetal Public NAT IP
- 1.1.7: Delete Baremetals
- 1.1.8: Detach Baremetal Local Subnet
- 1.1.9: List Baremetal Images
- 1.1.10: List Baremetal Products
- 1.1.11: List Baremetals
- 1.1.12: Lock Baremetal
- 1.1.13: Show Baremetal
- 1.1.14: Start Baremetals
- 1.1.15: Stop Baremetals
- 1.1.16: Unlock Baremetal
- 1.2: Models
- 1.2.1: AsyncResponse
- 1.2.2: BaremetalActionResponse
- 1.2.3: BaremetalCreateRequest
- 1.2.4: BaremetalListResponse
- 1.2.5: BaremetalListResponseV1Dot1
- 1.2.6: BaremetalListV1Dot1
- 1.2.7: BaremetalServerAssignPrivateNatIpRequest
- 1.2.8: BaremetalServerAssignPublicNatIpRequest
- 1.2.9: BaremetalServerIdResponse
- 1.2.10: BaremetalShowResponse
- 1.2.11: BaremetalShowResponseV1Dot1
- 1.2.12: BaremetalsOperationRequest
- 1.2.13: BaremetalStaticNatResponseV1Dot1
- 1.2.14: BaremetalTerminateRequest
- 1.2.15: ImageListResponse
- 1.2.16: ImageShowResponse
- 1.2.17: LocalDiskPartitionsRequest
- 1.2.18: LocalSubnetAttachRequest
- 1.2.19: LocalSubnetDetachRequest
- 1.2.20: LocalSubnetInfoResponse
- 1.2.21: LocalSubnetResponse
- 1.2.22: ProductListResponse
- 1.2.23: ProductListResponseV1Dot1
- 1.2.24: ProductShowResponse
- 1.2.25: ProductShowResponseV1Dot1
- 1.2.26: ServerDetailsRequest
- 1.2.27: TagRequest
- 2: Cloud Functions
- 2.1: APIs
- 2.1.1: Approve PrivateLink Endpoint
- 2.1.1.1: 1.2
- 2.1.2: Check Function Name Duplication
- 2.1.3: Connect PrivateLink Endpoint
- 2.1.3.1: 1.2
- 2.1.4: Create Cloud Function
- 2.1.5: Create Cloud Function Apigateway Trigger
- 2.1.6: Create Cloud Function Cronjob Trigger
- 2.1.7: Create PrivateLink Endpoint
- 2.1.7.1: 1.2
- 2.1.8: Delete Cloud Function
- 2.1.9: Delete Cloud Function Trigger
- 2.1.10: Delete PrivateLink Endpoint
- 2.1.10.1: 1.2
- 2.1.11: List Cloud Function Triggers
- 2.1.12: List Cloud Functions
- 2.1.13: List Runtimes
- 2.1.14: List Sample Codes
- 2.1.15: Request PrivateLink Endpoint
- 2.1.15.1: 1.2
- 2.1.16: Show Cloud Function
- 2.1.17: Show Cloud Function Code
- 2.1.18: Show Cloud Function Configuration
- 2.1.19: Show Cloud Function Logs
- 2.1.20: Show Cloud Function Metrics
- 2.1.21: Show Cloud Function Trigger
- 2.1.22: Update Cloud Function Code
- 2.1.23: Update Cloud Function Code File
- 2.1.24: Update Cloud Function Config
- 2.1.25: Update Cloud Function Cronjob Trigger
- 2.1.26: Update Cloud Function Url
- 2.1.27: Update Cloud Function Variables
- 2.1.28: Update PrivateLink Service
- 2.1.28.1: 1.2
- 2.2: Models
- 2.2.1: ApigatewayTriggerCreateRequest
- 2.2.2: CloudFunction
- 2.2.3: CloudFunctionCreateRequest
- 2.2.4: CloudFunctionCreateResponse
- 2.2.5: CloudFunctionForList
- 2.2.6: CloudFunctionListResponse
- 2.2.7: CloudFunctionShowResponse
- 2.2.8: Code
- 2.2.9: CodeFile
- 2.2.10: CodeSetRequest
- 2.2.11: Configuration
- 2.2.12: ConfigurationV1Dot2
- 2.2.13: CronjobTriggerCreateRequest
- 2.2.14: CronjobTriggerSetRequest
- 2.2.15: DuplicationShowResponse
- 2.2.16: Endpoint
- 2.2.17: EndpointCreateRequest
- 2.2.18: FunctionConfig
- 2.2.19: FunctionUrl
- 2.2.20: FunctionUrlRequest
- 2.2.21: FunctionVariable
- 2.2.22: FunctionVariables
- 2.2.23: Log
- 2.2.24: LogShowResponse
- 2.2.25: Metric
- 2.2.26: MetricShowResponse
- 2.2.27: PrivateLinkEndpoint
- 2.2.28: PrivateLinkEndpointApproval
- 2.2.29: PrivateLinkEndpointConnection
- 2.2.30: PrivateLinkEndpointCreateRequest
- 2.2.31: PrivateLinkEndpointRequest
- 2.2.32: PrivateLinkService
- 2.2.33: PrivateLinkServicePutRequest
- 2.2.34: Runtime
- 2.2.35: RuntimeListResponse
- 2.2.36: SampleCode
- 2.2.37: SampleCodesListResponse
- 2.2.38: Tag
- 2.2.39: Trigger
- 2.2.40: TriggerCreateResponse
- 2.2.41: TriggerDeleteRequest
- 2.2.42: TriggerForList
- 2.2.43: TriggersResponse
- 2.2.44: TriggerUpdateResponse
- 3: Virtual Server
- 3.1: APIs
- 3.1.1: Accept a volume transfer
- 3.1.2: Attach Virtual Server Security Group
- 3.1.2.1: 1.0
- 3.1.3: Attach Volume to Virtual Server
- 3.1.4: Create a snapshot
- 3.1.5: Create a volume transfer
- 3.1.6: Create Auto-Scaling Group
- 3.1.7: Create Auto-Scaling Group Notification
- 3.1.8: Create Auto-Scaling Group Policy
- 3.1.9: Create Auto-Scaling Group Schedule
- 3.1.10: Create Image
- 3.1.11: Create Image member
- 3.1.12: Create Keypair
- 3.1.13: Create Launch Configuration
- 3.1.14: Create Server Group
- 3.1.15: Create Server Interface
- 3.1.16: Create Server Interface Nat
- 3.1.17: Create Server Interface Private Nat
- 3.1.18: Create Server Volume
- 3.1.19: Create Sharing Image
- 3.1.20: Create Virtual Server
- 3.1.21: Create Virtual Server Custom Image
- 3.1.22: Create Virtual Server Dump
- 3.1.23: Create Volume
- 3.1.24: Delete a snapshot
- 3.1.25: Delete a volume transfer
- 3.1.26: Delete Auto-Scaling Group
- 3.1.27: Delete Auto-Scaling Group Notification
- 3.1.28: Delete Auto-Scaling Group Policy
- 3.1.29: Delete Auto-Scaling Group Schedule
- 3.1.30: Delete Image
- 3.1.31: Delete Image member
- 3.1.32: Delete Keypair
- 3.1.33: Delete Launch Configuration
- 3.1.34: Delete Server Group
- 3.1.35: Delete Server Interface
- 3.1.36: Delete Server Interface Nat
- 3.1.37: Delete Server Interface Private Nat
- 3.1.38: Delete Server Volume
- 3.1.39: Delete Virtual Server
- 3.1.40: Delete Volume
- 3.1.41: Detach Virtual Server Security Group
- 3.1.41.1: 1.0
- 3.1.42: Detach Volume from Virtual Server
- 3.1.43: Extend Volume
- 3.1.44: Get region's maximum partition size.
- 3.1.45: Import Image
- 3.1.46: List Auto-Scaling Group LB Server Groups
- 3.1.47: List Auto-Scaling Group Notifications
- 3.1.48: List Auto-Scaling Group Policies
- 3.1.49: List Auto-Scaling Group Schedules
- 3.1.50: List Auto-Scaling Group Virtual Servers
- 3.1.51: List Auto-Scaling Groups
- 3.1.52: List Default Configs
- 3.1.53: List Image members
- 3.1.54: List Images
- 3.1.55: List Keypairs
- 3.1.56: List Launch Configurations
- 3.1.57: List pending Images
- 3.1.58: List Server Groups
- 3.1.59: List Server Interfaces
- 3.1.60: List Server Ips
- 3.1.61: List Server Types
- 3.1.62: List Server Volumes
- 3.1.63: List snapshots and details
- 3.1.64: List Virtual Server Security Group
- 3.1.65: List Virtual Servers
- 3.1.66: List volume transfers
- 3.1.67: List volume types and details
- 3.1.68: List volumes and details
- 3.1.69: Lock Virtual Server
- 3.1.70: Reboot Virtual Server
- 3.1.71: Rebuild Virtual Server
- 3.1.72: Revert Volume to snapshot
- 3.1.73: Show a snapshot’s details
- 3.1.74: Show Auto-Scaling Group
- 3.1.75: Show Auto-Scaling Group Notification
- 3.1.76: Show Auto-Scaling Group Policy
- 3.1.77: Show Auto-Scaling Group Schedule
- 3.1.78: Show default Volume type’s details
- 3.1.79: Show Image
- 3.1.80: Show Image member
- 3.1.81: Show Keypair
- 3.1.82: Show Launch Configuration
- 3.1.83: Show Server Group
- 3.1.84: Show Server Interface
- 3.1.85: Show Server Ip
- 3.1.86: Show Server Quota Set
- 3.1.87: Show Server Type
- 3.1.88: Show Server Volume
- 3.1.89: Show Virtual Server
- 3.1.90: Show Virtual Server Console Log
- 3.1.91: Show Virtual Server Password
- 3.1.92: Show Volume Quota Set
- 3.1.93: Show volume transfer detail
- 3.1.94: Show Volume type’s details
- 3.1.95: Show Volume's details
- 3.1.96: Start Virtual Server
- 3.1.97: Stop Virtual Server
- 3.1.98: Unlock Virtual Server
- 3.1.99: Update a snapshot
- 3.1.100: Update Auto-Scaling Group
- 3.1.101: Update Auto-Scaling Group LB Server Groups
- 3.1.102: Update Auto-Scaling Group Notification
- 3.1.103: Update Auto-Scaling Group Policy
- 3.1.104: Update Auto-Scaling Group Schedule
- 3.1.105: Update Auto-Scaling Group server count
- 3.1.106: Update Image
- 3.1.107: Update Image member
- 3.1.108: Update Server Interface
- 3.1.109: Update Server Volume
- 3.1.110: Update Virtual Server
- 3.1.111: Update Virtual Server type
- 3.1.112: Update Volume
- 3.2: Models
- 3.2.1: AutoScalingGroup
- 3.2.2: AutoScalingGroupCreateRequest
- 3.2.3: AutoScalingGroupLbServerGroup
- 3.2.4: AutoScalingGroupLbServerGroupListResponse
- 3.2.5: AutoScalingGroupLbServerGroupSetRequest
- 3.2.6: AutoScalingGroupLbServerGroupShowResponse
- 3.2.7: AutoScalingGroupListResponse
- 3.2.8: AutoScalingGroupNotificationCreateRequest
- 3.2.9: AutoScalingGroupNotificationListResponse
- 3.2.10: AutoScalingGroupNotificationShowResponse
- 3.2.11: AutoScalingGroupNotificationUpdateRequest
- 3.2.12: AutoScalingGroupPolicyCreateRequest
- 3.2.13: AutoScalingGroupPolicyListResponse
- 3.2.14: AutoScalingGroupPolicyShowResponse
- 3.2.15: AutoScalingGroupPolicyUpdateRequest
- 3.2.16: AutoScalingGroupScheduleCreateRequest
- 3.2.17: AutoScalingGroupScheduleListResponse
- 3.2.18: AutoScalingGroupScheduleShowResponse
- 3.2.19: AutoScalingGroupScheduleUpdateRequest
- 3.2.20: AutoScalingGroupSetRequest
- 3.2.21: AutoScalingGroupSetServerCountRequest
- 3.2.22: AutoScalingGroupShowResponse
- 3.2.23: AutoScalingGroupVirtualServerListResponse
- 3.2.24: AutoScalingGroupVirtualServerShowResponse
- 3.2.25: DefaultConfigListResponse
- 3.2.26: ImageCreateRequest
- 3.2.27: ImageImportRequest
- 3.2.28: ImageListResponse
- 3.2.29: ImageMemberCreateRequest
- 3.2.30: ImageMemberListResponse
- 3.2.31: ImageMemberSetRequest
- 3.2.32: ImageMemberShowResponse
- 3.2.33: ImageSetRequest
- 3.2.34: ImageShowResponse
- 3.2.35: InterfaceAttachmentFixedIp
- 3.2.36: InterfaceResponse
- 3.2.37: Keypair
- 3.2.38: KeypairCreateRequest
- 3.2.39: KeypairCreateResponse
- 3.2.40: KeypairListResponse
- 3.2.41: KeypairShowResponse
- 3.2.42: LaunchConfigurationCreateRequest
- 3.2.43: LaunchConfigurationDetailShowResponse
- 3.2.44: LaunchConfigurationListResponse
- 3.2.45: LaunchConfigurationShowResponse
- 3.2.46: LaunchConfigurationVolume
- 3.2.47: Network
- 3.2.48: PrivateStaticNat
- 3.2.49: PublicStaticNat
- 3.2.50: SecurityGroupResponse
- 3.2.51: SecurityGroupResponseRule
- 3.2.52: SecurityGroupResponseRuleIpRange
- 3.2.53: ServerConsoleLogResponse
- 3.2.54: ServerCreateImageRequestBody
- 3.2.55: ServerCreateImageResponse
- 3.2.56: ServerCreateRequest
- 3.2.57: ServerCreateResponse
- 3.2.58: ServerCreateResponseParam
- 3.2.59: ServerGroup
- 3.2.60: ServerGroupCreateRequest
- 3.2.61: ServerGroupListResponse
- 3.2.62: ServerGroupPartitionSizeResponse
- 3.2.63: ServerInterfaceCreateRequest
- 3.2.64: ServerInterfaceListResponse
- 3.2.65: ServerInterfaceUpdateRequest
- 3.2.66: ServerIpsResponse
- 3.2.67: ServerListResponse
- 3.2.68: ServerPasswordRequest
- 3.2.69: ServerPasswordResponse
- 3.2.70: ServerPrivateStaticNatCreateRequest
- 3.2.71: ServerQuotaSet
- 3.2.72: ServerQuotaSetObject
- 3.2.73: ServerRebootRequestBody
- 3.2.74: ServerSecurityGroupActionRequestBody
- 3.2.75: ServerSecurityGroupListResponse
- 3.2.76: ServerSetServerTypeRequestBody
- 3.2.77: ServerShowResponse
- 3.2.78: ServerShowResponseAddress
- 3.2.79: ServerShowResponseAddressIpAddress
- 3.2.80: ServerShowResponseSecurityGroup
- 3.2.81: ServerShowResponseServerType
- 3.2.82: ServerShowResponseVolume
- 3.2.83: ServerStaticNatCreateRequest
- 3.2.84: ServersVolumeResponse
- 3.2.85: ServerType
- 3.2.86: ServerTypeListResponse
- 3.2.87: ServerUpdateRequest
- 3.2.88: ServerVolumesCreateRequest
- 3.2.89: ServerVolumesResponse
- 3.2.90: ServerVolumesUpdateRequest
- 3.2.91: SnapshotCreateRequest
- 3.2.92: SnapshotDetailResponse
- 3.2.93: SnapshotListResponse
- 3.2.94: SnapshotUpdateRequest
- 3.2.95: Tag
- 3.2.96: Volume
- 3.2.97: VolumeCreateRequest
- 3.2.98: VolumeExtendRequest
- 3.2.99: VolumeImageMetadataResponse
- 3.2.100: VolumeListResponse
- 3.2.101: VolumeQuotaSet
- 3.2.102: VolumeQuotaSetObject
- 3.2.103: VolumeRevertRequest
- 3.2.104: VolumeServer
- 3.2.105: VolumeServerAttachRequest
- 3.2.106: VolumeServerAttachResponse
- 3.2.107: VolumeShowResponse
- 3.2.108: VolumeTransferAcceptResponse
- 3.2.109: VolumeTransferAccessRequest
- 3.2.110: VolumeTransferCreateResponse
- 3.2.111: VolumeTransferListResponse
- 3.2.112: VolumeTransferRequest
- 3.2.113: VolumeTransferShowResponse
- 3.2.114: VolumeTypeDetailResponse
- 3.2.115: VolumeTypeExtraSpecs
- 3.2.116: VolumeTypeListResponse
- 3.2.117: VolumeUpdateRequest
1 - Bare Metal Server
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 Bare Metal Server 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
OpenAPI URL
https://baremetal.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
1.1 - APIs
1.1.1 - Assign Baremetal Private NAT IP
1.1.1.1 - 1.1
post /v1/baremetals/{baremetal_id}/private-nat-ips
Description
Bare Metal Server Private NAT IP 연결 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | BaremetalServerAssignPrivateNatIpRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalStaticNatResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/private-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"private_nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
"private_nat_ip_id": "03cd065d8acc4e47b11a11dc1411323e"
}
Example HTTP response
Response 202
{
"nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
"nat_ip": "192.170.2.10",
"nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
"state": "ACTIVE",
"static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3"
}
1.1.2 - Assign Baremetal Public NAT IP
1.1.2.1 - 1.1
post /v1/baremetals/{baremetal_id}/public-nat-ips
Description
Bare Metal Server NAT IP 연결 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | BaremetalServerAssignPublicNatIpRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalServerIdResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/public-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.2.2 - 1.0
post /v1/baremetals/{baremetal_id}/public-nat-ips
Description
Bare Metal Server NAT IP 연결 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | BaremetalServerAssignPublicNatIpRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalServerIdResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/public-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.3 - Attach Baremetal Local Subnet
1.1.3.1 - 1.1
put /v1/baremetals/local-subnet/{baremetal_id}/attach
Description
Bare Metal Server 로컬 서브넷 연결 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | LocalSubnetAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LocalSubnetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/local-subnet/{baremetal_id}/attach
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"local_subnet_ip": "192.168.0.1"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
"is_success": true
}
1.1.3.2 - 1.0
put /v1/baremetals/local-subnet/{baremetal_id}/attach
Description
Bare Metal Server 로컬 서브넷 연결 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | LocalSubnetAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LocalSubnetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/local-subnet/{baremetal_id}/attach
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"local_subnet_ip": "192.168.0.1"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
"is_success": true
}
1.1.4 - Create Baremetals
1.1.4.1 - 1.1
post /v1/baremetals
Description
Bare Metal Server 생성 요청 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"init_script": "init script",
"lock_enabled": true,
"os_user_id": "user001",
"os_user_password": "password",
"placement_group_name": "pgtest",
"region_id": "kr-west1",
"server_details": [
{
"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
}
],
"subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"tags": [
{
"key": "key",
"value": "value"
}
],
"use_placement_group": false,
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.4.2 - 1.0
post /v1/baremetals
Description
Bare Metal Server 생성 요청 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"init_script": "init script",
"lock_enabled": true,
"os_user_id": "user001",
"os_user_password": "password",
"placement_group_name": "pgtest",
"region_id": "kr-west1",
"server_details": [
{
"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
}
],
"subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"tags": [
{
"key": "key",
"value": "value"
}
],
"use_placement_group": false,
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.5 - Delete Baremetal Private NAT IP
1.1.5.1 - 1.1
delete /v1/baremetals/{baremetal_id}/private-nat-ips
Description
Bare Metal Server Private NAT IP 해지 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalStaticNatResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/private-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 202
{
"nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
"nat_ip": "192.170.2.10",
"nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
"state": "ACTIVE",
"static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3"
}
1.1.6 - Delete Baremetal Public NAT IP
1.1.6.1 - 1.1
delete /v1/baremetals/{baremetal_id}/public-nat-ips
Description
Bare Metal Server NAT IP 해지 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalServerIdResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/public-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.6.2 - 1.0
delete /v1/baremetals/{baremetal_id}/public-nat-ips
Description
Bare Metal Server NAT IP 해지 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | BaremetalServerIdResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/public-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.7 - Delete Baremetals
1.1.7.1 - 1.1
delete /v1/baremetals
Description
Bare Metal Server 해지 요청 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalTerminateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"baremetal_id_list": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.7.2 - 1.0
delete /v1/baremetals
Description
Bare Metal Server 해지 요청 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalTerminateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"baremetal_id_list": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.8 - Detach Baremetal Local Subnet
1.1.8.1 - 1.1
put /v1/baremetals/local-subnet/{baremetal_id}/detach
Description
Bare Metal Server 로컬 서브넷 해지 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | LocalSubnetDetachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LocalSubnetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/local-subnet/{baremetal_id}/detach
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"local_subnet_ip": "192.168.0.1"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
"is_success": true
}
1.1.8.2 - 1.0
put /v1/baremetals/local-subnet/{baremetal_id}/detach
Description
Bare Metal Server 로컬 서브넷 해지 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
| body | body required | LocalSubnetDetachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LocalSubnetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/local-subnet/{baremetal_id}/detach
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"local_subnet_ip": "192.168.0.1"
}
Example HTTP response
Response 202
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac",
"is_success": true
}
1.1.9 - List Baremetal Images
1.1.9.1 - 1.1
get /v1/images
Description
Bare Metal Server 이미지 조회 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | region_id required | 리전 ID Example : kr-west1 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images?region_id={region_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"images": [
{
"created_at": "2024-07-11 08:56:59",
"id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"name": "RHEL 8.8 for BM",
"os_distro": "RHEL",
"scp_image_type": "STANDARD",
"scp_os_version": "8.7"
}
]
}
1.1.9.2 - 1.0
get /v1/images
Description
Bare Metal Server 이미지 조회 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | region_id required | 리전 ID Example : kr-west1 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images?region_id={region_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"images": [
{
"created_at": "2024-07-11 08:56:59",
"id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"name": "RHEL 8.8 for BM",
"os_distro": "RHEL",
"scp_image_type": "STANDARD",
"scp_os_version": "8.7"
}
]
}
1.1.10 - List Baremetal Products
1.1.10.1 - 1.1
get /v1/bm_products
Description
Bare Metal Server Scale type 조회 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | image_id optional | 이미지 ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ProductListResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/bm_products
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"products": [
{
"compute_class_type_name": "StandardMetal-2",
"compute_class_type_value": "s2_metal",
"cpu_name": "cpu 16 vCore",
"cpu_unit": "vCPU",
"cpu_value": "64",
"created_at": "2024-05-17T00:23:17Z",
"description": "vCPU 16 │ Memory 128G │ Disk 480G",
"disk_unit": "GB",
"disk_value": "480",
"id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"memory_name": "server memory 128GB",
"memory_unit": "GB",
"memory_value": "128",
"modified_at": "2024-05-17T00:23:17Z",
"name": "s2v16m128_metal",
"name_with_generation": "s2v16m128_metal",
"os_disk_gb": "480",
"state": "AVAILABLE",
"type": "SCALE"
}
]
}
1.1.10.2 - 1.0
get /v1/bm_products
Description
Bare Metal Server Scale type 조회 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | image_id optional | 이미지 ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ProductListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/bm_products
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"products": [
{
"attri_name": "attri name",
"attri_value": "attri value",
"compute_class_type_name": "StandardMetal-2",
"compute_class_type_unit": "compute_class_type_unit",
"compute_class_type_value": "s2_metal",
"cpu_generation": "cpu generation",
"cpu_name": "cpu 16 vCore",
"cpu_unit": "vCPU",
"cpu_value": "64",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "vCPU 16 │ Memory 128G │ Disk 480G",
"disk_name": "disk_name",
"disk_unit": "GB",
"disk_value": "480",
"id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"infiniband_name": "infiniband_name",
"infiniband_unit": "infiniband_unit",
"infiniband_value": "infiniband_value",
"memory_name": "server memory 128GB",
"memory_unit": "GB",
"memory_value": "128",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "s2v16m128_metal",
"name_with_generation": "s2v16m128_metal",
"socket_name": "socket_name",
"socket_unit": "socket_unit",
"socket_value": "socket_value",
"state": "AVAILABLE",
"type": "SCALE"
}
]
}
1.1.11 - List Baremetals
1.1.11.1 - 1.1
get /v1/baremetals
Description
Bare Metal Server 목록 조회 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | server_name optional | Bare Metal Server 이름 Example : bmserver-001 | any of [string, null] | None |
| query | state optional | Bare Metal Server 상태 Example : RUNNING | any of [string, null] | None |
| query | ip optional | Bare Metal Server IP 주소 Example : 192.168.0.1 | any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalListResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"baremetals": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"image_version": "RHEL 8.7 for BM",
"lock_enabled": true,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"network_id": "ab313c43291e4b678f4bacffe10768ae",
"os_type": "WINDOWS",
"placement_group_name": "pgtest",
"policy_ip": "192.168.0.1",
"product_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"region_id": "kr-west1",
"server_name": "bmserver-001",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
],
"count": 20
}
1.1.11.2 - 1.0
get /v1/baremetals
Description
Bare Metal Server 목록 조회 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | server_name optional | Bare Metal Server 이름 Example : bmserver-001 | any of [string, null] | None |
| query | state optional | Bare Metal Server 상태 Example : RUNNING | any of [string, null] | None |
| query | ip optional | Bare Metal Server IP 주소 Example : 192.168.0.1 | any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"baremetals": [
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"hyper_threading_use": true,
"id": "20c507a036c447cdb3b19468d8ea62ac",
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"image_version": "RHEL 8.7 for BM",
"init_script": "init script",
"local_subnet_info": [
{
"interface_name": "ens8f1,bond_serv.2",
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"policy_local_subnet_ip": "192.168.0.1",
"state": "CREATING",
"vlan_id": 500,
"vni_role_name": "mgmtJ4dzQBo"
}
],
"lock_enabled": true,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"network_id": "ab313c43291e4b678f4bacffe10768ae",
"os_type": "WINDOWS",
"placement_group_name": "pgtest",
"policy_ip": "192.168.0.1",
"policy_nat": "192.168.0.1",
"policy_use_nat": true,
"product_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"public_nat_status": "ACTIVE",
"region_id": "kr-west1",
"root_account": "rootaccount",
"server_name": "bmserver-001",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"time_zone": "Asia/Seoul",
"use_local_subnet": true,
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
],
"count": 20
}
1.1.12 - Lock Baremetal
1.1.12.1 - 1.1
put /v1/baremetals/{baremetal_id}/lock
Description
Bare Metal Server Lock 활성화 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/lock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.12.2 - 1.0
put /v1/baremetals/{baremetal_id}/lock
Description
Bare Metal Server Lock 활성화 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/lock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.13 - Show Baremetal
1.1.13.1 - 1.1
get /v1/baremetals/{baremetal_id}
Description
Bare Metal Server 상세 조회 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalShowResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"hyper_threading_use": true,
"id": "20c507a036c447cdb3b19468d8ea62ac",
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"image_version": "RHEL 8.7 for BM",
"init_script": "init script",
"local_subnet_info": [
{
"interface_name": "ens8f1,bond_serv.2",
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"policy_local_subnet_ip": "192.168.0.1",
"state": "CREATING",
"vlan_id": 500,
"vni_role_name": "mgmtJ4dzQBo"
}
],
"lock_enabled": true,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"network_id": "ab313c43291e4b678f4bacffe10768ae",
"os_type": "WINDOWS",
"placement_group_name": "pgtest",
"policy_ip": "192.168.0.1",
"private_nat_info": {
"nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
"nat_ip": "192.170.2.10",
"nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
"state": "ACTIVE",
"static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3"
},
"product_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"public_nat_info": {
"nat_id": "a4fd0216cd32442a82733bbb8be0e82b",
"nat_ip": "192.170.2.10",
"nat_ip_id": "20c507a036c447cdb3b19468d8ea62ac",
"state": "ACTIVE",
"static_nat_id": "a1b97ae4695b40b0866e86a19cb191d3"
},
"region_id": "kr-west1",
"root_account": "rootaccount",
"server_name": "bmserver-001",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"time_zone": "Asia/Seoul",
"use_local_subnet": true,
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
1.1.13.2 - 1.0
get /v1/baremetals/{baremetal_id}
Description
Bare Metal Server 상세 조회 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"hyper_threading_use": true,
"id": "20c507a036c447cdb3b19468d8ea62ac",
"image_id": "IMAGE-7XFMaJpLsapKvskFMjCtmm",
"image_version": "RHEL 8.7 for BM",
"init_script": "init script",
"local_subnet_info": [
{
"interface_name": "ens8f1,bond_serv.2",
"local_subnet_id": "ab313c43291e4b678f4bacffe10768ae",
"policy_local_subnet_ip": "192.168.0.1",
"state": "CREATING",
"vlan_id": 500,
"vni_role_name": "mgmtJ4dzQBo"
}
],
"lock_enabled": true,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef716e80-1fac-4faa-892d-0132fc7f5583",
"network_id": "ab313c43291e4b678f4bacffe10768ae",
"os_type": "WINDOWS",
"placement_group_name": "pgtest",
"policy_ip": "192.168.0.1",
"policy_nat": "192.168.0.1",
"policy_use_nat": true,
"product_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg",
"public_nat_status": "ACTIVE",
"region_id": "kr-west1",
"root_account": "rootaccount",
"server_name": "bmserver-001",
"server_type": "s1v8m32_metal",
"state": "RUNNING",
"time_zone": "Asia/Seoul",
"use_local_subnet": true,
"vpc_id": "e58348b1bc9148e5af86500fd4ef99ca"
}
1.1.14 - Start Baremetals
1.1.14.1 - 1.1
post /v1/baremetals/start
Description
Bare Metal Server 시작(부팅) 요청 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalsOperationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"bare_metal_server_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.14.2 - 1.0
post /v1/baremetals/start
Description
Bare Metal Server 시작(부팅) 요청 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalsOperationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"bare_metal_server_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.15 - Stop Baremetals
1.1.15.1 - 1.1
post /v1/baremetals/stop
Description
Bare Metal Server 중지 요청 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalsOperationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Request body
{
"bare_metal_server_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.15.2 - 1.0
post /v1/baremetals/stop
Description
Bare Metal Server 중지 요청 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BaremetalsOperationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Request body
{
"bare_metal_server_ids": [
"20c507a036c447cdb3b19468d8ea62ac"
]
}
Example HTTP response
Response 202
{
"account_id": "f5c8e56a4d9b49a8bd89e14758a32d53",
"request_id": "req-002daa83-52d9-41e8-9b0f-d31d35610f65",
"resource_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.16 - Unlock Baremetal
1.1.16.1 - 1.1
put /v1/baremetals/{baremetal_id}/unlock
Description
Bare Metal Server Lock 해지 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/unlock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.1"
Example HTTP response
Response 200
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.1.16.2 - 1.0
put /v1/baremetals/{baremetal_id}/unlock
Description
Bare Metal Server Lock 해지 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaremetalActionResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baremetals/{baremetal_id}/unlock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = baremetal 1.0"
Example HTTP response
Response 200
{
"baremetal_id": "20c507a036c447cdb3b19468d8ea62ac"
}
1.2 - Models
1.2.1 - AsyncResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | string | |
| request_id required | Request ID Example : req-002daa83-52d9-41e8-9b0f-d31d35610f65 | string | |
| resource_id required | 자원 ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
1.2.2 - BaremetalActionResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
1.2.3 - BaremetalCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | 이미지 ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| init_script optional | Init script Example : init script | any of [string, null] | |
| lock_enabled optional | Lock 사용 여부 Example : True | boolean | |
| os_user_id required | OS 유저 ID Example : user001 | string | |
| os_user_password required | OS 유저 패스워드 Example : password | string | |
| placement_group_name optional | Placement Group 이름 Example : pgtest | any of [string, null] | |
| region_id required | 리전 ID Example : kr-west1 | string | |
| server_details required | 서버별 세부 설정 | array[ServerDetailsRequest] | |
| subnet_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| tags optional | 태그 | any of [array[TagRequest], null] | |
| use_placement_group optional | placement group 사용 여부 Example : False | boolean | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
1.2.4 - BaremetalListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetals required | array[BaremetalShowResponse] | ||
| count required | 대수 Example : 20 | any of [integer, null] |
1.2.5 - BaremetalListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetals required | array[BaremetalListV1Dot1] | ||
| count required | 대수 Example : 20 | integer |
1.2.6 - BaremetalListV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | 이미지 ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| image_version required | 이미지 버전 Example : RHEL 8.7 for BM | string | |
| lock_enabled optional | Lock 사용 여부 Example : True | boolean | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| network_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| os_type required | OS type Example : WINDOWS | string | |
| placement_group_name optional | Placement Group 이름 Example : pgtest | any of [string, null] | |
| policy_ip required | 정책 IP Example : 192.168.0.1 | string | |
| product_type_id required | Bare Metal Server 스케일 ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| region_id required | 리전 ID Example : kr-west1 | string | |
| server_name required | Bare Metal Server 이름 Example : bmserver-001 | string | |
| server_type required | Bare Metal Server 스케일 타입 Example : s1v8m32_metal | string | |
| state required | Bare Metal Server 상태 Example : RUNNING | string | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
1.2.7 - BaremetalServerAssignPrivateNatIpRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| private_nat_id required | Private NAT ID Example : a4fd0216cd32442a82733bbb8be0e82b | string | |
| private_nat_ip_id required | Private NAT IP ID Example : 03cd065d8acc4e47b11a11dc1411323e | string |
1.2.8 - BaremetalServerAssignPublicNatIpRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| public_ip_address_id required | Public NAT ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
1.2.9 - BaremetalServerIdResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
1.2.10 - BaremetalShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : ef716e80-1fac-4faa-892d-0132fc7f5583 | string | |
| hyper_threading_use required | Hyper threading 사용 여부 Example : True | boolean | |
| id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| image_id required | 이미지 ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| image_version required | 이미지 버전 Example : RHEL 8.7 for BM | string | |
| init_script required | Init script Example : init script | string | |
| local_subnet_info optional | Local Subnet 정보 | any of [array[LocalSubnetInfoResponse], null] | |
| lock_enabled optional | Lock 사용 여부 Example : True | boolean | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : ef716e80-1fac-4faa-892d-0132fc7f5583 | string | |
| network_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| os_type required | OS type Example : WINDOWS | string | |
| placement_group_name optional | Placement Group 이름 Example : pgtest | any of [string, null] | |
| policy_ip required | 정책 IP Example : 192.168.0.1 | string | |
| policy_nat optional | Public NAT IP Example : 192.168.0.1 | any of [string, null] | |
| policy_use_nat optional | Public NAT 사용 여부 Example : True | boolean | |
| product_type_id required | Bare Metal Server 스케일 ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| public_nat_status optional | Public NAT 상태 Example : ACTIVE | any of [string, null] | |
| region_id required | 리전 ID Example : kr-west1 | string | |
| root_account required | 루트 계정 Example : rootaccount | string | |
| server_name required | Bare Metal Server 이름 Example : bmserver-001 | string | |
| server_type required | Bare Metal Server 스케일 타입 Example : s1v8m32_metal | string | |
| state required | Bare Metal Server 상태 Example : RUNNING | string | |
| time_zone required | 타임존 Example : Asia/Seoul | string | |
| use_local_subnet optional | 로컬 서브넷 사용 여부 Example : True | boolean | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
1.2.11 - BaremetalShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : ef716e80-1fac-4faa-892d-0132fc7f5583 | string | |
| hyper_threading_use required | Hyper threading 사용 여부 Example : True | boolean | |
| id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| image_id required | 이미지 ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| image_version required | 이미지 버전 Example : RHEL 8.7 for BM | string | |
| init_script required | Init script Example : init script | string | |
| local_subnet_info optional | Local Subnet 정보 | any of [array[LocalSubnetInfoResponse], null] | |
| lock_enabled optional | Lock 사용 여부 Example : True | boolean | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : ef716e80-1fac-4faa-892d-0132fc7f5583 | string | |
| network_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| os_type required | OS type Example : WINDOWS | string | |
| placement_group_name optional | Placement Group 이름 Example : pgtest | any of [string, null] | |
| policy_ip required | 정책 IP Example : 192.168.0.1 | string | |
| private_nat_info optional | Private NAT 정보 | any of [BaremetalStaticNatResponseV1Dot1, null] | |
| product_type_id required | Bare Metal Server 스케일 ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| public_nat_info optional | Public NAT 정보 | any of [BaremetalStaticNatResponseV1Dot1, null] | |
| region_id required | 리전 ID Example : kr-west1 | string | |
| root_account required | 루트 계정 Example : rootaccount | string | |
| server_name required | Bare Metal Server 이름 Example : bmserver-001 | string | |
| server_type required | Bare Metal Server 스케일 타입 Example : s1v8m32_metal | string | |
| state required | Bare Metal Server 상태 Example : RUNNING | string | |
| time_zone required | 타임존 Example : Asia/Seoul | string | |
| use_local_subnet optional | 로컬 서브넷 사용 여부 Example : True | boolean | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
1.2.12 - BaremetalsOperationRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| bare_metal_server_ids required | Bare Metal Server ID 리스트 Example : ['20c507a036c447cdb3b19468d8ea62ac'] | array[object] |
1.2.13 - BaremetalStaticNatResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| nat_id optional | NAT ID Example : a4fd0216cd32442a82733bbb8be0e82b | any of [string, null] | |
| nat_ip required | NAT IP Example : 192.170.2.10 | string | |
| nat_ip_id required | NAT IP ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| state required | Static NAT 상태 Example : ACTIVE | string | |
| static_nat_id optional | Static NAT ID Example : a1b97ae4695b40b0866e86a19cb191d3 | any of [string, null] |
1.2.14 - BaremetalTerminateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id_list required | Bare Metal Server ID 리스트 Example : ['20c507a036c447cdb3b19468d8ea62ac'] | array[object] |
1.2.15 - ImageListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| images required | array[ImageShowResponse] |
1.2.16 - ImageShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-07-11 08:56:59 | string | |
| id required | 이미지 ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| name required | 이미지명 Example : RHEL 8.8 for BM | string | |
| os_distro required | OS type Example : RHEL | string | |
| scp_image_type required | 이미지 타입 Example : STANDARD | string | |
| scp_os_version required | OS 버전 Example : 8.7 | string |
1.2.17 - LocalDiskPartitionsRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| mount_point required | 마운트 포인트 Example : /mountpoint | string | |
| partition_name optional | 파티션명 Example : partitionname | any of [string, null] | |
| partition_size required | 파티션 크기 Example : 20 | integer | |
| partition_type required | 파티션 타입 Example : ext4 | string |
1.2.18 - LocalSubnetAttachRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| local_subnet_id required | 로컬 Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| local_subnet_ip optional | 로컬 Subnet IP Example : 192.168.0.1 | any of [string, null] |
1.2.19 - LocalSubnetDetachRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| local_subnet_id required | 로컬 Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| local_subnet_ip required | 로컬 Subnet IP Example : 192.168.0.1 | string |
1.2.20 - LocalSubnetInfoResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| interface_name required | Interface명 Example : ens8f1,bond_serv.2 | string | |
| local_subnet_id required | 로컬 Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| policy_local_subnet_ip required | 로컬 Subnet IP Example : 192.168.0.1 | string | |
| state required | Local subnet IP의 상태 Example : CREATING | string | |
| vlan_id required | Vlan ID Example : 500 | string | |
| vni_role_name required | VNI Role Name Example : mgmtJ4dzQBo | string |
1.2.21 - LocalSubnetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| is_success optional | success flag Example : True | boolean |
1.2.22 - ProductListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| products required | Product List | array[ProductShowResponse] |
1.2.23 - ProductListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| products required | Product List | array[ProductShowResponseV1Dot1] |
1.2.24 - ProductShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| attri_name required | Attribute 이름 Example : attri name | string | |
| attri_value required | Attribute value Example : attri value | string | |
| compute_class_type_name required | Compute class type 이름 Example : StandardMetal-2 | string | |
| compute_class_type_unit required | Compute class type unit Example : compute_class_type_unit | string | |
| compute_class_type_value required | Compute class type value Example : s2_metal | string | |
| cpu_generation required | CPU generation Example : cpu generation | string | |
| cpu_name required | CPU 이름 Example : cpu 16 vCore | string | |
| cpu_unit required | CPU unit Example : vCPU | string | |
| cpu_value required | CPU value Example : 64 | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description required | 설명 Example : vCPU 16 │ Memory 128G │ Disk 480G | string | |
| disk_name required | Disk명 Example : disk_name | string | |
| disk_unit required | Disk unit Example : GB | string | |
| disk_value required | Disk value Example : 480 | string | |
| id required | ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| infiniband_name required | InfiniBand 이름 Example : infiniband_name | string | |
| infiniband_unit required | InfiniBand unit Example : infiniband_unit | string | |
| infiniband_value required | Infiniband value Example : infiniband_value | string | |
| memory_name required | Memroy 이름 Example : server memory 128GB | string | |
| memory_unit required | Memory unit Example : GB | string | |
| memory_value required | Memory value Example : 128 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | 이름 Example : s2v16m128_metal | string | |
| name_with_generation required | 세대 Example : s2v16m128_metal | string | |
| socket_name required | Socket 이름 Example : socket_name | string | |
| socket_unit required | Socket unit Example : socket_unit | string | |
| socket_value required | Socket value Example : socket_value | string | |
| state required | State Example : AVAILABLE | string | |
| type required | 유형 Example : SCALE | string |
1.2.25 - ProductShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| compute_class_type_name required | Compute class type 이름 Example : StandardMetal-2 | string | |
| compute_class_type_value required | Compute class type value Example : s2_metal | string | |
| cpu_name required | CPU 이름 Example : cpu 16 vCore | any of [string, null] | |
| cpu_unit required | CPU unit Example : vCPU | string | |
| cpu_value required | CPU value Example : 64 | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| description required | 설명 Example : vCPU 16 │ Memory 128G │ Disk 480G | any of [string, null] | |
| disk_unit required | Disk unit Example : GB | any of [string, null] | |
| disk_value required | Disk value Example : 480 | string | |
| id required | ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| memory_name required | Memroy 이름 Example : server memory 128GB | any of [string, null] | |
| memory_unit required | Memory unit Example : GB | any of [string, null] | |
| memory_value required | Memory value Example : 128 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| name required | 이름 Example : s2v16m128_metal | string | |
| name_with_generation required | 세대 Example : s2v16m128_metal | string | |
| os_disk_gb required | OS Disk 값 Example : 480 | string | |
| state required | State Example : AVAILABLE | string | |
| type required | 유형 Example : SCALE | string |
1.2.26 - ServerDetailsRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| bare_metal_local_subnet_id optional | 로컬 Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | any of [string, null] | |
| bare_metal_local_subnet_ip_address optional | 로컬 Subnet IP Example : 192.168.0.1 | any of [string, null] | |
| bare_metal_server_name required | Bare Metal Server 이름 Example : bmserver-001 | string | |
| ip_address optional | Private IP Example : 192.168.0.1 | any of [string, null] | |
| local_disk_partitions optional | 로컬 디스크 파티션 | any of [array[LocalDiskPartitionsRequest], null] | |
| local_disk_type optional | 로컬 디스크 타입 Example : flat | any of [string, null] | |
| nat_enabled required | Public NAT 사용 여부 Example : True | boolean | |
| public_ip_address_id optional | Public NAT ID Example : 20c507a036c447cdb3b19468d8ea62ac | any of [string, null] | |
| server_type_id required | Server Type ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| use_hyper_threading optional | Hyper threading 사용 여부 Example : True | boolean |
1.2.27 - TagRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | key Example : key | string | |
| value optional | value Example : value | any of [string, null] |
2 - Cloud Functions
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 Cloud Function 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | DEPRECATED | 20260430 |
| 1.2 | CURRENT | - |
OpenAPI URL
https://scf.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
2.1 - APIs
2.1.1 - Approve PrivateLink Endpoint
2.1.1.1 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/approval
Description
PrivateLink Endpoint 승인
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointApproval |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/approval
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"type": "APPROVE"
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.2 - Check Function Name Duplication
2.1.2.1 - 1.2
get /v1/cloud-functions/check-duplication
Description
Cloud Function 이름 중복 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name required | 이름 Example : sample-function-name | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DuplicationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/check-duplication?name={name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"result": true
}
2.1.2.2 - 1.1
get /v1/cloud-functions/check-duplication
Description
Cloud Function 이름 중복 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name required | 이름 Example : sample-function-name | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DuplicationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/check-duplication?name={name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"result": true
}
2.1.2.3 - 1.0
get /v1/cloud-functions/check-duplication
Description
Cloud Function 이름 중복 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name required | 이름 Example : sample-function-name | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DuplicationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/check-duplication?name={name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"result": true
}
2.1.3 - Connect PrivateLink Endpoint
2.1.3.1 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/connection
Description
PrivateLink Endpoint 연결
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointConnection |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/connection
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"type": "RECONNECT"
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.4 - Create Cloud Function
2.1.4.1 - 1.2
post /v1/cloud-functions
Description
Cloud Function 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CloudFunctionCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CloudFunctionCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"content": "sample",
"name": "sample-function-name",
"runtime": "Node.js:20",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"message": "Description",
"state": "READY"
}
2.1.4.2 - 1.1
post /v1/cloud-functions
Description
Cloud Function 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CloudFunctionCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CloudFunctionCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Request body
{
"content": "sample",
"name": "sample-function-name",
"runtime": "Node.js:20",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"message": "Description",
"state": "READY"
}
2.1.4.3 - 1.0
post /v1/cloud-functions
Description
Cloud Function 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CloudFunctionCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CloudFunctionCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Request body
{
"content": "sample",
"name": "sample-function-name",
"runtime": "Node.js:20",
"tags": [
{
"key": "",
"value": ""
}
]
}
Example HTTP response
Response 202
{
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"message": "Description",
"state": "READY"
}
2.1.5 - Create Cloud Function Apigateway Trigger
2.1.5.1 - 1.2
post /v1/triggers/apigateway
Description
Cloud Function 트리거 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ApigatewayTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/apigateway
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"apigateway_api_id": "31e749b7b260868f441e862b",
"apigateway_stage_name": "sample",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.5.2 - 1.1
post /v1/triggers/apigateway
Description
Cloud Function 트리거 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ApigatewayTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/apigateway
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Request body
{
"apigateway_api_id": "31e749b7b260868f441e862b",
"apigateway_stage_name": "sample",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.5.3 - 1.0
post /v1/triggers/apigateway
Description
Cloud Function 트리거 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ApigatewayTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/apigateway
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Request body
{
"apigateway_api_id": "31e749b7b260868f441e862b",
"apigateway_stage_name": "sample",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.6 - Create Cloud Function Cronjob Trigger
2.1.6.1 - 1.2
post /v1/triggers/cronjob
Description
Cloud Function 트리거 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CronjobTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.6.2 - 1.1
post /v1/triggers/cronjob
Description
Cloud Function 트리거 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CronjobTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.6.3 - 1.0
post /v1/triggers/cronjob
Description
Cloud Function 트리거 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CronjobTriggerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.7 - Create PrivateLink Endpoint
2.1.7.1 - 1.2
post /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints
Description
PrivateLink Endpoint 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"endpoint": {
"alias": "sample",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.8 - Delete Cloud Function
2.1.8.1 - 1.2
delete /v1/cloud-functions/{cloud_function_id}
Description
Cloud Function 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 204
2.1.8.2 - 1.1
delete /v1/cloud-functions/{cloud_function_id}
Description
Cloud Function 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 204
2.1.8.3 - 1.0
delete /v1/cloud-functions/{cloud_function_id}
Description
Cloud Function 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 204
2.1.9 - Delete Cloud Function Trigger
2.1.9.1 - 1.2
delete /v1/triggers/{trigger_id}
Description
Cloud Function 트리거 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | 트리거 ID Example : 1 | integer | None |
| body | body required | TriggerDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
Example HTTP response
Response 204
2.1.9.2 - 1.1
delete /v1/triggers/{trigger_id}
Description
Cloud Function 트리거 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | 트리거 ID Example : 1 | integer | None |
| body | body required | TriggerDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
Example HTTP response
Response 204
2.1.9.3 - 1.0
delete /v1/triggers/{trigger_id}
Description
Cloud Function 트리거 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | 트리거 ID Example : 1 | integer | None |
| body | body required | TriggerDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
Example HTTP response
Response 204
2.1.10 - Delete PrivateLink Endpoint
2.1.10.1 - 1.2
delete /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}
Description
PrivateLink Endpoint 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 204
2.1.11 - List Cloud Function Triggers
2.1.11.1 - 1.2
get /v1/triggers
Description
Cloud Function 트리거 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | trigger_name optional | 트리거 타입 Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | None |
| query | trigger_type optional | 트리거 타입 Example : apigateway | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggersResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers?cloud_function_id={cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"count": 20,
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.11.2 - 1.1
get /v1/triggers
Description
Cloud Function 트리거 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | trigger_name optional | 트리거 타입 Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | None |
| query | trigger_type optional | 트리거 타입 Example : apigateway | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggersResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers?cloud_function_id={cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"count": 20,
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.11.3 - 1.0
get /v1/triggers
Description
Cloud Function 트리거 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | trigger_name optional | 트리거 타입 Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | None |
| query | trigger_type optional | 트리거 타입 Example : apigateway | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggersResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers?cloud_function_id={cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"count": 20,
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.12 - List Cloud Functions
2.1.12.1 - 1.2
get /v1/cloud-functions
Description
Cloud Function 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | name optional | 이름 Example : sample-function-name | any of [string, null] | None |
| query | state optional | 함수 상태 Example : READY | any of [array[string], string, null] | None |
| query | runtime optional | 런타임 Example : Node.js:20 | any of [array[string], string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"cloud_functions": [
{
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"created_at": "2025-05-22T06:21:17.580522",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
],
"count": 20
}
2.1.12.2 - 1.1
get /v1/cloud-functions
Description
Cloud Function 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | name optional | 이름 Example : sample-function-name | any of [string, null] | None |
| query | state optional | 함수 상태 Example : READY | any of [array[string], string, null] | None |
| query | runtime optional | 런타임 Example : Node.js:20 | any of [array[string], string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"cloud_functions": [
{
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"created_at": "2025-05-22T06:21:17.580522",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
],
"count": 20
}
2.1.12.3 - 1.0
get /v1/cloud-functions
Description
Cloud Function 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | sort optional | sort Example : name:asc | any of [string, null] | None |
| query | page optional | page Example : 0 | any of [integer, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | None |
| query | name optional | 이름 Example : sample-function-name | any of [string, null] | None |
| query | state optional | 함수 상태 Example : READY | any of [array[string], string, null] | None |
| query | runtime optional | 런타임 Example : Node.js:20 | any of [array[string], string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"cloud_functions": [
{
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"created_at": "2025-05-22T06:21:17.580522",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
],
"count": 20
}
2.1.13 - List Runtimes
2.1.13.1 - 1.2
get /v1/cloud-functions/runtimes
Description
Runtime 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RuntimeListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/runtimes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"count": "3",
"runtimes": [
{
"base_image_seq": "3",
"name": "sample",
"version": "1.0.0"
}
]
}
2.1.13.2 - 1.1
get /v1/cloud-functions/runtimes
Description
Runtime 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RuntimeListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/runtimes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"count": "3",
"runtimes": [
{
"base_image_seq": "3",
"name": "sample",
"version": "1.0.0"
}
]
}
2.1.13.3 - 1.0
get /v1/cloud-functions/runtimes
Description
Runtime 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RuntimeListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/runtimes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"count": "3",
"runtimes": [
{
"base_image_seq": "3",
"name": "sample",
"version": "1.0.0"
}
]
}
2.1.14 - List Sample Codes
2.1.14.1 - 1.2
get /v1/cloud-functions/sample-codes
Description
Sample 코드 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SampleCodesListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/sample-codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"count": "3",
"sample_codes": [
{
"content": "sample",
"default": false,
"description": "sample",
"name": "sample",
"runtime": "Node.js:20",
"seq": "3",
"version": "sample"
}
]
}
2.1.14.2 - 1.1
get /v1/cloud-functions/sample-codes
Description
Sample 코드 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SampleCodesListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/sample-codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"count": "3",
"sample_codes": [
{
"content": "sample",
"default": false,
"description": "sample",
"name": "sample",
"runtime": "Node.js:20",
"seq": "3",
"version": "sample"
}
]
}
2.1.14.3 - 1.0
get /v1/cloud-functions/sample-codes
Description
Sample 코드 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SampleCodesListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/sample-codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"count": "3",
"sample_codes": [
{
"content": "sample",
"default": false,
"description": "sample",
"name": "sample",
"runtime": "Node.js:20",
"seq": "3",
"version": "sample"
}
]
}
2.1.15 - Request PrivateLink Endpoint
2.1.15.1 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/request
Description
PrivateLink Endpoint 요청
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| path | endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkEndpointRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateLinkEndpoint |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints/{endpoint_id}/request
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"type": "CANCEL"
}
Example HTTP response
Response 200
{
"endpoint": {
"endpoint_alias": "sample",
"endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"state": "Active"
}
}
2.1.16 - Show Cloud Function
2.1.16.1 - 1.2
get /v1/cloud-functions/{cloud_function_id}
Description
Cloud Function 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"cloud_function": {
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
}
2.1.16.2 - 1.1
get /v1/cloud-functions/{cloud_function_id}
Description
Cloud Function 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"cloud_function": {
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
}
2.1.16.3 - 1.0
get /v1/cloud-functions/{cloud_function_id}
Description
Cloud Function 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CloudFunctionShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"cloud_function": {
"account_id": "617b3d0e90c24a5fa1f65a3824861354",
"function_url": "https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello",
"id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"name": "sample",
"runtime": "Node.js:20",
"state": "READY",
"user_id": "617b3d0e90c24a5fa1f65a3824861354"
}
}
2.1.17 - Show Cloud Function Code
2.1.17.1 - 1.2
get /v1/cloud-functions/{cloud_function_id}/codes
Description
Cloud Function 코드 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.17.2 - 1.1
get /v1/cloud-functions/{cloud_function_id}/codes
Description
Cloud Function 코드 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.17.3 - 1.0
get /v1/cloud-functions/{cloud_function_id}/codes
Description
Cloud Function 코드 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.18 - Show Cloud Function Configuration
2.1.18.1 - 1.2
get /v1/cloud-functions/{cloud_function_id}/configurations
Description
Cloud Function 구성 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ConfigurationV1Dot2 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"config": {
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
},
"privatelink_endpoints": [],
"privatelink_service": {
"private_url": "https://sample.scf.private.kr-west1.e.samsungsdscloud.com",
"privatelink_service_enabled": true,
"privatelink_service_id": "ba30549f550141ef9af6546543s",
"privatelink_service_name": "PRIVATELINKSERVICE",
"requested_endpoints": []
},
"url": {
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
},
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.18.2 - 1.1
get /v1/cloud-functions/{cloud_function_id}/configurations
Description
Cloud Function 구성 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Configuration |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"config": {
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
},
"url": {
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
},
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.18.3 - 1.0
get /v1/cloud-functions/{cloud_function_id}/configurations
Description
Cloud Function 구성 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Configuration |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"config": {
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
},
"url": {
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
},
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.19 - Show Cloud Function Logs
2.1.19.1 - 1.2
get /v1/cloud-functions/{cloud_function_id}/logs
Description
Cloud Function Log 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | 시간 Example : 3 | any of [integer, null] | None |
| query | start optional | 시작 일자 Example : 20250517 | any of [string, null] | None |
| query | end optional | 종료 일자 Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/logs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"count": "3",
"logs": [
{
"log": "[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST",
"time": "2025-05-17 00:23:17"
}
]
}
2.1.19.2 - 1.1
get /v1/cloud-functions/{cloud_function_id}/logs
Description
Cloud Function Log 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | 시간 Example : 3 | any of [integer, null] | None |
| query | start optional | 시작 일자 Example : 20250517 | any of [string, null] | None |
| query | end optional | 종료 일자 Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/logs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"count": "3",
"logs": [
{
"log": "[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST",
"time": "2025-05-17 00:23:17"
}
]
}
2.1.19.3 - 1.0
get /v1/cloud-functions/{cloud_function_id}/logs
Description
Cloud Function Log 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | 시간 Example : 3 | any of [integer, null] | None |
| query | start optional | 시작 일자 Example : 20250517 | any of [string, null] | None |
| query | end optional | 종료 일자 Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/logs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"count": "3",
"logs": [
{
"log": "[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST",
"time": "2025-05-17 00:23:17"
}
]
}
2.1.20 - Show Cloud Function Metrics
2.1.20.1 - 1.2
get /v1/cloud-functions/{cloud_function_id}/metrics
Description
Cloud Function Metric 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | 시간 Example : 3 | any of [integer, null] | None |
| query | start optional | 시작 일자 Example : 20250517 | any of [string, null] | None |
| query | end optional | 종료 일자 Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/metrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"actual_pods": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"fail_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"function_memory": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_latency": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"success_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
]
}
2.1.20.2 - 1.1
get /v1/cloud-functions/{cloud_function_id}/metrics
Description
Cloud Function Metric 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | 시간 Example : 3 | any of [integer, null] | None |
| query | start optional | 시작 일자 Example : 20250517 | any of [string, null] | None |
| query | end optional | 종료 일자 Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/metrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"actual_pods": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"fail_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"function_memory": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_latency": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"success_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
]
}
2.1.20.3 - 1.0
get /v1/cloud-functions/{cloud_function_id}/metrics
Description
Cloud Function Metric 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| query | time optional | 시간 Example : 3 | any of [integer, null] | None |
| query | start optional | 시작 일자 Example : 20250517 | any of [string, null] | None |
| query | end optional | 종료 일자 Example : 20250517 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/metrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"actual_pods": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"fail_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"function_memory": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"request_latency": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
],
"success_count": [
{
"metric_data": "1.0033444816053512",
"time": "16:37"
}
]
}
2.1.21 - Show Cloud Function Trigger
2.1.21.1 - 1.2
get /v1/triggers/{trigger_id}
Description
Cloud Function 트리거 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | 트리거 ID Example : 1 | integer | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Trigger |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_sid": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
2.1.21.2 - 1.1
get /v1/triggers/{trigger_id}
Description
Cloud Function 트리거 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | 트리거 ID Example : 1 | integer | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Trigger |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_sid": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
2.1.21.3 - 1.0
get /v1/triggers/{trigger_id}
Description
Cloud Function 트리거 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | 트리거 ID Example : 1 | integer | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Trigger |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Example HTTP response
Response 200
{
"alias": "$LATEST",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_sid": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
2.1.22 - Update Cloud Function Code
2.1.22.1 - 1.2
put /v1/cloud-functions/{cloud_function_id}/codes
Description
Cloud Function 코드 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"content": "print(\"Hello World\")"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.22.2 - 1.1
put /v1/cloud-functions/{cloud_function_id}/codes
Description
Cloud Function 코드 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Request body
{
"content": "print(\"Hello World\")"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.22.3 - 1.0
put /v1/cloud-functions/{cloud_function_id}/codes
Description
Cloud Function 코드 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Request body
{
"content": "print(\"Hello World\")"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.23 - Update Cloud Function Code File
2.1.23.1 - 1.2
put /v1/cloud-functions/{cloud_function_id}/codes/file
Description
Cloud Function 코드 파일 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeFile |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes/file
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"class_name": "com.example.Handler",
"method_name": "handleRequest",
"obs_url": "https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.23.2 - 1.1
put /v1/cloud-functions/{cloud_function_id}/codes/file
Description
Cloud Function 코드 파일 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | CodeFile |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Code |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/codes/file
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Request body
{
"class_name": "com.example.Handler",
"method_name": "handleRequest",
"obs_url": "https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar"
}
Example HTTP response
Response 202
{
"class_name": "com.example.Handler",
"code_text": "ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==",
"code_type": "text",
"file_name": "sample",
"file_transfer_status": "sample",
"file_upload_at": "2025-05-17 00:23:17",
"method_name": "handleRequest",
"runtime": "Node.js:20"
}
2.1.24 - Update Cloud Function Config
2.1.24.1 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/config
Description
Cloud Function 일반 구성 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionConfig |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionConfig |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/config
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
Example HTTP response
Response 200
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
2.1.24.2 - 1.1
put /v1/cloud-functions/{cloud_function_id}/configurations/config
Description
Cloud Function 일반 구성 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionConfig |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionConfig |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/config
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Request body
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
Example HTTP response
Response 200
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
2.1.24.3 - 1.0
put /v1/cloud-functions/{cloud_function_id}/configurations/config
Description
Cloud Function 일반 구성 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionConfig |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionConfig |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/config
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Request body
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
Example HTTP response
Response 200
{
"max_scale": "5",
"memory": "256",
"min_scale": "1",
"timeout": "100"
}
2.1.25 - Update Cloud Function Cronjob Trigger
2.1.25.1 - 1.2
put /v1/triggers/cronjob/{trigger_id}
Description
Cloud Function 트리거 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | 트리거 ID Example : 1 | integer | None |
| body | body required | CronjobTriggerSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerUpdateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.25.2 - 1.1
put /v1/triggers/cronjob/{trigger_id}
Description
Cloud Function 트리거 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | 트리거 ID Example : 1 | integer | None |
| body | body required | CronjobTriggerSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerUpdateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.25.3 - 1.0
put /v1/triggers/cronjob/{trigger_id}
Description
Cloud Function 트리거 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trigger_id required | 트리거 ID Example : 1 | integer | None |
| body | body required | CronjobTriggerSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TriggerUpdateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/triggers/cronjob/{trigger_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Request body
{
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo"
}
Example HTTP response
Response 200
{
"alias": "$LATEST",
"cloud_function_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
"triggers": [
{
"schedule": "* * * * 0",
"timezone": "Asia/Tokyo",
"trigger_id": 1,
"trigger_name": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_target_account_id": "617b3d0e90c24a5fa1f65a3824861354",
"trigger_target_srn": "srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe",
"trigger_target_uuid": "8c9f6c1c928a45b4bbd1e4da5531d656",
"trigger_type": "apigateway"
}
]
}
2.1.26 - Update Cloud Function Url
2.1.26.1 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/url
Description
Cloud Function 함수 URL 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionUrlRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionUrl |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/url
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"allow_ips": [],
"auth_type": "NONE",
"public_ip_acl_enabled": true,
"url_enabled": true
}
Example HTTP response
Response 200
{
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
}
2.1.26.2 - 1.1
put /v1/cloud-functions/{cloud_function_id}/configurations/url
Description
Cloud Function 함수 URL 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionUrlRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionUrl |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/url
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Request body
{
"allow_ips": [],
"auth_type": "NONE",
"public_ip_acl_enabled": true,
"url_enabled": true
}
Example HTTP response
Response 200
{
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
}
2.1.26.3 - 1.0
put /v1/cloud-functions/{cloud_function_id}/configurations/url
Description
Cloud Function 함수 URL 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionUrlRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionUrl |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/url
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Request body
{
"allow_ips": [],
"auth_type": "NONE",
"public_ip_acl_enabled": true,
"url_enabled": true
}
Example HTTP response
Response 200
{
"allow_ips": [
""
],
"auth_type": "NONE",
"public_endpoint_url": "https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function",
"public_ip_acl_enabled": true,
"url_enabled": true
}
2.1.27 - Update Cloud Function Variables
2.1.27.1 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Description
Cloud Function 환경 변수 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionVariables |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionVariables |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
Example HTTP response
Response 200
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.27.2 - 1.1
put /v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Description
Cloud Function 환경 변수 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionVariables |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionVariables |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.1"
Request body
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
Example HTTP response
Response 200
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.27.3 - 1.0
put /v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Description
Cloud Function 환경 변수 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | FunctionVariables |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FunctionVariables |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/environment-variables
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.0"
Request body
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
Example HTTP response
Response 200
{
"variables": [
{
"key": "sample",
"value": "sample"
}
]
}
2.1.28 - Update PrivateLink Service
2.1.28.1 - 1.2
put /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-services
Description
PrivateLink Service 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | None |
| body | body required | PrivateLinkServicePutRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | PrivateLinkService |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-services
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = scf 1.2"
Request body
{
"privatelink_service_enabled": true
}
Example HTTP response
Response 202
{
"private_url": "https://sample.scf.private.kr-west1.e.samsungsdscloud.com",
"privatelink_service_enabled": true,
"privatelink_service_id": "ba30549f550141ef9af6546543s",
"privatelink_service_name": "PRIVATELINKSERVICE",
"requested_endpoints": []
}
2.2 - Models
2.2.1 - ApigatewayTriggerCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| apigateway_api_id required | Apigateway API ID Example : 31e749b7b260868f441e862bPattern : ^[0-9a-f]{24}$ | string | |
| apigateway_stage_name required | Apigateway 스테이지 이름 Example : samplePattern : ^[a-z0-9\-]+$ | string | |
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656Pattern : ^[0-9a-f]{32}$ | string |
2.2.2 - CloudFunction
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 어카운트 ID Example : 617b3d0e90c24a5fa1f65a3824861354 | string | |
| function_url required | 함수 URL Example : https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello | any of [string, null] | |
| id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| name required | Cloud Functions 이름 Example : sample | string | |
| runtime required | 런타임 Example : Node.js:20 | string | |
| state required | 함수 상태 Example : READY | string | |
| user_id required | 사용자 ID Example : 617b3d0e90c24a5fa1f65a3824861354 | string |
2.2.3 - CloudFunctionCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| content required | 코드 내용 Example : sample | string | |
| name required | 이름 Example : sample-function-namePattern : ^[a-z][a-z0-9-]*$Minimum length : 3Maximum length : 64 | string | |
| runtime required | 런타임 Example : Node.js:20 | string | |
| tags optional | 태그 목록 | any of [array[Tag], null] |
2.2.4 - CloudFunctionCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| message required | 설명 Example : Description | string | |
| state required | 함수 상태 Example : READY | string |
2.2.5 - CloudFunctionForList
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 어카운트 ID Example : 617b3d0e90c24a5fa1f65a3824861354 | string | |
| created_at required | 생성 시간 Example : 2025-05-22T06:21:17.580522 | string (date-time) | |
| function_url required | 함수 URL Example : https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello | any of [string, null] | |
| id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| name required | Cloud Functions 이름 Example : sample | string | |
| runtime required | 런타임 Example : Node.js:20 | string | |
| state required | 함수 상태 Example : READY | string | |
| user_id required | 사용자 ID Example : 617b3d0e90c24a5fa1f65a3824861354 | string |
2.2.6 - CloudFunctionListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cloud_functions required | 내용 | array[CloudFunctionForList] | |
| count required | 합계 Example : 20 | integer |
2.2.7 - CloudFunctionShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cloud_function required | CloudFunction |
2.2.8 - Code
| Name | Description | Schema | Default |
|---|---|---|---|
| class_name optional | 클래스명 Example : com.example.Handler | any of [string, null] | |
| code_text optional | 코드 내용 Example : ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM== | any of [string, null] | |
| code_type required | 코드 유형 Example : text | string | |
| file_name optional | 파일명 Example : sample | any of [string, null] | |
| file_transfer_status optional | 파일 전송 상태 Example : sample | any of [string, null] | |
| file_upload_at optional | 파일 업로드 시간 Example : 2025-05-17 00:23:17 | any of [string, null] | |
| method_name optional | 메소드명 Example : handleRequest | any of [string, null] | |
| runtime required | 런타임 Example : Node.js:20 | string |
2.2.9 - CodeFile
| Name | Description | Schema | Default |
|---|---|---|---|
| class_name required | 클래스명 Example : com.example.Handler | string | |
| method_name required | 메소드명 Example : handleRequest | string | |
| obs_url optional | Object Storage URL Example : https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar | any of [string, null] |
2.2.10 - CodeSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| content required | 코드 내용 Example : print("Hello World") | string |
2.2.11 - Configuration
| Name | Description | Schema | Default |
|---|---|---|---|
| config required | 일반 구성 | FunctionConfig | |
| url required | 함수 URL | FunctionUrl | |
| variables optional | 환경 변수 | any of [array[FunctionVariable], null] |
2.2.12 - ConfigurationV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| config required | 일반 구성 | FunctionConfig | |
| privatelink_endpoints optional | Endpoints | any of [array[Endpoint], null] | |
| privatelink_service optional | PrivateLink Service | any of [PrivateLinkService, null] | |
| url required | 함수 URL | FunctionUrl | |
| variables optional | 환경 변수 | any of [array[FunctionVariable], null] |
2.2.13 - CronjobTriggerCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656Pattern : ^[0-9a-f]{32}$ | string | |
| schedule required | 스케쥴 Example : * * * * 0 | string | |
| timezone required | 타임존 Example : Asia/Tokyo | string |
2.2.14 - CronjobTriggerSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656Pattern : ^[0-9a-f]{32}$ | string | |
| schedule required | 스케쥴 Example : * * * * 0 | string | |
| timezone required | 타임존 Example : Asia/Tokyo | string |
2.2.15 - DuplicationShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | 결과 Example : True | boolean |
2.2.16 - Endpoint
| Name | Description | Schema | Default |
|---|---|---|---|
| endpoint_alias optional | Alias Example : sample | any of [string, null] | |
| endpoint_id required | Endpoint Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| service_id optional | Service Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | |
| state required | 상태 Example : Active | string |
2.2.17 - EndpointCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| alias required | Alias Example : sample | string | |
| service_id required | Service Id Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string |
2.2.18 - FunctionConfig
| Name | Description | Schema | Default |
|---|---|---|---|
| max_scale required | 최대 작업 수 Example : 5 | integer | |
| memory required | 메모리 Example : 256 | integer | |
| min_scale required | 최소 작업 수 Example : 1 | integer | |
| timeout required | 제한 시간 Example : 100 | integer |
2.2.19 - FunctionUrl
| Name | Description | Schema | Default |
|---|---|---|---|
| allow_ips optional | 허용 IP Example : | any of [array[string], null] | |
| auth_type optional | 인증 유형 Example : NONE | any of [string, null] | |
| public_endpoint_url optional | Public 엔드포인트 URL Example : https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function | any of [string, null] | |
| public_ip_acl_enabled optional | Public IP 접근 제어 사용 Example : True | any of [boolean, null] | |
| url_enabled required | URL 사용 Example : True | boolean |
2.2.20 - FunctionUrlRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| allow_ips optional | 허용 IP Example : | any of [array[string], null] | |
| auth_type optional | 인증 유형 Example : NONE | any of [string, null] | |
| public_ip_acl_enabled required | Public IP 접근 제어 사용 Example : True | boolean | |
| url_enabled required | URL 사용 Example : True | boolean |
2.2.21 - FunctionVariable
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | 키 Example : sample | string | |
| value required | 값 Example : sample | string |
2.2.22 - FunctionVariables
| Name | Description | Schema | Default |
|---|---|---|---|
| variables required | 환경 변수 | array[FunctionVariable] |
2.2.23 - Log
| Name | Description | Schema | Default |
|---|---|---|---|
| log required | 로그 Example : [2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST | string | |
| time required | 시간 Example : 2025-05-17 00:23:17 | string |
2.2.24 - LogShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | 합계 Example : 3 | integer | |
| logs required | 로그 | array[Log] |
2.2.25 - Metric
| Name | Description | Schema | Default |
|---|---|---|---|
| metric_data required | Metric 데이터 Example : 1.0033444816053512 | object | |
| time required | 시간 Example : 16:37 | string |
2.2.26 - MetricShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| actual_pods required | 실제 파드 | array[Metric] | |
| fail_count required | 실패 카운트 | array[Metric] | |
| function_memory required | 함수 메모리 | array[Metric] | |
| request_count required | 요청 카운트 | array[Metric] | |
| request_latency required | 요청 레이턴시 | array[Metric] | |
| success_count required | 성공 카운트 | array[Metric] |
2.2.27 - PrivateLinkEndpoint
| Name | Description | Schema | Default |
|---|---|---|---|
| endpoint required | Endpoint | Endpoint |
2.2.28 - PrivateLinkEndpointApproval
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | 타입 Example : APPROVE | enum (APPROVE, REJECT) |
2.2.29 - PrivateLinkEndpointConnection
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | 타입 Example : RECONNECT | enum (DISCONNECT, RECONNECT) |
2.2.30 - PrivateLinkEndpointCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| endpoint required | Endpoint | EndpointCreateRequest |
2.2.31 - PrivateLinkEndpointRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | 타입 Example : CANCEL | enum (CANCEL, RE_REQUEST) |
2.2.32 - PrivateLinkService
| Name | Description | Schema | Default |
|---|---|---|---|
| private_url optional | Private Url Example : https://sample.scf.private.kr-west1.e.samsungsdscloud.com | any of [string, null] | |
| privatelink_service_enabled required | PrivateLink Service 활성화 Example : True | boolean | |
| privatelink_service_id optional | PrivateLink Service ID Example : ba30549f550141ef9af6546543s | any of [string, null] | |
| privatelink_service_name optional | PrivateLink Service Example : PRIVATELINKSERVICE | any of [string, null] | |
| requested_endpoints optional | Endpoint | any of [array[Endpoint], null] |
2.2.33 - PrivateLinkServicePutRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| privatelink_service_enabled required | PrivateLink Service 활성화 Example : True | boolean |
2.2.34 - Runtime
| Name | Description | Schema | Default |
|---|---|---|---|
| base_image_seq required | 기본 이미지 번호 Example : 3 | integer | |
| name required | 이름 Example : sample | string | |
| version required | 버전 Example : 1.0.0 | string |
2.2.35 - RuntimeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | 합계 Example : 3 | integer | |
| runtimes required | Runtimes List | array[Runtime] |
2.2.36 - SampleCode
| Name | Description | Schema | Default |
|---|---|---|---|
| content required | 코드 내용 Example : sample | string | |
| default required | 기본값 Example : False | boolean | |
| description required | 설명 Example : sample | string | |
| name required | 이름 Example : sample | string | |
| runtime required | 런타임 Example : Node.js:20 | string | |
| seq required | 번호 Example : 3 | integer | |
| version required | 버전 Example : sample | string |
2.2.37 - SampleCodesListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | 합계 Example : 3 | integer | |
| sample_codes required | Sample Codes List | array[SampleCode] |
2.2.38 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | 태그 키 Example : | string | |
| value required | 태그 값 Example : | any of [string, null] |
2.2.39 - Trigger
| Name | Description | Schema | Default |
|---|---|---|---|
| alias required | Alias Example : $LATEST | string | |
| schedule optional | 스케쥴 Example : * * * * 0 | any of [string, null] | |
| timezone optional | 타임존 Example : Asia/Tokyo | any of [string, null] | |
| trigger_id required | 트리거 ID Example : 1 | integer | |
| trigger_name required | 트리거 타입 Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| trigger_sid required | 트리거 타겟 어카운트 ID Example : 617b3d0e90c24a5fa1f65a3824861354 | any of [string, null] | |
| trigger_target_account_id required | 트리거 타겟 어카운트 ID Example : 617b3d0e90c24a5fa1f65a3824861354 | any of [string, null] | |
| trigger_target_srn required | 트리거 타겟 SRN Example : srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe | any of [string, null] | |
| trigger_target_uuid required | 트리거 타겟 UUID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | |
| trigger_type required | 트리거 타입 Example : apigateway | string |
2.2.40 - TriggerCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| alias optional | Alias Example : $LATEST | any of [string, null] | |
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| triggers required | 트리거 | array[TriggerForList] |
2.2.41 - TriggerDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656Pattern : ^[0-9a-f]{32}$ | string | |
| trigger_type required | 트리거 타입 Example : apigateway | string |
2.2.42 - TriggerForList
| Name | Description | Schema | Default |
|---|---|---|---|
| schedule optional | 스케쥴 Example : * * * * 0 | any of [string, null] | |
| timezone optional | 타임존 Example : Asia/Tokyo | any of [string, null] | |
| trigger_id optional | 트리거 ID Example : 1 | any of [integer, null] | |
| trigger_name required | 트리거 타입 Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| trigger_target_account_id required | 트리거 타겟 어카운트 ID Example : 617b3d0e90c24a5fa1f65a3824861354 | any of [string, null] | |
| trigger_target_srn required | 트리거 타겟 SRN Example : srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe | any of [string, null] | |
| trigger_target_uuid required | 트리거 타겟 UUID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | any of [string, null] | |
| trigger_type required | 트리거 타입 Example : apigateway | string |
2.2.43 - TriggersResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| alias required | Alias Example : $LATEST | string | |
| count required | 합계 Example : 20 | integer | |
| triggers required | 트리거 | array[TriggerForList] |
2.2.44 - TriggerUpdateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| alias optional | Alias Example : $LATEST | any of [string, null] | |
| cloud_function_id required | Cloud Functions ID Example : 8c9f6c1c928a45b4bbd1e4da5531d656 | string | |
| triggers required | 트리거 | array[TriggerForList] |
3 - Virtual Server
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 Virtual Server 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
OpenAPI URL
https://virtualserver.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
3.1 - APIs
3.1.1 - Accept a volume transfer
3.1.1.1 - 1.1
post /v1/volume-transfer/{transfer_id}/accept
Description
Accept a volume transfer.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
| body | body required | VolumeTransferAccessRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeTransferAcceptResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}/accept
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"auth_key": "f5972fdb456897eb"
}
Example HTTP response
Response 202
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.1.2 - 1.0
post /v1/volume-transfer/{transfer_id}/accept
Description
Accept a volume transfer.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
| body | body required | VolumeTransferAccessRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeTransferAcceptResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}/accept
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"auth_key": "f5972fdb456897eb"
}
Example HTTP response
Response 202
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.2 - Attach Virtual Server Security Group
3.1.2.1 - 1.0
post /v1/servers/{server_id}/security-groups
Description
서버에 Security Group을 추가한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerSecurityGroupActionRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"security_group_id": "c09c3f05-03d9-443f-b27a-40e0f973c75f"
}
Example HTTP response
Response 202
3.1.3 - Attach Volume to Virtual Server
3.1.3.1 - 1.1
post /v1/volumes/{volume_id}/servers
Description
볼륨을 서버에 연결한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeServerAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeServerAttachResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"delete_on_termination": false,
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
Example HTTP response
Response 202
{
"delete_on_termination": false,
"device": "/dev/vda",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.3.2 - 1.0
post /v1/volumes/{volume_id}/servers
Description
볼륨을 서버에 연결한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeServerAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeServerAttachResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"delete_on_termination": false,
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
Example HTTP response
Response 202
{
"delete_on_termination": false,
"device": "/dev/vda",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.4 - Create a snapshot
3.1.4.1 - 1.1
post /v1/snapshots
Description
Create a snapshot.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SnapshotCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"description": "description",
"force": true,
"metadata": "",
"name": "snapshot-1",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.4.2 - 1.0
post /v1/snapshots
Description
Create a snapshot.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SnapshotCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"description": "description",
"force": true,
"metadata": "",
"name": "snapshot-1",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.5 - Create a volume transfer
3.1.5.1 - 1.1
post /v1/volume-transfer
Description
Create a volume transfer.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeTransferRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeTransferCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"auth_key": "f5972fdb456897eb",
"created_at": "",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.5.2 - 1.0
post /v1/volume-transfer
Description
Create a volume transfer.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeTransferRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeTransferCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 202
{
"auth_key": "f5972fdb456897eb",
"created_at": "",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.6 - Create Auto-Scaling Group
3.1.6.1 - 1.1
post /v1/auto-scaling-groups
Description
Auto-Scaling Group을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AutoScalingGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"name": "auto-scaling-group-name",
"notifications": [],
"scaling_policies": [],
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"subnet_ids": [
""
],
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.6.2 - 1.0
post /v1/auto-scaling-groups
Description
Auto-Scaling Group을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AutoScalingGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"name": "auto-scaling-group-name",
"notifications": [],
"scaling_policies": [],
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"subnet_ids": [
""
],
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.7 - Create Auto-Scaling Group Notification
3.1.7.1 - 1.1
post /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
Auto-Scaling Group 알림을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupNotificationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupNotificationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"user_ids": [
"570907805e5447be84b618450ef52o0t"
]
}
Example HTTP response
Response 201
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
3.1.7.2 - 1.0
post /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
Auto-Scaling Group 알림을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupNotificationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupNotificationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"user_ids": [
"570907805e5447be84b618450ef52o0t"
]
}
Example HTTP response
Response 201
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
3.1.8 - Create Auto-Scaling Group Policy
3.1.8.1 - 1.1
post /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
Auto-Scaling Group 정책을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupPolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"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
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 1,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
3.1.8.2 - 1.0
post /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
Auto-Scaling Group 정책을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupPolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"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
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 1,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
3.1.9 - Create Auto-Scaling Group Schedule
3.1.9.1 - 1.1
post /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Auto-Scaling Group 스케줄을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupScheduleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupScheduleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
3.1.9.2 - 1.0
post /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Auto-Scaling Group 스케줄을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupScheduleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AutoScalingGroupScheduleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
3.1.10 - Create Image
3.1.10.1 - 1.1
post /v1/images
Description
이미지를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ImageCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"container_format": "bare",
"disk_format": "qcow2",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"protected": false,
"tags": "[{'key': 'key', 'value': 'value'}]",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
3.1.10.2 - 1.0
post /v1/images
Description
이미지를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ImageCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"container_format": "bare",
"disk_format": "qcow2",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"protected": false,
"tags": "[{'key': 'key', 'value': 'value'}]",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
3.1.11 - Create Image member
3.1.11.1 - 1.1
post /v1/images/{image_id}/members
Description
이미지 멤버를 추가한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageMemberCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
3.1.11.2 - 1.0
post /v1/images/{image_id}/members
Description
이미지 멤버를 추가한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageMemberCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
3.1.12 - Create Keypair
3.1.12.1 - 1.1
post /v1/keypairs
Description
키페어를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | KeypairCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | KeypairCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/keypairs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "keypairname",
"public_key": "publickey",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 201
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"private_key": "privatekey",
"public_key": "publickey",
"type": "ssh"
}
3.1.12.2 - 1.0
post /v1/keypairs
Description
키페어를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | KeypairCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | KeypairCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/keypairs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "keypairname",
"public_key": "publickey",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 201
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"private_key": "privatekey",
"public_key": "publickey",
"type": "ssh"
}
3.1.13 - Create Launch Configuration
3.1.13.1 - 1.1
post /v1/launch-configurations
Description
Launch Configuration을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LaunchConfigurationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | LaunchConfigurationDetailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"name": "launch-configuration-name",
"server_type_id": "s1v1m2",
"tags": "[{'key': 'key', 'value': 'value'}]",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "publickey",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
3.1.13.2 - 1.0
post /v1/launch-configurations
Description
Launch Configuration을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LaunchConfigurationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | LaunchConfigurationDetailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"name": "launch-configuration-name",
"server_type_id": "s1v1m2",
"tags": "[{'key': 'key', 'value': 'value'}]",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "publickey",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
3.1.14 - Create Server Group
3.1.14.1 - 1.1
post /v1/server-groups
Description
서버 그룹을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServerGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | ServerGroup |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "server-group",
"policy": "anti-affinity",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": "['2a9be312-5d4b-4bc8-b2ae-35100fa9241f']",
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
3.1.14.2 - 1.0
post /v1/server-groups
Description
서버 그룹을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServerGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | ServerGroup |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "server-group",
"policy": "anti-affinity",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 201
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": "['2a9be312-5d4b-4bc8-b2ae-35100fa9241f']",
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
3.1.15 - Create Server Interface
3.1.15.1 - 1.1
post /v1/servers/{server_id}/interfaces
Description
서버 인터페이스를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerInterfaceCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InterfaceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
Example HTTP response
Response 200
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
3.1.15.2 - 1.0
post /v1/servers/{server_id}/interfaces
Description
서버 인터페이스를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerInterfaceCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InterfaceResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
Example HTTP response
Response 200
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
3.1.16 - Create Server Interface Nat
3.1.16.1 - 1.1
post /v1/servers/{server_id}/interfaces/{port_id}/static-nats
Description
Create Server Interface Nat.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601"
}
Example HTTP response
Response 201
3.1.16.2 - 1.0
post /v1/servers/{server_id}/interfaces/{port_id}/static-nats
Description
Create Server Interface Nat.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601"
}
Example HTTP response
Response 201
3.1.17 - Create Server Interface Private Nat
3.1.17.1 - 1.1
post /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Description
Create Server Interface Private Nat.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerPrivateStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"private_nat_id": "3a6c1dc6b1b24e02a444d672c2798a1c",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496"
}
Example HTTP response
Response 201
3.1.17.2 - 1.0
post /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Description
Create Server Interface Private Nat.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerPrivateStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"private_nat_id": "3a6c1dc6b1b24e02a444d672c2798a1c",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496"
}
Example HTTP response
Response 201
3.1.18 - Create Server Volume
3.1.18.1 - 1.1
post /v1/servers/{server_id}/volumes
Description
서버 볼륨을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerVolumesCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServersVolumeResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"delete_on_termination": false,
"device": "/dev/vda",
"volume_id": ""
}
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.18.2 - 1.0
post /v1/servers/{server_id}/volumes
Description
서버 볼륨을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerVolumesCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServersVolumeResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"delete_on_termination": false,
"device": "/dev/vda",
"volume_id": ""
}
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.19 - Create Sharing Image
3.1.19.1 - 1.1
post /v1/images/{image_id}/share
Description
공유용 이미지를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/share
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.19.2 - 1.0
post /v1/images/{image_id}/share
Description
공유용 이미지를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/share
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.20 - Create Virtual Server
3.1.20.1 - 1.1
post /v1/servers
Description
서버를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | ServerCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"lock": false,
"max_count": 2,
"metadata": "",
"name": "servername",
"networks": [
{
"fixed_ip": "192.169.3.2",
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"public_ip_id": "615fa9cd5cff486c9de679b3ce63e601",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
],
"partition_number": 1,
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type_id": "s1v1m2",
"tags": "[{'key': 'key', 'value': 'value'}]",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": []
}
Example HTTP response
Response 202
{
"servers": [
{
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
]
}
3.1.20.2 - 1.0
post /v1/servers
Description
서버를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServerCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | ServerCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"keypair_name": "keypairname",
"lock": false,
"max_count": 2,
"metadata": "",
"name": "servername",
"networks": [
{
"fixed_ip": "192.169.3.2",
"port_id": "91424c08-0b26-49fb-9808-ed042292ceef",
"public_ip_id": "615fa9cd5cff486c9de679b3ce63e601",
"subnet_id": "78b2ee3f074145c580ab6abac4821f97"
}
],
"partition_number": 1,
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type_id": "s1v1m2",
"tags": "[{'key': 'key', 'value': 'value'}]",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": []
}
Example HTTP response
Response 202
{
"servers": [
{
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
]
}
3.1.21 - Create Virtual Server Custom Image
3.1.21.1 - 1.1
post /v1/servers/{server_id}/images
Description
서버 커스텀 이미지를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerCreateImageRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | ServerCreateImageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"image_name": "imagename"
}
Example HTTP response
Response 202
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}
3.1.21.2 - 1.0
post /v1/servers/{server_id}/images
Description
서버 커스텀 이미지를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerCreateImageRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | ServerCreateImageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"image_name": "imagename"
}
Example HTTP response
Response 202
{
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}
3.1.22 - Create Virtual Server Dump
3.1.22.1 - 1.1
post /v1/servers/{server_id}/dump
Description
서버 Dump를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/dump
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.22.2 - 1.0
post /v1/servers/{server_id}/dump
Description
서버 Dump를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/dump
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.23 - Create Volume
3.1.23.1 - 1.1
post /v1/volumes
Description
볼륨 생성을 요청한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "volume01",
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"tags": "[{'key': 'key', 'value': 'value'}]",
"volume_type": "SSD"
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-02-11T06:44:46.280Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-02-11T06:44:46.322Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
3.1.23.2 - 1.0
post /v1/volumes
Description
볼륨 생성을 요청한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "volume01",
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"tags": "[{'key': 'key', 'value': 'value'}]",
"volume_type": "SSD"
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-02-11T06:44:46.280Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-02-11T06:44:46.322Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
3.1.24 - Delete a snapshot
3.1.24.1 - 1.1
delete /v1/snapshots/{snapshot_id}
Description
Delete a snapshot.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | 스냅샷 ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.24.2 - 1.0
delete /v1/snapshots/{snapshot_id}
Description
Delete a snapshot.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | 스냅샷 ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.25 - Delete a volume transfer
3.1.25.1 - 1.1
delete /v1/volume-transfer/{transfer_id}
Description
Delete a volume transfer.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.25.2 - 1.0
delete /v1/volume-transfer/{transfer_id}
Description
Delete a volume transfer.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.26 - Delete Auto-Scaling Group
3.1.26.1 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Auto-Scaling Group을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
3.1.26.2 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Auto-Scaling Group을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
3.1.27 - Delete Auto-Scaling Group Notification
3.1.27.1 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Auto-Scaling Group 알림을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | 알림 ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
3.1.27.2 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Auto-Scaling Group 알림을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | 알림 ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
3.1.28 - Delete Auto-Scaling Group Policy
3.1.28.1 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Auto-Scaling Group 정책을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | 정책 ID Example : 0761d76085f54363bab07909baf69841 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
3.1.28.2 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Auto-Scaling Group 정책을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | 정책 ID Example : 0761d76085f54363bab07909baf69841 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
3.1.29 - Delete Auto-Scaling Group Schedule
3.1.29.1 - 1.1
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Auto-Scaling Group 스케줄을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | 스케줄 ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
3.1.29.2 - 1.0
delete /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Auto-Scaling Group 스케줄을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | 스케줄 ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
3.1.30 - Delete Image
3.1.30.1 - 1.1
delete /v1/images/{image_id}
Description
이미지를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
3.1.30.2 - 1.0
delete /v1/images/{image_id}
Description
이미지를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
3.1.31 - Delete Image member
3.1.31.1 - 1.1
delete /v1/images/{image_id}/members/{member_id}
Description
이미지 멤버를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | 멤버 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
3.1.31.2 - 1.0
delete /v1/images/{image_id}/members/{member_id}
Description
이미지 멤버를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | 멤버 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
3.1.32 - Delete Keypair
3.1.32.1 - 1.1
delete /v1/keypairs/{keypair_name}
Description
키페어를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | keypair_name required | 키페어 이름 Example : keypairname | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
3.1.32.2 - 1.0
delete /v1/keypairs/{keypair_name}
Description
키페어를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | keypair_name required | 키페어 이름 Example : keypairname | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
3.1.33 - Delete Launch Configuration
3.1.33.1 - 1.1
delete /v1/launch-configurations/{launch_configuration_id}
Description
Launch Configuration을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 204
3.1.33.2 - 1.0
delete /v1/launch-configurations/{launch_configuration_id}
Description
Launch Configuration을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 204
3.1.34 - Delete Server Group
3.1.34.1 - 1.1
delete /v1/server-groups/{server_group_id}
Description
서버 그룹을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_group_id required | 서버 그룹 ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
3.1.34.2 - 1.0
delete /v1/server-groups/{server_group_id}
Description
서버 그룹을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_group_id required | 서버 그룹 ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
3.1.35 - Delete Server Interface
3.1.35.1 - 1.1
delete /v1/servers/{server_id}/interfaces/{port_id}
Description
서버 인터페이스를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
3.1.35.2 - 1.0
delete /v1/servers/{server_id}/interfaces/{port_id}
Description
서버 인터페이스를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
3.1.36 - Delete Server Interface Nat
3.1.36.1 - 1.1
delete /v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Description
서버 인터페이스 NAT를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| path | nat_id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.36.2 - 1.0
delete /v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Description
서버 인터페이스 NAT를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| path | nat_id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/static-nats/{nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.37 - Delete Server Interface Private Nat
3.1.37.1 - 1.1
delete /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Description
서버 인터페이스 Private NAT를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| path | nat_id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.37.2 - 1.0
delete /v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Description
서버 인터페이스 Private NAT를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| path | nat_id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}/private-static-nats/{nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.38 - Delete Server Volume
3.1.38.1 - 1.1
delete /v1/servers/{server_id}/volumes/{volume_id}
Description
서버 볼륨을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.38.2 - 1.0
delete /v1/servers/{server_id}/volumes/{volume_id}
Description
서버 볼륨을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.39 - Delete Virtual Server
3.1.39.1 - 1.1
delete /v1/servers/{server_id}
Description
서버를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.39.2 - 1.0
delete /v1/servers/{server_id}
Description
서버를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.40 - Delete Volume
3.1.40.1 - 1.1
delete /v1/volumes/{volume_id}
Description
볼륨 삭제를 요청한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| query | cascade optional | 스냅샷 삭제 여부 Example : True | any of [boolean, null] | True |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.40.2 - 1.0
delete /v1/volumes/{volume_id}
Description
볼륨 삭제를 요청한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| query | cascade optional | 스냅샷 삭제 여부 Example : True | any of [boolean, null] | True |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.41 - Detach Virtual Server Security Group
3.1.41.1 - 1.0
delete /v1/servers/{server_id}/security-groups/{security_group_id}
Description
서버에서 Security Group을 해제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | security_group_id required | Security Group ID Example : c09c3f05-03d9-443f-b27a-40e0f973c75f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups/{security_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.42 - Detach Volume from Virtual Server
3.1.42.1 - 1.1
delete /v1/volumes/{volume_id}/servers/{server_id}
Description
볼륨을 서버에서 연결 해제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.42.2 - 1.0
delete /v1/volumes/{volume_id}/servers/{server_id}
Description
볼륨을 서버에서 연결 해제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.43 - Extend Volume
3.1.43.1 - 1.1
put /v1/volumes/{volume_id}/size
Description
볼륨 용량을 증설 요청한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeExtendRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/size
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"size": 104
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-02-11T06:44:46.280Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-02-11T06:44:46.322Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
3.1.43.2 - 1.0
put /v1/volumes/{volume_id}/size
Description
볼륨 용량을 증설 요청한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeExtendRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/size
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"size": 104
}
Example HTTP response
Response 202
{
"bootable": false,
"created_at": "2026-02-11T06:44:46.280Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-02-11T06:44:46.322Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
3.1.44 - Get region's maximum partition size.
3.1.44.1 - 1.1
get /v1/server-groups/partition-size
Description
해당 리전의 최대 파티션 사이즈를 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroupPartitionSizeResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-groups/partition-size
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"partition_size": ""
}
3.1.44.2 - 1.0
get /v1/server-groups/partition-size
Description
해당 리전의 최대 파티션 사이즈를 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroupPartitionSizeResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-groups/partition-size
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"partition_size": ""
}
3.1.45 - Import Image
3.1.45.1 - 1.1
post /v1/images/{image_id}/import
Description
이미지 파일을 추가한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageImportRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/import
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2"
}
Example HTTP response
Response 202
3.1.45.2 - 1.0
post /v1/images/{image_id}/import
Description
이미지 파일을 추가한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageImportRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/images/{image_id}/import
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2"
}
Example HTTP response
Response 202
3.1.46 - List Auto-Scaling Group LB Server Groups
3.1.46.1 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
Auto-Scaling Group LB 서버 그룹 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | 0 |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupLbServerGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"lb_server_groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "lb-server-group-name",
"port": 8080
}
]
}
3.1.46.2 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
Auto-Scaling Group LB 서버 그룹 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | 0 |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupLbServerGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"lb_server_groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "lb-server-group-name",
"port": 8080
}
]
}
3.1.47 - List Auto-Scaling Group Notifications
3.1.47.1 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
Auto-Scaling Group 알림 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | user_ids optional | 사용자 ID 목록 Example : ['570907805e5447be84b618450ef52o0t'] | any of [array[string], null] | [] |
| query | notification_state optional | Auto-Scaling Group 알림 상태 Example : ACTIVE | any of [string, null] | [] |
| query | notification_event optional | Auto-Scaling Group 알림 이벤트 Example : SCALE_OUT | any of [string, null] | [] |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | 0 |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
3.1.47.2 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Description
Auto-Scaling Group 알림 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | user_ids optional | 사용자 ID 목록 Example : ['570907805e5447be84b618450ef52o0t'] | any of [array[string], null] | [] |
| query | notification_state optional | Auto-Scaling Group 알림 상태 Example : ACTIVE | any of [string, null] | [] |
| query | notification_event optional | Auto-Scaling Group 알림 이벤트 Example : SCALE_OUT | any of [string, null] | [] |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | 0 |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"notifications": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
]
}
3.1.48 - List Auto-Scaling Group Policies
3.1.48.1 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
Auto-Scaling Group 정책 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | name optional | 정책 이름 Example : policy-name | any of [string, null] | None |
| query | metric_method optional | 메트릭 방법 Example : AVG | any of [enum (AVG, MIN, MAX), null] | None |
| query | metric_type optional | 메트릭 유형 Example : CPU | any of [string, null] | None |
| query | scale_type optional | 스케일 유형 Example : SCALE_OUT | any of [enum (SCALE_OUT, SCALE_IN), null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | 0 |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"policies": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 1,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
]
}
3.1.48.2 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Description
Auto-Scaling Group 정책 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | name optional | 정책 이름 Example : policy-name | any of [string, null] | None |
| query | metric_method optional | 메트릭 방법 Example : AVG | any of [enum (AVG, MIN, MAX), null] | None |
| query | metric_type optional | 메트릭 유형 Example : CPU | any of [string, null] | None |
| query | scale_type optional | 스케일 유형 Example : SCALE_OUT | any of [enum (SCALE_OUT, SCALE_IN), null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | 0 |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"policies": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 1,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
]
}
3.1.49 - List Auto-Scaling Group Schedules
3.1.49.1 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Auto-Scaling Group 스케줄 목록을 조회한다..
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | frequency optional | 빈도 Example : WEEKLY | any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"schedules": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.49.2 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Description
Auto-Scaling Group 스케줄 목록을 조회한다..
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | frequency optional | 빈도 Example : WEEKLY | any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"schedules": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.50 - List Auto-Scaling Group Virtual Servers
3.1.50.1 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Description
Auto-Scaling Group Virtual Server 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupVirtualServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-02-11T06:44:44.306Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_linked_state": "ATTACHED",
"locked": false,
"metadata": "",
"modified_at": "2026-02-11T06:44:44.337Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
3.1.50.2 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Description
Auto-Scaling Group Virtual Server 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupVirtualServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/virtual-servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-02-11T06:44:44.306Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"lb_linked_state": "ATTACHED",
"locked": false,
"metadata": "",
"modified_at": "2026-02-11T06:44:44.337Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
3.1.51 - List Auto-Scaling Groups
3.1.51.1 - 1.1
get /v1/auto-scaling-groups
Description
Auto-Scaling Group 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Auto-Scaling Group 이름 Example : auto-scaling-group-name | any of [string, null] | None |
| query | state optional | Auto-Scaling Group 상태 Example : IN_SERVICE | any of [string, null] | None |
| query | launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | None |
| query | launch_configuration_name optional | Launch Configuration 이름 Example : launch-configuration-name | any of [string, null] | None |
| query | lb_server_group_id optional | LB 서버 그룹 ID Example : d06e87d3-ca9a-461b-8e88-077a542a7335 | any of [string, null] | None |
| query | security_group_id optional | Security Group ID Example : c09c3f05-03d9-443f-b27a-40e0f973c75f | any of [string, null] | None |
| query | subnet_id optional | 서브넷 ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] | None |
| query | created_by optional | 생성자 ID Example : 97e6b22c9a4143789ca522df7457a32f | any of [string, null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | 0 |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"auto_scaling_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
],
"count": 20
}
3.1.51.2 - 1.0
get /v1/auto-scaling-groups
Description
Auto-Scaling Group 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Auto-Scaling Group 이름 Example : auto-scaling-group-name | any of [string, null] | None |
| query | state optional | Auto-Scaling Group 상태 Example : IN_SERVICE | any of [string, null] | None |
| query | launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | None |
| query | launch_configuration_name optional | Launch Configuration 이름 Example : launch-configuration-name | any of [string, null] | None |
| query | lb_server_group_id optional | LB 서버 그룹 ID Example : d06e87d3-ca9a-461b-8e88-077a542a7335 | any of [string, null] | None |
| query | security_group_id optional | Security Group ID Example : c09c3f05-03d9-443f-b27a-40e0f973c75f | any of [string, null] | None |
| query | subnet_id optional | 서브넷 ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] | None |
| query | created_by optional | 생성자 ID Example : 97e6b22c9a4143789ca522df7457a32f | any of [string, null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | 0 |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc,id:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/auto-scaling-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"auto_scaling_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
],
"count": 20
}
3.1.52 - List Default Configs
3.1.52.1 - 1.1
get /v1/default-configs
Description
기본 설정 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | 이름 Example : key | any of [string, null] | None |
| query | category optional | 분류 Example : AUTO_SCALING_GROUP | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DefaultConfigListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/default-configs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"configs": "('key': 'value'}",
"count": 20
}
3.1.52.2 - 1.0
get /v1/default-configs
Description
기본 설정 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | 이름 Example : key | any of [string, null] | None |
| query | category optional | 분류 Example : AUTO_SCALING_GROUP | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DefaultConfigListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/default-configs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"configs": "('key': 'value'}",
"count": 20
}
3.1.53 - List Image members
3.1.53.1 - 1.1
get /v1/images/{image_id}/members
Description
이미지 멤버 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"members": [
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
]
}
3.1.53.2 - 1.0
get /v1/images/{image_id}/members
Description
이미지 멤버 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"members": [
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
]
}
3.1.54 - List Images
3.1.54.1 - 1.1
get /v1/images
Description
이미지 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | scp_image_type optional | 이미지 타입 Example : custom | any of [string, null] | None |
| query | scp_original_image_type optional | 원본 이미지 타입 Example : standard | any of [string, null] | None |
| query | name optional | 이미지 이름 Example : imagename | any of [string, null] | None |
| query | os_distro optional | OS 배포판 Example : alma | any of [string, null] | None |
| query | status optional | 상태 Example : active | any of [string, null] | None |
| query | visibility optional | 가시성 Example : private | any of [enum (public, community, shared, private), null] | None |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
3.1.54.2 - 1.0
get /v1/images
Description
이미지 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | scp_image_type optional | 이미지 타입 Example : custom | any of [string, null] | None |
| query | scp_original_image_type optional | 원본 이미지 타입 Example : standard | any of [string, null] | None |
| query | name optional | 이미지 이름 Example : imagename | any of [string, null] | None |
| query | os_distro optional | OS 배포판 Example : alma | any of [string, null] | None |
| query | status optional | 상태 Example : active | any of [string, null] | None |
| query | visibility optional | 가시성 Example : private | any of [enum (public, community, shared, private), null] | None |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
3.1.55 - List Keypairs
3.1.55.1 - 1.1
get /v1/keypairs
Description
키페어 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | KeypairListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/keypairs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"keypairs": [
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"public_key": "publickey",
"type": "ssh"
}
]
}
3.1.55.2 - 1.0
get /v1/keypairs
Description
키페어 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | KeypairListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/keypairs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"keypairs": [
{
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypairname",
"public_key": "publickey",
"type": "ssh"
}
]
}
3.1.56 - List Launch Configurations
3.1.56.1 - 1.1
get /v1/launch-configurations
Description
Launch Configuration 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Launch Configuration 이름 Example : launch-configuration-name | any of [string, null] | |
| query | image_id optional | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | 0 |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:asc | any of [string, null] | created_at:asc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LaunchConfigurationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 20,
"launch_configurations": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"boot_disk_size": 104,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"extra_disk_size": 104,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "publickey",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
]
}
3.1.56.2 - 1.0
get /v1/launch-configurations
Description
Launch Configuration 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Launch Configuration 이름 Example : launch-configuration-name | any of [string, null] | |
| query | image_id optional | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | 0 |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:asc | any of [string, null] | created_at:asc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LaunchConfigurationListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 20,
"launch_configurations": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"boot_disk_size": 104,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"extra_disk_size": 104,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "publickey",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
]
}
3.1.57 - List pending Images
3.1.57.1 - 1.1
get /v1/pending-images
Description
공유 대기 중인 이미지 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | scp_image_type optional | 이미지 타입 Example : custom | any of [string, null] | None |
| query | scp_original_image_type optional | 원본 이미지 타입 Example : standard | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/pending-images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
3.1.57.2 - 1.0
get /v1/pending-images
Description
공유 대기 중인 이미지 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | scp_image_type optional | 이미지 타입 Example : custom | any of [string, null] | None |
| query | scp_original_image_type optional | 원본 이미지 타입 Example : standard | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/pending-images
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"images": [
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
]
}
3.1.58 - List Server Groups
3.1.58.1 - 1.1
get /v1/server-groups
Description
서버 그룹 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroupListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"server_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": "['2a9be312-5d4b-4bc8-b2ae-35100fa9241f']",
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
]
}
3.1.58.2 - 1.0
get /v1/server-groups
Description
서버 그룹 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroupListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"server_groups": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": "['2a9be312-5d4b-4bc8-b2ae-35100fa9241f']",
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
]
}
3.1.59 - List Server Interfaces
3.1.59.1 - 1.1
get /v1/servers/{server_id}/interfaces
Description
서버 인터페이스 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerInterfaceListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
3.1.59.2 - 1.0
get /v1/servers/{server_id}/interfaces
Description
서버 인터페이스 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerInterfaceListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
3.1.60 - List Server Ips
3.1.60.1 - 1.1
get /v1/servers/{server_id}/ips
Description
서버 IP 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerIpsResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers/{server_id}/ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
]
}
3.1.60.2 - 1.0
get /v1/servers/{server_id}/ips
Description
서버 IP 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerIpsResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers/{server_id}/ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
]
}
3.1.61 - List Server Types
3.1.61.1 - 1.1
get /v1/server-types
Description
서버 타입 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 페이지 항목 개수 Example : 20 | integer | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| query | min_disk optional | 최소 디스크 크기 Example : 0 | integer | None |
| query | min_ram optional | 최소 램 크기 Example : 2048 | integer | None |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerTypeListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"server_types": [
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
]
}
3.1.61.2 - 1.0
get /v1/server-types
Description
서버 타입 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 페이지 항목 개수 Example : 20 | integer | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| query | min_disk optional | 최소 디스크 크기 Example : 0 | integer | None |
| query | min_ram optional | 최소 램 크기 Example : 2048 | integer | None |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerTypeListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/server-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"server_types": [
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
]
}
3.1.62 - List Server Volumes
3.1.62.1 - 1.1
get /v1/servers/{server_id}/volumes
Description
서버 볼륨 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerVolumesResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"volumes": [
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
3.1.62.2 - 1.0
get /v1/servers/{server_id}/volumes
Description
서버 볼륨 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerVolumesResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"volumes": [
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
3.1.63 - List snapshots and details
3.1.63.1 - 1.1
get /v1/snapshots
Description
List snapshots and details.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | volume_id optional | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | any of [string, null] | None |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | with_count optional | 총 개수 여부 Example : True | any of [boolean, null] | True |
| query | name optional | 스냅샷명 Example : snapshot-1 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 100,
"snapshots": [
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
3.1.63.2 - 1.0
get /v1/snapshots
Description
List snapshots and details.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | volume_id optional | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | any of [string, null] | None |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | with_count optional | 총 개수 여부 Example : True | any of [boolean, null] | True |
| query | name optional | 스냅샷명 Example : snapshot-1 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 100,
"snapshots": [
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
3.1.64 - List Virtual Server Security Group
3.1.64.1 - 1.1
get /v1/servers/{server_id}/security-groups
Description
서버 Security Group 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerSecurityGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"security_groups": [
{
"account_id": "6f70656e737461636b20342065766572",
"description": "Security group description",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "securitygroup",
"rules": [
{
"from_port": 1,
"id": "ca5cb96b-9df6-4af7-9682-4d60a58d38a5",
"ip_protocol": "tcp",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"to_port": 65535
}
]
}
]
}
3.1.64.2 - 1.0
get /v1/servers/{server_id}/security-groups
Description
서버 Security Group 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerSecurityGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/security-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"security_groups": [
{
"account_id": "6f70656e737461636b20342065766572",
"description": "Security group description",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "securitygroup",
"rules": [
{
"from_port": 1,
"id": "ca5cb96b-9df6-4af7-9682-4d60a58d38a5",
"ip_protocol": "tcp",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"to_port": 65535
}
]
}
]
}
3.1.65 - List Virtual Servers
3.1.65.1 - 1.1
get /v1/servers
Description
서버 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | 서버 이름 Example : servername | any of [string, null] | None |
| query | ip optional | IP 주소 Example : 192.169.3.2 | any of [string, null] | None |
| query | state optional | 서버 상태 Example : ACTIVE | any of [string, null] | None |
| query | product_category optional | 상품군 Example : compute | any of [enum (compute, container), null] | None |
| query | product_offering optional | 상품 Example : virtual_server | any of [array[enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm)], enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | None |
| query | vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] | None |
| query | server_type_id optional | 서버 타입 ID Example : s1v1m2 | any of [string, null] | None |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc |
| query | auto_scaling_group_id optional | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-02-11T06:44:45.212Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-02-11T06:44:45.237Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
3.1.65.2 - 1.0
get /v1/servers
Description
서버 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | 서버 이름 Example : servername | any of [string, null] | None |
| query | ip optional | IP 주소 Example : 192.169.3.2 | any of [string, null] | None |
| query | state optional | 서버 상태 Example : ACTIVE | any of [string, null] | None |
| query | product_category optional | 상품군 Example : compute | any of [enum (compute, container), null] | None |
| query | product_offering optional | 상품 Example : virtual_server | any of [array[enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm)], enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | None |
| query | vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] | None |
| query | server_type_id optional | 서버 타입 ID Example : s1v1m2 | any of [string, null] | None |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | created_at:desc |
| query | auto_scaling_group_id optional | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/servers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"servers": [
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-02-11T06:44:45.212Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-02-11T06:44:45.237Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
]
}
3.1.66 - List volume transfers
3.1.66.1 - 1.1
get /v1/volume-transfer
Description
List volume transfers.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTransferListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"transfers": [
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
3.1.66.2 - 1.0
get /v1/volume-transfer
Description
List volume transfers.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTransferListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"transfers": [
{
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
]
}
3.1.67 - List volume types and details
3.1.67.1 - 1.1
get /v1/volume-types
Description
볼륨 유형 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | name:asc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"volume_types": [
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
]
}
3.1.67.2 - 1.0
get /v1/volume-types
Description
볼륨 유형 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | None |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | name:asc |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"volume_types": [
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
]
}
3.1.68 - List volumes and details
3.1.68.1 - 1.1
get /v1/volumes
Description
볼륨 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | 총 개수 여부 Example : True | any of [boolean, null] | True |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | None |
| query | name optional | 볼륨명 Example : volume01 | any of [string, null] | None |
| query | state optional | 볼륨 상태 Example : available | any of [string, null] | None |
| query | bootable optional | 부트 디스크 여부 Example : False | any of [boolean, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"count": 100,
"volumes": [
{
"bootable": false,
"created_at": "2026-02-11T06:44:46.280Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-02-11T06:44:46.322Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
]
}
3.1.68.2 - 1.0
get /v1/volumes
Description
볼륨 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | 총 개수 여부 Example : True | any of [boolean, null] | True |
| query | limit optional | 페이지 항목 개수 Example : 20 | any of [integer, null] | 20 |
| query | marker optional | 이전 요청에서 마지막으로 반환된 항목 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | any of [string, null] | None |
| query | sort optional | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 Example : created_at:desc | any of [string, null] | None |
| query | offset optional | 목록에서 시작할 지점의 인덱스 Example : 0 | any of [integer, null] | None |
| query | name optional | 볼륨명 Example : volume01 | any of [string, null] | None |
| query | state optional | 볼륨 상태 Example : available | any of [string, null] | None |
| query | bootable optional | 부트 디스크 여부 Example : False | any of [boolean, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"count": 100,
"volumes": [
{
"bootable": false,
"created_at": "2026-02-11T06:44:46.280Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-02-11T06:44:46.322Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
]
}
3.1.69 - Lock Virtual Server
3.1.69.1 - 1.1
post /v1/servers/{server_id}/lock
Description
서버에 Lock을 건다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/lock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.69.2 - 1.0
post /v1/servers/{server_id}/lock
Description
서버에 Lock을 건다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/lock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.70 - Reboot Virtual Server
3.1.70.1 - 1.1
post /v1/servers/{server_id}/reboot
Description
서버를 재시작한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerRebootRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/reboot
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"reboot_type": "SOFT"
}
Example HTTP response
Response 202
3.1.70.2 - 1.0
post /v1/servers/{server_id}/reboot
Description
서버를 재시작한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerRebootRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/reboot
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"reboot_type": "SOFT"
}
Example HTTP response
Response 202
3.1.71 - Rebuild Virtual Server
3.1.71.1 - 1.1
post /v1/servers/{server_id}/rebuild
Description
서버를 재빌드한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/rebuild
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.71.2 - 1.0
post /v1/servers/{server_id}/rebuild
Description
서버를 재빌드한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/rebuild
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.72 - Revert Volume to snapshot
3.1.72.1 - 1.1
post /v1/volumes/{volume_id}/revert
Description
Revert Volume to snapshot.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeRevertRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/revert
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790"
}
Example HTTP response
Response 202
3.1.72.2 - 1.0
post /v1/volumes/{volume_id}/revert
Description
Revert Volume to snapshot.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeRevertRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/revert
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790"
}
Example HTTP response
Response 202
3.1.73 - Show a snapshot’s details
3.1.73.1 - 1.1
get /v1/snapshots/{snapshot_id}
Description
Show a snapshot’s details.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | 스냅샷 ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.73.2 - 1.0
get /v1/snapshots/{snapshot_id}
Description
Show a snapshot’s details.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | 스냅샷 ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.74 - Show Auto-Scaling Group
3.1.74.1 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Auto-Scaling Group을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.74.2 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Auto-Scaling Group을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.75 - Show Auto-Scaling Group Notification
3.1.75.1 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Auto-Scaling Group 알림을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | 알림 ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
3.1.75.2 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Auto-Scaling Group 알림을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | 알림 ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
3.1.76 - Show Auto-Scaling Group Policy
3.1.76.1 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Auto-Scaling Group 정책을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | 정책 ID Example : 0761d76085f54363bab07909baf69841 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 1,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
3.1.76.2 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Auto-Scaling Group 정책을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | 정책 ID Example : 0761d76085f54363bab07909baf69841 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 1,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
3.1.77 - Show Auto-Scaling Group Schedule
3.1.77.1 - 1.1
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Auto-Scaling Group을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | 스케줄 ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
3.1.77.2 - 1.0
get /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Auto-Scaling Group을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | 스케줄 ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
3.1.78 - Show default Volume type’s details
3.1.78.1 - 1.1
get /v1/volume-types/default
Description
기본 볼륨 유형을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeDetailResponse |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/default
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
3.1.78.2 - 1.0
get /v1/volume-types/default
Description
기본 볼륨 유형을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeDetailResponse |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/default
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
3.1.79 - Show Image
3.1.79.1 - 1.1
get /v1/images/{image_id}
Description
이미지를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
3.1.79.2 - 1.0
get /v1/images/{image_id}
Description
이미지를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
3.1.80 - Show Image member
3.1.80.1 - 1.1
get /v1/images/{image_id}/members/{member_id}
Description
이미지 멤버를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | 멤버 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
3.1.80.2 - 1.0
get /v1/images/{image_id}/members/{member_id}
Description
이미지 멤버를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | 멤버 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
3.1.81 - Show Keypair
3.1.81.1 - 1.1
get /v1/keypairs/{keypair_name}
Description
키페어를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | keypair_name required | 키페어 이름 Example : keypairname | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | KeypairShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"id": 1,
"name": "keypairname",
"public_key": "publickey",
"type": "ssh",
"user_id": "570907805e5447be84b618450ef52o0t"
}
3.1.81.2 - 1.0
get /v1/keypairs/{keypair_name}
Description
키페어를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | keypair_name required | 키페어 이름 Example : keypairname | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | KeypairShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/keypairs/{keypair_name}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"id": 1,
"name": "keypairname",
"public_key": "publickey",
"type": "ssh",
"user_id": "570907805e5447be84b618450ef52o0t"
}
3.1.82 - Show Launch Configuration
3.1.82.1 - 1.1
get /v1/launch-configurations/{launch_configuration_id}
Description
Launch Configuration을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LaunchConfigurationDetailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "publickey",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
3.1.82.2 - 1.0
get /v1/launch-configurations/{launch_configuration_id}
Description
Launch Configuration을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LaunchConfigurationDetailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/launch-configurations/{launch_configuration_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_count": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"keypair_name": "keypairname",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "launch-configuration-name",
"public_key": "publickey",
"server_type_id": "s1v1m2",
"state": "ACTIVE",
"user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
"volumes": [
{
"boot_index": 0,
"size": 104,
"type": "SSD"
}
]
}
3.1.83 - Show Server Group
3.1.83.1 - 1.1
get /v1/server-groups/{server_group_id}
Description
서버 그룹을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_group_id required | 서버 그룹 ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroup |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": "['2a9be312-5d4b-4bc8-b2ae-35100fa9241f']",
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
3.1.83.2 - 1.0
get /v1/server-groups/{server_group_id}
Description
서버 그룹을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_group_id required | 서버 그룹 ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerGroup |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-groups/{server_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"members": "['2a9be312-5d4b-4bc8-b2ae-35100fa9241f']",
"name": "server-group",
"partition_size": 3,
"policy": "anti-affinity",
"user_id": "570907805e5447be84b618450ef52o0t"
}
3.1.84 - Show Server Interface
3.1.84.1 - 1.1
get /v1/servers/{server_id}/interfaces/{port_id}
Description
서버 인터페이스를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerInterfaceListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
3.1.84.2 - 1.0
get /v1/servers/{server_id}/interfaces/{port_id}
Description
서버 인터페이스를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerInterfaceListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"interfaces": [
{
"fixed_ips": [
{
"ip_address": "192.169.3.2"
}
],
"mac_addr": "fa:16:3e:c0:71:2b",
"port_id": "f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc",
"port_state": "ACTIVE",
"private_static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"private_nat_ip_id": "1f0cb5390c40483592ddc5a282f53496",
"state": "ACTIVE"
},
"static_nat": {
"external_ip_address": "182.197.61.81",
"id": "224b80106e6f41b38efe98ac9ddbf280",
"publicip_id": "615fa9cd5cff486c9de679b3ce63e601",
"state": "ACTIVE"
},
"subnet_id": "183c6c30df0c4fcbb16422aa2d64aa21"
}
]
}
3.1.85 - Show Server Ip
3.1.85.1 - 1.1
get /v1/servers/{server_id}/ips/{subnet_id}
Description
서버 IP를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | subnet_id required | 서브넷 ID Example : 78b2ee3f074145c580ab6abac4821f97 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponseAddress |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/ips/{subnet_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
3.1.85.2 - 1.0
get /v1/servers/{server_id}/ips/{subnet_id}
Description
서버 IP를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | subnet_id required | 서브넷 ID Example : 78b2ee3f074145c580ab6abac4821f97 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponseAddress |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/ips/{subnet_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
3.1.86 - Show Server Quota Set
3.1.86.1 - 1.1
get /v1/quota-sets
Description
서버 쿼터 셋을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/quota-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"cores": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"id": "fc7283354c6143a58629b59f4c3e16b2",
"instances": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"keypairs": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"metadata_items": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"ram": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_group_members": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_groups": {
"in_use": 10,
"limit": 20,
"reserved": 0
}
}
3.1.86.2 - 1.0
get /v1/quota-sets
Description
서버 쿼터 셋을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/quota-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"cores": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"id": "fc7283354c6143a58629b59f4c3e16b2",
"instances": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"keypairs": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"metadata_items": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"ram": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_group_members": {
"in_use": 10,
"limit": 20,
"reserved": 0
},
"server_groups": {
"in_use": 10,
"limit": 20,
"reserved": 0
}
}
3.1.87 - Show Server Type
3.1.87.1 - 1.1
get /v1/server-types/{server_type_id}
Description
서버 타입을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_type_id required | 서버 타입 ID Example : s1v1m2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerType |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-types/{server_type_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
3.1.87.2 - 1.0
get /v1/server-types/{server_type_id}
Description
서버 타입을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_type_id required | 서버 타입 ID Example : s1v1m2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerType |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/server-types/{server_type_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"description": "description",
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
}
3.1.88 - Show Server Volume
3.1.88.1 - 1.1
get /v1/servers/{server_id}/volumes/{volume_id}
Description
서버 볼륨을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServersVolumeResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.88.2 - 1.0
get /v1/servers/{server_id}/volumes/{volume_id}
Description
서버 볼륨을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServersVolumeResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"delete_on_termination": false,
"device": "/dev/vda",
"id": "3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c",
"server_id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.89 - Show Virtual Server
3.1.89.1 - 1.1
get /v1/servers/{server_id}
Description
서버를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-02-11T06:44:45.212Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-02-11T06:44:45.237Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.89.2 - 1.0
get /v1/servers/{server_id}
Description
서버를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-02-11T06:44:45.212Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-02-11T06:44:45.237Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.90 - Show Virtual Server Console Log
3.1.90.1 - 1.1
get /v1/servers/{server_id}/console-log
Description
서버 콘솔 로그를 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| query | line_size optional | Number of log lines to get Example : 1 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerConsoleLogResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/console-log
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"output": "FAKE CONSOLE OUTPUT"
}
3.1.90.2 - 1.0
get /v1/servers/{server_id}/console-log
Description
서버 콘솔 로그를 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| query | line_size optional | Number of log lines to get Example : 1 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerConsoleLogResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/console-log
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"output": "FAKE CONSOLE OUTPUT"
}
3.1.91 - Show Virtual Server Password
3.1.91.1 - 1.1
post /v1/servers/{server_id}/password
Description
서버 비밀번호를 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerPasswordRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerPasswordResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/password
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"private_key": "privatekey"
}
Example HTTP response
Response 200
{
"password": "password"
}
3.1.91.2 - 1.0
post /v1/servers/{server_id}/password
Description
서버 비밀번호를 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerPasswordRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerPasswordResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/password
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"private_key": "privatekey"
}
Example HTTP response
Response 200
{
"password": "password"
}
3.1.92 - Show Volume Quota Set
3.1.92.1 - 1.1
get /v1/volumes/quota-sets
Description
볼륨 쿼터 셋을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/volumes/quota-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"id": "fc7283354c6143a58629b59f4c3e16b2",
"per_volume_size": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"snapshots": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"usages": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"volumes": {
"in_use": 10,
"limit": "",
"reserved": 0
}
}
3.1.92.2 - 1.0
get /v1/volumes/quota-sets
Description
볼륨 쿼터 셋을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeQuotaSet |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/volumes/quota-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"id": "fc7283354c6143a58629b59f4c3e16b2",
"per_volume_size": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"snapshots": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"usages": {
"in_use": 10,
"limit": "",
"reserved": 0
},
"volumes": {
"in_use": 10,
"limit": "",
"reserved": 0
}
}
3.1.93 - Show volume transfer detail
3.1.93.1 - 1.1
get /v1/volume-transfer/{transfer_id}
Description
Show volume transfer detail.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTransferShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"created_at": "",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.93.2 - 1.0
get /v1/volume-transfer/{transfer_id}
Description
Show volume transfer detail.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transfer_id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTransferShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volume-transfer/{transfer_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"created_at": "",
"id": "1ac231be-823b-4a4d-8ff0-aac503a7118a",
"name": "volume01",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.94 - Show Volume type’s details
3.1.94.1 - 1.1
get /v1/volume-types/{volume_type_id}
Description
볼륨 유형을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_type_id required | 볼륨 유형 ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/{volume_type_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
3.1.94.2 - 1.0
get /v1/volume-types/{volume_type_id}
Description
볼륨 유형을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_type_id required | 볼륨 유형 ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeTypeDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/volume-types/{volume_type_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"description": "Volume type description",
"extra_specs": {
"multiattach": "<is> True"
},
"id": "c643ac35-3aec-43e6-b97a-3d6f666c5207",
"name": "SSD"
}
3.1.95 - Show Volume's details
3.1.95.1 - 1.1
get /v1/volumes/{volume_id}
Description
볼륨을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-02-11T06:44:46.280Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-02-11T06:44:46.322Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
3.1.95.2 - 1.0
get /v1/volumes/{volume_id}
Description
볼륨을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-02-11T06:44:46.280Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-02-11T06:44:46.322Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
3.1.96 - Start Virtual Server
3.1.96.1 - 1.1
post /v1/servers/{server_id}/start
Description
서버를 시작한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.96.2 - 1.0
post /v1/servers/{server_id}/start
Description
서버를 시작한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.97 - Stop Virtual Server
3.1.97.1 - 1.1
post /v1/servers/{server_id}/stop
Description
서버를 중지한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.97.2 - 1.0
post /v1/servers/{server_id}/stop
Description
서버를 중지한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.98 - Unlock Virtual Server
3.1.98.1 - 1.1
post /v1/servers/{server_id}/unlock
Description
서버 Lock을 푼다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/unlock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Example HTTP response
Response 202
3.1.98.2 - 1.0
post /v1/servers/{server_id}/unlock
Description
서버 Lock을 푼다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/unlock
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Example HTTP response
Response 202
3.1.99 - Update a snapshot
3.1.99.1 - 1.1
put /v1/snapshots/{snapshot_id}
Description
Update a snapshot.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | 스냅샷 ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
| body | body required | SnapshotUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"description": "description",
"name": "snapshot-1"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.99.2 - 1.0
put /v1/snapshots/{snapshot_id}
Description
Update a snapshot.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | 스냅샷 ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | None |
| body | body required | SnapshotUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"description": "description",
"name": "snapshot-1"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"description": "description",
"id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"metadata": "",
"name": "snapshot-1",
"size": 104,
"status": "available",
"updated_at": "2025-07-26T12:00:00Z",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
3.1.100 - Update Auto-Scaling Group
3.1.100.1 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Auto-Scaling Group을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.100.2 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}
Description
Auto-Scaling Group을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.101 - Update Auto-Scaling Group LB Server Groups
3.1.101.1 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
Auto-Scaling Group LB 서버 그룹을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupLbServerGroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"lb_server_groups": [
{
"id": "d06e87d3-ca9a-461b-8e88-077a542a7335",
"port": 8080
}
]
}
Example HTTP response
Response 202
3.1.101.2 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Description
Auto-Scaling Group LB 서버 그룹을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupLbServerGroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/lb-server-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"lb_server_groups": [
{
"id": "d06e87d3-ca9a-461b-8e88-077a542a7335",
"port": 8080
}
]
}
Example HTTP response
Response 202
3.1.102 - Update Auto-Scaling Group Notification
3.1.102.1 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Auto-Scaling Group 알림을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | 알림 ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
| body | body required | AutoScalingGroupNotificationUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
3.1.102.2 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Description
Auto-Scaling Group 알림을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | notification_id required | 알림 ID Example : fa7fd191410744cd810a290c0b4d22b9 | string | None |
| body | body required | AutoScalingGroupNotificationUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupNotificationShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/notifications/{notification_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"notification_events": [
"SCALE_OUT",
"SCALE_OUT_FAIL"
],
"notification_state": "ACTIVE",
"user_id": "570907805e5447be84b618450ef52o0t",
"user_name": "scpuser"
}
3.1.103 - Update Auto-Scaling Group Policy
3.1.103.1 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Auto-Scaling Group 정책을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | 정책 ID Example : 0761d76085f54363bab07909baf69841 | string | None |
| body | body required | AutoScalingGroupPolicyUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"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,
"state": "ACTIVE",
"threshold": 60
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 1,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
3.1.103.2 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Description
Auto-Scaling Group 정책을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | policy_id required | 정책 ID Example : 0761d76085f54363bab07909baf69841 | string | None |
| body | body required | AutoScalingGroupPolicyUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"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,
"state": "ACTIVE",
"threshold": 60
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"comparison_operator": "ge",
"cooldown_seconds": 300,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"evaluation_minutes": 1,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"metric_method": "AVG",
"metric_type": "CPU",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "policy-name",
"scale_method": "AMOUNT",
"scale_type": "SCALE_OUT",
"scale_value": 10,
"state": "ACTIVE",
"threshold": 60,
"threshold_unit": "%"
}
3.1.104 - Update Auto-Scaling Group Schedule
3.1.104.1 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Auto-Scaling Group 스케줄을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | 스케줄 ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
| body | body required | AutoScalingGroupScheduleUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
3.1.104.2 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Description
Auto-Scaling Group 스케줄을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| path | schedule_id required | 스케줄 ID Example : 43d4841abd404220af5f0904037aba71 | string | None |
| body | body required | AutoScalingGroupScheduleUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupScheduleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/schedules/{schedule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"day_of_month": "-1,1",
"day_of_week": "SU,SA",
"description": "description",
"desired_server_count": 1,
"end_date": "2025-01-01",
"frequency": "WEEKLY",
"hour": 9,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"max_server_count": 2,
"min_server_count": 1,
"minute": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "schedulename",
"start_date": "2024-01-01",
"state": "ACTIVE",
"timezone": "Asia/Seoul"
}
3.1.105 - Update Auto-Scaling Group server count
3.1.105.1 - 1.1
put /v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Description
Auto-Scaling Group 서버 수를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupSetServerCountRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"desired_server_count": 1,
"max_server_count": 2,
"min_server_count": 1
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.105.2 - 1.0
put /v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Description
Auto-Scaling Group 서버 수를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | None |
| body | body required | AutoScalingGroupSetServerCountRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AutoScalingGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/auto-scaling-groups/{auto_scaling_group_id}/server-count
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"desired_server_count": 1,
"max_server_count": 2,
"min_server_count": 1
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"desired_server_count": 1,
"desired_server_count_editable": true,
"drain_enabled": true,
"drain_timeout": 300,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"launch_configuration_name": "launch-configuration-name",
"lb_server_groups": [],
"max_server_count": 2,
"min_server_count": 1,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "auto-scaling-group-name",
"security_group_ids": "['c09c3f05-03d9-443f-b27a-40e0f973c75f']",
"server_name_prefix": "server-name-prefix",
"state": "IN_SERVICE",
"subnet_ids": [],
"total_server_count": 1,
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.106 - Update Image
3.1.106.1 - 1.1
put /v1/images/{image_id}
Description
이미지를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"min_disk": 100,
"min_ram": 0,
"protected": false,
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
3.1.106.2 - 1.0
put /v1/images/{image_id}
Description
이미지를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| body | body required | ImageSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"min_disk": 100,
"min_ram": 0,
"protected": false,
"visibility": "private"
}
Example HTTP response
Response 200
{
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"created_at": "2025-07-22T09:00:00Z",
"disk_format": "qcow2",
"file": "/v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"min_disk": 100,
"min_ram": 0,
"name": "imagename",
"os_distro": "alma",
"os_hash_algo": "sha512",
"os_hash_value": "c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99",
"os_hidden": false,
"owner": "a8f10467abfc4b87b64614ab36eb9ae4",
"owner_account_name": "AccountName",
"owner_user_name": "user@samsung.com",
"protected": false,
"root_device_name": "/dev/vda",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"scp_os_build_version": "20250101",
"scp_os_version": "8.8",
"size": 2429747200,
"status": "active",
"updated_at": "2025-07-26T12:00:00Z",
"url": "https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2",
"virtual_size": 17179869184,
"visibility": "private",
"volumes": "[{\"tag\": null, \"volume_id\": null, \"encryption_options\": null, \"encryption_secret_uuid\": null, \"encryption_format\": null, \"device_name\": \"/dev/vda\", \"disk_bus\": \"virtio\", \"volume_type\": null, \"encrypted\": null, \"image_id\": null, \"device_type\": \"disk\", \"source_type\": \"snapshot\", \"delete_on_termination\": false, \"volume_size\": 104, \"guest_format\": null, \"boot_index\": 0, \"destination_type\": \"volume\", \"snapshot_id\": \"abde9e38-2ed5-4ecd-b23c-b0120e30690e\", \"no_device\": null}]"
}
3.1.107 - Update Image member
3.1.107.1 - 1.1
put /v1/images/{image_id}/members/{member_id}
Description
이미지 멤버를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | 멤버 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
| body | body required | ImageMemberSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"status": "pending"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
3.1.107.2 - 1.0
put /v1/images/{image_id}/members/{member_id}
Description
이미지 멤버를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | None |
| path | member_id required | 멤버 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | None |
| body | body required | ImageMemberSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ImageMemberShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/images/{image_id}/members/{member_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"status": "pending"
}
Example HTTP response
Response 200
{
"created_at": "2025-07-22T09:00:00Z",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"member_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"status": "pending",
"updated_at": "2025-07-26T12:00:00Z"
}
3.1.108 - Update Server Interface
3.1.108.1 - 1.1
put /v1/servers/{server_id}/interfaces/{port_id}
Description
서버 인터페이스를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerInterfaceUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"fixed_ip_address": "192.169.3.2",
"subnet_id": ""
}
Example HTTP response
Response 202
3.1.108.2 - 1.0
put /v1/servers/{server_id}/interfaces/{port_id}
Description
서버 인터페이스를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | port_id required | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | string | None |
| body | body required | ServerInterfaceUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/interfaces/{port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"fixed_ip_address": "192.169.3.2",
"subnet_id": ""
}
Example HTTP response
Response 202
3.1.109 - Update Server Volume
3.1.109.1 - 1.1
put /v1/servers/{server_id}/volumes/{volume_id}
Description
서버 볼륨을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | ServerVolumesUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"delete_on_termination": false,
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
3.1.109.2 - 1.0
put /v1/servers/{server_id}/volumes/{volume_id}
Description
서버 볼륨을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | ServerVolumesUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"delete_on_termination": false,
"volume_id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
Example HTTP response
Response 200
3.1.110 - Update Virtual Server
3.1.110.1 - 1.1
put /v1/servers/{server_id}
Description
서버를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "servername"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-02-11T06:44:45.212Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-02-11T06:44:45.237Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.110.2 - 1.0
put /v1/servers/{server_id}
Description
서버를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServerShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/servers/{server_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "servername"
}
Example HTTP response
Response 200
{
"account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
"addresses": [
{
"ip_addresses": [
{
"ip_address": "192.169.3.2",
"version": 4
}
],
"subnet_name": "subnetname"
}
],
"auto_scaling_group_id": "52613bd852b04b39adcb15a8364d856d",
"created_at": "2026-02-11T06:44:45.212Z",
"created_by": "97e6b22c9a4143789ca522df7457a32f",
"disk_config": "MANUAL",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"is_marketplace": false,
"keypair_name": "keypairname",
"launch_configuration_id": "b5aea5a675fc4f6b9e0fcd1288354c5f",
"locked": false,
"metadata": "",
"modified_at": "2026-02-11T06:44:45.237Z",
"name": "servername",
"partition_number": 1,
"planned_compute_os_type": "windows",
"product_category": "compute",
"product_offering": "virtual_server",
"security_groups": [
{
"name": "securitygroup"
}
],
"server_group_id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"server_type": {
"disk": 100,
"ephemeral": 0,
"extra_specs": "",
"id": "s1v1m2",
"name": "s1v1m2",
"ram": 2,
"swap": 0,
"vcpus": 1
},
"state": "ACTIVE",
"volumes": [
{
"delete_on_termination": false,
"id": "3f500f00-ed80-4566-a057-e31760226f9a"
}
],
"vpc_id": "cc976b621087484ea5fd527f4b78708b"
}
3.1.111 - Update Virtual Server type
3.1.111.1 - 1.1
post /v1/servers/{server_id}/server-type
Description
서버 타입을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerSetServerTypeRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/server-type
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"server_type": "s1v1m2"
}
Example HTTP response
Response 202
3.1.111.2 - 1.0
post /v1/servers/{server_id}/server-type
Description
서버 타입을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | None |
| body | body required | ServerSetServerTypeRequestBody |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/servers/{server_id}/server-type
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"server_type": "s1v1m2"
}
Example HTTP response
Response 202
3.1.112 - Update Volume
3.1.112.1 - 1.1
put /v1/volumes/{volume_id}
Description
볼륨을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.1"
Request body
{
"name": "volume01"
}
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-02-11T06:44:46.280Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-02-11T06:44:46.322Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
3.1.112.2 - 1.0
put /v1/volumes/{volume_id}
Description
볼륨을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | None |
| body | body required | VolumeUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = virtualserver 1.0"
Request body
{
"name": "volume01"
}
Example HTTP response
Response 200
{
"bootable": false,
"created_at": "2026-02-11T06:44:46.280Z",
"encrypted": true,
"id": "3f500f00-ed80-4566-a057-e31760226f9a",
"modified_at": "2025-07-26T12:00:00Z",
"multiattach": false,
"name": "volume01",
"servers": [
{
"attached_at": "2026-02-11T06:44:46.322Z",
"device": "/dev/vda",
"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
}
],
"size": 104,
"snapshot_id": "cceed636-1f1e-4bb0-b85c-4e5b9e0bf790",
"state": "available",
"user_id": "570907805e5447be84b618450ef52o0t",
"volume_image_metadata": {
"checksum": "7538e0fcb56e0e272cfd89eb384d6613",
"container_format": "bare",
"disk_format": "qcow2",
"image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
"image_name": "imagename",
"min_disk": 100,
"min_ram": 0,
"os_distro": "alma",
"scp_image_type": "custom",
"scp_k8s_version": "v1.28.7",
"scp_original_image_type": "standard",
"signature_verified": false,
"size": 2429747200
},
"volume_type": "SSD",
"volume_type_id": "c643ac35-3aec-43e6-b97a-3d6f666c5207"
}
3.2 - Models
3.2.1 - AutoScalingGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 계정 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| desired_server_count required | 목표 서버 수 Example : 1 | integer | |
| desired_server_count_editable required | 목표 서버 수 수정 가능 여부 Example : True | boolean | |
| drain_enabled required | Drain 사용 여부 Example : True | boolean | |
| drain_timeout optional | Drain timeout 값 Example : 300 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| launch_configuration_name required | Launch Configuration 이름 Example : launch-configuration-name | string | |
| lb_server_groups optional | LB 서버 그룹 목록 | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | 최대 서버 수 Example : 2 | integer | |
| min_server_count required | 최소 서버 수 Example : 1 | integer | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Auto-Scaling Group 이름 Example : auto-scaling-group-name | string | |
| security_group_ids optional | Security Group ID 목록 Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | 서버 이름 접두사 Example : server-name-prefix | string | |
| state required | Auto-Scaling Group 상태 Example : IN_SERVICE | string | |
| subnet_ids optional | Subnet ID 목록 | array[string] | |
| vpc_id required | VPC ID Example : cc976b621087484ea5fd527f4b78708b | string |
3.2.2 - AutoScalingGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count required | 목표 서버 수 Example : 1 | integer | |
| desired_server_count_editable required | 목표 서버 수 수정 가능 여부 Example : True | boolean | |
| drain_enabled optional | Drain 사용 여부 Example : True | any of [boolean, null] | |
| drain_timeout optional | Drain timeout 값 Example : 300 | any of [integer, null] | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| lb_server_groups optional | LB 서버 그룹 목록 | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | 최대 서버 수 Example : 2 | integer | |
| min_server_count required | 최소 서버 수 Example : 1 | integer | |
| name required | Auto-Scaling Group 이름 Example : auto-scaling-group-namePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| notifications optional | Notifications | any of [array[AutoScalingGroupNotificationCreateRequest], null] | |
| scaling_policies optional | Scaling policy list | any of [array[AutoScalingGroupPolicyCreateRequest], null] | |
| security_group_ids optional | Security Group ID 목록 Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | 서버 이름 접두사 Example : server-name-prefixPattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 61 | string | |
| subnet_ids required | Subnet ID 목록 | array[string] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] |
3.2.3 - AutoScalingGroupLbServerGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | LB 서버 그룹 ID Example : d06e87d3-ca9a-461b-8e88-077a542a7335 | string | |
| port required | LB 서버 그룹 포트 Example : 8080Minimum : 1Maximum : 65534 | integer |
3.2.4 - AutoScalingGroupLbServerGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| lb_server_groups required | LB 서버 그룹 목록 | array[AutoScalingGroupLbServerGroupShowResponse] |
3.2.5 - AutoScalingGroupLbServerGroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_server_groups required | LB 서버 그룹 목록 | array[AutoScalingGroupLbServerGroup] |
3.2.6 - AutoScalingGroupLbServerGroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | LB 서버 그룹 이름 Example : lb-server-group-name | string | |
| port required | LB 서버 그룹 포트 Example : 8080 | integer |
3.2.7 - AutoScalingGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| auto_scaling_groups required | Auto-Scaling Group 목록 | array[AutoScalingGroup] | |
| count required | count Example : 20 | integer |
3.2.8 - AutoScalingGroupNotificationCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| notification_events required | Auto-Scaling Group 알림 이벤트 목록 Example : ['SCALE_OUT', 'SCALE_OUT_FAIL'] | array[string] | |
| user_ids required | 사용자 ID 목록 Example : ['570907805e5447be84b618450ef52o0t'] | array[string] |
3.2.9 - AutoScalingGroupNotificationListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| notifications required | Auto-Scaling Group 알림 목록 | array[AutoScalingGroupNotificationShowResponse] |
3.2.10 - AutoScalingGroupNotificationShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 계정 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| notification_events required | Auto-Scaling Group 알림 이벤트 목록 Example : ['SCALE_OUT', 'SCALE_OUT_FAIL'] | array[string] | |
| notification_state required | Auto-Scaling Group 알림 상태 Example : ACTIVE | string | |
| user_id required | 사용자 ID Example : 570907805e5447be84b618450ef52o0t | string | |
| user_name required | User name Example : scpuser | string |
3.2.11 - AutoScalingGroupNotificationUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| notification_events optional | Auto-Scaling Group 알림 이벤트 목록 Example : ['SCALE_OUT', 'SCALE_OUT_FAIL'] | any of [array[string], null] | |
| notification_state optional | Auto-Scaling Group 알림 상태 Example : ACTIVE | any of [string, null] |
3.2.12 - AutoScalingGroupPolicyCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| comparison_operator required | 비교 연산자 Example : gePattern : ^(ge|gt|le|lt)$ | string | |
| cooldown_seconds required | 쿨다운 시간(초 단위) Example : 300 | integer | |
| evaluation_minutes required | 평가 시간(분 단위) Example : 1 | integer | |
| metric_method required | 메트릭 방법 Example : AVGPattern : ^(AVG|MIN|MAX)$ | string | |
| metric_type required | 메트릭 유형 Example : CPUPattern : ^(CPU|MEMORY|NETWORK_IN_BYTES|NETWORK_OUT_BYTES|NETWORK_IN_PACKETS|NETWORK_OUT_PACKETS)$ | string | |
| name required | 정책 이름 Example : policy-namePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| scale_method required | 스케일 방법 Example : AMOUNTPattern : ^(AMOUNT|PERCENTAGE|FIXED)$ | string | |
| scale_type required | 스케일 유형 Example : SCALE_OUTPattern : ^(SCALE_IN|SCALE_OUT)$ | string | |
| scale_value required | 스켕일 값 Example : 10 | integer | |
| threshold required | 임계값 Example : 60 | integer |
3.2.13 - AutoScalingGroupPolicyListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| policies required | array[AutoScalingGroupPolicyShowResponse] |
3.2.14 - AutoScalingGroupPolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 계정 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | |
| comparison_operator required | 비교 연산자 Example : ge | string | |
| cooldown_seconds required | 쿨다운 시간(초 단위) Example : 300 | integer | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| evaluation_minutes required | 평가 시간(분 단위) Example : 1 | integer | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| metric_method required | 메트릭 방법 Example : AVG | string | |
| metric_type required | 메트릭 유형 Example : CPU | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | 정책 이름 Example : policy-name | string | |
| scale_method required | 스케일 방법 Example : AMOUNT | string | |
| scale_type required | 스케일 유형 Example : SCALE_OUT | string | |
| scale_value required | 스켕일 값 Example : 10 | integer | |
| state required | 정책 상태 Example : ACTIVE | string | |
| threshold required | 임계값 Example : 60 | integer | |
| threshold_unit required | 임계값 단위 Example : % | string |
3.2.15 - AutoScalingGroupPolicyUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| comparison_operator optional | 비교 연산자 Example : gePattern : ^(ge|gt|le|lt)$ | any of [string, null] | |
| cooldown_seconds optional | 쿨다운 시간(초 단위) Example : 300 | any of [integer, null] | |
| evaluation_minutes optional | 평가 시간(분 단위) Example : 1 | any of [integer, null] | |
| metric_method optional | 메트릭 방법 Example : AVGPattern : ^(AVG|MIN|MAX)$ | any of [string, null] | |
| metric_type optional | 메트릭 유형 Example : CPUPattern : ^(CPU|MEMORY|NETWORK_IN_BYTES|NETWORK_OUT_BYTES|NETWORK_IN_PACKETS|NETWORK_OUT_PACKETS)$ | any of [string, null] | |
| name optional | 정책 이름 Example : policy-namePattern : ^[a-zA-Z0-9-_]*$ | any of [string, null] | |
| scale_method optional | 스케일 방법 Example : AMOUNTPattern : ^(AMOUNT|PERCENTAGE|FIXED)$ | any of [string, null] | |
| scale_type optional | 스케일 유형 Example : SCALE_OUTPattern : ^(SCALE_IN|SCALE_OUT)$ | any of [string, null] | |
| scale_value optional | 스켕일 값 Example : 10 | any of [integer, null] | |
| state optional | 정책 상태 Example : ACTIVEPattern : ^(ACTIVE|INACTIVE)$ | any of [string, null] | |
| threshold optional | 임계값 Example : 60 | any of [integer, null] |
3.2.16 - AutoScalingGroupScheduleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| day_of_month optional | 일 Example : -1,1 | any of [string, null] | |
| day_of_week optional | 요일 Example : SU,SA | any of [string, null] | |
| description optional | 설명 Example : description | any of [string, null] | |
| desired_server_count optional | 목표 서버 수 Example : 1 | any of [integer, null] | |
| end_date optional | 종료 날짜 Example : 2025-01-01 | any of [string, null] | |
| frequency required | 빈도 Example : WEEKLY | enum (ONCE, DAILY, WEEKLY, MONTHLY) | |
| hour required | 시간 Example : 9Maximum : 23 | integer | |
| max_server_count optional | 최대 서버 수 Example : 2 | any of [integer, null] | |
| min_server_count optional | 최소 서버 수 Example : 1 | any of [integer, null] | |
| minute required | 분 Example : 0 | integer | |
| name required | 스케쥴 이름 Example : schedulenamePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| start_date required | 시작 날짜 Example : 2024-01-01 | string | |
| state optional | 스케쥴 상태 Example : ACTIVE | enum (ACTIVE, INACTIVE, DELETED) | |
| timezone required | 시간대 Example : Asia/Seoul | string |
3.2.17 - AutoScalingGroupScheduleListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| schedules required | array[AutoScalingGroupScheduleShowResponse] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
3.2.18 - AutoScalingGroupScheduleShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 계정 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| day_of_month required | 일 Example : -1,1 | any of [string, null] | |
| day_of_week required | 요일 Example : SU,SA | any of [string, null] | |
| description required | 설명 Example : description | any of [string, null] | |
| desired_server_count required | 목표 서버 수 Example : 1 | any of [integer, null] | |
| end_date required | 종료 날짜 Example : 2025-01-01 | any of [string, null] | |
| frequency required | 빈도 Example : WEEKLY | enum (ONCE, DAILY, WEEKLY, MONTHLY) | |
| hour required | 시간 Example : 9 | integer | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| max_server_count required | 최대 서버 수 Example : 2 | any of [integer, null] | |
| min_server_count required | 최소 서버 수 Example : 1 | any of [integer, null] | |
| minute required | 분 Example : 0 | integer | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | 스케쥴 이름 Example : schedulename | string | |
| start_date required | 시작 날짜 Example : 2024-01-01 | string | |
| state required | 스케쥴 상태 Example : ACTIVE | string | |
| timezone required | 시간대 Example : Asia/Seoul | string |
3.2.19 - AutoScalingGroupScheduleUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| day_of_month optional | 일 Example : -1,1 | any of [string, null] | |
| day_of_week optional | 요일 Example : SU,SA | any of [string, null] | |
| description optional | 설명 Example : description | any of [string, null] | |
| desired_server_count optional | 목표 서버 수 Example : 1 | any of [integer, null] | |
| end_date optional | 종료 날짜 Example : 2025-01-01 | any of [string, null] | |
| frequency optional | 빈도 Example : WEEKLY | any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | |
| hour optional | 시간 Example : 9 | any of [integer, null] | |
| max_server_count optional | 최대 서버 수 Example : 2 | any of [integer, null] | |
| min_server_count optional | 최소 서버 수 Example : 1 | any of [integer, null] | |
| minute optional | 분 Example : 0 | any of [integer, null] | |
| name optional | 스케쥴 이름 Example : schedulenamePattern : ^[a-zA-Z0-9-_]*$ | any of [string, null] | |
| start_date optional | 시작 날짜 Example : 2024-01-01 | any of [string, null] | |
| state optional | 스케쥴 상태 Example : ACTIVE | enum (ACTIVE, INACTIVE, DELETED) | |
| timezone optional | 시간대 Example : Asia/Seoul | any of [string, null] |
3.2.20 - AutoScalingGroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count_editable optional | 목표 서버 수 수정 가능 여부 Example : True | any of [boolean, null] | |
| drain_enabled optional | Drain 사용 여부 Example : True | any of [boolean, null] | |
| drain_timeout optional | Drain timeout 값 Example : 300 | any of [integer, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| security_group_ids optional | Security Group ID 목록 Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] |
3.2.21 - AutoScalingGroupSetServerCountRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count optional | 목표 서버 수 Example : 1 | any of [integer, null] | |
| max_server_count optional | 최대 서버 수 Example : 2 | any of [integer, null] | |
| min_server_count optional | 최소 서버 수 Example : 1 | any of [integer, null] |
3.2.22 - AutoScalingGroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 계정 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| desired_server_count required | 목표 서버 수 Example : 1 | integer | |
| desired_server_count_editable required | 목표 서버 수 수정 가능 여부 Example : True | boolean | |
| drain_enabled required | Drain 사용 여부 Example : True | boolean | |
| drain_timeout optional | Drain timeout 값 Example : 300 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| launch_configuration_name required | Launch Configuration 이름 Example : launch-configuration-name | string | |
| lb_server_groups optional | LB 서버 그룹 목록 | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | 최대 서버 수 Example : 2 | integer | |
| min_server_count required | 최소 서버 수 Example : 1 | integer | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Auto-Scaling Group 이름 Example : auto-scaling-group-name | string | |
| security_group_ids optional | Security Group ID 목록 Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | 서버 이름 접두사 Example : server-name-prefix | string | |
| state required | Auto-Scaling Group 상태 Example : IN_SERVICE | string | |
| subnet_ids optional | Subnet ID 목록 | array[string] | |
| total_server_count required | 총 서버 수 Example : 1 | integer | |
| vpc_id required | VPC ID Example : cc976b621087484ea5fd527f4b78708b | string |
3.2.23 - AutoScalingGroupVirtualServerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| servers required | 서버 목록 | array[AutoScalingGroupVirtualServerShowResponse] |
3.2.24 - AutoScalingGroupVirtualServerShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 계정 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| addresses optional | 주소 목록 | any of [array[ServerShowResponseAddress], null] | |
| auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | |
| created_at required | 생성일시 Example : 2026-02-11T06:44:44.306Z | string (date-time) | |
| created_by required | 생성자 ID Example : 97e6b22c9a4143789ca522df7457a32f | string | |
| disk_config required | 디스크 컨피그 Example : MANUAL | string | |
| id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| image_id optional | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | |
| is_marketplace optional | Marketplace 여부 Example : False | any of [boolean, null] | |
| keypair_name optional | 키페어 이름 Example : keypairname | any of [string, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| lb_linked_state optional | Load Balancer 연결 상태 Example : ATTACHED | any of [string, null] | |
| locked required | 잠김 여부 Example : False | boolean | |
| metadata required | 메타 데이터 Example : | object | |
| modified_at required | 수정일시 Example : 2026-02-11T06:44:44.337Z | string (date-time) | |
| name required | 서버 이름 Example : servername | string | |
| partition_number optional | 파티션 넘버 Example : 1 | any of [integer, null] | |
| planned_compute_os_type optional | Planned Compute OS 유형 Example : windows | any of [enum (open_source, windows, rhel), null] | |
| product_category optional | 상품군 Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | 상품 Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Group 목록 | any of [array[ServerShowResponseSecurityGroup], null] | |
| server_group_id optional | 서버 그룹 ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type required | 서버 타입 | ServerShowResponseServerType | |
| state required | 서버 상태 Example : ACTIVE | string | |
| volumes required | 볼륨 | array[ServerShowResponseVolume] | |
| vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] |
3.2.25 - DefaultConfigListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| configs required | 설정 값 Example : ('key': 'value'} | object | |
| count required | count Example : 20 | integer |
3.2.26 - ImageCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| container_format optional | 컨테이너 형식 Example : barePattern : bare | string | bare |
| disk_format optional | 디스크 형식 Example : qcow2Pattern : qcow2 | string | qcow2 |
| min_disk optional | 최소 디스크 Example : 100 | integer | |
| min_ram optional | 최소 RAM Example : 0Maximum : 2097151 | integer | |
| name required | 이미지 이름 Example : imagenamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| os_distro required | OS 배포판 Example : alma | enum (alma, centos, rhel, rocky, ubuntu, windows, oracle) | |
| protected optional | 보호 Example : False | boolean | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| url required | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2Maximum length : 255 | string | |
| visibility optional | 가시성 Example : privatePattern : private|shared | string | private |
3.2.27 - ImageImportRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| url required | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2Pattern : .*\.qcow2$Maximum length : 255 | string |
3.2.28 - ImageListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| images required | array[ImageShowResponse] |
3.2.29 - ImageMemberCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| member_id required | 멤버 ID Example : a8f10467abfc4b87b64614ab36eb9ae4Pattern : ^[A-Za-z0-9-]*$Minimum length : 1Maximum length : 64 | string |
3.2.30 - ImageMemberListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| members required | array[ImageMemberShowResponse] |
3.2.31 - ImageMemberSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| status required | 멤버 상태 Example : pending | enum (pending, accepted, rejected) |
3.2.32 - ImageMemberShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성일시 Example : 2025-07-22T09:00:00Z | string | |
| image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| member_id required | 멤버 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| status required | 멤버 상태 Example : pending | string | |
| updated_at required | 수정일시 Example : 2025-07-26T12:00:00Z | string |
3.2.33 - ImageSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| min_disk optional | 최소 디스크 Example : 100 | any of [integer, null] | |
| min_ram optional | 최소 RAM Example : 0 | any of [integer, null] | |
| protected optional | 보호 Example : False | any of [boolean, null] | |
| visibility optional | 가시성 Example : privatePattern : private|shared | any of [string, null] |
3.2.34 - ImageShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| checksum optional | 체크섬 Example : 7538e0fcb56e0e272cfd89eb384d6613 | any of [string, null] | |
| container_format required | 컨테이너 형식 Example : bare | string | |
| created_at required | 생성일시 Example : 2025-07-22T09:00:00Z | string | |
| disk_format required | 디스크 형식 Example : qcow2 | string | |
| file required | 파일 Example : /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file | string | |
| id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| min_disk required | 최소 디스크 Example : 100 | integer | |
| min_ram required | 최소 RAM Example : 0 | integer | |
| name required | 이미지 이름 Example : imagename | string | |
| os_distro optional | OS 배포판 Example : alma | any of [string, null] | |
| os_hash_algo optional | OS 해시 알고리즘 Example : sha512 | any of [string, null] | |
| os_hash_value optional | OS 해시 값 Example : c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 | any of [string, null] | |
| os_hidden required | OS 숨김 여부 Example : False | boolean | |
| owner required | Owner account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| owner_account_name optional | 소유 account 이름 Example : AccountName | any of [string, null] | |
| owner_user_name optional | 소유자 이름 Example : user@samsung.com | any of [string, null] | |
| protected required | 보호 Example : False | boolean | |
| root_device_name optional | 루트 디바이스 이름 Example : /dev/vda | any of [string, null] | |
| scp_image_type optional | 이미지 타입 Example : custom | any of [string, null] | |
| scp_k8s_version optional | K8S 버전 Example : v1.28.7 | any of [string, null] | |
| scp_original_image_type optional | 원본 이미지 타입 Example : standard | any of [string, null] | |
| scp_os_build_version optional | OS 빌드 버전 Example : 20250101 | any of [string, null] | |
| scp_os_version optional | OS 버전 Example : 8.8 | any of [string, null] | |
| size optional | 크기 Example : 2429747200 | any of [integer, null] | |
| status required | 상태 Example : active | string | |
| updated_at required | 수정일시 Example : 2025-07-26T12:00:00Z | string | |
| url optional | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 | any of [string, null] | |
| virtual_size optional | 가상 크기 Example : 17179869184 | any of [integer, null] | |
| visibility required | 가시성 Example : private | string | |
| volumes optional | 볼륨 Example : [{"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}] | any of [string, null] |
3.2.35 - InterfaceAttachmentFixedIp
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_address required | IP 주소 Example : 192.169.3.2 | string |
3.2.36 - InterfaceResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ips required | Fixed Ip list | array[InterfaceAttachmentFixedIp] | |
| mac_addr required | MAC 주소 Example : fa:16:3e:c0:71:2b | string | |
| port_id required | 포트 ID Example : f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc | string | |
| port_state required | Port State Example : ACTIVE | string | |
| private_static_nat optional | Private Static NAT | PrivateStaticNat | |
| static_nat optional | Public Static NAT | PublicStaticNat | |
| subnet_id required | 서브넷 ID Example : 183c6c30df0c4fcbb16422aa2d64aa21 | string |
3.2.37 - Keypair
| Name | Description | Schema | Default |
|---|---|---|---|
| fingerprint required | Fingerprint Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd | string | |
| name required | 키페어 이름 Example : keypairname | string | |
| public_key required | Public Key Example : publickey | string | |
| type required | 키페어 유형 Example : ssh | string |
3.2.38 - KeypairCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | 키페어 이름 Example : keypairnamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| public_key optional | Public Key Example : publickey | any of [string, null] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] |
3.2.39 - KeypairCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| fingerprint required | Fingerprint Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd | string | |
| name required | 키페어 이름 Example : keypairname | string | |
| private_key optional | 비밀 키 Example : privatekey | any of [string, null] | |
| public_key required | Public Key Example : publickey | string | |
| type required | 키페어 유형 Example : ssh | string |
3.2.40 - KeypairListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| keypairs required | array[Keypair] |
3.2.41 - KeypairShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성일시 Example : 2025-07-22T09:00:00Z | string (date-time) | |
| fingerprint required | Fingerprint Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd | string | |
| id required | 키페어 ID Example : 1 | integer | |
| name required | 키페어 이름 Example : keypairname | string | |
| public_key required | Public Key Example : publickey | string | |
| type required | 키페어 유형 Example : ssh | string | |
| user_id required | 사용자 ID Example : 570907805e5447be84b618450ef52o0t | string |
3.2.42 - LaunchConfigurationCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| keypair_name required | 키페어 이름 Example : keypairname | string | |
| name required | Launch Configuration 이름 Example : launch-configuration-namePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| server_type_id required | 서버 타입 ID Example : s1v1m2 | string | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| user_data optional | 사용자 데이터 Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | 볼륨 | any of [array[LaunchConfigurationVolume], null] |
3.2.43 - LaunchConfigurationDetailShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 계정 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_count optional | Launch Configuration에 연결된 Auto-Scaling Group 수 Example : 1 | any of [integer, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| image_name required | 이미지 이름 Example : imagename | string | |
| keypair_name required | 키페어 이름 Example : keypairname | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Launch Configuration 이름 Example : launch-configuration-name | string | |
| public_key optional | Public Key Example : publickey | any of [string, null] | |
| server_type_id required | 서버 타입 ID Example : s1v1m2 | string | |
| state required | Launch Configuration 상태 Example : ACTIVE | string | |
| user_data optional | 사용자 데이터 Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | 볼륨 | any of [array[LaunchConfigurationVolume], null] |
3.2.44 - LaunchConfigurationListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | count Example : 20 | integer | |
| launch_configurations required | Launch Configuration 목록 | array[LaunchConfigurationShowResponse] |
3.2.45 - LaunchConfigurationShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 계정 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_count optional | Launch Configuration에 연결된 Auto-Scaling Group 수 Example : 1 | any of [integer, null] | |
| boot_disk_size optional | 기본 볼륨 크기 Example : 104 | any of [integer, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| extra_disk_size optional | 추가 볼륨 크기 Example : 104 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| image_name required | 이미지 이름 Example : imagename | string | |
| keypair_name required | 키페어 이름 Example : keypairname | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Launch Configuration 이름 Example : launch-configuration-name | string | |
| public_key optional | Public Key Example : publickey | any of [string, null] | |
| server_type_id required | 서버 타입 ID Example : s1v1m2 | string | |
| state required | Launch Configuration 상태 Example : ACTIVE | string | |
| user_data optional | 사용자 데이터 Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | 볼륨 | any of [array[LaunchConfigurationVolume], null] |
3.2.46 - LaunchConfigurationVolume
| Name | Description | Schema | Default |
|---|---|---|---|
| boot_index required | 부팅 장치를 시도하는 순서 Example : 0 | integer | |
| size required | 볼륨 크기 Example : 104 | integer | |
| type optional | 볼륨 타입 Example : SSD | any of [string, null] |
3.2.47 - Network
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ip optional | 고정 IP Example : 192.169.3.2 | any of [string, null] | |
| port_id optional | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | any of [string, null] | |
| public_ip_id optional | 공개 IP ID Example : 615fa9cd5cff486c9de679b3ce63e601 | any of [string, null] | |
| subnet_id optional | 서브넷 ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] |
3.2.48 - PrivateStaticNat
| Name | Description | Schema | Default |
|---|---|---|---|
| external_ip_address required | 외부 IP 주소 Example : 182.197.61.81 | string | |
| id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | |
| private_nat_ip_id optional | 비공개 NAT IP ID Example : 1f0cb5390c40483592ddc5a282f53496 | any of [string, null] | |
| state required | NAT 상태 Example : ACTIVE | string |
3.2.49 - PublicStaticNat
| Name | Description | Schema | Default |
|---|---|---|---|
| external_ip_address required | 외부 IP 주소 Example : 182.197.61.81 | string | |
| id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | |
| publicip_id optional | 공개 IP ID Example : 615fa9cd5cff486c9de679b3ce63e601 | any of [string, null] | |
| state required | NAT 상태 Example : ACTIVE | string |
3.2.50 - SecurityGroupResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Server Group owner’s account ID Example : 6f70656e737461636b20342065766572 | string | |
| description required | Security group description Example : Security group description | string | |
| id required | Security Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | |
| name required | Security Group 이름 Example : securitygroup | string | |
| rules required | Security group rules | array[SecurityGroupResponseRule] |
3.2.51 - SecurityGroupResponseRule
| Name | Description | Schema | Default |
|---|---|---|---|
| from_port required | From port rule Example : 1 | any of [integer, null] | |
| id required | Security group rule ID Example : ca5cb96b-9df6-4af7-9682-4d60a58d38a5 | string | |
| ip_protocol required | Ip protocol Example : tcp | any of [string, null] | |
| ip_range optional | Ip range | any of [SecurityGroupResponseRuleIpRange, null] | |
| to_port required | To port rule Example : 65535 | any of [integer, null] |
3.2.52 - SecurityGroupResponseRuleIpRange
| Name | Description | Schema | Default |
|---|---|---|---|
| cidr optional | Cidr Example : 0.0.0.0/0 | any of [string, null] |
3.2.53 - ServerConsoleLogResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| output optional | Server console log output Example : FAKE CONSOLE OUTPUT | any of [string, null] |
3.2.54 - ServerCreateImageRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| image_name required | 이미지 이름 Example : imagename | string |
3.2.55 - ServerCreateImageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string |
3.2.56 - ServerCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| keypair_name required | 키페어 이름 Example : keypairname | string | |
| lock optional | 잠김 여부 Example : False | any of [boolean, null] | |
| max_count optional | 최대 생성 개수 Example : 2 | any of [integer, null] | 1 |
| metadata optional | 메타 데이터 Example : | any of [object, null] | |
| name required | 서버 이름 Example : servernamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 63 | string | |
| networks required | 네트워크 목록 | array[Network] | |
| partition_number optional | 파티션 넘버 Example : 1 | any of [integer, null] | |
| product_category optional | 상품군 Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | 상품 Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Group 목록 Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_group_id optional | 서버 그룹 ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type_id required | 서버 타입 ID Example : s1v1m2 | string | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| user_data optional | 사용자 데이터 Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | 볼륨 | any of [array[Volume], null] |
3.2.57 - ServerCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| servers required | 서버 ID 목록 | array[ServerCreateResponseParam] |
3.2.58 - ServerCreateResponseParam
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string |
3.2.59 - ServerGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 계정 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| id required | 서버 그룹 ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | |
| members required | 서버 그룹 멤버 Example : ['2a9be312-5d4b-4bc8-b2ae-35100fa9241f'] | array[string] | |
| name required | 서버 그룹 명 Example : server-group | string | |
| partition_size required | 파티션 사이즈 Example : 3 | any of [integer, null] | |
| policy required | 서버 그룹 정책 Example : anti-affinity | string | |
| user_id required | 사용자 ID Example : 570907805e5447be84b618450ef52o0t | string |
3.2.60 - ServerGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | 서버 그룹 명 Example : server-groupPattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| policy required | 서버 그룹 정책 Example : anti-affinityPattern : ^affinity$|^anti-affinity$|^partition$ | string | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] |
3.2.61 - ServerGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| server_groups required | array[ServerGroup] |
3.2.62 - ServerGroupPartitionSizeResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| partition_size required | Example : | integer |
3.2.63 - ServerInterfaceCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ips optional | Fixed Ip list | any of [array[InterfaceAttachmentFixedIp], null] | |
| port_id optional | 포트 ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | any of [string, null] | |
| subnet_id optional | 서브넷 ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] |
3.2.64 - ServerInterfaceListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| interfaces required | 인터페이스 목록 | array[InterfaceResponse] |
3.2.65 - ServerInterfaceUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ip_address optional | IP 주소 Example : 192.169.3.2 | any of [string, null] | |
| subnet_id optional | 서브넷 ID Example : | any of [string, null] |
3.2.66 - ServerIpsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| addresses required | IP 주소 목록 | array[ServerShowResponseAddress] |
3.2.67 - ServerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| servers required | 서버 목록 | array[ServerShowResponse] |
3.2.68 - ServerPasswordRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| private_key optional | 비밀 키 Example : privatekey | any of [string, null] |
3.2.69 - ServerPasswordResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| password optional | Server password Example : password | any of [string, null] |
3.2.70 - ServerPrivateStaticNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| private_nat_id required | Private NAT ID Example : 3a6c1dc6b1b24e02a444d672c2798a1c | string | |
| private_nat_ip_id required | 비공개 NAT IP ID Example : 1f0cb5390c40483592ddc5a282f53496 | string |
3.2.71 - ServerQuotaSet
| Name | Description | Schema | Default |
|---|---|---|---|
| cores required | 코어 한도 | ServerQuotaSetObject | |
| id required | 쿼터 셋 ID Example : fc7283354c6143a58629b59f4c3e16b2 | string | |
| instances required | 인스턴스 한도 | ServerQuotaSetObject | |
| keypairs required | 키페어 한도 | ServerQuotaSetObject | |
| metadata_items required | 메타 데이터 항목 한도 | ServerQuotaSetObject | |
| ram required | 램 한도 | ServerQuotaSetObject | |
| server_group_members required | 서버 그룹 멤버 한도 | ServerQuotaSetObject | |
| server_groups required | 서버 그룹 한도 | ServerQuotaSetObject |
3.2.72 - ServerQuotaSetObject
| Name | Description | Schema | Default |
|---|---|---|---|
| in_use required | 사용 중인 수 Example : 10 | integer | |
| limit required | 최대 한도 수 Example : 20 | integer | |
| reserved required | 예약 중인 수 Example : 0 | integer |
3.2.73 - ServerRebootRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| reboot_type optional | 재시작 유형 Example : SOFT | any of [enum (SOFT, HARD), null] | SOFT |
3.2.74 - ServerSecurityGroupActionRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| security_group_id required | Security Group ID Example : c09c3f05-03d9-443f-b27a-40e0f973c75f | string |
3.2.75 - ServerSecurityGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| security_groups required | Security Group 목록 | array[SecurityGroupResponse] |
3.2.76 - ServerSetServerTypeRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| server_type required | 서버 타입 Example : s1v1m2 | string |
3.2.77 - ServerShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 계정 ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| addresses optional | 주소 목록 | any of [array[ServerShowResponseAddress], null] | |
| auto_scaling_group_id optional | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | any of [string, null] | |
| created_at required | 생성일시 Example : 2026-02-11T06:44:45.212Z | string (date-time) | |
| created_by required | 생성자 ID Example : 97e6b22c9a4143789ca522df7457a32f | string | |
| disk_config required | 디스크 컨피그 Example : MANUAL | string | |
| id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| image_id optional | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | |
| is_marketplace optional | Marketplace 여부 Example : False | any of [boolean, null] | |
| keypair_name optional | 키페어 이름 Example : keypairname | any of [string, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| locked required | 잠김 여부 Example : False | boolean | |
| metadata required | 메타 데이터 Example : | object | |
| modified_at required | 수정일시 Example : 2026-02-11T06:44:45.237Z | string (date-time) | |
| name required | 서버 이름 Example : servername | string | |
| partition_number optional | 파티션 넘버 Example : 1 | any of [integer, null] | |
| planned_compute_os_type optional | Planned Compute OS 유형 Example : windows | any of [enum (open_source, windows, rhel), null] | |
| product_category optional | 상품군 Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | 상품 Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Group 목록 | any of [array[ServerShowResponseSecurityGroup], null] | |
| server_group_id optional | 서버 그룹 ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type required | 서버 타입 | ServerShowResponseServerType | |
| state required | 서버 상태 Example : ACTIVE | string | |
| volumes required | 볼륨 | array[ServerShowResponseVolume] | |
| vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] |
3.2.78 - ServerShowResponseAddress
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_addresses required | IP 주소 목록 | array[ServerShowResponseAddressIpAddress] | |
| subnet_name required | 서브넷 이름 Example : subnetname | string |
3.2.79 - ServerShowResponseAddressIpAddress
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_address required | IP 주소 Example : 192.169.3.2 | string | |
| version required | IP 주소 버전 Example : 4 | integer |
3.2.80 - ServerShowResponseSecurityGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Security Group 이름 Example : securitygroup | string |
3.2.81 - ServerShowResponseServerType
| Name | Description | Schema | Default |
|---|---|---|---|
| disk required | 루트 디스크 크기 Example : 100 | integer | |
| ephemeral required | 임시 디스크 크기 Example : 0 | integer | |
| extra_specs required | 추가 스펙 Example : | object | |
| id optional | 서버 타입 ID Example : s1v1m2 | any of [string, null] | |
| name required | 서버 타입 이름 Example : s1v1m2 | string | |
| ram required | RAM 크기 Example : 2 | integer | |
| swap required | 전용 스왑 디스크 크기 Example : 0 | integer | |
| vcpus required | CPU 수 Example : 1 | integer |
3.2.82 - ServerShowResponseVolume
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination required | 해지 시 삭제 Example : False | boolean | |
| id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
3.2.83 - ServerStaticNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| publicip_id required | 공개 IP ID Example : 615fa9cd5cff486c9de679b3ce63e601 | string |
3.2.84 - ServersVolumeResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination required | 해지 시 삭제 Example : False | boolean | |
| device required | Device name Example : /dev/vda | string | |
| id required | 볼륨 연결 ID Example : 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c | string | |
| server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
3.2.85 - ServerType
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | 설명 Example : description | any of [string, null] | |
| disk required | 루트 디스크 크기 Example : 100 | integer | |
| ephemeral required | 임시 디스크 크기 Example : 0 | integer | |
| extra_specs required | 추가 스펙 Example : | object | |
| id required | 서버 타입 ID Example : s1v1m2 | string | |
| name required | 서버 타입 이름 Example : s1v1m2 | string | |
| ram required | RAM 크기 Example : 2 | integer | |
| swap required | 전용 스왑 디스크 크기 Example : 0 | integer | |
| vcpus required | CPU 수 Example : 1 | integer |
3.2.86 - ServerTypeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| server_types required | array[ServerType] |
3.2.87 - ServerUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | 서버 이름 Example : servernamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 63 | string |
3.2.88 - ServerVolumesCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination optional | 해지 시 삭제 Example : False | any of [boolean, null] | |
| device optional | Device name Example : /dev/vda | any of [string, null] | |
| volume_id required | 볼륨 ID Example : | string |
3.2.89 - ServerVolumesResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| volumes required | 볼륨 | array[ServersVolumeResponse] |
3.2.90 - ServerVolumesUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination optional | 해지 시 삭제 Example : False | any of [boolean, null] | |
| volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
3.2.91 - SnapshotCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 설명 Example : description | any of [string, null] | |
| force optional | Force Example : True | any of [boolean, null] | |
| metadata optional | Snapshot metadata Example : | any of [object, null] | |
| name required | 스냅샷명 Example : snapshot-1Pattern : ^[a-zA-Z0-9-_ ]+$Maximum length : 255 | string | |
| volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
3.2.92 - SnapshotDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성일시 Example : 2025-07-22T09:00:00Z | string | |
| description optional | 설명 Example : description | any of [string, null] | |
| id required | 스냅샷 ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | |
| metadata optional | Snapshot metadata Example : | any of [object, null] | |
| name optional | 스냅샷명 Example : snapshot-1 | any of [string, null] | |
| size required | 볼륨 크기 Example : 104 | integer | |
| status optional | 볼륨 상태 Example : available | any of [string, null] | |
| updated_at optional | 수정일시 Example : 2025-07-26T12:00:00Z | any of [string, null] | |
| user_id optional | 사용자 ID Example : 570907805e5447be84b618450ef52o0t | any of [string, null] | |
| volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
3.2.93 - SnapshotListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | Total count Example : 100 | any of [integer, null] | |
| snapshots required | array[SnapshotDetailResponse] |
3.2.94 - SnapshotUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 설명 Example : description | any of [string, null] | |
| name required | 스냅샷명 Example : snapshot-1Pattern : ^[a-zA-Z0-9-_ ]+$ | any of [string, null] |
3.2.95 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key Example : Key | string | |
| value optional | Value Example : Value | any of [string, null] |
3.2.96 - Volume
| Name | Description | Schema | Default |
|---|---|---|---|
| boot_index required | 부팅 장치를 시도하는 순서 Example : 0 | integer | |
| delete_on_termination optional | 해지 시 삭제 Example : False | any of [boolean, null] | |
| size required | 볼륨 크기 Example : 104 | integer | |
| source_type optional | 소스 유형 Example : image | any of [enum (blank, image), null] | |
| type optional | 볼륨 타입 Example : SSD | any of [string, null] |
3.2.97 - VolumeCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | 볼륨명 Example : volume01Pattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| size required | 볼륨 크기 Example : 104Minimum : 8 | integer | |
| snapshot_id optional | 스냅샷 ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | any of [string, null] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| volume_type optional | 볼륨 타입 Example : SSD | any of [string, null] |
3.2.98 - VolumeExtendRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| size required | 볼륨 크기 Example : 104Minimum : 8 | integer |
3.2.99 - VolumeImageMetadataResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| checksum optional | 체크섬 Example : 7538e0fcb56e0e272cfd89eb384d6613 | any of [string, null] | |
| container_format optional | 컨테이너 형식 Example : bare | any of [string, null] | |
| disk_format optional | 디스크 형식 Example : qcow2 | any of [string, null] | |
| image_id optional | 이미지 ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | |
| image_name optional | 이미지 이름 Example : imagename | any of [string, null] | |
| min_disk optional | 최소 디스크 Example : 100 | any of [integer, null] | |
| min_ram optional | 최소 RAM Example : 0 | any of [integer, null] | |
| os_distro optional | OS 배포판 Example : alma | any of [string, null] | |
| scp_image_type optional | 이미지 타입 Example : custom | any of [string, null] | |
| scp_k8s_version optional | K8S 버전 Example : v1.28.7 | any of [string, null] | |
| scp_original_image_type optional | 원본 이미지 타입 Example : standard | any of [string, null] | |
| signature_verified optional | 서명 인증 완료 Example : False | any of [boolean, null] | |
| size optional | 크기 Example : 2429747200 | any of [integer, null] |
3.2.100 - VolumeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | Total count Example : 100 | any of [integer, null] | |
| volumes required | array[VolumeShowResponse] |
3.2.101 - VolumeQuotaSet
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | 쿼터 셋 ID Example : fc7283354c6143a58629b59f4c3e16b2 | string | |
| per_volume_size required | 볼륨 별 크기 한도 | VolumeQuotaSetObject | |
| snapshots required | Snapshot Quota | VolumeQuotaSetObject | |
| usages required | 사용량 한도 | VolumeQuotaSetObject | |
| volumes required | Volume Quota | VolumeQuotaSetObject |
3.2.102 - VolumeQuotaSetObject
| Name | Description | Schema | Default |
|---|---|---|---|
| in_use required | 사용 중인 수 Example : 10 | integer | |
| limit required | 최대 한도 수 Example : | integer | |
| reserved required | 예약 중인 수 Example : 0 | integer |
3.2.103 - VolumeRevertRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| snapshot_id required | 스냅샷 ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string |
3.2.104 - VolumeServer
| Name | Description | Schema | Default |
|---|---|---|---|
| attached_at required | The time when the volume was attached to the server. Example : 2026-02-11T06:44:46.322Z | string (date-time) | |
| device required | Device name Example : /dev/vda | string | |
| id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string |
3.2.105 - VolumeServerAttachRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination optional | 해지 시 삭제 Example : False | any of [boolean, null] | |
| server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string |
3.2.106 - VolumeServerAttachResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination required | 해지 시 삭제 Example : False | boolean | |
| device required | Device name Example : /dev/vda | string | |
| server_id required | 서버 ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
3.2.107 - VolumeShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| bootable required | 부트 디스크 여부 Example : False | boolean | |
| created_at required | 생성일시 Example : 2026-02-11T06:44:46.280Z | string (date-time) | |
| encrypted required | 암호화 여부 Example : True | boolean | |
| id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | |
| modified_at optional | 수정일시 Example : 2025-07-26T12:00:00Z | any of [string (date-time), null] | |
| multiattach required | 다중 연결 Example : False | boolean | |
| name optional | 볼륨명 Example : volume01 | any of [string, null] | |
| servers required | Attached servers | array[VolumeServer] | |
| size required | 볼륨 크기 Example : 104 | integer | |
| snapshot_id optional | 스냅샷 ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | any of [string, null] | |
| state required | 볼륨 상태 Example : available | string | |
| user_id required | 사용자 ID Example : 570907805e5447be84b618450ef52o0t | string | |
| volume_image_metadata optional | 볼륨 이미지 메타데이터 | any of [VolumeImageMetadataResponse, null] | |
| volume_type required | 볼륨 타입 Example : SSD | string | |
| volume_type_id required | 볼륨 유형 ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string |
3.2.108 - VolumeTransferAcceptResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | |
| name optional | 볼륨명 Example : volume01 | any of [string, null] | |
| volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
3.2.109 - VolumeTransferAccessRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| auth_key required | Auth key Example : f5972fdb456897eb | string |
3.2.110 - VolumeTransferCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| auth_key required | Auth key Example : f5972fdb456897eb | string | |
| created_at required | 생성일시 Example : | string | |
| id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | |
| name optional | 볼륨명 Example : volume01 | any of [string, null] | |
| volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
3.2.111 - VolumeTransferListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| transfers required | Volume Transfer List | array[VolumeTransferAcceptResponse] |
3.2.112 - VolumeTransferRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name optional | 볼륨명 Example : volume01 | any of [string, null] | |
| volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
3.2.113 - VolumeTransferShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성일시 Example : | string | |
| id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | |
| name optional | 볼륨명 Example : volume01 | any of [string, null] | |
| volume_id required | 볼륨 ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
3.2.114 - VolumeTypeDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Volume type description Example : Volume type description | any of [string, null] | |
| extra_specs required | 추가 스펙 | any of [VolumeTypeExtraSpecs, null] | |
| id required | 볼륨 유형 ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string | |
| name optional | 볼륨 유형명 Example : SSD | any of [string, null] |
3.2.115 - VolumeTypeExtraSpecs
| Name | Description | Schema | Default |
|---|---|---|---|
| multiattach optional | 다중 연결 Example : <is> True | any of [string, null] |
3.2.116 - VolumeTypeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| volume_types required | 볼륨 타입 목록 | array[VolumeTypeDetailResponse] |
3.2.117 - VolumeUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name optional | 볼륨명 Example : volume01Pattern : ^[a-zA-Z0-9-_ ]*$ | any of [string, null] |