이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

Networking

1: Direct Connect

1.1: APIs

1.1.1: Create Direct Connect

1.1.1.1: 1.0

1.1.2: Create Routing Rule

1.1.2.1: 1.0

1.1.3: Delete Direct Connect

1.1.3.1: 1.0

1.1.4: Delete Routing Rule

1.1.4.1: 1.0

1.1.5: List Direct Connects

1.1.5.1: 1.0

1.1.6: List Routing Rules

1.1.6.1: 1.0

1.1.7: Set Direct Connect

1.1.7.1: 1.0

1.1.8: Show Direct Connect

1.1.8.1: 1.0

1.2: Models

1.2.1: DirectConnect
1.2.2: DirectConnectCreateRequest
1.2.3: DirectConnectListResponse
1.2.4: DirectConnectSetRequest
1.2.5: DirectConnectShowResponse
1.2.6: RoutingRule
1.2.7: RoutingRuleCreateRequest
1.2.8: RoutingRuleListResponse
1.2.9: RoutingRuleShowResponse
1.2.10: Tag

2: DNS

2.1: APIs

2.1.1: Activate Private DNS

2.1.1.1: 1.3
2.1.1.2: 1.2
2.1.1.3: 1.1
2.1.1.4: 1.0

2.1.2: Create Hosted Zone

2.1.2.1: 1.3
2.1.2.2: 1.2
2.1.2.3: 1.1
2.1.2.4: 1.0

2.1.3: Create Hosted Zone Record

2.1.3.1: 1.3

2.1.4: Create Private DNS

2.1.4.1: 1.3
2.1.4.2: 1.2
2.1.4.3: 1.1
2.1.4.4: 1.0

2.1.5: Create Public Domain

2.1.5.1: 1.2
2.1.5.2: 1.1
2.1.5.3: 1.0

2.1.6: Create Public Domain Name

2.1.6.1: 1.3

2.1.7: Create Record

2.1.7.1: 1.2
2.1.7.2: 1.1
2.1.7.3: 1.0

2.1.8: Delete Hosted Zone

2.1.8.1: 1.3
2.1.8.2: 1.2
2.1.8.3: 1.1
2.1.8.4: 1.0

2.1.9: Delete Hosted Zone Record

2.1.9.1: 1.3

2.1.10: Delete Private DNS

2.1.10.1: 1.3
2.1.10.2: 1.2
2.1.10.3: 1.1
2.1.10.4: 1.0

2.1.11: Delete Record

2.1.11.1: 1.2
2.1.11.2: 1.1
2.1.11.3: 1.0

2.1.12: Get Public Domain Detail

2.1.12.1: 1.2
2.1.12.2: 1.1
2.1.12.3: 1.0

2.1.13: List Hosted Zone Records

2.1.13.1: 1.3

2.1.14: List Hosted Zones

2.1.14.1: 1.3
2.1.14.2: 1.2
2.1.14.3: 1.1
2.1.14.4: 1.0

2.1.15: List Private DNS

2.1.15.1: 1.3
2.1.15.2: 1.2
2.1.15.3: 1.1
2.1.15.4: 1.0

2.1.16: List Public Domain Names

2.1.16.1: 1.3

2.1.17: List Public Domains

2.1.17.1: 1.2
2.1.17.2: 1.1
2.1.17.3: 1.0

2.1.18: List Records

2.1.18.1: 1.2
2.1.18.2: 1.1
2.1.18.3: 1.0

2.1.19: Set Hosted Zone Record

2.1.19.1: 1.3

2.1.20: Set Private DNS

2.1.20.1: 1.3
2.1.20.2: 1.2
2.1.20.3: 1.1
2.1.20.4: 1.0

2.1.21: Set Public Domain Name

2.1.21.1: 1.3

2.1.22: Set Public Domain Name Whois Info

2.1.22.1: 1.3

2.1.23: Show Hosted Zone

2.1.23.1: 1.3
2.1.23.2: 1.2
2.1.23.3: 1.1
2.1.23.4: 1.0

2.1.24: Show Hosted Zone Record

2.1.24.1: 1.3

2.1.25: Show Private DNS

2.1.25.1: 1.3
2.1.25.2: 1.2
2.1.25.3: 1.1
2.1.25.4: 1.0

2.1.26: Show Public Domain Name

2.1.26.1: 1.3

2.1.27: Show Record

2.1.27.1: 1.2
2.1.27.2: 1.1
2.1.27.3: 1.0

2.1.28: Transfer Public Domain Name

2.1.28.1: 1.3

2.1.29: Update auto_extension or description

2.1.29.1: 1.2
2.1.29.2: 1.1
2.1.29.3: 1.0

2.1.30: Update Hosted Zone

2.1.30.1: 1.3
2.1.30.2: 1.2
2.1.30.3: 1.1
2.1.30.4: 1.0

2.1.31: Update Record

2.1.31.1: 1.2
2.1.31.2: 1.1
2.1.31.3: 1.0

2.1.32: Update WHOIS info for Public Domain

2.1.32.1: 1.2
2.1.32.2: 1.1
2.1.32.3: 1.0

2.2: Models

2.2.1: CreatePublicDomainRequest
2.2.2: CreatePublicDomainResponse
2.2.3: HostedZone
2.2.4: HostedZoneCreateRequest
2.2.5: HostedZoneCreateRequestV1Dot2
2.2.6: HostedZoneCreateRequestV1Dot3
2.2.7: HostedZoneCreateResponse
2.2.8: HostedZoneDeleteResponse
2.2.9: HostedZoneListResponse
2.2.10: HostedZoneListResponseV1Dot1
2.2.11: HostedZoneListResponseV1Dot2
2.2.12: HostedZoneListResponseV1Dot3
2.2.13: HostedZoneSetRequest
2.2.14: HostedZoneSetRequestV1Dot3
2.2.15: HostedZoneSetResponse
2.2.16: HostedZoneShowResponse
2.2.17: HostedZoneShowResponseV1Dot2
2.2.18: HostedZoneShowResponseV1Dot3
2.2.19: HostedZoneV1Dot2
2.2.20: HostedZoneV1Dot3
2.2.21: PrivateDns
2.2.22: PrivateDnsActivateRequest
2.2.23: PrivateDnsCreateRequest
2.2.24: PrivateDnsListResponse
2.2.25: PrivateDnsSetRequest
2.2.26: PrivateDnsShowResponse
2.2.27: PubblicDomainWhoisInfoUpdateRequest
2.2.28: PublicDomainDetail
2.2.29: PublicDomainDetailResponse
2.2.30: PublicDomainListItem
2.2.31: PublicDomainListResponse
2.2.32: PublicDomainPartialUpdateRequest
2.2.33: PublicDomainPartialUpdateResponse
2.2.34: PublicDomainTransferRequest
2.2.35: PublicDomainTransferResponse
2.2.36: PublicDomainWhoisInfoUpdateResponse
2.2.37: Record
2.2.38: RecordCreateRequest
2.2.39: RecordCreateRequestV1Dot0To1Dot2
2.2.40: RecordCreateResponse
2.2.41: RecordListResponse
2.2.42: RecordSetRequest
2.2.43: RecordSetResponse
2.2.44: RecordShowResponse
2.2.45: Tag

3: Firewall

3.1: APIs

3.1.1: Create Firewall Rule

3.1.1.1: 1.0

3.1.2: Delete Firewall Rule

3.1.2.1: 1.0

3.1.3: List Firewall Rules

3.1.3.1: 1.0

3.1.4: List Firewalls

3.1.4.1: 1.0

3.1.5: Set Firewall

3.1.5.1: 1.0

3.1.6: Set Firewall Rule

3.1.6.1: 1.0

3.1.7: Show Firewall

3.1.7.1: 1.0

3.1.8: Show Firewall Rule

3.1.8.1: 1.0

3.2: Models

3.2.1: Firewall
3.2.2: FirewallListResponse
3.2.3: FirewallPort
3.2.4: FirewallRule
3.2.5: FirewallRuleCreateRequest
3.2.6: FirewallRuleCreateSingleRequest
3.2.7: FirewallRuleListResponse
3.2.8: FirewallRuleSetRequest
3.2.9: FirewallRuleShowResponse
3.2.10: FirewallSetRequest
3.2.11: FirewallShowResponse

4: Global CDN

4.1: APIs

4.1.1: Create Cdn Service

4.1.1.1: 1.0

4.1.2: Delete Cdn Service

4.1.2.1: 1.0

4.1.3: Detail Cdn Service

4.1.3.1: 1.0

4.1.4: List Cdn Service

4.1.4.1: 1.0

4.1.5: Purge Cdn Service

4.1.5.1: 1.0

4.1.6: Start Cdn Service

4.1.6.1: 1.0

4.1.7: Stop Cdn Service

4.1.7.1: 1.0

4.1.8: Update Cdn Service

4.1.8.1: 1.0

4.1.9: Update Description of Cdn Service

4.1.9.1: 1.0

4.2: Models

4.2.1: CdnServiceCreateRequest
4.2.2: CdnServiceDetail
4.2.3: CdnServiceDetailResponse
4.2.4: CdnServiceListResponse
4.2.5: CdnServiceModifyDescriptionRequest
4.2.6: CdnServicePurgeRequest
4.2.7: CdnServiceResponse
4.2.8: CdnServiceResponseResult
4.2.9: CdnServiceResult
4.2.10: CdnServiceUpdateRequest
4.2.11: Tag

5: GSLB

5.1: APIs

5.1.1: CreateGslb

5.1.1.1: 1.1
5.1.1.2: 1.0

5.1.2: DeleteGslb

5.1.2.1: 1.1
5.1.2.2: 1.0

5.1.3: ListGslbResources

5.1.3.1: 1.1
5.1.3.2: 1.0

5.1.4: ListGslbs

5.1.4.1: 1.1
5.1.4.2: 1.0

5.1.5: ListGslbsRegionalRoutingControl

5.1.5.1: 1.1

5.1.6: SetGslb

5.1.6.1: 1.1
5.1.6.2: 1.0

5.1.7: SetGslbHealthCheck

5.1.7.1: 1.1
5.1.7.2: 1.0

5.1.8: SetGslbRegionalRoutingControl

5.1.8.1: 1.1

5.1.9: SetGslbResources

5.1.9.1: 1.1
5.1.9.2: 1.0

5.1.10: ShowGslb

5.1.10.1: 1.1
5.1.10.2: 1.0

5.2: Models

5.2.1: GslbCreateRequest
5.2.2: GslbCreateRequestV1Dot1
5.2.3: GslbDetail
5.2.4: GslbHealthCheck
5.2.5: GslbHeathCheckShowResponse
5.2.6: GslbListResponse
5.2.7: GslbResource
5.2.8: GslbResourceListResponse
5.2.9: GslbResourceListResponseV1Dot1
5.2.10: GslbResourceResponse
5.2.11: GslbResourceResponseV1Dot1
5.2.12: GslbResourceSetRequest
5.2.13: GslbResourceSetRequestV1Dot1
5.2.14: GslbResourcesSetRequest
5.2.15: GslbResourceV1Dot1
5.2.16: GslbResponseCommon
5.2.17: GslbRoutingControlListResponse
5.2.18: GslbRoutingControlRequest
5.2.19: GslbRoutingControlResponse
5.2.20: GslbRoutingControlResponseCommon
5.2.21: GslbSetRequest
5.2.22: GslbShowResponse
5.2.23: Tag

6: Load Balancer

6.1: APIs

6.1.1: AddLbServerGroupMembers

6.1.1.1: 1.2
6.1.1.2: 1.1

6.1.2: CreateLBHealthCheck

6.1.2.1: 1.2
6.1.2.2: 1.1

6.1.3: CreateLbListener

6.1.3.1: 1.2
6.1.3.2: 1.1

6.1.4: CreateLBServerGroup

6.1.4.1: 1.2
6.1.4.2: 1.1

6.1.5: CreateLoadbalancer

6.1.5.1: 1.2
6.1.5.2: 1.1

6.1.6: CreateLoadbalancerPublicNatIp

6.1.6.1: 1.2
6.1.6.2: 1.1

6.1.7: DeleteLBHealthCheck

6.1.7.1: 1.2
6.1.7.2: 1.1

6.1.8: DeleteLbListener

6.1.8.1: 1.2
6.1.8.2: 1.1

6.1.9: DeleteLBServerGroup

6.1.9.1: 1.2
6.1.9.2: 1.1

6.1.10: DeleteLoadbalancer

6.1.10.1: 1.2
6.1.10.2: 1.1

6.1.11: DeleteLoadbalancerPublicNatIp

6.1.11.1: 1.2
6.1.11.2: 1.1

6.1.12: ListLBHealthChecks

6.1.12.1: 1.2
6.1.12.2: 1.1

6.1.13: ListLbListeners

6.1.13.1: 1.2
6.1.13.2: 1.1

6.1.14: ListLbServerGroupMembers

6.1.14.1: 1.2
6.1.14.2: 1.1

6.1.15: ListLBServerGroups

6.1.15.1: 1.2
6.1.15.2: 1.1

6.1.16: ListLoadbalancerCertificates

6.1.16.1: 1.2
6.1.16.2: 1.1

6.1.17: ListLoadbalancers

6.1.17.1: 1.2
6.1.17.2: 1.1

6.1.18: RemoveLbServerGroupMember

6.1.18.1: 1.2
6.1.18.2: 1.1

6.1.19: RemoveLbServerGroupMembers

6.1.19.1: 1.2

6.1.20: SetLBHealthCheck

6.1.20.1: 1.2
6.1.20.2: 1.1

6.1.21: SetLbListener

6.1.21.1: 1.2
6.1.21.2: 1.1

6.1.22: SetLBServerGroup

6.1.22.1: 1.2
6.1.22.2: 1.1

6.1.23: SetLbServerGroupMember

6.1.23.1: 1.2
6.1.23.2: 1.1

6.1.24: SetLoadbalancer

6.1.24.1: 1.1

6.1.25: ShowLBHealthCheck

6.1.25.1: 1.2
6.1.25.2: 1.1

6.1.26: ShowLbListener

6.1.26.1: 1.2
6.1.26.2: 1.1

6.1.27: ShowLBServerGroup

6.1.27.1: 1.2
6.1.27.2: 1.1

6.1.28: ShowLbServerGroupMember

6.1.28.1: 1.2
6.1.28.2: 1.1

6.1.29: ShowLoadbalancer

6.1.29.1: 1.2
6.1.29.2: 1.1

6.1.30: ShowLoadbalancerCertificate

6.1.30.1: 1.2
6.1.30.2: 1.1

6.1.31: ShowLoadbalancerPublicNatIp

6.1.31.1: 1.2
6.1.31.2: 1.1

6.2: Models

6.2.1: HttpsRedirection
6.2.2: LbCertificate
6.2.3: LbCertificateForShow
6.2.4: LbCertificateListResponse
6.2.5: LbCertificateShowResponse
6.2.6: LbHealthCheckCreate
6.2.7: LbHealthCheckCreateRequest
6.2.8: LbHealthCheckList
6.2.9: LbHealthCheckListResponse
6.2.10: LbHealthCheckSet
6.2.11: LbHealthCheckSetRequest
6.2.12: LbHealthCheckShow
6.2.13: LbHealthCheckShowResponse
6.2.14: LbListenerCreateRequest
6.2.15: LbListenerCreateRequestV1Dot2
6.2.16: LbListenerListResponse
6.2.17: LbListenerSetRequest
6.2.18: LbListenerSetRequestV1Dot2
6.2.19: LbListenerShowResponse
6.2.20: LbServerGroup
6.2.21: LbServerGroupCreate
6.2.22: LbServerGroupCreateRequest
6.2.23: LbServerGroupList
6.2.24: LbServerGroupListResponse
6.2.25: LbServerGroupSet
6.2.26: LbServerGroupSetRequest
6.2.27: LbServerGroupShowResponse
6.2.28: ListenerForCreate
6.2.29: ListenerForList
6.2.30: ListenerForSet
6.2.31: ListenerForShow
6.2.32: Loadbalancer
6.2.33: LoadbalancerCreateRequest
6.2.34: LoadbalancerCreateRequestDetail
6.2.35: LoadbalancerCreateResponse
6.2.36: LoadbalancerCreateResponseDetail
6.2.37: LoadbalancerListResponse
6.2.38: LoadbalancerListResponseDetail
6.2.39: LoadbalancerShowResponse
6.2.40: LoadbalancerStaticNatResponse
6.2.41: LoadbalancerUpdateRequest
6.2.42: LoadbalancerUpdateRequestDetail
6.2.43: Member
6.2.44: MemberCreateRequestV1Dot1
6.2.45: MemberDeleteBulkRequestV1Dot2
6.2.46: MemberListCreateRequestV1Dot1
6.2.47: MemberListResponse
6.2.48: MemberSet
6.2.49: MemberSetRequest
6.2.50: MemberShowResponse
6.2.51: MemberWithHealthState
6.2.52: MemberWithHealthStateListResponse
6.2.53: SniCertificate
6.2.54: SslCertificate
6.2.55: StaticNat
6.2.56: StaticNatCreateRequest
6.2.57: StaticNatCreateRequestDetail
6.2.58: StaticNatCreateResponse
6.2.59: StaticNatCreateResponseDetail
6.2.60: Tag

7: Security Group

7.1: APIs

7.1.1: Create Security Group

7.1.1.1: 1.0

7.1.2: Create Security Group Rule

7.1.2.1: 1.0

7.1.3: Delete Security Group

7.1.3.1: 1.0

7.1.4: Delete Security Group Rule

7.1.4.1: 1.0

7.1.5: List Security Group Rules

7.1.5.1: 1.0

7.1.6: List Security Groups

7.1.6.1: 1.0

7.1.7: Set Security Group

7.1.7.1: 1.0

7.1.8: Show Security Group

7.1.8.1: 1.0

7.1.9: Show Security Group Rule

7.1.9.1: 1.0

7.2: Models

7.2.1: SecurityGroup
7.2.2: SecurityGroupCreateRequest
7.2.3: SecurityGroupListResponse
7.2.4: SecurityGroupRule
7.2.5: SecurityGroupRuleCreateRequest
7.2.6: SecurityGroupRuleListResponse
7.2.7: SecurityGroupRuleShowResponse
7.2.8: SecurityGroupSetRequest
7.2.9: SecurityGroupShowResponse
7.2.10: Tag

8: VPC

8.1: APIs

8.1.1: Approval VPC Peering

8.1.1.1: 1.1

8.1.2: Approve PrivateLink Endpoint

8.1.2.1: 1.1

8.1.3: Connect PrivateLink Endpoint

8.1.3.1: 1.1

8.1.4: Create Internet Gateway

8.1.4.1: 1.1
8.1.4.2: 1.0

8.1.5: Create NAT Gateway

8.1.5.1: 1.1
8.1.5.2: 1.0

8.1.6: Create Port

8.1.6.1: 1.1
8.1.6.2: 1.0

8.1.7: Create Private NAT

8.1.7.1: 1.1
8.1.7.2: 1.0

8.1.8: Create Private NAT IP

8.1.8.1: 1.1
8.1.8.2: 1.0

8.1.9: Create PrivateLink Endpoint

8.1.9.1: 1.1

8.1.10: Create PrivateLink Service

8.1.10.1: 1.1

8.1.11: Create PublicIP

8.1.11.1: 1.1
8.1.11.2: 1.0

8.1.12: Create Subnet

8.1.12.1: 1.1
8.1.12.2: 1.0

8.1.13: Create Transit Gateway

8.1.13.1: 1.1
8.1.13.2: 1.0

8.1.14: Create Transit Gateway Rule

8.1.14.1: 1.1
8.1.14.2: 1.0

8.1.15: Create Transit Gateway VPC Connection

8.1.15.1: 1.1
8.1.15.2: 1.0

8.1.16: Create VPC

8.1.16.1: 1.1
8.1.16.2: 1.0

8.1.17: Create VPC Endpoint

8.1.17.1: 1.1
8.1.17.2: 1.0

8.1.18: Create VPC Peering

8.1.18.1: 1.1
8.1.18.2: 1.0

8.1.19: Create Vpc Peering Rule

8.1.19.1: 1.1
8.1.19.2: 1.0

8.1.20: Delete Internet Gateway

8.1.20.1: 1.1
8.1.20.2: 1.0

8.1.21: Delete NAT Gateway

8.1.21.1: 1.1
8.1.21.2: 1.0

8.1.22: Delete Port

8.1.22.1: 1.1
8.1.22.2: 1.0

8.1.23: Delete Private NAT

8.1.23.1: 1.1
8.1.23.2: 1.0

8.1.24: Delete Private NAT IP

8.1.24.1: 1.1
8.1.24.2: 1.0

8.1.25: Delete PrivateLink Endpoint

8.1.25.1: 1.1

8.1.26: Delete PrivateLink Service

8.1.26.1: 1.1

8.1.27: Delete PublicIP

8.1.27.1: 1.1
8.1.27.2: 1.0

8.1.28: Delete Subnet

8.1.28.1: 1.1
8.1.28.2: 1.0

8.1.29: Delete Transit Gateway

8.1.29.1: 1.1
8.1.29.2: 1.0

8.1.30: Delete Transit Gateway Rule

8.1.30.1: 1.1
8.1.30.2: 1.0

8.1.31: Delete Transit Gateway VPC Connection

8.1.31.1: 1.1
8.1.31.2: 1.0

8.1.32: Delete VPC

8.1.32.1: 1.1
8.1.32.2: 1.0

8.1.33: Delete VPC Endpoint

8.1.33.1: 1.1
8.1.33.2: 1.0

8.1.34: Delete VPC Peering

8.1.34.1: 1.1
8.1.34.2: 1.0

8.1.35: Delete VPC Peering Rule

8.1.35.1: 1.1
8.1.35.2: 1.0

8.1.36: List Connected PrivateLink Endpoints

8.1.36.1: 1.1

8.1.37: List Internet Gateways

8.1.37.1: 1.1
8.1.37.2: 1.0

8.1.38: List NAT Gateways

8.1.38.1: 1.1
8.1.38.2: 1.0

8.1.39: List Ports

8.1.39.1: 1.1
8.1.39.2: 1.0

8.1.40: List Private NAT

8.1.40.1: 1.1
8.1.40.2: 1.0

8.1.41: List Private NAT IP

8.1.41.1: 1.1
8.1.41.2: 1.0

8.1.42: List PrivateLink Endpoint

8.1.42.1: 1.1

8.1.43: List PrivateLink Service

8.1.43.1: 1.1

8.1.44: List PublicIPs

8.1.44.1: 1.1
8.1.44.2: 1.0

8.1.45: List SAP Secondary Subnets

8.1.45.1: 1.1

8.1.46: List Subnets

8.1.46.1: 1.1
8.1.46.2: 1.0

8.1.47: List Transit Gateway Rules

8.1.47.1: 1.1
8.1.47.2: 1.0

8.1.48: List Transit Gateway VPC Connections

8.1.48.1: 1.1
8.1.48.2: 1.0

8.1.49: List Transit Gateways

8.1.49.1: 1.1
8.1.49.2: 1.0

8.1.50: List VPC Endpoint

8.1.50.1: 1.1
8.1.50.2: 1.0

8.1.51: List VPC Endpoint Connectable Resources

8.1.51.1: 1.1
8.1.51.2: 1.0

8.1.52: List VPC Peering

8.1.52.1: 1.1
8.1.52.2: 1.0

8.1.53: List VPC Peering Rules

8.1.53.1: 1.1
8.1.53.2: 1.0

8.1.54: List VPCs

8.1.54.1: 1.1
8.1.54.2: 1.0

8.1.55: Request PrivateLink Endpoint

8.1.55.1: 1.1

8.1.56: Set Internet Gateway

8.1.56.1: 1.1
8.1.56.2: 1.0

8.1.57: Set NAT Gateway

8.1.57.1: 1.1
8.1.57.2: 1.0

8.1.58: Set Port

8.1.58.1: 1.1
8.1.58.2: 1.0

8.1.59: Set Private NAT

8.1.59.1: 1.1
8.1.59.2: 1.0

8.1.60: Set PrivateLink Endpoint

8.1.60.1: 1.1

8.1.61: Set PrivateLink Service

8.1.61.1: 1.1

8.1.62: Set PublicIP

8.1.62.1: 1.1
8.1.62.2: 1.0

8.1.63: Set Subnet

8.1.63.1: 1.1
8.1.63.2: 1.0

8.1.64: Set Transit Gateway

8.1.64.1: 1.1
8.1.64.2: 1.0

8.1.65: Set VPC

8.1.65.1: 1.1
8.1.65.2: 1.0

8.1.66: Set VPC Endpoint

8.1.66.1: 1.1
8.1.66.2: 1.0

8.1.67: Set VPC Peering

8.1.67.1: 1.1
8.1.67.2: 1.0

8.1.68: Show Internet Gateway

8.1.68.1: 1.1
8.1.68.2: 1.0

8.1.69: Show NAT Gateway

8.1.69.1: 1.1
8.1.69.2: 1.0

8.1.70: Show Port

8.1.70.1: 1.1
8.1.70.2: 1.0

8.1.71: Show Private NAT

8.1.71.1: 1.1
8.1.71.2: 1.0

8.1.72: Show PrivateLink Endpoint

8.1.72.1: 1.1

8.1.73: Show PrivateLink Service

8.1.73.1: 1.1

8.1.74: Show PublicIP

8.1.74.1: 1.1
8.1.74.2: 1.0

8.1.75: Show Subnet

8.1.75.1: 1.1
8.1.75.2: 1.0

8.1.76: Show Transit Gateway

8.1.76.1: 1.1
8.1.76.2: 1.0

8.1.77: Show VPC

8.1.77.1: 1.1
8.1.77.2: 1.0

8.1.78: Show VPC Endpoint

8.1.78.1: 1.1
8.1.78.2: 1.0

8.1.79: Show VPC Peering

8.1.79.1: 1.1
8.1.79.2: 1.0

8.2: Models

8.2.1: ConnectedEndpointListResponse
8.2.2: ConnectedPrivateLinkEndpoint
8.2.3: InternetGateway
8.2.4: InternetGatewayCreateRequest
8.2.5: InternetGatewayListResponse
8.2.6: InternetGatewaySetRequest
8.2.7: InternetGatewayShowResponse
8.2.8: NatGateway
8.2.9: NatGatewayCreateRequest
8.2.10: NatGatewayListResponse
8.2.11: NatGatewaySetRequest
8.2.12: NatGatewayShowResponse
8.2.13: Port
8.2.14: PortCreateRequest
8.2.15: PortList
8.2.16: PortListResponse
8.2.17: PortSecurityGroup
8.2.18: PortSetRequest
8.2.19: PortShowResponse
8.2.20: PrivateLinkEndpoint
8.2.21: PrivateLinkEndpointApprovalRequest
8.2.22: PrivateLinkEndpointConnectionRequest
8.2.23: PrivateLinkEndpointCreateRequest
8.2.24: PrivateLinkEndpointDetail
8.2.25: PrivateLinkEndpointListResponse
8.2.26: PrivateLinkEndpointRequest
8.2.27: PrivateLinkEndpointSetRequest
8.2.28: PrivateLinkEndpointShowResponse
8.2.29: PrivateLinkEndpointSummary
8.2.30: PrivateLinkEndpointSummaryShowResponse
8.2.31: PrivateLinkService
8.2.32: PrivateLinkServiceCreateRequest
8.2.33: PrivateLinkServiceDetail
8.2.34: PrivateLinkServiceListResponse
8.2.35: PrivateLinkServiceSetRequest
8.2.36: PrivateLinkServiceShowResponse
8.2.37: PrivateNat
8.2.38: PrivateNatCreateRequest
8.2.39: PrivateNatIp
8.2.40: PrivateNatIpCreateRequest
8.2.41: PrivateNatIpListResponse
8.2.42: PrivateNatIpShowResponse
8.2.43: PrivateNatListResponse
8.2.44: PrivateNatSetRequest
8.2.45: PrivateNatShowResponse
8.2.46: Publicip
8.2.47: PublicipCreateRequest
8.2.48: PublicipListResponse
8.2.49: PublicipSetRequest
8.2.50: PublicipShowResponse
8.2.51: SapSecondarySubnet
8.2.52: SapSecondarySubnetListResponse
8.2.53: Subnet
8.2.54: SubnetCreateRequest
8.2.55: SubnetDetail
8.2.56: SubnetListResponse
8.2.57: SubnetSetRequest
8.2.58: SubnetShowResponse
8.2.59: Tag
8.2.60: TransitGateway
8.2.61: TransitGatewayCreateRequest
8.2.62: TransitGatewayListResponse
8.2.63: TransitGatewayRule
8.2.64: TransitGatewayRuleCreateRequest
8.2.65: TransitGatewayRuleListResponse
8.2.66: TransitGatewayRuleShowResponse
8.2.67: TransitGatewaySetRequest
8.2.68: TransitGatewayShowResponse
8.2.69: TransitGatewayVpcConnection
8.2.70: TransitGatewayVpcConnectionCreateRequest
8.2.71: TransitGatewayVpcConnectionListResponse
8.2.72: TransitGatewayVpcConnectionShowResponse
8.2.73: Vpc
8.2.74: VpcCreateRequest
8.2.75: VpcEndpoint
8.2.76: VpcEndpointConnectableResourceDetail
8.2.77: VpcEndpointConnectableResourceListResponse
8.2.78: VpcEndpointCreateRequest
8.2.79: VpcEndpointListResponse
8.2.80: VpcEndpointSetRequest
8.2.81: VpcEndpointShowResponse
8.2.82: VpcListResponse
8.2.83: VpcPeering
8.2.84: VpcPeeringApprovalRequest
8.2.85: VpcPeeringCreateRequest
8.2.86: VpcPeeringListResponse
8.2.87: VpcPeeringRule
8.2.88: VpcPeeringRuleCreateRequest
8.2.89: VpcPeeringRuleListResponse
8.2.90: VpcPeeringRuleShowResponse
8.2.91: VpcPeeringSetRequest
8.2.92: VpcPeeringShowResponse
8.2.93: VpcSetRequest
8.2.94: VpcShowResponse

9: VPN

9.1: APIs

9.1.1: Create VPN Gateway

9.1.1.1: 1.1
9.1.1.2: 1.0

9.1.2: Create VPN Tunnel

9.1.2.1: 1.1
9.1.2.2: 1.0

9.1.3: Delete VPN Gateway

9.1.3.1: 1.1
9.1.3.2: 1.0

9.1.4: Delete VPN Tunnel

9.1.4.1: 1.1
9.1.4.2: 1.0

9.1.5: List VPN Gateways

9.1.5.1: 1.1
9.1.5.2: 1.0

9.1.6: List VPN Tunnels

9.1.6.1: 1.1
9.1.6.2: 1.0

9.1.7: Set VPN Gateway

9.1.7.1: 1.1
9.1.7.2: 1.0

9.1.8: Set VPN Tunnel

9.1.8.1: 1.1
9.1.8.2: 1.0

9.1.9: Show VPN Gateway

9.1.9.1: 1.1
9.1.9.2: 1.0

9.1.10: Show VPN Tunnel

9.1.10.1: 1.1
9.1.10.2: 1.0

9.2: Models

9.2.1: Tag
9.2.2: VpnGateway
9.2.3: VpnGatewayCreateRequest
9.2.4: VpnGatewayListResponse
9.2.5: VpnGatewaySetRequest
9.2.6: VpnGatewayShowResponse
9.2.7: VpnPhase1
9.2.8: VpnPhase1CreateRequest
9.2.9: VpnPhase1CreateRequestV1Dot1
9.2.10: VpnPhase1Detail
9.2.11: VpnPhase1DetailV1Dot1
9.2.12: VpnPhase1SetRequest
9.2.13: VpnPhase1SetRequestV1Dot1
9.2.14: VpnPhase1V1Dot1
9.2.15: VpnPhase2
9.2.16: VpnPhase2CreateRequest
9.2.17: VpnPhase2CreateRequestV1Dot1
9.2.18: VpnPhase2Detail
9.2.19: VpnPhase2DetailV1Dot1
9.2.20: VpnPhase2SetRequest
9.2.21: VpnPhase2SetRequestV1Dot1
9.2.22: VpnPhase2V1Dot1
9.2.23: VpnTunnel
9.2.24: VpnTunnelCreateRequest
9.2.25: VpnTunnelCreateRequestV1Dot1
9.2.26: VpnTunnelDetail
9.2.27: VpnTunnelDetailV1Dot1
9.2.28: VpnTunnelDetailWithStatus
9.2.29: VpnTunnelDetailWithStatusV1Dot1
9.2.30: VpnTunnelListResponse
9.2.31: VpnTunnelListResponseV1Dot1
9.2.32: VpnTunnelSetRequest
9.2.33: VpnTunnelSetRequestV1Dot1
9.2.34: VpnTunnelShowResponse
9.2.35: VpnTunnelShowResponseV1Dot1
9.2.36: VpnTunnelShowWithStatusResponse
9.2.37: VpnTunnelShowWithStatusResponseV1Dot1
9.2.38: VpnTunnelV1Dot1

1 - Direct Connect

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Direct Connect 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://direct-connect.{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 - Create Direct Connect

1.1.1.1 - 1.0

post /v1/direct-connects

Description

Direct Connect를 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		DirectConnectCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	DirectConnectShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/direct-connects

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = direct-connect 1.0"

Request body

{
    "bandwidth": "",
    "description": "",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "name": "",
    "tags": [],
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "direct_connect": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.1.2 - Create Routing Rule

1.1.2.1 - 1.0

post /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Routing Rule을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example :	string	None
body	body required		RoutingRuleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	RoutingRuleShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = direct-connect 1.0"

Request body

{
    "description": "",
    "destination_cidr": "",
    "destination_resource_id": "",
    "destination_type": "VPC"
}

Example HTTP response

Response 202

{
    "routing_rule": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "destination_cidr": "",
        "destination_resource_id": "",
        "destination_resource_name": "",
        "destination_type": "VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "owner_id": "",
        "owner_type": "INTERNET_GATEWAY",
        "state": "CREATING"
    }
}

1.1.3 - Delete Direct Connect

1.1.3.1 - 1.0

delete /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.0"

Example HTTP response

Response 202

1.1.4 - Delete Routing Rule

1.1.4.1 - 1.0

delete /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id}

Description

Routing Rule을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example :	string	None
path	routing_rule_id required	Routing Rule ID Example :	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/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_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 = direct-connect 1.0"

Example HTTP response

Response 202

1.1.5 - List Direct Connects

1.1.5.1 - 1.0

get /v1/direct-connects

Description

Direct Connect 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Direct Connect ID Example :	string
query	name optional	Direct Connect명 Example :	string
query	state optional	상태 Example :	enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR)
query	vpc_id optional	VPC ID Example :	string
query	vpc_name optional	VPC 명 Example :	string

Responses

HTTP Code	Description	Schema
200	OK	DirectConnectListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/direct-connects

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = direct-connect 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "direct_connects": [
        {
            "account_id": "",
            "bandwidth": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "firewall_id": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "vpc_id": "",
            "vpc_name": ""
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.1.6 - List Routing Rules

1.1.6.1 - 1.0

get /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Routing Rule 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example :	string	None
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Routing Rule ID Example :	any of [string, null]	None
query	destination_type optional	목적지 타입 Example :	enum (VPC, ON_PREMISE)	None
query	destination_cidr optional	목적지 CIDR Example :	any of [string, null]	None
query	state optional	상태 Example :	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)	None

Responses

HTTP Code	Description	Schema
200	OK	RoutingRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = direct-connect 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "routing_rules": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination_cidr": "",
            "destination_resource_id": "",
            "destination_resource_name": "",
            "destination_type": "VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "owner_id": "",
            "owner_type": "INTERNET_GATEWAY",
            "state": "CREATING"
        }
    ]
}

1.1.7 - Set Direct Connect

1.1.7.1 - 1.0

put /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example :	string	None
body	body required		DirectConnectSetRequest

Responses

HTTP Code	Description	Schema
200	OK	DirectConnectShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.1.8 - Show Direct Connect

1.1.8.1 - 1.0

get /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 상세조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	DirectConnectShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.0"

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.2 - Models

1.2.1 - DirectConnect

Name	Description	Schema
account_id required	Account ID Example :	string
bandwidth required	포트용량 Example :	integer
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Direct Connect 설명 Example :	any of [string, null]
firewall_id optional	Firewall ID Example :	any of [string, null]
id required	Direct Connect ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Direct Connect명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR)
vpc_id required	VPC ID Example :	string
vpc_name required	VPC 명 Example :	string

1.2.2 - DirectConnectCreateRequest

Name	Description	Schema
bandwidth required	포트용량 Example :	integer
description optional	Direct Connect 설명 Example : Maximum length : `50`	string
firewall_enabled optional	Firewall 사용 Example : `False`	boolean
firewall_loggable optional	방화벽 로깅 가능 Example : `False`	boolean
name required	Direct Connect명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	태그 목록	array[Tag]
vpc_id required	VPC ID Example :	string

1.2.3 - DirectConnectListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
direct_connects required		array[DirectConnect]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]

1.2.4 - DirectConnectSetRequest

Name	Description	Schema	Default
description required	Direct Connect 설명 Example : Maximum length : `50`	string

1.2.5 - DirectConnectShowResponse

Name	Description	Schema	Default
direct_connect required		DirectConnect

1.2.6 - RoutingRule

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	설명 Example :	string
destination_cidr required	목적지 CIDR Example :	string
destination_resource_id required	목적지 자원 ID Example :	any of [string, null]
destination_resource_name optional	목적지 자원명 Example :	any of [string, null]
destination_type required	목적지 타입 Example : `VPC`	enum (VPC, ON_PREMISE, INTERNET, TGW)
id required	Routing Rule ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
owner_id required	Routing Rule 소유자 ID Example :	string
owner_type required	Routing Rule 소유자 타입 Example : `INTERNET_GATEWAY`	enum (INTERNET_GATEWAY, GROUP_GATEWAY, DIRECT_CONNECT, SUBNET, PRIVATE_NAT, TRANSIT_GATEWAY, VPC_PEERING, SECURE_INTERNET_GATEWAY)
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)

1.2.7 - RoutingRuleCreateRequest

Name	Description	Schema
description optional	설명 Example : Maximum length : `50`	string
destination_cidr required	목적지 CIDR Example :	string
destination_resource_id optional	목적지 자원 ID Example :	any of [string, null]
destination_type required	목적지 타입 Example : `VPC`	enum (VPC, ON_PREMISE)

1.2.8 - RoutingRuleListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
routing_rules required		array[RoutingRule]

1.2.9 - RoutingRuleShowResponse

Name	Description	Schema	Default
routing_rule required		RoutingRule

1.2.10 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

2 - DNS

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 DNS 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	DEPRECATED	20260331
1.2	DEPRECATED	20260331
1.3	CURRENT	-

OpenAPI URL

https://dns.{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 - Activate Private DNS

2.1.1.1 - 1.3

post /v1/private-dns/activate

Description

Activate Private DNS

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsActivateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/activate

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"

Request body

{
    "name": "private-dns01"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.1.2 - 1.2

post /v1/private-dns/activate

Description

Activate Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsActivateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/activate

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"

Request body

{
    "name": "private-dns01"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.1.3 - 1.1

post /v1/private-dns/activate

Description

Activate Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsActivateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/activate

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"

Request body

{
    "name": "private-dns01"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.1.4 - 1.0

post /v1/private-dns/activate

Description

Activate Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsActivateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/activate

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"

Request body

{
    "name": "private-dns01"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.2 - Create Hosted Zone

2.1.2.1 - 1.3

post /v1/hosted-zones

Description

Create a new hosted zone.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		HostedZoneCreateRequestV1Dot3

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneShowResponseV1Dot3
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"

Request body

{
    "description": "This is description",
    "name": "my-zone.com",
    "private_dns_id": "",
    "tags": [],
    "type": "public"
}

Example HTTP response

Response 202

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "private_dns_name": "private-dns01",
    "status": "CREATING",
    "ttl": "3600"
}

2.1.2.2 - 1.2

post /v1/hosted-zones

Description

Create a new hosted zone.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		HostedZoneCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneShowResponseV1Dot2
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"

Request body

{
    "description": "",
    "email": "",
    "name": "",
    "private_dns_id": "",
    "tags": [],
    "type": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "private_dns_id": "",
    "private_dns_name": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.2.3 - 1.1

post /v1/hosted-zones

Description

Create a new hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		HostedZoneCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneCreateResponse
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"

Request body

{
    "description": "",
    "email": "",
    "name": "",
    "tags": [],
    "type": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.2.4 - 1.0

post /v1/hosted-zones

Description

Create a new hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		HostedZoneCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneCreateResponse
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"

Request body

{
    "description": "",
    "email": "",
    "name": "",
    "tags": [],
    "type": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.3 - Create Hosted Zone Record

2.1.3.1 - 1.3

post /v1/hosted-zones/{hosted_zone_id}/records

Description

Create a new recordset in the hosted zone

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
body	body required		RecordCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"

Request body

{
    "description": "",
    "name": "",
    "records": [
        {}
    ],
    "ttl": "",
    "type": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.4 - Create Private DNS

2.1.4.1 - 1.3

post /v1/private-dns

Description

Create Private DNS

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-dns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"

Request body

{
    "connected_vpc_ids": [],
    "description": "This is description",
    "name": "private-dns01",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.4.2 - 1.2

post /v1/private-dns

Description

Create Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-dns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"

Request body

{
    "connected_vpc_ids": [],
    "description": "This is description",
    "name": "private-dns01",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.4.3 - 1.1

post /v1/private-dns

Description

Create Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-dns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"

Request body

{
    "connected_vpc_ids": [],
    "description": "This is description",
    "name": "private-dns01",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.4.4 - 1.0

post /v1/private-dns

Description

Create Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-dns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"

Request body

{
    "connected_vpc_ids": [],
    "description": "This is description",
    "name": "private-dns01",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.5 - Create Public Domain

2.1.5.1 - 1.2

post /v1/public-domain-names

Description

Create a new Public Domain record

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		CreatePublicDomainRequest

Responses

HTTP Code	Description	Schema
201	Created	CreatePublicDomainResponse

Example HTTP request

Request path

/v1/public-domain-names

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"

Request body

{
    "address_type": "",
    "auto_extension": true,
    "description": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "name": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_name_en": "",
    "register_name_ko": "",
    "register_telno": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "public_domain_name": {
        "address_type": "",
        "auto_extension": "",
        "created_at": "",
        "created_by": "",
        "description": "",
        "domestic_address_en": "",
        "domestic_address_ko": "",
        "domestic_first_address_en": "",
        "domestic_first_address_ko": "",
        "domestic_second_address_en": "",
        "domestic_second_address_ko": "",
        "expired_date": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "overseas_address": "",
        "overseas_first_address": "",
        "overseas_second_address": "",
        "overseas_third_address": "",
        "postal_code": "",
        "register_email": "",
        "register_name_en": "",
        "register_name_ko": "",
        "register_telno": "",
        "start_date": "",
        "status": ""
    }
}

2.1.5.2 - 1.1

post /v1/public-domain-names

Description

Create a new Public Domain record

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		CreatePublicDomainRequest

Responses

HTTP Code	Description	Schema
201	Created	CreatePublicDomainResponse

Example HTTP request

Request path

/v1/public-domain-names

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"

Request body

{
    "address_type": "",
    "auto_extension": true,
    "description": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "name": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_name_en": "",
    "register_name_ko": "",
    "register_telno": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "public_domain_name": {
        "address_type": "",
        "auto_extension": "",
        "created_at": "",
        "created_by": "",
        "description": "",
        "domestic_address_en": "",
        "domestic_address_ko": "",
        "domestic_first_address_en": "",
        "domestic_first_address_ko": "",
        "domestic_second_address_en": "",
        "domestic_second_address_ko": "",
        "expired_date": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "overseas_address": "",
        "overseas_first_address": "",
        "overseas_second_address": "",
        "overseas_third_address": "",
        "postal_code": "",
        "register_email": "",
        "register_name_en": "",
        "register_name_ko": "",
        "register_telno": "",
        "start_date": "",
        "status": ""
    }
}

2.1.5.3 - 1.0

post /v1/public-domain-names

Description

Create a new Public Domain record

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		CreatePublicDomainRequest

Responses

HTTP Code	Description	Schema
201	Created	CreatePublicDomainResponse

Example HTTP request

Request path

/v1/public-domain-names

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"

Request body

{
    "address_type": "",
    "auto_extension": true,
    "description": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "name": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_name_en": "",
    "register_name_ko": "",
    "register_telno": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "public_domain_name": {
        "address_type": "",
        "auto_extension": "",
        "created_at": "",
        "created_by": "",
        "description": "",
        "domestic_address_en": "",
        "domestic_address_ko": "",
        "domestic_first_address_en": "",
        "domestic_first_address_ko": "",
        "domestic_second_address_en": "",
        "domestic_second_address_ko": "",
        "expired_date": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "overseas_address": "",
        "overseas_first_address": "",
        "overseas_second_address": "",
        "overseas_third_address": "",
        "postal_code": "",
        "register_email": "",
        "register_name_en": "",
        "register_name_ko": "",
        "register_telno": "",
        "start_date": "",
        "status": ""
    }
}

2.1.6 - Create Public Domain Name

2.1.6.1 - 1.3

post /v1/public-domain-names

Description

Create a new Public Domain Name

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		CreatePublicDomainRequest

Responses

HTTP Code	Description	Schema
201	Created	CreatePublicDomainResponse

Example HTTP request

Request path

/v1/public-domain-names

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"

Request body

{
    "address_type": "",
    "auto_extension": true,
    "description": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "name": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_name_en": "",
    "register_name_ko": "",
    "register_telno": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "public_domain_name": {
        "address_type": "",
        "auto_extension": "",
        "created_at": "",
        "created_by": "",
        "description": "",
        "domestic_address_en": "",
        "domestic_address_ko": "",
        "domestic_first_address_en": "",
        "domestic_first_address_ko": "",
        "domestic_second_address_en": "",
        "domestic_second_address_ko": "",
        "expired_date": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "overseas_address": "",
        "overseas_first_address": "",
        "overseas_second_address": "",
        "overseas_third_address": "",
        "postal_code": "",
        "register_email": "",
        "register_name_en": "",
        "register_name_ko": "",
        "register_telno": "",
        "start_date": "",
        "status": ""
    }
}

2.1.7 - Create Record

2.1.7.1 - 1.2

post /v1/hosted-zones/{hosted_zone_id}/records

Description

Create a new recordset in the hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
body	body required		RecordCreateRequestV1Dot0To1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"

Request body

{
    "description": "",
    "name": "",
    "records": [
        {}
    ],
    "ttl": "",
    "type": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.7.2 - 1.1

post /v1/hosted-zones/{hosted_zone_id}/records

Description

Create a new recordset in the hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
body	body required		RecordCreateRequestV1Dot0To1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"

Request body

{
    "description": "",
    "name": "",
    "records": [
        {}
    ],
    "ttl": "",
    "type": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.7.3 - 1.0

post /v1/hosted-zones/{hosted_zone_id}/records

Description

Create a new recordset in the hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
body	body required		RecordCreateRequestV1Dot0To1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"

Request body

{
    "description": "",
    "name": "",
    "records": [
        {}
    ],
    "ttl": "",
    "type": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.8 - Delete Hosted Zone

2.1.8.1 - 1.3

delete /v1/hosted-zones/{hosted_zone_id}

Description

Delete a hosted zone

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.3"

Example HTTP response

Response 202

2.1.8.2 - 1.2

delete /v1/hosted-zones/{hosted_zone_id}

Description

Delete a hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneShowResponseV1Dot2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.2"

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "private_dns_id": "",
    "private_dns_name": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.8.3 - 1.1

delete /v1/hosted-zones/{hosted_zone_id}

Description

Delete a hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneDeleteResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.1"

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.8.4 - 1.0

delete /v1/hosted-zones/{hosted_zone_id}

Description

Delete a hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneDeleteResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.0"

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.9 - Delete Hosted Zone Record

2.1.9.1 - 1.3

delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Delete hosted zone record

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.3"

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.10 - Delete Private DNS

2.1.10.1 - 1.3

delete /v1/private-dns/{private_dns_id}

Description

Delete Private DNS

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.3"

Example HTTP response

Response 202

2.1.10.2 - 1.2

delete /v1/private-dns/{private_dns_id}

Description

Delete Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.2"

Example HTTP response

Response 202

2.1.10.3 - 1.1

delete /v1/private-dns/{private_dns_id}

Description

Delete Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.1"

Example HTTP response

Response 202

2.1.10.4 - 1.0

delete /v1/private-dns/{private_dns_id}

Description

Delete Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.0"

Example HTTP response

Response 202

2.1.11 - Delete Record

2.1.11.1 - 1.2

delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Delete a recordset

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.2"

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.11.2 - 1.1

delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Delete a recordset

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.1"

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.11.3 - 1.0

delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Delete a recordset

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.0"

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.12 - Get Public Domain Detail

2.1.12.1 - 1.2

get /v1/public-domain-names/{public_domain_id}

Description

Retrieve detailed information for a specific public domain by ID

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainDetailResponse

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.2"

Example HTTP response

Response 200

{
    "public_domain_name": {
        "address_type": "",
        "auto_extension": "",
        "created_at": "",
        "created_by": "",
        "description": "",
        "domestic_address_en": "",
        "domestic_address_ko": "",
        "domestic_first_address_en": "",
        "domestic_first_address_ko": "",
        "domestic_second_address_en": "",
        "domestic_second_address_ko": "",
        "expired_date": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "overseas_address": "",
        "overseas_first_address": "",
        "overseas_second_address": "",
        "overseas_third_address": "",
        "postal_code": "",
        "register_email": "",
        "register_name_en": "",
        "register_name_ko": "",
        "register_telno": "",
        "start_date": "",
        "status": ""
    }
}

2.1.12.2 - 1.1

get /v1/public-domain-names/{public_domain_id}

Description

Retrieve detailed information for a specific public domain by ID

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainDetailResponse

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.1"

Example HTTP response

Response 200

{
    "public_domain_name": {
        "address_type": "",
        "auto_extension": "",
        "created_at": "",
        "created_by": "",
        "description": "",
        "domestic_address_en": "",
        "domestic_address_ko": "",
        "domestic_first_address_en": "",
        "domestic_first_address_ko": "",
        "domestic_second_address_en": "",
        "domestic_second_address_ko": "",
        "expired_date": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "overseas_address": "",
        "overseas_first_address": "",
        "overseas_second_address": "",
        "overseas_third_address": "",
        "postal_code": "",
        "register_email": "",
        "register_name_en": "",
        "register_name_ko": "",
        "register_telno": "",
        "start_date": "",
        "status": ""
    }
}

2.1.12.3 - 1.0

get /v1/public-domain-names/{public_domain_id}

Description

Retrieve detailed information for a specific public domain by ID

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainDetailResponse

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.0"

Example HTTP response

Response 200

{
    "public_domain_name": {
        "address_type": "",
        "auto_extension": "",
        "created_at": "",
        "created_by": "",
        "description": "",
        "domestic_address_en": "",
        "domestic_address_ko": "",
        "domestic_first_address_en": "",
        "domestic_first_address_ko": "",
        "domestic_second_address_en": "",
        "domestic_second_address_ko": "",
        "expired_date": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "overseas_address": "",
        "overseas_first_address": "",
        "overseas_second_address": "",
        "overseas_third_address": "",
        "postal_code": "",
        "register_email": "",
        "register_name_en": "",
        "register_name_ko": "",
        "register_telno": "",
        "start_date": "",
        "status": ""
    }
}

2.1.13 - List Hosted Zone Records

2.1.13.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}/records

Description

Get record list in a hosted zone

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
query	limit optional	limit Example :	any of [integer, null]	None
query	marker optional	marker Example :	any of [string, null]	None
query	sort_dir optional	sort direction Example :	any of [string, null]	None
query	sort_key optional	sort key Example :	any of [string, null]	None
query	name optional	name Example :	any of [string, null]	None
query	exact_name optional	name Example :	any of [string, null]	None
query	type optional	Type of the record Example :	any of [string, null]	None
query	data optional	Record data Example :	any of [string, null]	None
query	status optional	The status Example :	any of [string, null]	None
query	description optional	description Example :	any of [string, null]	None
query	ttl optional	TTL for the zone. Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RecordListResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "links": "",
    "metadata": "",
    "records": [
        {
            "action": "",
            "created_at": "",
            "description": "",
            "id": "",
            "links": "",
            "name": "",
            "project_id": "",
            "records": [
                ""
            ],
            "status": "",
            "ttl": "",
            "type": "",
            "updated_at": "",
            "version": "",
            "zone_id": "",
            "zone_name": ""
        }
    ]
}

2.1.14 - List Hosted Zones

2.1.14.1 - 1.3

get /v1/hosted-zones

Description

Return list of hosted zones

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

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	name optional	name Example : `my-zone.com`	any of [string, null]	None
query	type optional	Type of zone Example :	any of [enum (public, private), null]	None
query	status optional	The status Example :	any of [enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN), null]	None

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneListResponseV1Dot3
403	Forbidden	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "hosted_zones": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "hosted_zone_type": "public",
            "id": "3432012nfdksdf03ktrld9234lgfg",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "my-zone.com",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "private_dns_id": "10fjkewefprivatedns3193rud543",
            "private_dns_name": "private-dns01",
            "status": "CREATING",
            "ttl": "3600"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.14.2 - 1.2

get /v1/hosted-zones

Description

Return list of hosted zones

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
query	name optional	name Example :	any of [string, null]	None
query	exact_name optional	name Example :	any of [string, null]	None
query	type optional	Type of zone Example :	any of [string, null]	None
query	email optional	email Example :	any of [string, null]	None
query	status optional	The status Example :	any of [string, null]	None
query	description optional	description Example :	any of [string, null]	None
query	ttl optional	TTL for the zone. Example :	any of [integer, null]	None
query	page optional	Page Example : `0`	any of [integer, null]	0
query	size optional	Size Example : `20`	any of [integer, null]	20
query	sort optional	Sort Example : `name:asc`	any of [string, null]	name:asc

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneListResponseV1Dot2
403	Forbidden	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"

Example HTTP response

Response 200

{
    "count": "",
    "hosted_zones": [
        {
            "action": "",
            "attributes": "",
            "created_at": "",
            "description": "",
            "email": "",
            "hosted_zone_type": "",
            "id": "",
            "links": "",
            "masters": [
                ""
            ],
            "name": "",
            "pool_id": "",
            "private_dns_id": "",
            "private_dns_name": "",
            "project_id": "",
            "serial": "",
            "shared": "",
            "status": "",
            "transferred_at": "",
            "ttl": "",
            "type": "",
            "updated_at": "",
            "version": ""
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "page": "",
    "size": "",
    "sort": ""
}

2.1.14.3 - 1.1

get /v1/hosted-zones

Description

Return list of hosted zones

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
query	name optional	name Example :	any of [string, null]	None
query	exact_name optional	name Example :	any of [string, null]	None
query	type optional	Type of zone Example :	any of [string, null]	None
query	email optional	email Example :	any of [string, null]	None
query	status optional	The status Example :	any of [string, null]	None
query	description optional	description Example :	any of [string, null]	None
query	ttl optional	TTL for the zone. Example :	any of [integer, null]	None
query	page optional	Page Example : `0`	any of [integer, null]	0
query	size optional	Size Example : `20`	any of [integer, null]	20
query	sort optional	Sort Example : `name:asc`	any of [string, null]	name:asc

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneListResponseV1Dot1
403	Forbidden	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"

Example HTTP response

Response 200

{
    "count": "",
    "hosted_zones": [
        {
            "action": "",
            "attributes": "",
            "created_at": "",
            "description": "",
            "email": "",
            "hosted_zone_type": "",
            "id": "",
            "links": "",
            "masters": [
                ""
            ],
            "name": "",
            "pool_id": "",
            "project_id": "",
            "serial": "",
            "shared": "",
            "status": "",
            "transferred_at": "",
            "ttl": "",
            "type": "",
            "updated_at": "",
            "version": ""
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "page": "",
    "size": "",
    "sort": ""
}

2.1.14.4 - 1.0

get /v1/hosted-zones

Description

Return list of hosted zones

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	limit optional	limit Example :	any of [integer, null]	None
query	marker optional	marker Example :	any of [string, null]	None
query	sort_dir optional	sort direction Example :	any of [string, null]	None
query	sort_key optional	sort key Example :	any of [string, null]	None
query	name optional	name Example :	any of [string, null]	None
query	exact_name optional	name Example :	any of [string, null]	None
query	type optional	Type of zone Example :	any of [string, null]	None
query	email optional	email Example :	any of [string, null]	None
query	status optional	The status Example :	any of [string, null]	None
query	description optional	description Example :	any of [string, null]	None
query	ttl optional	TTL for the zone. Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneListResponse
403	Forbidden	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": "",
    "metadata": "",
    "zones": [
        {
            "action": "",
            "attributes": "",
            "created_at": "",
            "description": "",
            "email": "",
            "hosted_zone_type": "",
            "id": "",
            "links": "",
            "masters": [
                ""
            ],
            "name": "",
            "pool_id": "",
            "project_id": "",
            "serial": "",
            "shared": "",
            "status": "",
            "transferred_at": "",
            "ttl": "",
            "type": "",
            "updated_at": "",
            "version": ""
        }
    ]
}

2.1.15 - List Private DNS

2.1.15.1 - 1.3

get /v1/private-dns

Description

List all Private DNS

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

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	id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]	None
query	name optional	Private DNS Name Example :	any of [string, null]	None
query	vpc_id optional	Connected VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateDnsListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-dns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_dns": [
        {
            "auth_dns_name": "",
            "connected_vpc_ids": [
                ""
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "id": "10fjkewefprivatedns3193rud543",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "private-dns01",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "pool_name": "",
            "registered_region": "KR-WEST1",
            "resolver_ip": "198.19.0.101",
            "resolver_name": "",
            "state": "CREATING"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.15.2 - 1.2

get /v1/private-dns

Description

List all Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

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	id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]	None
query	name optional	Private DNS Name Example :	any of [string, null]	None
query	vpc_id optional	Connected VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateDnsListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-dns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_dns": [
        {
            "auth_dns_name": "",
            "connected_vpc_ids": [
                ""
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "id": "10fjkewefprivatedns3193rud543",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "private-dns01",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "pool_name": "",
            "registered_region": "KR-WEST1",
            "resolver_ip": "198.19.0.101",
            "resolver_name": "",
            "state": "CREATING"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.15.3 - 1.1

get /v1/private-dns

Description

List all Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

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	id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]	None
query	name optional	Private DNS Name Example :	any of [string, null]	None
query	vpc_id optional	Connected VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateDnsListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-dns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_dns": [
        {
            "auth_dns_name": "",
            "connected_vpc_ids": [
                ""
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "id": "10fjkewefprivatedns3193rud543",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "private-dns01",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "pool_name": "",
            "registered_region": "KR-WEST1",
            "resolver_ip": "198.19.0.101",
            "resolver_name": "",
            "state": "CREATING"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.15.4 - 1.0

get /v1/private-dns

Description

List all Private DNS

상태 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	id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]	None
query	name optional	Private DNS Name Example :	any of [string, null]	None
query	vpc_id optional	Connected VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateDnsListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-dns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_dns": [
        {
            "auth_dns_name": "",
            "connected_vpc_ids": [
                ""
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "id": "10fjkewefprivatedns3193rud543",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "private-dns01",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "pool_name": "",
            "registered_region": "KR-WEST1",
            "resolver_ip": "198.19.0.101",
            "resolver_name": "",
            "state": "CREATING"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.16 - List Public Domain Names

2.1.16.1 - 1.3

get /v1/public-domain-names

Description

Return list of Public Domain Names

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

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	name optional	name Example :	any of [string, null]	None
query	created_by optional	Created By_ Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainListResponse

Example HTTP request

Request path

/v1/public-domain-names

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "public_domain_names": [
        {
            "created_at": "",
            "created_by": "",
            "expired_date": "",
            "id": "",
            "modified_at": "",
            "modified_by": "",
            "name": "",
            "register_email": "",
            "start_date": "",
            "status": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.17 - List Public Domains

2.1.17.1 - 1.2

get /v1/public-domain-names

Description

List all Public Domains

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

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	name optional	name Example :	any of [string, null]	None
query	created_by optional	Created By_ Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainListResponse

Example HTTP request

Request path

/v1/public-domain-names

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "public_domain_names": [
        {
            "created_at": "",
            "created_by": "",
            "expired_date": "",
            "id": "",
            "modified_at": "",
            "modified_by": "",
            "name": "",
            "register_email": "",
            "start_date": "",
            "status": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.17.2 - 1.1

get /v1/public-domain-names

Description

List all Public Domains

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

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	name optional	name Example :	any of [string, null]	None
query	created_by optional	Created By_ Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainListResponse

Example HTTP request

Request path

/v1/public-domain-names

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "public_domain_names": [
        {
            "created_at": "",
            "created_by": "",
            "expired_date": "",
            "id": "",
            "modified_at": "",
            "modified_by": "",
            "name": "",
            "register_email": "",
            "start_date": "",
            "status": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.17.3 - 1.0

get /v1/public-domain-names

Description

List all Public Domains

상태 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	name optional	name Example :	any of [string, null]	None
query	created_by optional	Created By_ Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainListResponse

Example HTTP request

Request path

/v1/public-domain-names

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "public_domain_names": [
        {
            "created_at": "",
            "created_by": "",
            "expired_date": "",
            "id": "",
            "modified_at": "",
            "modified_by": "",
            "name": "",
            "register_email": "",
            "start_date": "",
            "status": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.18 - List Records

2.1.18.1 - 1.2

get /v1/hosted-zones/{hosted_zone_id}/records

Description

Get recordset list in a hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
query	limit optional	limit Example :	any of [integer, null]	None
query	marker optional	marker Example :	any of [string, null]	None
query	sort_dir optional	sort direction Example :	any of [string, null]	None
query	sort_key optional	sort key Example :	any of [string, null]	None
query	name optional	name Example :	any of [string, null]	None
query	exact_name optional	name Example :	any of [string, null]	None
query	type optional	Type of the record Example :	any of [string, null]	None
query	data optional	Record data Example :	any of [string, null]	None
query	status optional	The status Example :	any of [string, null]	None
query	description optional	description Example :	any of [string, null]	None
query	ttl optional	TTL for the zone. Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RecordListResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "links": "",
    "metadata": "",
    "records": [
        {
            "action": "",
            "created_at": "",
            "description": "",
            "id": "",
            "links": "",
            "name": "",
            "project_id": "",
            "records": [
                ""
            ],
            "status": "",
            "ttl": "",
            "type": "",
            "updated_at": "",
            "version": "",
            "zone_id": "",
            "zone_name": ""
        }
    ]
}

2.1.18.2 - 1.1

get /v1/hosted-zones/{hosted_zone_id}/records

Description

Get recordset list in a hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
query	limit optional	limit Example :	any of [integer, null]	None
query	marker optional	marker Example :	any of [string, null]	None
query	sort_dir optional	sort direction Example :	any of [string, null]	None
query	sort_key optional	sort key Example :	any of [string, null]	None
query	name optional	name Example :	any of [string, null]	None
query	exact_name optional	name Example :	any of [string, null]	None
query	type optional	Type of the record Example :	any of [string, null]	None
query	data optional	Record data Example :	any of [string, null]	None
query	status optional	The status Example :	any of [string, null]	None
query	description optional	description Example :	any of [string, null]	None
query	ttl optional	TTL for the zone. Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RecordListResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": "",
    "metadata": "",
    "records": [
        {
            "action": "",
            "created_at": "",
            "description": "",
            "id": "",
            "links": "",
            "name": "",
            "project_id": "",
            "records": [
                ""
            ],
            "status": "",
            "ttl": "",
            "type": "",
            "updated_at": "",
            "version": "",
            "zone_id": "",
            "zone_name": ""
        }
    ]
}

2.1.18.3 - 1.0

get /v1/hosted-zones/{hosted_zone_id}/records

Description

Get recordset list in a hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
query	limit optional	limit Example :	any of [integer, null]	None
query	marker optional	marker Example :	any of [string, null]	None
query	sort_dir optional	sort direction Example :	any of [string, null]	None
query	sort_key optional	sort key Example :	any of [string, null]	None
query	name optional	name Example :	any of [string, null]	None
query	exact_name optional	name Example :	any of [string, null]	None
query	type optional	Type of the record Example :	any of [string, null]	None
query	data optional	Record data Example :	any of [string, null]	None
query	status optional	The status Example :	any of [string, null]	None
query	description optional	description Example :	any of [string, null]	None
query	ttl optional	TTL for the zone. Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RecordListResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": "",
    "metadata": "",
    "records": [
        {
            "action": "",
            "created_at": "",
            "description": "",
            "id": "",
            "links": "",
            "name": "",
            "project_id": "",
            "records": [
                ""
            ],
            "status": "",
            "ttl": "",
            "type": "",
            "updated_at": "",
            "version": "",
            "zone_id": "",
            "zone_name": ""
        }
    ]
}

2.1.19 - Set Hosted Zone Record

2.1.19.1 - 1.3

put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Update Hosted Zone record

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None
body	body required		RecordSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	RecordSetResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.3"

Request body

{
    "records": "",
    "ttl": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.20 - Set Private DNS

2.1.20.1 - 1.3

put /v1/private-dns/{private_dns_id}

Description

Update Private DNS

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None
body	body required		PrivateDnsSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.3"

Request body

{
    "connected_vpc_ids": [
        ""
    ],
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.20.2 - 1.2

put /v1/private-dns/{private_dns_id}

Description

Update Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None
body	body required		PrivateDnsSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.2"

Request body

{
    "connected_vpc_ids": [
        ""
    ],
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.20.3 - 1.1

put /v1/private-dns/{private_dns_id}

Description

Update Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None
body	body required		PrivateDnsSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.1"

Request body

{
    "connected_vpc_ids": [
        ""
    ],
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.20.4 - 1.0

put /v1/private-dns/{private_dns_id}

Description

Update Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None
body	body required		PrivateDnsSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateDnsShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.0"

Request body

{
    "connected_vpc_ids": [
        ""
    ],
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.21 - Set Public Domain Name

2.1.21.1 - 1.3

put /v1/public-domain-names/{public_domain_id}

Description

Update Public Domain Name

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None
body	body required		PublicDomainPartialUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainPartialUpdateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.3"

Request body

{
    "auto_extension": "",
    "description": ""
}

Example HTTP response

Response 200

{
    "auto_extension": "",
    "description": "",
    "id": ""
}

2.1.22 - Set Public Domain Name Whois Info

2.1.22.1 - 1.3

put /v1/public-domain-names/{public_domain_id}/information

Description

Update Public Domain Name Whois Info

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None
body	body required		PubblicDomainWhoisInfoUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainWhoisInfoUpdateResponse

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/information

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.3"

Request body

{
    "address_type": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_telno": ""
}

Example HTTP response

Response 200

{
    "address_type": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "name": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_name_en": "",
    "register_name_ko": "",
    "register_telno": ""
}

2.1.23 - Show Hosted Zone

2.1.23.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}

Description

Return details of a hosted zone.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneShowResponseV1Dot3
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.3"

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "private_dns_name": "private-dns01",
    "status": "CREATING",
    "ttl": "3600"
}

2.1.23.2 - 1.2

get /v1/hosted-zones/{hosted_zone_id}

Description

Return details of a hosted zone.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneShowResponseV1Dot2
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.2"

Example HTTP response

Response 200

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "private_dns_id": "",
    "private_dns_name": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.23.3 - 1.1

get /v1/hosted-zones/{hosted_zone_id}

Description

Return details of a hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.1"

Example HTTP response

Response 200

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.23.4 - 1.0

get /v1/hosted-zones/{hosted_zone_id}

Description

Return details of a hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.0"

Example HTTP response

Response 200

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.24 - Show Hosted Zone Record

2.1.24.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Get details of a hosted zone record

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	RecordShowResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.3"

Example HTTP response

Response 200

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.25 - Show Private DNS

2.1.25.1 - 1.3

get /v1/private-dns/{private_dns_id}

Description

Show Private DNS

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateDnsShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.3"

Example HTTP response

Response 200

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.25.2 - 1.2

get /v1/private-dns/{private_dns_id}

Description

Show Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateDnsShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.2"

Example HTTP response

Response 200

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.25.3 - 1.1

get /v1/private-dns/{private_dns_id}

Description

Show Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateDnsShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.1"

Example HTTP response

Response 200

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.25.4 - 1.0

get /v1/private-dns/{private_dns_id}

Description

Show Private DNS

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateDnsShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.0"

Example HTTP response

Response 200

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.26 - Show Public Domain Name

2.1.26.1 - 1.3

get /v1/public-domain-names/{public_domain_id}

Description

Return details of a public domain name

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainDetailResponse

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.3"

Example HTTP response

Response 200

{
    "public_domain_name": {
        "address_type": "",
        "auto_extension": "",
        "created_at": "",
        "created_by": "",
        "description": "",
        "domestic_address_en": "",
        "domestic_address_ko": "",
        "domestic_first_address_en": "",
        "domestic_first_address_ko": "",
        "domestic_second_address_en": "",
        "domestic_second_address_ko": "",
        "expired_date": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "overseas_address": "",
        "overseas_first_address": "",
        "overseas_second_address": "",
        "overseas_third_address": "",
        "postal_code": "",
        "register_email": "",
        "register_name_en": "",
        "register_name_ko": "",
        "register_telno": "",
        "start_date": "",
        "status": ""
    }
}

2.1.27 - Show Record

2.1.27.1 - 1.2

get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Get details of a recordset

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	RecordShowResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.2"

Example HTTP response

Response 200

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.27.2 - 1.1

get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Get details of a recordset

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	RecordShowResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.1"

Example HTTP response

Response 200

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.27.3 - 1.0

get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Get details of a recordset

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	RecordShowResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.0"

Example HTTP response

Response 200

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.28 - Transfer Public Domain Name

2.1.28.1 - 1.3

post /v1/public-domain-names/{public_domain_id}/transfer

Description

Transfer Public Domain Name

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None
body	body required		PublicDomainTransferRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainTransferResponse

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/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 = dns 1.3"

Request body

{
    "target_account_id": "",
    "type": "REQUEST"
}

Example HTTP response

Response 200

{
    "auto_extension": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "",
    "expired_date": "2026-02-11T06:41:41.289Z",
    "id": "",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "",
    "start_date": "2026-02-11T06:41:41.289Z",
    "state": "ACTIVE"
}

2.1.29 - Update auto_extension or description

2.1.29.1 - 1.2

put /v1/public-domain-names/{public_domain_id}

Description

Update auto_extension or description of a Public Domain

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None
body	body required		PublicDomainPartialUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainPartialUpdateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.2"

Request body

{
    "auto_extension": "",
    "description": ""
}

Example HTTP response

Response 200

{
    "auto_extension": "",
    "description": "",
    "id": ""
}

2.1.29.2 - 1.1

put /v1/public-domain-names/{public_domain_id}

Description

Update auto_extension or description of a Public Domain

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None
body	body required		PublicDomainPartialUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainPartialUpdateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.1"

Request body

{
    "auto_extension": "",
    "description": ""
}

Example HTTP response

Response 200

{
    "auto_extension": "",
    "description": "",
    "id": ""
}

2.1.29.3 - 1.0

put /v1/public-domain-names/{public_domain_id}

Description

Update auto_extension or description of a Public Domain

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None
body	body required		PublicDomainPartialUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainPartialUpdateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.0"

Request body

{
    "auto_extension": "",
    "description": ""
}

Example HTTP response

Response 200

{
    "auto_extension": "",
    "description": "",
    "id": ""
}

2.1.30 - Update Hosted Zone

2.1.30.1 - 1.3

put /v1/hosted-zones/{hosted_zone_id}

Description

Update a hosted zone.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
body	body required		HostedZoneSetRequestV1Dot3

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneShowResponseV1Dot3
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.3"

Request body

{
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "private_dns_name": "private-dns01",
    "status": "CREATING",
    "ttl": "3600"
}

2.1.30.2 - 1.2

put /v1/hosted-zones/{hosted_zone_id}

Description

Update a hosted zone.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
body	body required		HostedZoneSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneShowResponseV1Dot2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.2"

Request body

{
    "description": "",
    "email": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "private_dns_id": "",
    "private_dns_name": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.30.3 - 1.1

put /v1/hosted-zones/{hosted_zone_id}

Description

Update a hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
body	body required		HostedZoneSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.1"

Request body

{
    "description": "",
    "email": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.30.4 - 1.0

put /v1/hosted-zones/{hosted_zone_id}

Description

Update a hosted zone

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example :	string	None
body	body required		HostedZoneSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.0"

Request body

{
    "description": "",
    "email": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "",
    "description": "",
    "email": "",
    "hosted_zone_type": "",
    "id": "",
    "links": "",
    "masters": [
        ""
    ],
    "name": "",
    "pool_id": "",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "",
    "transferred_at": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.31 - Update Record

2.1.31.1 - 1.2

put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Update a recordset

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None
body	body required		RecordSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	RecordSetResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.2"

Request body

{
    "records": "",
    "ttl": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.31.2 - 1.1

put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Update a recordset

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None
body	body required		RecordSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	RecordSetResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.1"

Request body

{
    "records": "",
    "ttl": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.31.3 - 1.0

put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Update a recordset

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Zone ID Example :	string	None
path	record_id required	Record ID Example :	string	None
body	body required		RecordSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	RecordSetResponse

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.0"

Request body

{
    "records": "",
    "ttl": ""
}

Example HTTP response

Response 202

{
    "action": "",
    "created_at": "",
    "description": "",
    "id": "",
    "links": "",
    "name": "",
    "project_id": "",
    "records": [
        ""
    ],
    "status": "",
    "ttl": "",
    "type": "",
    "updated_at": "",
    "version": "",
    "zone_id": "",
    "zone_name": ""
}

2.1.32 - Update WHOIS info for Public Domain

2.1.32.1 - 1.2

put /v1/public-domain-names/{public_domain_id}/information

Description

Update WHOIS information and sync with DB for a public domain

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None
body	body required		PubblicDomainWhoisInfoUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainWhoisInfoUpdateResponse

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/information

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.2"

Request body

{
    "address_type": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_telno": ""
}

Example HTTP response

Response 200

{
    "address_type": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "name": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_name_en": "",
    "register_name_ko": "",
    "register_telno": ""
}

2.1.32.2 - 1.1

put /v1/public-domain-names/{public_domain_id}/information

Description

Update WHOIS information and sync with DB for a public domain

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None
body	body required		PubblicDomainWhoisInfoUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainWhoisInfoUpdateResponse

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/information

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.1"

Request body

{
    "address_type": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_telno": ""
}

Example HTTP response

Response 200

{
    "address_type": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "name": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_name_en": "",
    "register_name_ko": "",
    "register_telno": ""
}

2.1.32.3 - 1.0

put /v1/public-domain-names/{public_domain_id}/information

Description

Update WHOIS information and sync with DB for a public domain

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	Id Example :	string	None
body	body required		PubblicDomainWhoisInfoUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainWhoisInfoUpdateResponse

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/information

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = dns 1.0"

Request body

{
    "address_type": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_telno": ""
}

Example HTTP response

Response 200

{
    "address_type": "",
    "domestic_first_address_en": "",
    "domestic_first_address_ko": "",
    "domestic_second_address_en": "",
    "domestic_second_address_ko": "",
    "name": "",
    "overseas_first_address": "",
    "overseas_second_address": "",
    "overseas_third_address": "",
    "postal_code": "",
    "register_email": "",
    "register_name_en": "",
    "register_name_ko": "",
    "register_telno": ""
}

2.2 - Models

2.2.1 - CreatePublicDomainRequest

Name	Description	Schema	Default
address_type required	Address type Example :	string
auto_extension optional	Auto extension flag Example : `True`	any of [boolean, null]	True
description optional	description Example :	any of [string, null]
domestic_first_address_en required	Domestic first address (EN) Example :	any of [string, null]
domestic_first_address_ko required	Domestic first address (KO) Example :	any of [string, null]
domestic_second_address_en required	Domestic second address (EN) Example :	any of [string, null]
domestic_second_address_ko required	Domestic second address (KO) Example : Maximum length : `16`	string
name required	name Example :	string
overseas_first_address required	Overseas address - Address Example :	any of [string, null]
overseas_second_address required	Overseas address - City Example :	any of [string, null]
overseas_third_address required	Overseas address - State & Country Example :	any of [string, null]
postal_code required	Postal code Example : Maximum length : `6`	string
register_email required	Register email Example :	string
register_name_en required	Register Name Overseas Example : Maximum length : `30`	string
register_name_ko required	Register Name Domestic Example : Maximum length : `30`	string
register_telno required	Register telephone number Example :	string
tags optional	Tag List	array[Tag]

2.2.2 - CreatePublicDomainResponse

Name	Description	Schema	Default
public_domain_name required		PublicDomainDetail

2.2.3 - HostedZone

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
email required	email Example :	string
hosted_zone_type optional	Hosted Zone type Example :	any of [string, null]
id required	Id Example :	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example :	string
pool_id required	Designate Pool ID Example :	string
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example :	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.4 - HostedZoneCreateRequest

Name	Description	Schema
description optional	description Example :	any of [string, null]
email required	email Example :	string
name required	name Example :	string
tags optional	Tag List	array[Tag]
type optional	Type of zone Example : Pattern : `^(public\|private)$`	any of [string, null]

2.2.5 - HostedZoneCreateRequestV1Dot2

Name	Description	Schema
description optional	description Example :	any of [string, null]
email required	email Example :	string
name required	name Example :	string
private_dns_id optional	Private DNS ID Example :	any of [string, null]
tags optional	Tag List	array[Tag]
type optional	Type of zone Example : Pattern : `^(public\|private)$`	any of [string, null]

2.2.6 - HostedZoneCreateRequestV1Dot3

Name	Description	Schema
description optional	description Example : `This is description`	any of [string, null]
name required	name Example : `my-zone.com`	string
private_dns_id optional	Private DNS ID Example :	any of [string, null]
tags optional	Tag List	array[Tag]
type required	Type of zone Example : `public`	enum (public, private)

2.2.7 - HostedZoneCreateResponse

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
email required	email Example :	string
hosted_zone_type optional	Hosted Zone type Example :	any of [string, null]
id required	Id Example :	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example :	string
pool_id required	Designate Pool ID Example :	string
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example :	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.8 - HostedZoneDeleteResponse

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
email required	email Example :	string
hosted_zone_type optional	Hosted Zone type Example :	any of [string, null]
id required	Id Example :	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example :	string
pool_id required	Designate Pool ID Example :	string
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example :	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.9 - HostedZoneListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	Links to resource Example :	any of [object, null]
metadata optional	Total Count Example :	any of [object, null]
zones required	Hosted Zone LIST	array[HostedZone]

2.2.10 - HostedZoneListResponseV1Dot1

Name	Description	Schema
count required	Count Example :	integer
hosted_zones required	Hosted Zone LIST	array[HostedZone]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
page required	Page Example :	integer
size required	Size Example :	integer
sort required	Sort Example :	string

2.2.11 - HostedZoneListResponseV1Dot2

Name	Description	Schema
count required	Count Example :	integer
hosted_zones required	Hosted Zone LIST	array[HostedZoneV1Dot2]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
page required	Page Example :	integer
size required	Size Example :	integer
sort required	Sort Example :	string

2.2.12 - HostedZoneListResponseV1Dot3

Name	Description	Schema
count required	count Example : `20`	integer
hosted_zones required	Hosted Zone LIST	array[HostedZoneV1Dot3]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.2.13 - HostedZoneSetRequest

Name	Description	Schema	Default
description optional	description Example :	any of [string, null]
email optional	email Example :	any of [string, null]

2.2.14 - HostedZoneSetRequestV1Dot3

Name	Description	Schema	Default
description optional	description Example : `This is description`	any of [string, null]

2.2.15 - HostedZoneSetResponse

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
email required	email Example :	string
hosted_zone_type optional	Hosted Zone type Example :	any of [string, null]
id required	Id Example :	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example :	string
pool_id required	Designate Pool ID Example :	string
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example :	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.16 - HostedZoneShowResponse

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
email required	email Example :	string
hosted_zone_type optional	Hosted Zone type Example :	any of [string, null]
id required	Id Example :	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example :	string
pool_id required	Designate Pool ID Example :	string
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example :	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.17 - HostedZoneShowResponseV1Dot2

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
email required	email Example :	string
hosted_zone_type optional	Hosted Zone type Example :	any of [string, null]
id required	Id Example :	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example :	string
pool_id required	Designate Pool ID Example :	string
private_dns_id optional	Private DNS ID Example :	any of [string, null]
private_dns_name optional	Private DNS Name Example :	any of [string, null]
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example :	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.18 - HostedZoneShowResponseV1Dot3

Name	Description	Schema
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	description Example : `This is description`	any of [string, null]
hosted_zone_type optional	Hosted Zone type Example : `public`	enum (public, private)
id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Hosted Zone Name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
private_dns_id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]
private_dns_name optional	Private DNS Name Example : `private-dns01`	any of [string, null]
status required	State Example : `CREATING`	enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN)
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]

2.2.19 - HostedZoneV1Dot2

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
email required	email Example :	string
hosted_zone_type optional	Hosted Zone type Example :	any of [string, null]
id required	Id Example :	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example :	string
pool_id required	Designate Pool ID Example :	string
private_dns_id optional	Private DNS ID Example :	any of [string, null]
private_dns_name optional	Private DNS Name Example :	any of [string, null]
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example :	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.20 - HostedZoneV1Dot3

Name	Description	Schema
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	description Example : `This is description`	any of [string, null]
hosted_zone_type optional	Hosted Zone type Example : `public`	enum (public, private)
id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Hosted Zone Name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
private_dns_id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]
private_dns_name optional	Private DNS Name Example : `private-dns01`	any of [string, null]
status required	State Example : `CREATING`	enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN)
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]

2.2.21 - PrivateDns

Name	Description	Schema
auth_dns_name required	Auth DNS Name Example :	any of [string, null]
connected_vpc_ids optional	Connected VPC ID	array[string]
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	description Example : `This is description`	any of [string, null]
id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Private DNS Name Example : `private-dns01`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	any of [string, null]
pool_name required	Pool Name Example :	any of [string, null]
registered_region required	Registered Region Example : `KR-WEST1`	any of [string, null]
resolver_ip required	Private DNS Resolver IP Example : `198.19.0.101`	any of [string, null]
resolver_name required	Private DNS Resolver Name Example :	any of [string, null]
state required	State Example : `CREATING`	enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR)

2.2.22 - PrivateDnsActivateRequest

Name	Description	Schema	Default
name required	Private DNS Name Example : `private-dns01` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string

2.2.23 - PrivateDnsCreateRequest

Name	Description	Schema
connected_vpc_ids optional	Connected VPC ID	array[string]
description optional	description Example : `This is description`	any of [string, null]
name required	Private DNS Name Example : `private-dns01` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional		any of [array[Tag], null]

2.2.24 - PrivateDnsListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
private_dns required		array[PrivateDns]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.2.25 - PrivateDnsSetRequest

Name	Description	Schema	Default
connected_vpc_ids optional	Connected VPC ID Example :	any of [array[string], null]
description optional	description Example : `This is description`	any of [string, null]

2.2.26 - PrivateDnsShowResponse

Name	Description	Schema	Default
private_dns required		PrivateDns

2.2.27 - PubblicDomainWhoisInfoUpdateRequest

Name	Description	Schema
address_type required	Address type Example :	string
domestic_first_address_en required	Domestic first address (EN) Example :	string
domestic_first_address_ko required	Domestic first address (KO) Example :	string
domestic_second_address_en required	Domestic second address (EN) Example :	any of [string, null]
domestic_second_address_ko required	Domestic second address (KO) Example : Maximum length : `16`	string
overseas_first_address required	Overseas address - Address Example :	any of [string, null]
overseas_second_address required	Overseas address - City Example :	any of [string, null]
overseas_third_address required	Overseas address - State & Country Example :	any of [string, null]
postal_code required	Postal code Example : Maximum length : `6`	string
register_email required	Register email Example :	string
register_telno required	Register telephone number Example :	string

2.2.28 - PublicDomainDetail

Name	Description	Schema
address_type required	Address type Example :	string
auto_extension required	Auto extension flag Example :	boolean
created_at required	Created Date Example :	string
created_by required	Created By_ Example :	string
description optional	description Example :	any of [string, null]
domestic_address_en required	Domestic Address (EN) Example :	string
domestic_address_ko required	Domestic Address (KO) Example :	string
domestic_first_address_en required	Domestic first address (EN) Example :	string
domestic_first_address_ko required	Domestic first address (KO) Example :	string
domestic_second_address_en required	Domestic second address (EN) Example :	string
domestic_second_address_ko required	Domestic second address (KO) Example :	string
expired_date required	Expired date Example :	string
id required	ID Example :	string
modified_at required	Modified Date Example :	string
modified_by required	Modified By_ Example :	string
name required	Public Domain Name Example :	string
overseas_address optional	Overseas Address Example :	string
overseas_first_address required	Overseas address - Address Example :	string
overseas_second_address required	Overseas address - City Example :	string
overseas_third_address required	Overseas address - State & Country Example :	string
postal_code required	Postal code Example :	string
register_email required	Register email Example :	string
register_name_en required	Register Name Overseas Example :	string
register_name_ko required	Register Name Domestic Example :	string
register_telno required	Register telephone number Example :	string
start_date required	Start date Example :	string
status required	The status Example :	string

2.2.29 - PublicDomainDetailResponse

Name	Description	Schema	Default
public_domain_name required		PublicDomainDetail

2.2.30 - PublicDomainListItem

Name	Description	Schema
created_at required	Start date Example :	string
created_by required	Start date Example :	string
expired_date required	Expired date Example :	string
id required	Id Example :	string
modified_at required	Start date Example :	string
modified_by required	Start date Example :	string
name required	name Example :	string
register_email required	Register email Example :	string
start_date required	Start date Example :	string
status required	The status Example :	string

2.2.31 - PublicDomainListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
public_domain_names required		array[PublicDomainListItem]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.2.32 - PublicDomainPartialUpdateRequest

Name	Description	Schema	Default
auto_extension optional	Auto extension flag Example :	any of [boolean, null]
description optional	description Example :	any of [string, null]

2.2.33 - PublicDomainPartialUpdateResponse

Name	Description	Schema
auto_extension optional	Auto extension flag Example :	any of [boolean, null]
description optional	description Example :	any of [string, null]
id required	Id Example :	string

2.2.34 - PublicDomainTransferRequest

Name	Description	Schema	Default
target_account_id optional	Target account id (required when type=REQUEST) Example :	any of [string, null]
type required	Transfer operation type Example : `REQUEST`	enum (REQUEST, CANCEL, APPROVE, REJECT)

2.2.35 - PublicDomainTransferResponse

Name	Description	Schema
auto_extension required	Auto extension flag Example :	boolean
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	description Example :	any of [string, null]
expired_date required	Expired date Example : `2026-02-11T06:41:41.289Z`	string (date-time)
id required	ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Public Domain Name Example :	string
start_date required	Start date Example : `2026-02-11T06:41:41.289Z`	string (date-time)
state required	State Example : `ACTIVE`	enum (ACTIVE, CREATING, REGISTERED, EXPIRED, DELETED, TRANSFER_REQUESTING, TRANSFER_REQUESTED, DELETING)

2.2.36 - PublicDomainWhoisInfoUpdateResponse

Name	Description	Schema
address_type required	Address type Example :	string
domestic_first_address_en required	Domestic first address (EN) Example :	string
domestic_first_address_ko required	Domestic first address (KO) Example :	string
domestic_second_address_en required	Domestic second address (EN) Example :	any of [string, null]
domestic_second_address_ko required	Domestic second address (KO) Example : Maximum length : `16`	string
name required	name Example :	string
overseas_first_address required	Overseas address - Address Example :	any of [string, null]
overseas_second_address required	Overseas address - City Example :	any of [string, null]
overseas_third_address required	Overseas address - State & Country Example :	any of [string, null]
postal_code required	Postal code Example : Maximum length : `6`	string
register_email required	Register email Example :	string
register_name_en required	Register Name Overseas Example :	string
register_name_ko required	Register Name Domestic Example :	string
register_telno required	Register telephone number Example :	string

2.2.37 - Record

Name	Description	Schema
action optional	current action in progress Example :	any of [string, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
id optional	Id Example :	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example :	any of [string, null]
project_id optional	ProjectID Example :	any of [string, null]
records optional	A list of data for this record Example :	any of [array[string], null]
status optional	The status Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of the record Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example :	any of [string, null]
zone_name optional	The name of the zone that contains this record Example :	any of [string, null]

2.2.38 - RecordCreateRequest

Name	Description	Schema
description optional	description Example :	any of [string, null]
name required	name Example :	string
records required	A list of data for this record	array[object]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type required	Type of the record Example :	string

2.2.39 - RecordCreateRequestV1Dot0To1Dot2

Name	Description	Schema
description optional	description Example :	any of [string, null]
name required	name Example :	string
records required	A list of data for this record	array[object]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type required	Type of the record Example :	string

2.2.40 - RecordCreateResponse

Name	Description	Schema
action optional	current action in progress Example :	any of [string, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
id optional	Id Example :	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example :	any of [string, null]
project_id optional	ProjectID Example :	any of [string, null]
records optional	records for the record Example :	any of [array[string], null]
status optional	The status Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of the record Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example :	any of [string, null]
zone_name optional	The name of the zone that contains this record Example :	any of [string, null]

2.2.41 - RecordListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	Links to resource Example :	any of [object, null]
metadata optional	the total count Example :	any of [object, null]
records required	record list	array[Record]

2.2.42 - RecordSetRequest

Name	Description	Schema	Default
records optional	A list of data for this record Example :	any of [array[object], null]
ttl optional	TTL for the record Example :	any of [integer, null]

2.2.43 - RecordSetResponse

Name	Description	Schema
action optional	current action in progress Example :	any of [string, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
id optional	Id Example :	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example :	any of [string, null]
project_id optional	ProjectID Example :	any of [string, null]
records optional	records for the record Example :	any of [array[string], null]
status optional	The status Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of the record Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example :	any of [string, null]
zone_name optional	The name of the zone that contains this record Example :	any of [string, null]

2.2.44 - RecordShowResponse

Name	Description	Schema
action optional	current action in progress Example :	any of [string, null]
created_at optional	Created Date Example :	any of [string, null]
description optional	description Example :	any of [string, null]
id optional	Id Example :	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example :	any of [string, null]
project_id optional	ProjectID Example :	any of [string, null]
records optional	records for the record. Example :	any of [array[string], null]
status optional	The status Example :	any of [string, null]
ttl optional	TTL for the zone. Example :	any of [integer, null]
type optional	Type of the record Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example :	any of [string, null]
zone_name optional	The name of the zone that contains this record Example :	any of [string, null]

2.2.45 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

3 - Firewall

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다. 본 가이드는 Firewall 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://firewall.{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 - Create Firewall Rule

3.1.1.1 - 1.0

post /v1/firewalls/rules

Description

firewall rule 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		FirewallRuleCreateSingleRequest

Responses

HTTP Code	Description	Schema
201	Created	FirewallRuleShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/firewalls/rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.0"

Request body

{
    "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
    "firewall_rule": {
        "action": "ALLOW",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "direction": "INBOUND",
        "order_direction": "BEFORE",
        "order_rule_id": "043aa63459da466faad71fe4fe587031",
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "status": "ENABLE"
    }
}

Example HTTP response

Response 201

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

3.1.2 - Delete Firewall Rule

3.1.2.1 - 1.0

delete /v1/firewalls/rules/{firewall_rule_id}

Description

firewall rule 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	firewall_rule_id required	Firewall rule ID Example : `b156740b6335468d8354eb9ef8eddf5a`	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/firewalls/rules/{firewall_rule_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 = firewall 1.0"

Example HTTP response

Response 204

3.1.3 - List Firewall Rules

3.1.3.1 - 1.0

get /v1/firewalls/rules

Description

firewall rule 목록 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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	firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
query	src_ip optional	출발지 IP Example : `192.168.1.1`	string	None
query	dst_ip optional	목적지 IP Example : `192.168.1.1`	string	None
query	description optional	Firewall rule 설명 Example : `Firewall rule description example`	string	None
query	state optional	Firewall rule 상태	array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)]	[]
query	status optional	Firewall rule 사용 여부 Example :	enum (ENABLE, DISABLE)	None
query	fetch_all optional	Firewall rule 전체 조회 Example : `False`	boolean	False

Responses

HTTP Code	Description	Schema
200	OK	FirewallRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/firewalls/rules?firewall_id={firewall_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 = firewall 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "firewall_rules": [
        {
            "action": "ALLOW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Firewall rule description example",
            "destination_address": [
                "10.0.0.1",
                "10.0.0.2"
            ],
            "destination_interface": "IFW1-v1001dn",
            "direction": "INBOUND",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "b156740b6335468d8354eb9ef8eddf5a",
            "sequence": 100,
            "service": [
                {
                    "service_type": "TCP",
                    "service_value": "443"
                }
            ],
            "source_address": [
                "192.168.1.1",
                "192.168.1.2"
            ],
            "source_interface": "IFW1-v2501up",
            "state": "CREATING",
            "status": "ENABLE",
            "vendor_rule_id": "72"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.4 - List Firewalls

3.1.4.1 - 1.0

get /v1/firewalls

Description

firewall 목록 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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	name optional	Firewall 이름 Example : `FW_IGW_secuVPC`	string	None
query	vpc_name optional	VPC 명 Example : `secuVPC`	string	None
query	product_type optional	Firewall 상품 유형	array[enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)]	[]
query	state optional	Firewall 상태	array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)]	[]

Responses

HTTP Code	Description	Schema
200	OK	FirewallListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/firewalls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "firewalls": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "flavor_name": "SMALL",
            "flavor_rule_quota": 100,
            "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "FW_IGW_secuVPC",
            "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
            "product_type": "IGW",
            "state": "CREATING",
            "status": "ENABLE",
            "total_rule_count": 8,
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "secuVPC"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.5 - Set Firewall

3.1.5.1 - 1.0

put /v1/firewalls/{firewall_id}

Description

firewall 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
body	body required		FirewallSetRequest

Responses

HTTP Code	Description	Schema
200	OK	FirewallShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/firewalls/{firewall_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 = firewall 1.0"

Request body

{
    "flavor_name": "EXSMALL",
    "loggable": false
}

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC"
    }
}

3.1.6 - Set Firewall Rule

3.1.6.1 - 1.0

put /v1/firewalls/rules/{firewall_rule_id}

Description

firewall rule 수정한다,

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	firewall_rule_id required	Firewall rule ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
body	body required		FirewallRuleSetRequest

Responses

HTTP Code	Description	Schema
200	OK	FirewallRuleShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_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 = firewall 1.0"

Request body

{
    "action": "ALLOW",
    "description": "Firewall rule description example",
    "destination_address": [
        "10.0.0.1",
        "10.0.0.2"
    ],
    "direction": "INBOUND",
    "service": [
        {
            "service_type": "TCP",
            "service_value": "443"
        }
    ],
    "source_address": [
        "192.168.1.1",
        "192.168.1.2"
    ]
}

Example HTTP response

Response 200

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

3.1.7 - Show Firewall

3.1.7.1 - 1.0

get /v1/firewalls/{firewall_id}

Description

firewall 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None

Responses

HTTP Code	Description	Schema
200	OK	FirewallShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/firewalls/{firewall_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 = firewall 1.0"

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC"
    }
}

3.1.8 - Show Firewall Rule

3.1.8.1 - 1.0

get /v1/firewalls/rules/{firewall_rule_id}

Description

firewall rule 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	firewall_rule_id required	Firewall rule ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None

Responses

HTTP Code	Description	Schema
200	OK	FirewallRuleShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_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 = firewall 1.0"

Example HTTP response

Response 200

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

3.2 - Models

3.2.1 - Firewall

Name	Description	Schema
account_id required	Account ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
flavor_name optional	Firewall 사이즈 이름 Example : `SMALL`	string
flavor_rule_quota optional	Firewall 규칙 수 제한 Example : `100`	integer
fw_resource_id required	FW 리소스 ID Example : `005fd1d30dea11f08a2c56773bef875b`	string
id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
loggable required	로그 사용 여부 Example : `False`	boolean
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Firewall 이름 Example : `FW_IGW_secuVPC`	string
pre_product_id optional	선행 상품 ID Example : `76479b7ffee1431198d9beb4502cda08`	string
product_type required	Firewall 상품 유형 Example : `IGW`	enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)
state required	Firewall 상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)
status required	Firewall 활성 여부 Example : `ENABLE`	enum (ENABLE, DISABLE)
total_rule_count optional	전체 규칙 개수 Example : `8`	integer
vpc_id required	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	any of [string, null]
vpc_name required	VPC 명 Example : `secuVPC`	any of [string, null]

3.2.2 - FirewallListResponse

Name	Description	Schema
count required	count Example : `20`	integer
firewalls required		array[Firewall]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

3.2.3 - FirewallPort

Name	Description	Schema	Default
service_type required	서비스 프로토콜 유형 Example : `TCP`	enum (TCP, UDP, ICMP, IP, TCP_ALL, UDP_ALL, ICMP_ALL, ALL)
service_value optional	서비스 포트 값 Example : `443`	string

3.2.4 - FirewallRule

Name	Description	Schema
action required	Firewall rule 동작 Example : `ALLOW`	enum (ALLOW, DENY)
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Firewall rule 설명 Example : `Firewall rule description example`	any of [string, null]
destination_address required	목적지 주소 Example : `['10.0.0.1', '10.0.0.2']`	array[string]
destination_interface required	목적지 인터페이스 이름 Example : `IFW1-v1001dn`	string
direction required	Firewall rule 방향 Example : `INBOUND`	enum (INBOUND, OUTBOUND)
firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
id required	Firewall rule ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name optional	Firewall rule 이름 Example : `b156740b6335468d8354eb9ef8eddf5a`	any of [string, null]
sequence required	Firewall rule 순서 Example : `100`	integer
service required	서비스 포트	array[FirewallPort]
source_address required	출발지 주소 Example : `['192.168.1.1', '192.168.1.2']`	array[string]
source_interface required	출발지 인터페이스 이름 Example : `IFW1-v2501up`	string
state required	Firewall rule 상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status required	Firewall rule 사용 여부 Example : `ENABLE`	enum (ENABLE, DISABLE)
vendor_rule_id required	벤더 규칙 ID Example : `72`	string

3.2.5 - FirewallRuleCreateRequest

Name	Description	Schema
action required	Firewall rule 동작 Example : `ALLOW`	enum (ALLOW, DENY)
description optional	Firewall rule 설명 Example : `Firewall rule description example`	any of [string, null]
destination_address required	목적지 주소 Example : `['10.0.0.1', '10.0.0.2']`	array[string]
direction required	Firewall rule 방향 Example : `INBOUND`	enum (INBOUND, OUTBOUND)
order_direction optional	순서 방향 Example : `BEFORE`	enum (BEFORE, AFTER, BOTTOM)
order_rule_id optional	순서 규칙 ID Example : `043aa63459da466faad71fe4fe587031`	string
service required	서비스 포트	array[FirewallPort]
source_address required	출발지 주소 Example : `['192.168.1.1', '192.168.1.2']`	array[string]
status required	Firewall rule 사용 여부 Example : `ENABLE`	enum (ENABLE, DISABLE)

3.2.6 - FirewallRuleCreateSingleRequest

Name	Description	Schema	Default
firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
firewall_rule required	Firewall rule 목록	FirewallRuleCreateRequest

3.2.7 - FirewallRuleListResponse

Name	Description	Schema
count required	count Example : `20`	integer
firewall_rules required		array[FirewallRule]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

3.2.8 - FirewallRuleSetRequest

Name	Description	Schema
action required	Firewall rule 동작 Example : `ALLOW`	enum (ALLOW, DENY)
description optional	Firewall rule 설명 Example : `Firewall rule description example`	any of [string, null]
destination_address required	목적지 주소 Example : `['10.0.0.1', '10.0.0.2']`	array[string]
direction required	Firewall rule 방향 Example : `INBOUND`	enum (INBOUND, OUTBOUND)
service required	서비스 포트	array[FirewallPort]
source_address required	출발지 주소 Example : `['192.168.1.1', '192.168.1.2']`	array[string]

3.2.9 - FirewallRuleShowResponse

Name	Description	Schema	Default
firewall_rule required		FirewallRule

3.2.10 - FirewallSetRequest

Name	Description	Schema	Default
flavor_name optional	Firewall 사이즈 이름 Example : `EXSMALL`	enum (EXSMALL, SMALL, MEDIUM, LARGE, EXLARGE)
loggable optional	로그 사용 여부 Example : `False`	boolean

3.2.11 - FirewallShowResponse

Name	Description	Schema	Default
firewall required		Firewall

4 - Global CDN

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Global CDN 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://cdn.{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

4.1 - APIs

4.1.1 - Create Cdn Service

4.1.1.1 - 1.0

post /v1/cdns

Description

create cdn service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		CdnServiceCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	CdnServiceResponseResult
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/cdns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Request body

{
    "cache_expiry_time": "",
    "cache_key_hostname": "REQUEST_HOST_HEADER",
    "caching_option": "",
    "cdn_origin_hostname": "test.example.com",
    "cdn_origin_port": "",
    "cdn_origin_protocol": "",
    "cdn_service_domain_prefix": "global1",
    "cdn_service_origin_path": "/test/global/",
    "content_policy": "",
    "custom_forward_host_header": "",
    "description": "",
    "forward_host_header": "REQUEST_HOST_HEADER",
    "name": "test1",
    "origin_hostname_type": "DOMAIN",
    "query_string_ignored": "",
    "range_request_allowed": "",
    "request_custom_headers": "",
    "response_custom_headers": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.2 - Delete Cdn Service

4.1.2.1 - 1.0

delete /v1/cdns/{id}

Description

delete cdn service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	CdnServiceResponseResult
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.3 - Detail Cdn Service

4.1.3.1 - 1.0

get /v1/cdns/{id}

Description

detail cdn service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	CdnServiceDetailResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Example HTTP response

Response 200

{
    "cdn": {
        "account_id": "",
        "cache_expiry_time": "",
        "cache_key_hostname": "",
        "caching_option": "",
        "cdn_origin_hostname": "",
        "cdn_origin_port": "",
        "cdn_origin_protocol": "",
        "cdn_service_activation_state": "",
        "cdn_service_config_version": "",
        "cdn_service_domain": "",
        "cdn_service_origin_path": "",
        "cdn_service_state": "",
        "content_policy": "",
        "created_at": "",
        "created_by": "",
        "custom_forward_host_header": "",
        "description": "",
        "forward_host_header": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "origin_hostname_type": "",
        "query_string_ignored": "",
        "range_request_allowed": "",
        "region": "",
        "request_custom_headers": "",
        "response_custom_headers": ""
    }
}

4.1.4 - List Cdn Service

4.1.4.1 - 1.0

get /v1/cdns

Description

list cdn service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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	created_by optional	create by Example :	any of [string, null]	None
query	name optional	cdn service name Example :	any of [string, null]	None
query	cdn_service_domain optional	cdn service domain Example :	any of [string, null]	None
query	cdn_origin_hostname optional	cdn service origin host name Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	CdnServiceListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/cdns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Example HTTP response

Response 200

{
    "cdn": [
        {
            "account_id": "",
            "cdn_origin_hostname": "",
            "cdn_service_domain": "",
            "cdn_service_state": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "region": ""
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

4.1.5 - Purge Cdn Service

4.1.5.1 - 1.0

post /v1/cdns/{id}/purge

Description

purge cdn service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None
body	body required		CdnServicePurgeRequest

Responses

HTTP Code	Description	Schema
202	Accepted	CdnServiceResponseResult
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/cdns/{id}/purge

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Request body

{
    "custom_url": "/test/",
    "target_content": "",
    "target_url": ""
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.6 - Start Cdn Service

4.1.6.1 - 1.0

post /v1/cdns/{id}/start

Description

start cdn service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	CdnServiceResponseResult
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.7 - Stop Cdn Service

4.1.7.1 - 1.0

post /v1/cdns/{id}/stop

Description

stop cdn service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	CdnServiceResponseResult
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.8 - Update Cdn Service

4.1.8.1 - 1.0

put /v1/cdns/{id}

Description

update cdn service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None
body	body required		CdnServiceUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	CdnServiceResponseResult
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Request body

{
    "cache_expiry_time": "",
    "cache_key_hostname": "REQUEST_HOST_HEADER",
    "caching_option": "",
    "cdn_origin_hostname": "test.example.com",
    "cdn_origin_port": "",
    "cdn_origin_protocol": "",
    "cdn_service_origin_path": "/test/global/",
    "content_policy": "",
    "custom_forward_host_header": "",
    "forward_host_header": "REQUEST_HOST_HEADER",
    "origin_hostname_type": "DOMAIN",
    "query_string_ignored": "",
    "range_request_allowed": "",
    "request_custom_headers": "",
    "response_custom_headers": ""
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.9 - Update Description of Cdn Service

4.1.9.1 - 1.0

put /v1/cdns/{id}/description

Description

Update description of cdn service

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None
body	body required		CdnServiceModifyDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	CdnServiceDetailResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/cdns/{id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "cdn": {
        "account_id": "",
        "cache_expiry_time": "",
        "cache_key_hostname": "",
        "caching_option": "",
        "cdn_origin_hostname": "",
        "cdn_origin_port": "",
        "cdn_origin_protocol": "",
        "cdn_service_activation_state": "",
        "cdn_service_config_version": "",
        "cdn_service_domain": "",
        "cdn_service_origin_path": "",
        "cdn_service_state": "",
        "content_policy": "",
        "created_at": "",
        "created_by": "",
        "custom_forward_host_header": "",
        "description": "",
        "forward_host_header": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "origin_hostname_type": "",
        "query_string_ignored": "",
        "range_request_allowed": "",
        "region": "",
        "request_custom_headers": "",
        "response_custom_headers": ""
    }
}

4.2 - Models

4.2.1 - CdnServiceCreateRequest

Name	Description	Schema
cache_expiry_time required	cache expiry time Example : Minimum : `3600` Maximum : `2592000`	integer
cache_key_hostname required	cache key hostname Example : `REQUEST_HOST_HEADER`	enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME)
caching_option required	caching option Example :	string
cdn_origin_hostname required	cdn service origin host name Example : `test.example.com` Pattern : `^(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9]\|[A-Za-z0-9][A-Za-z0-9\-][A-Za-z0-9])$\|^((25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$` Maximum length* : `253`	string
cdn_origin_port required	cdn service origin port Example : Minimum : `1` Maximum : `65535`	integer
cdn_origin_protocol required	cdn service origin protocol Example :	string
cdn_service_domain_prefix required	cdn service domain prefix Example : `global1` Pattern : `^[a-z0-9]$` Minimum length* : `4` Maximum length : `40`	string
cdn_service_origin_path optional	cdn service origin path Example : `/test/global/` Pattern : `^/$\|^(/[a-zA-Z0-9-._]+)+/$`	any of [string, null]
content_policy required	content policy Example :	string
custom_forward_host_header optional	custom forward host header Example :	any of [string, null]
description optional	Description Example :	any of [string, null]
forward_host_header required	forward host header Example : `REQUEST_HOST_HEADER`	enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM)
name required	cdn service name Example : `test1` Pattern : `^[a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `20`	string
origin_hostname_type required	origin hostname type Example : `DOMAIN`	enum (DOMAIN, IP)
query_string_ignored required	query string ignored Example :	boolean
range_request_allowed required	range request allowed Example :	boolean
request_custom_headers optional	request custom headers Example :	object
response_custom_headers optional	response custom header Example :	object
tags optional	Tag List	array[Tag]

4.2.2 - CdnServiceDetail

Name	Description	Schema
account_id required	Account ID Example :	string
cache_expiry_time required	cache expiry time Example :	integer
cache_key_hostname required	cache key hostname Example :	string
caching_option required	caching option Example :	string
cdn_origin_hostname required	cdn service origin host name Example :	string
cdn_origin_port required	cdn service origin port Example :	integer
cdn_origin_protocol required	cdn service origin protocol Example :	string
cdn_service_activation_state required	cdn service activation state Example :	string
cdn_service_config_version required	cdn service config version Example :	integer
cdn_service_domain required	cdn service domain Example :	string
cdn_service_origin_path required	cdn service origin path Example :	string
cdn_service_state required	cdn service state Example :	string
content_policy required	content policy Example :	string
created_at required	create at Example :	string
created_by required	create by Example :	string
custom_forward_host_header required	custom forward host header Example :	string
description required	Description Example :	string
forward_host_header required	forward host header Example :	string
id required	cdn service id Example :	string
modified_at required	modified at Example :	string
modified_by required	modified by Example :	string
name required	cdn service name Example :	string
origin_hostname_type required	origin hostname type Example :	string
query_string_ignored required	query string ignored Example :	boolean
range_request_allowed required	range request allowed Example :	boolean
region required	region Example :	string
request_custom_headers required	request custom headers Example :	object
response_custom_headers required	response custom header Example :	object

4.2.3 - CdnServiceDetailResponse

Name	Description	Schema	Default
cdn required		CdnServiceDetail

4.2.4 - CdnServiceListResponse

Name	Description	Schema
cdn required		array[CdnServiceResponse]
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

4.2.5 - CdnServiceModifyDescriptionRequest

Name	Description	Schema	Default
description required	Description Example :	string

4.2.6 - CdnServicePurgeRequest

Name	Description	Schema
custom_url optional	custom url Example : `/test/` Pattern : `^/[a-zA-Z0-9-._/]*$`	any of [string, null]
target_content required	target content Example :	string
target_url required	target url Example :	string

4.2.7 - CdnServiceResponse

Name	Description	Schema
account_id required	Account ID Example :	string
cdn_origin_hostname required	cdn service origin host name Example :	string
cdn_service_domain required	cdn service domain Example :	string
cdn_service_state required	cdn service state Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example :	any of [string, null]
id required	cdn service id Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	cdn service name Example :	string
region required	region Example :	string

4.2.8 - CdnServiceResponseResult

Name	Description	Schema	Default
cdn required		CdnServiceResult

4.2.9 - CdnServiceResult

Name	Description	Schema
account_id required	Account ID Example :	string
resource_id required	resource id Example :	string
workflow_id required	workflow id Example :	string

4.2.10 - CdnServiceUpdateRequest

Name	Description	Schema
cache_expiry_time required	cache expiry time Example : Minimum : `3600` Maximum : `2592000`	integer
cache_key_hostname required	cache key hostname Example : `REQUEST_HOST_HEADER`	enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME)
caching_option required	caching option Example :	string
cdn_origin_hostname required	cdn service origin host name Example : `test.example.com` Pattern : `^(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9]\|[A-Za-z0-9][A-Za-z0-9\-][A-Za-z0-9])$\|^((25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$` Maximum length* : `253`	string
cdn_origin_port required	cdn service origin port Example : Minimum : `1` Maximum : `65535`	integer
cdn_origin_protocol required	cdn service origin protocol Example :	string
cdn_service_origin_path optional	cdn service origin path Example : `/test/global/` Pattern : `^/$\|^(/[a-zA-Z0-9-._]+)+/$`	any of [string, null]
content_policy required	content policy Example :	string
custom_forward_host_header optional	custom forward host header Example :	any of [string, null]
forward_host_header required	forward host header Example : `REQUEST_HOST_HEADER`	enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM)
origin_hostname_type required	origin hostname type Example : `DOMAIN`	enum (DOMAIN, IP)
query_string_ignored required	query string ignored Example :	boolean
range_request_allowed required	range request allowed Example :	boolean
request_custom_headers optional	request custom headers Example :	any of [object, null]
response_custom_headers optional	response custom header Example :	any of [object, null]

4.2.11 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

5 - GSLB

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 GSLB 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	SUPPORTED	20260531
1.1	CURRENT	-

OpenAPI URL

https://gslb.{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

5.1 - APIs

5.1.1 - CreateGslb

5.1.1.1 - 1.1

post /v1/gslbs

Description

GSLB 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		GslbCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
202	Accepted	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.1"

Request body

{
    "algorithm": "",
    "description": "",
    "env_usage": "",
    "health_check": {
        "health_check_interval": "",
        "health_check_probe_timeout": "",
        "health_check_user_id": "",
        "health_check_user_password": "",
        "protocol": "",
        "receive_string": "",
        "send_string": "",
        "service_port": "",
        "timeout": ""
    },
    "name": "",
    "resources": [
        {
            "description": "",
            "destination": "",
            "region": "",
            "weight": 0
        }
    ],
    "tags": []
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.1.2 - 1.0

post /v1/gslbs

Description

GSLB 생성

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		GslbCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.0"

Request body

{
    "algorithm": "",
    "description": "",
    "env_usage": "",
    "health_check": {
        "health_check_interval": "",
        "health_check_probe_timeout": "",
        "health_check_user_id": "",
        "health_check_user_password": "",
        "protocol": "",
        "receive_string": "",
        "send_string": "",
        "service_port": "",
        "timeout": ""
    },
    "name": "",
    "resources": [
        {
            "description": "",
            "destination": "",
            "disabled": false,
            "region": "",
            "weight": 0
        }
    ],
    "tags": []
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.2 - DeleteGslb

5.1.2.1 - 1.1

delete /v1/gslbs/{gslb_id}

Description

GSLB 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.1"

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.2.2 - 1.0

delete /v1/gslbs/{gslb_id}

Description

GSLB 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.0"

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.3 - ListGslbResources

5.1.3.1 - 1.1

get /v1/gslbs/{gslb_id}/resources

Description

GSLB Resource 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	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

Responses

HTTP Code	Description	Schema
200	OK	GslbResourceListResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "gslb_resources": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination": "",
            "health_check_status": "CONNECTED",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "region": "",
            "status": "ENABLE",
            "weight": 0
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.3.2 - 1.0

get /v1/gslbs/{gslb_id}/resources

Description

GSLB Resource 목록 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	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

Responses

HTTP Code	Description	Schema
200	OK	GslbResourceListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "gslb_resources": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination": "",
            "disabled": false,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "region": "",
            "weight": 0
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.4 - ListGslbs

5.1.4.1 - 1.1

get /v1/gslbs

Description

GSLB 목록 조회

상태 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	state optional	GSLB 상태. Example :	any of [string, null]	None
query	name optional	GSLB 이름 Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	GslbListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "gslbs": [
        {
            "algorithm": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "env_usage": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "linked_resource_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.4.2 - 1.0

get /v1/gslbs

Description

GSLB 목록 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

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	state optional	GSLB 상태. Example :	any of [string, null]	None
query	name optional	GSLB 이름 Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	GslbListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "gslbs": [
        {
            "algorithm": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "env_usage": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "linked_resource_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.5 - ListGslbsRegionalRoutingControl

5.1.5.1 - 1.1

get /v1/gslbs/routing-control

Description

GSLB Region 별 Resource 목록 조회

상태 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	region optional	GSLB Resource 위치 Example :	any of [string, null]	None
query	status optional	GSLB Resource 사용 여부 Example :	any of [string, null]	None
query	name optional	GSLB 이름 Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	GslbRoutingControlListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/routing-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "regional_gslbs": [
        {
            "algorithm": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "env_usage": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "linked_regional_resource_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "region": "",
            "status": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.6 - SetGslb

5.1.6.1 - 1.1

put /v1/gslbs/{gslb_id}

Description

GSLB 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbSetRequest

Responses

HTTP Code	Description	Schema
200	OK	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.1"

Request body

{
    "algorithm": "",
    "description": ""
}

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.6.2 - 1.0

put /v1/gslbs/{gslb_id}

Description

GSLB 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbSetRequest

Responses

HTTP Code	Description	Schema
200	OK	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.0"

Request body

{
    "algorithm": "",
    "description": ""
}

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.7 - SetGslbHealthCheck

5.1.7.1 - 1.1

put /v1/gslbs/{gslb_id}/health-check

Description

GSLB Health Check 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbHealthCheck

Responses

HTTP Code	Description	Schema
202	Accepted	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/health-check

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.1"

Request body

{
    "health_check_interval": "",
    "health_check_probe_timeout": "",
    "health_check_user_id": "",
    "health_check_user_password": "",
    "protocol": "",
    "receive_string": "",
    "send_string": "",
    "service_port": "",
    "timeout": ""
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.7.2 - 1.0

put /v1/gslbs/{gslb_id}/health-check

Description

GSLB Health Check 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbHealthCheck

Responses

HTTP Code	Description	Schema
202	Accepted	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/health-check

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.0"

Request body

{
    "health_check_interval": "",
    "health_check_probe_timeout": "",
    "health_check_user_id": "",
    "health_check_user_password": "",
    "protocol": "",
    "receive_string": "",
    "send_string": "",
    "service_port": "",
    "timeout": ""
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.8 - SetGslbRegionalRoutingControl

5.1.8.1 - 1.1

put /v1/gslbs/{gslb_id}/routing-control

Description

GSLB Regional Routing 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbRoutingControlRequest

Responses

HTTP Code	Description	Schema
202	Accepted	GslbRoutingControlResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/routing-control

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.1"

Request body

{
    "region": "",
    "status": ""
}

Example HTTP response

Response 202

{
    "regional_gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_regional_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "region": "",
        "status": ""
    }
}

5.1.9 - SetGslbResources

5.1.9.1 - 1.1

put /v1/gslbs/{gslb_id}/resources

Description

GSLB Resource 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbResourcesSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.1"

Request body

{
    "resources": [
        {
            "description": "",
            "destination": "",
            "region": "",
            "weight": 0
        }
    ]
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.9.2 - 1.0

put /v1/gslbs/{gslb_id}/resources

Description

GSLB Resource 수정

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbResourceSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = gslb 1.0"

Request body

{
    "resources": [
        {
            "description": "",
            "destination": "",
            "disabled": false,
            "region": "",
            "weight": 0
        }
    ]
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.10 - ShowGslb

5.1.10.1 - 1.1

get /v1/gslbs/{gslb_id}

Description

GSLB 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.1"

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.10.2 - 1.0

get /v1/gslbs/{gslb_id}

Description

GSLB 상세 조회

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	GslbShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.0"

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.2 - Models

5.2.1 - GslbCreateRequest

Name	Description	Schema
algorithm required	The GSLB Algorithm. Example :	string
description optional	설명 Example :	any of [string, null]
env_usage required	GSLB 용도 Example :	string
health_check optional	GSLB 헬스 체크.	any of [GslbHealthCheck, null]
name required	GSLB 이름 Example :	string
resources required		array[GslbResource]
tags optional	태그 목록	array[Tag]

5.2.2 - GslbCreateRequestV1Dot1

Name	Description	Schema
algorithm required	The GSLB Algorithm. Example :	string
description optional	설명 Example :	any of [string, null]
env_usage required	GSLB 용도 Example :	string
health_check optional	GSLB 헬스 체크.	any of [GslbHealthCheck, null]
name required	GSLB 이름 Example :	string
resources required		array[GslbResourceV1Dot1]
tags optional	태그 목록	array[Tag]

5.2.3 - GslbDetail

Name	Description	Schema
algorithm required	The GSLB Algorithm. Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
env_usage required	GSLB 용도 Example :	string
health_check required		any of [GslbHeathCheckShowResponse, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
linked_resource_count required	GSLB 연결 대상 Example :	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	GSLB 이름 Example :	string
state required	GSLB 상태. Example :	string

5.2.4 - GslbHealthCheck

Name	Description	Schema
health_check_interval optional	The GSLB Health Check Interval. Example :	any of [integer, null]
health_check_probe_timeout optional	The GSLB Health Check Probe Timeout. Example :	any of [integer, null]
health_check_user_id optional	The GSLB Health Check User Name. Example :	any of [string, null]
health_check_user_password optional	The GSLB Health Check Password. Example :	any of [string, null]
protocol required	The GSLB Health Check Protocol. Example :	string
receive_string optional	The GSLB Health Check Receive String. Example :	any of [string, null]
send_string optional	The GSLB Health Check Send String. Example :	any of [string, null]
service_port optional	The GSLB Health Check Service Port. Example :	any of [integer, null]
timeout optional	The GSLB Health Check Timeout. Example :	any of [integer, null]

5.2.5 - GslbHeathCheckShowResponse

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
health_check_interval optional	The GSLB Health Check Interval. Example :	any of [integer, null]
health_check_probe_timeout optional	The GSLB Health Check Probe Timeout. Example :	any of [integer, null]
health_check_user_id optional	The GSLB Health Check User Name. Example :	any of [string, null]
health_check_user_password optional	The GSLB Health Check Password. Example :	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
protocol required	The GSLB Health Check Protocol. Example :	string
receive_string optional	The GSLB Health Check Receive String. Example :	any of [string, null]
send_string optional	The GSLB Health Check Send String. Example :	any of [string, null]
service_port optional	The GSLB Health Check Service Port. Example :	any of [integer, null]
timeout optional	The GSLB Health Check Timeout. Example :	any of [integer, null]

5.2.6 - GslbListResponse

Name	Description	Schema
count required	count Example : `20`	integer
gslbs required		array[GslbResponseCommon]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

5.2.7 - GslbResource

Name	Description	Schema
description optional	설명 Example :	any of [string, null]
destination required	GSLB Resource 목적지. Example :	string
disabled optional	GSLB Resource 사용 여부. Example : `False`	any of [boolean, null]
region required	GSLB Resource 위치 Example :	string
weight optional	GSLB Resource 가중치. Example : `0`	any of [integer, null]

5.2.8 - GslbResourceListResponse

Name	Description	Schema
count required	count Example : `20`	integer
gslb_resources required		array[GslbResourceResponse]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

5.2.9 - GslbResourceListResponseV1Dot1

Name	Description	Schema
count required	count Example : `20`	integer
gslb_resources required		array[GslbResourceResponseV1Dot1]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

5.2.10 - GslbResourceResponse

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
destination required	GSLB Resource 목적지. Example :	string
disabled optional	GSLB Resource 사용 여부. Example : `False`	any of [boolean, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
region required	GSLB Resource 위치 Example :	string
weight optional	GSLB Resource 가중치. Example : `0`	any of [integer, null]

5.2.11 - GslbResourceResponseV1Dot1

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
destination required	GSLB Resource 목적지. Example :	string
health_check_status required	GSLB Resource 연결 상태 Example : `CONNECTED`	enum (CONNECTED, DISCONNECTED)
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
region required	GSLB Resource 위치 Example :	string
status required	GSLB Resource 사용 여부 Example : `ENABLE`	enum (ENABLE, DISABLE)
weight optional	GSLB Resource 가중치. Example : `0`	any of [integer, null]

5.2.12 - GslbResourceSetRequest

Name	Description	Schema	Default
resources required		array[GslbResource]

5.2.13 - GslbResourceSetRequestV1Dot1

Name	Description	Schema
description optional	설명 Example :	any of [string, null]
destination required	GSLB Resource 목적지. Example :	string
region required	GSLB Resource 위치 Example :	string
weight optional	GSLB Resource 가중치. Example : `0`	any of [integer, null]

5.2.14 - GslbResourcesSetRequest

Name	Description	Schema	Default
resources required		array[GslbResourceSetRequestV1Dot1]

5.2.15 - GslbResourceV1Dot1

Name	Description	Schema
description optional	설명 Example :	any of [string, null]
destination required	GSLB Resource 목적지. Example :	string
region required	GSLB Resource 위치 Example :	string
weight optional	GSLB Resource 가중치. Example : `0`	any of [integer, null]

5.2.16 - GslbResponseCommon

Name	Description	Schema
algorithm required	The GSLB Algorithm. Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
env_usage required	GSLB 용도 Example :	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
linked_resource_count required	GSLB 연결 대상 Example :	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	GSLB 이름 Example :	string
state required	GSLB 상태. Example :	string

5.2.17 - GslbRoutingControlListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
regional_gslbs required		array[GslbRoutingControlResponseCommon]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

5.2.18 - GslbRoutingControlRequest

Name	Description	Schema	Default
region required	GSLB Resource 위치 Example :	string
status required	GSLB Resource 사용 여부 Example :	string

5.2.19 - GslbRoutingControlResponse

Name	Description	Schema	Default
regional_gslb required		GslbRoutingControlResponseCommon

5.2.20 - GslbRoutingControlResponseCommon

Name	Description	Schema
algorithm required	The GSLB Algorithm. Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
env_usage required	GSLB 용도 Example :	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
linked_regional_resource_count required	GSLB 위치별 연결 대상 Example :	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	GSLB 이름 Example :	string
region required	GSLB Resource 위치 Example :	string
status required	GSLB Resource 사용 여부 Example :	string

5.2.21 - GslbSetRequest

Name	Description	Schema	Default
algorithm optional	The GSLB Algorithm. Example :	any of [string, null]
description optional	설명 Example :	any of [string, null]

5.2.22 - GslbShowResponse

Name	Description	Schema	Default
gslb required		GslbDetail

5.2.23 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

6 - Load Balancer

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 LOADBALANCER 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251023
1.1	DEPRECATED	20260331
1.2	CURRENT	-

OpenAPI URL

https://loadbalancer.{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

6.1 - APIs

6.1.1 - AddLbServerGroupMembers

6.1.1.1 - 1.2

post /v1/lb-server-groups/{lb_server_group_id}/members

Description

Member를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	string	None
body	body required		MemberListCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
202	Accepted	MemberListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.2"

Request body

{
    "members": [
        {
            "member_ip": "192.168.0.1",
            "member_port": 80,
            "member_state": "ENABLE",
            "member_weight": 100,
            "name": "virtualserver-1",
            "object_id": "1",
            "object_type": "VM"
        }
    ]
}

Example HTTP response

Response 202

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING",
            "subnet_id": "",
            "uuid": ""
        }
    ]
}

6.1.1.2 - 1.1

post /v1/lb-server-groups/{lb_server_group_id}/members

Description

Member를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	string	None
body	body required		MemberListCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
202	Accepted	MemberListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.1"

Request body

{
    "members": [
        {
            "member_ip": "192.168.0.1",
            "member_port": 80,
            "member_state": "ENABLE",
            "member_weight": 100,
            "name": "virtualserver-1",
            "object_id": "1",
            "object_type": "VM"
        }
    ]
}

Example HTTP response

Response 202

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING",
            "subnet_id": "",
            "uuid": ""
        }
    ]
}

6.1.2 - CreateLBHealthCheck

6.1.2.1 - 1.2

post /v1/lb-health-checks

Description

LB 헬스 체크를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LbHealthCheckCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 201

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.2.2 - 1.1

post /v1/lb-health-checks

Description

LB 헬스 체크를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		LbHealthCheckCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 201

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.3 - CreateLbListener

6.1.3.1 - 1.2

post /v1/lb-listeners

Description

Listener를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LbListenerCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
201	Created	LbListenerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": false,
        "tags": [],
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 201

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.3.2 - 1.1

post /v1/lb-listeners

Description

Listener를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		LbListenerCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LbListenerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": false,
        "tags": [],
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 201

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.4 - CreateLBServerGroup

6.1.4.1 - 1.2

post /v1/lb-server-groups

Description

LB 서버 그룹을 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LbServerGroupCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/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 = loadbalancer 1.2"

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.4.2 - 1.1

post /v1/lb-server-groups

Description

LB 서버 그룹을 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		LbServerGroupCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/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 = loadbalancer 1.1"

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.5 - CreateLoadbalancer

6.1.5.1 - 1.2

post /v1/loadbalancers

Description

LoadBalancer를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LoadbalancerCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LoadbalancerCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"

Request body

{
    "loadbalancer": {
        "description": "",
        "firewall_enabled": true,
        "firewall_logging_enabled": true,
        "health_check_ip_1": "",
        "health_check_ip_2": "",
        "layer_type": "",
        "name": "",
        "publicip_id": "",
        "service_ip": "",
        "source_nat_ip": "",
        "subnet_id": "",
        "tags": [],
        "vpc_id": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.5.2 - 1.1

post /v1/loadbalancers

Description

LoadBalancer를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		LoadbalancerCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LoadbalancerCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"

Request body

{
    "loadbalancer": {
        "description": "",
        "firewall_enabled": true,
        "firewall_logging_enabled": true,
        "health_check_ip_1": "",
        "health_check_ip_2": "",
        "layer_type": "",
        "name": "",
        "publicip_id": "",
        "service_ip": "",
        "source_nat_ip": "",
        "subnet_id": "",
        "tags": [],
        "vpc_id": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.6 - CreateLoadbalancerPublicNatIp

6.1.6.1 - 1.2

post /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

LoadBalancer Public NAT를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	string	None
body	body required		StaticNatCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	StaticNatCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.2"

Request body

{
    "static_nat": {
        "publicip_id": ""
    }
}

Example HTTP response

Response 201

{
    "static_nat": {
        "account_id": "",
        "action_type": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "owner_id": "",
        "owner_name": "",
        "owner_type": "",
        "publicip_id": "",
        "service_ip_port_id": "",
        "state": "",
        "subnet_id": "",
        "type": "",
        "vpc_id": ""
    }
}

6.1.6.2 - 1.1

post /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

LoadBalancer Public NAT를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	string	None
body	body required		StaticNatCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	StaticNatCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.1"

Request body

{
    "static_nat": {
        "publicip_id": ""
    }
}

Example HTTP response

Response 201

{
    "static_nat": {
        "account_id": "",
        "action_type": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "owner_id": "",
        "owner_name": "",
        "owner_type": "",
        "publicip_id": "",
        "service_ip_port_id": "",
        "state": "",
        "subnet_id": "",
        "type": "",
        "vpc_id": ""
    }
}

6.1.7 - DeleteLBHealthCheck

6.1.7.1 - 1.2

delete /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB 헬스 체크 ID Example : `e3cd678b11784734bc366148aa37580e`	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/lb-health-checks/{lb_health_check_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 = loadbalancer 1.2"

Example HTTP response

Response 204

6.1.7.2 - 1.1

delete /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB 헬스 체크 ID Example : `e3cd678b11784734bc366148aa37580e`	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/lb-health-checks/{lb_health_check_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 = loadbalancer 1.1"

Example HTTP response

Response 204

6.1.8 - DeleteLbListener

6.1.8.1 - 1.2

delete /v1/lb-listeners/{listener_id}

Description

Listener를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	Listener 아이디 Example :	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/lb-listeners/{listener_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 = loadbalancer 1.2"

Example HTTP response

Response 204

6.1.8.2 - 1.1

delete /v1/lb-listeners/{listener_id}

Description

Listener를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	Listener 아이디 Example :	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/lb-listeners/{listener_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 = loadbalancer 1.1"

Example HTTP response

Response 204

6.1.9 - DeleteLBServerGroup

6.1.9.1 - 1.2

delete /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB 서버 그룹 ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	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/lb-server-groups/{lb_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 = loadbalancer 1.2"

Example HTTP response

Response 202

6.1.9.2 - 1.1

delete /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB 서버 그룹 ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	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/lb-server-groups/{lb_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 = loadbalancer 1.1"

Example HTTP response

Response 202

6.1.10 - DeleteLoadbalancer

6.1.10.1 - 1.2

delete /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	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/loadbalancers/{loadbalancer_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 = loadbalancer 1.2"

Example HTTP response

Response 202

6.1.10.2 - 1.1

delete /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	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/loadbalancers/{loadbalancer_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 = loadbalancer 1.1"

Example HTTP response

Response 202

6.1.11 - DeleteLoadbalancerPublicNatIp

6.1.11.1 - 1.2

delete /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

LoadBalancer Public NAT를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	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/loadbalancers/{loadbalancer_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 = loadbalancer 1.2"

Example HTTP response

Response 204

6.1.11.2 - 1.1

delete /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

LoadBalancer Public NAT를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	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/loadbalancers/{loadbalancer_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 = loadbalancer 1.1"

Example HTTP response

Response 204

6.1.12 - ListLBHealthChecks

6.1.12.1 - 1.2

get /v1/lb-health-checks

Description

LB 헬스 체크 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

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	name optional	LB 헬스 체크명 Example : `Test-LbMonitor-01`	any of [string, null]	None
query	protocol optional	프로토콜 Example : `['TCP', 'UDP']`	any of [array[enum (TCP, HTTP, HTTPS)], enum (TCP, HTTP, HTTPS), null]	None
query	subnet_id optional	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	LbHealthCheckListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "lb_health_checks": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_type": "DEFAULT",
            "id": "46c681018e33453085ca7c8db54e0076",
            "lb_server_group_count": 2,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "Test-LbMonitor-01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "subnet_id": "60fba45cb6c811efba41ba92e4fe7200"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.12.2 - 1.1

get /v1/lb-health-checks

Description

LB 헬스 체크 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

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	name optional	LB 헬스 체크명 Example : `Test-LbMonitor-01`	any of [string, null]	None
query	protocol optional	프로토콜 Example : `['TCP', 'UDP']`	any of [array[enum (TCP, HTTP, HTTPS)], enum (TCP, HTTP, HTTPS), null]	None
query	subnet_id optional	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	LbHealthCheckListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "lb_health_checks": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_type": "DEFAULT",
            "id": "46c681018e33453085ca7c8db54e0076",
            "lb_server_group_count": 2,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "Test-LbMonitor-01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "subnet_id": "60fba45cb6c811efba41ba92e4fe7200"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.13 - ListLbListeners

6.1.13.1 - 1.2

get /v1/lb-listeners

Description

Listener 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

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	loadbalancer_id optional	LB 아이디 Example :	any of [string, null]	None
query	state optional	Listener 상태 Example :	any of [string, null]	None
query	name optional	Listener 명 Example :	any of [string, null]	None
query	service_port optional	서비스 포트 Example :	any of [integer, null]	None
query	protocol optional	프로토콜 Example : `['TCP', 'UDP']`	any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS)], enum (TCP, UDP, HTTP, HTTPS, TLS), null]	None

Responses

HTTP Code	Description	Schema
200	OK	LbListenerListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "listeners": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "protocol": "",
            "service_port": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.13.2 - 1.1

get /v1/lb-listeners

Description

Listener 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

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	loadbalancer_id optional	LB 아이디 Example :	any of [string, null]	None
query	state optional	Listener 상태 Example :	any of [string, null]	None
query	name optional	Listener 명 Example :	any of [string, null]	None
query	service_port optional	서비스 포트 Example :	any of [integer, null]	None
query	protocol optional	프로토콜 Example : `['TCP', 'UDP']`	any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS)], enum (TCP, UDP, HTTP, HTTPS, TLS), null]	None

Responses

HTTP Code	Description	Schema
200	OK	LbListenerListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "listeners": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "protocol": "",
            "service_port": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.14 - ListLbServerGroupMembers

6.1.14.1 - 1.2

get /v1/lb-server-groups/{lb_server_group_id}/members

Description

Member 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	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	name optional	Member 명 Example :	any of [string, null]	None
query	member_ip optional	Member ID Example :	any of [string, null]	None
query	member_port optional	Member 포트 Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	MemberWithHealthStateListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_state": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.14.2 - 1.1

get /v1/lb-server-groups/{lb_server_group_id}/members

Description

Member 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	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	name optional	Member 명 Example :	any of [string, null]	None
query	member_ip optional	Member ID Example :	any of [string, null]	None
query	member_port optional	Member 포트 Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	MemberWithHealthStateListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_state": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.15 - ListLBServerGroups

6.1.15.1 - 1.2

get /v1/lb-server-groups

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

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	name optional	LB 서버 그룹 명 Example : `ServerGroup01`	any of [string, null]	None
query	protocol optional	프로토콜 Example : `['TCP', 'UDP']`	any of [array[enum (TCP, UDP)], enum (TCP, UDP), null]	None
query	subnet_id optional	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	any of [string, null]	None
query	lb_health_check_id optional	LB 헬스 체크 ID Example : `46c681018e33453085ca7c8db54e0076`	string	None
query	lb_method optional	부하 분산 Example : `ROUND_ROBIN`	any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]	None

Responses

HTTP Code	Description	Schema
200	OK	LbServerGroupListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "lb_server_groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
            "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
            "lb_name": "Test-LB-01",
            "lb_server_group_member_count": 2,
            "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServerGroup01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.15.2 - 1.1

get /v1/lb-server-groups

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

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	name optional	LB 서버 그룹 명 Example : `ServerGroup01`	any of [string, null]	None
query	protocol optional	프로토콜 Example : `['TCP', 'UDP']`	any of [array[enum (TCP, UDP)], enum (TCP, UDP), null]	None
query	subnet_id optional	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	any of [string, null]	None
query	lb_health_check_id optional	LB 헬스 체크 ID Example : `46c681018e33453085ca7c8db54e0076`	string	None
query	lb_method optional	부하 분산 Example : `ROUND_ROBIN`	any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]	None

Responses

HTTP Code	Description	Schema
200	OK	LbServerGroupListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "lb_server_groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
            "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
            "lb_name": "Test-LB-01",
            "lb_server_group_member_count": 2,
            "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServerGroup01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.16 - ListLoadbalancerCertificates

6.1.16.1 - 1.2

get /v1/loadbalancers/certificates

Description

인증서 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Responses

HTTP Code	Description	Schema
200	OK	LbCertificateListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/certificates

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "certificates": [
        {
            "cert_kind": "",
            "cn": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "not_after_dt": "2026-02-11T06:42:52.611Z",
            "not_before_dt": "2026-02-11T06:42:52.611Z",
            "state": ""
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

6.1.16.2 - 1.1

get /v1/loadbalancers/certificates

Description

인증서 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Responses

HTTP Code	Description	Schema
200	OK	LbCertificateListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/certificates

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "certificates": [
        {
            "cert_kind": "",
            "cn": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "not_after_dt": "2026-02-11T06:42:52.611Z",
            "not_before_dt": "2026-02-11T06:42:52.611Z",
            "state": ""
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

6.1.17 - ListLoadbalancers

6.1.17.1 - 1.2

get /v1/loadbalancers

Description

LoadBalancer 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

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	name optional	LoadBalancer 명 Example :	any of [string, null]	None
query	state optional	The state of the load balancer. Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), array[enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)]]
query	service_ip optional	LoadBalancer 서비스 IP Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	layer_type optional	계층 타입 Example :	any of [enum (L4, L7), array[enum (L4, L7)]]
query	vpc_id optional	VPC ID Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	LoadbalancerListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/loadbalancers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "loadbalancers": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "firewall_id": "",
            "id": "",
            "layer_type": "",
            "listener_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "public_nat_enabled": "",
            "service_ip": "",
            "source_nat_ip": "",
            "state": "",
            "subnet_id": "",
            "vpc_id": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.17.2 - 1.1

get /v1/loadbalancers

Description

LoadBalancer 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

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	name optional	LoadBalancer 명 Example :	any of [string, null]	None
query	state optional	The state of the load balancer. Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), array[enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)]]
query	service_ip optional	LoadBalancer 서비스 IP Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	layer_type optional	계층 타입 Example :	any of [enum (L4, L7), array[enum (L4, L7)]]
query	vpc_id optional	VPC ID Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	LoadbalancerListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/loadbalancers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "loadbalancers": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "firewall_id": "",
            "id": "",
            "layer_type": "",
            "listener_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "public_nat_enabled": "",
            "service_ip": "",
            "source_nat_ip": "",
            "state": "",
            "subnet_id": "",
            "vpc_id": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.18 - RemoveLbServerGroupMember

6.1.18.1 - 1.2

delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	string	None
path	member_id required	ID of Member Example :	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/lb-server-groups/{lb_server_group_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 = loadbalancer 1.2"

Example HTTP response

Response 202

6.1.18.2 - 1.1

delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	string	None
path	member_id required	ID of Member Example :	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/lb-server-groups/{lb_server_group_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 = loadbalancer 1.1"

Example HTTP response

Response 202

6.1.19 - RemoveLbServerGroupMembers

6.1.19.1 - 1.2

delete /v1/lb-server-groups/{lb_server_group_id}/members

Description

Remove Lb Server Group Members

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	string	None
body	body required		MemberDeleteBulkRequestV1Dot2

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/lb-server-groups/{lb_server_group_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 = loadbalancer 1.2"

Request body

{
    "member_id_list": [
        ""
    ]
}

Example HTTP response

Response 202

6.1.20 - SetLBHealthCheck

6.1.20.1 - 1.2

put /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB 헬스 체크 ID Example : `e3cd678b11784734bc366148aa37580e`	string	None
body	body required		LbHealthCheckSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.2"

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200"
    }
}

Example HTTP response

Response 202

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.20.2 - 1.1

put /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB 헬스 체크 ID Example : `e3cd678b11784734bc366148aa37580e`	string	None
body	body required		LbHealthCheckSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.1"

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200"
    }
}

Example HTTP response

Response 202

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.21 - SetLbListener

6.1.21.1 - 1.2

put /v1/lb-listeners/{listener_id}

Description

리스너 목록을 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	Listener 아이디 Example :	string	None
body	body required		LbListenerSetRequestV1Dot2

Responses

HTTP Code	Description	Schema
200	OK	LbListenerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.2"

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "insert_client_ip": "",
        "persistence": "",
        "response_timeout": "",
        "server_group_id": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": "",
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.21.2 - 1.1

put /v1/lb-listeners/{listener_id}

Description

리스너 목록을 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	Listener 아이디 Example :	string	None
body	body required		LbListenerSetRequest

Responses

HTTP Code	Description	Schema
200	OK	LbListenerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.1"

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "insert_client_ip": "",
        "persistence": "",
        "response_timeout": "",
        "server_group_id": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": "",
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.22 - SetLBServerGroup

6.1.22.1 - 1.2

put /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB 서버 그룹 ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string	None
body	body required		LbServerGroupSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_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 = loadbalancer 1.2"

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.22.2 - 1.1

put /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB 서버 그룹 ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string	None
body	body required		LbServerGroupSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_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 = loadbalancer 1.1"

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.23 - SetLbServerGroupMember

6.1.23.1 - 1.2

put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	string	None
path	member_id required	ID of Member Example :	string	None
body	body required		MemberSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	MemberShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.2"

Request body

{
    "member": {
        "member_port": 80,
        "member_state": "ENABLE",
        "member_weight": 100
    }
}

Example HTTP response

Response 202

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

6.1.23.2 - 1.1

put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	string	None
path	member_id required	ID of Member Example :	string	None
body	body required		MemberSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	MemberShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.1"

Request body

{
    "member": {
        "member_port": 80,
        "member_state": "ENABLE",
        "member_weight": 100
    }
}

Example HTTP response

Response 202

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

6.1.24 - SetLoadbalancer

6.1.24.1 - 1.1

put /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	string	None
body	body required		LoadbalancerUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LoadbalancerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.1"

Request body

{
    "loadbalancer": {
        "description": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.25 - ShowLBHealthCheck

6.1.25.1 - 1.2

get /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB 헬스 체크 ID Example : `e3cd678b11784734bc366148aa37580e`	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.25.2 - 1.1

get /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB 헬스 체크 ID Example : `e3cd678b11784734bc366148aa37580e`	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.26 - ShowLbListener

6.1.26.1 - 1.2

get /v1/lb-listeners/{listener_id}

Description

Listener를 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	Listener 아이디 Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbListenerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.26.2 - 1.1

get /v1/lb-listeners/{listener_id}

Description

Listener를 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	Listener 아이디 Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbListenerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.27 - ShowLBServerGroup

6.1.27.1 - 1.2

get /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB 서버 그룹 ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.27.2 - 1.1

get /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB 서버 그룹 ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.28 - ShowLbServerGroupMember

6.1.28.1 - 1.2

get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	string	None
path	member_id required	ID of Member Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	MemberShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

6.1.28.2 - 1.1

get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	Lb Server Group ID Example :	string	None
path	member_id required	ID of Member Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	MemberShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

6.1.29 - ShowLoadbalancer

6.1.29.1 - 1.2

get /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LoadbalancerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.29.2 - 1.1

get /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LoadbalancerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.30 - ShowLoadbalancerCertificate

6.1.30.1 - 1.2

get /v1/loadbalancers/certificates/{lb_certificate_id}

Description

인증서를 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	lb_certificate_id required	인증서 아이디 Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbCertificateShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/certificates/{lb_certificate_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "certificate": {
        "account_id": "",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "",
        "cn": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "not_after_dt": "2026-02-11T06:42:52.642Z",
        "not_before_dt": "2026-02-11T06:42:52.642Z",
        "organization": "",
        "private_key": "",
        "state": ""
    }
}

6.1.30.2 - 1.1

get /v1/loadbalancers/certificates/{lb_certificate_id}

Description

인증서를 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	lb_certificate_id required	인증서 아이디 Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbCertificateShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/certificates/{lb_certificate_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "certificate": {
        "account_id": "",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "",
        "cn": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "not_after_dt": "2026-02-11T06:42:52.642Z",
        "not_before_dt": "2026-02-11T06:42:52.642Z",
        "organization": "",
        "private_key": "",
        "state": ""
    }
}

6.1.31 - ShowLoadbalancerPublicNatIp

6.1.31.1 - 1.2

get /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

Show Load Balancer Public NAT IP

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LoadbalancerStaticNatResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "static_nat": {
        "external_ip_address": "",
        "publicip_id": "",
        "state": ""
    }
}

6.1.31.2 - 1.1

get /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

Show Load Balancer Public NAT IP

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	자원 ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LoadbalancerStaticNatResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "static_nat": {
        "external_ip_address": "",
        "publicip_id": "",
        "state": ""
    }
}

6.2 - Models

6.2.1 - HttpsRedirection

Name	Description	Schema
port optional	port Example :	any of [string, null]
protocol optional	프로토콜 Example :	any of [string, null]
response_code optional	response_code Example :	any of [string, null]

6.2.2 - LbCertificate

Name	Description	Schema
cert_kind optional	Example :	string
cn optional	Example :	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
name optional	Example :	string
not_after_dt optional	Example : `2026-02-11T06:42:52.611Z`	string (date-time)
not_before_dt optional	Example : `2026-02-11T06:42:52.611Z`	string (date-time)
state optional	Example :	string

6.2.3 - LbCertificateForShow

Name	Description	Schema
account_id required	The project ID of the certificate Example :	string
cert_body required	The body of the certificate Example :	string
cert_chain optional	The chain of the certificate Example :	any of [string, null]
cert_kind optional	Example :	string
cn optional	Example :	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
name optional	Example :	string
not_after_dt optional	Example : `2026-02-11T06:42:52.642Z`	string (date-time)
not_before_dt optional	Example : `2026-02-11T06:42:52.642Z`	string (date-time)
organization required	The organization of the certificate Example :	string
private_key required	인증서 개인키 Example :	string
state optional	Example :	string

6.2.4 - LbCertificateListResponse

Name	Description	Schema
certificates required		array[LbCertificate]
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]

6.2.5 - LbCertificateShowResponse

Name	Description	Schema	Default
certificate required		LbCertificateForShow

6.2.6 - LbHealthCheckCreate

Name	Description	Schema	Default
description optional	설명 Example : `this is an lb server group`	any of [string, null]
health_check_count optional	탐지 횟수 Example : `3` Minimum : `1` Maximum : `10`	integer	3
health_check_interval optional	헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. Example : `5` Minimum : `1` Maximum : `180`	integer	5
health_check_port optional	헬스 체크 포트 Example : `80`	any of [integer, null]
health_check_timeout optional	대기 시간 Example : `5` Minimum : `1` Maximum : `180`	integer	5
health_check_url optional	URL 모니터 Example : `/test` Pattern : `^\/[A-Za-z0-9/._?&=-]*$`	any of [string, null]
http_method optional	LB 헬스 체크 HTTP 방식 Example : `GET`	any of [enum (GET, POST), null]
name required	LB 헬스 체크명 Example : `ServerGroup01` Pattern : `^[a-zA-Z0-9][-a-zA-Z0-9_][a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `63`	string
protocol required	프로토콜 Example : `TCP`	enum (TCP, HTTP, HTTPS)
request_data optional	요청 문자열 Example : `username=admin&password=1234` Pattern : `^[a-zA-Z0-9_\W]*$`	any of [string, null]
response_code optional	응답 코드 Example : `200`	any of [string, null]
subnet_id required	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	string
tags optional	Tag List	array[Tag]
vpc_id required	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	string

6.2.7 - LbHealthCheckCreateRequest

Name	Description	Schema	Default
lb_health_check required		LbHealthCheckCreate

6.2.8 - LbHealthCheckList

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
health_check_type required	LB 헬스 체크 유형 Example : `DEFAULT`	enum (DEFAULT, CUSTOM)
id required	LB 헬스 체크 ID Example : `46c681018e33453085ca7c8db54e0076`	string
lb_server_group_count required	LB 서버 그룹 수 Example : `2`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	LB 헬스 체크명 Example : `Test-LbMonitor-01`	string
protocol required	프로토콜 Example : `TCP`	enum (TCP, HTTP, HTTPS)
state required	LB Health Check state Example : `ACTIVE`	string
subnet_id required	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	string

6.2.9 - LbHealthCheckListResponse

Name	Description	Schema
count required	count Example : `20`	integer
lb_health_checks required		array[LbHealthCheckList]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

6.2.10 - LbHealthCheckSet

Name	Description	Schema
description optional	설명 Example : `this is an lb server group`	any of [string, null]
health_check_count optional	탐지 횟수 Example : `3`	any of [integer, null]
health_check_interval optional	헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. Example : `5`	any of [integer, null]
health_check_port optional	헬스 체크 포트 Example : `80`	any of [integer, null]
health_check_timeout optional	대기 시간 Example : `5`	any of [integer, null]
health_check_url optional	URL 모니터 Example : `/test` Pattern : `^\/[A-Za-z0-9/._?&=-]*$`	any of [string, null]
http_method optional	LB 헬스 체크 HTTP 방식 Example : `GET`	any of [enum (GET, POST), null]
protocol optional	프로토콜 Example : `TCP`	any of [enum (TCP, HTTP, HTTPS), null]
request_data optional	요청 문자열 Example : `username=admin&password=1234` Pattern : `^[a-zA-Z0-9_\W]*$`	any of [string, null]
response_code optional	응답 코드 Example : `200`	any of [string, null]

6.2.11 - LbHealthCheckSetRequest

Name	Description	Schema	Default
lb_health_check required		LbHealthCheckSet

6.2.12 - LbHealthCheckShow

Name	Description	Schema	Default
account_id required	Account ID Example : `e3cd678b11784734bc366148aa37580e`	any of [string, null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example : `this is an lb server group`	any of [string, null]
health_check_count optional	탐지 횟수 Example : `3`	integer	3
health_check_interval optional	헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. Example : `5`	integer	5
health_check_port required	헬스 체크 포트 Example : `80`	any of [integer, null]
health_check_timeout optional	대기 시간 Example : `5`	integer	5
health_check_type required	LB 헬스 체크 유형 Example : `DEFAULT`	enum (DEFAULT, CUSTOM)
health_check_url required	URL 모니터 Example : `/test`	any of [string, null]
http_method required	LB 헬스 체크 HTTP 방식 Example : `GET`	any of [string, null]
id required	LB 헬스 체크 ID Example : `46c681018e33453085ca7c8db54e0076`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	LB 헬스 체크명 Example : `Test-LbMonitor-01`	string
protocol optional	프로토콜 Example : `TCP`	enum (TCP, HTTP, HTTPS)	TCP
request_data required	요청 문자열 Example : `username=admin&password=1234`	any of [string, null]
response_code required	응답 코드 Example : `200`	any of [string, null]
state required	LB Health Check state Example : `ACTIVE`	string
subnet_id required	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]
vpc_id required	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	any of [string, null]

6.2.13 - LbHealthCheckShowResponse

Name	Description	Schema	Default
lb_health_check required		LbHealthCheckShow

6.2.14 - LbListenerCreateRequest

Name	Description	Schema	Default
listener required		ListenerForCreate

6.2.15 - LbListenerCreateRequestV1Dot2

Name	Description	Schema	Default
listener required		ListenerForCreate

6.2.16 - LbListenerListResponse

Name	Description	Schema
count required	count Example : `20`	integer
listeners required	리스너 목록	array[ListenerForList]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

6.2.17 - LbListenerSetRequest

Name	Description	Schema	Default
listener required		ListenerForSet

6.2.18 - LbListenerSetRequestV1Dot2

Name	Description	Schema	Default
listener required		ListenerForSet

6.2.19 - LbListenerShowResponse

Name	Description	Schema	Default
listener required		ListenerForShow

6.2.20 - LbServerGroup

Name	Description	Schema
account_id required	Account ID Example : `e3cd678b11784734bc366148aa37580e`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example : `this is an lb server group`	any of [string, null]
id required	LB 서버 그룹 ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string
lb_health_check_id required	LB 헬스 체크 ID Example : `46c681018e33453085ca7c8db54e0076`	any of [string, null]
lb_method required	부하 분산 Example : `ROUND_ROBIN`	enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)
lb_name optional	Load Balancer 명 Example : `Test-LB-01`	any of [string, null]
loadbalancer_id optional	Load Balancer ID Example : `82efa35c88834bc083020443e57faa10`	any of [string, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	LB 서버 그룹 명 Example : `ServerGroup01`	string
protocol required	프로토콜 Example : `TCP`	enum (TCP, UDP)
state required	LB 서버 그룹 상태 Example : `ACTIVE`	string
subnet_id required	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	string
vpc_id required	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	string

6.2.21 - LbServerGroupCreate

Name	Description	Schema
description optional	설명 Example : `this is an lb server group`	any of [string, null]
lb_health_check_id optional	LB 헬스 체크 ID Example : `46c681018e33453085ca7c8db54e0076`	any of [string, null]
lb_method required	부하 분산 Example : `ROUND_ROBIN`	enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)
name required	LB 헬스 체크명 Example : `ServerGroup01` Pattern : `^[a-zA-Z0-9][-a-zA-Z0-9_][a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `63`	string
protocol required	프로토콜 Example : `TCP`	enum (TCP, UDP)
subnet_id required	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	string
tags optional	Tag List	array[Tag]
vpc_id required	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	string

6.2.22 - LbServerGroupCreateRequest

Name	Description	Schema	Default
lb_server_group required		LbServerGroupCreate

6.2.23 - LbServerGroupList

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	LB 서버 그룹 ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string
lb_health_check_id required	LB 헬스 체크 ID Example : `46c681018e33453085ca7c8db54e0076`	any of [string, null]
lb_name optional	Load Balancer 명 Example : `Test-LB-01`	any of [string, null]
lb_server_group_member_count required	서버 멤버 수 Example : `2`	integer
loadbalancer_id optional	Load Balancer ID Example : `82efa35c88834bc083020443e57faa10`	any of [string, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	LB 서버 그룹 명 Example : `ServerGroup01`	string
protocol required	프로토콜 Example : `TCP`	enum (TCP, UDP)
state required	LB 서버 그룹 상태 Example : `ACTIVE`	string
vpc_id required	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	string

6.2.24 - LbServerGroupListResponse

Name	Description	Schema
count required	count Example : `20`	integer
lb_server_groups required		array[LbServerGroupList]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

6.2.25 - LbServerGroupSet

Name	Description	Schema
description optional	설명 Example : `this is an lb server group`	any of [string, null]
lb_health_check_id optional	LB 헬스 체크 ID Example : `46c681018e33453085ca7c8db54e0076`	any of [string, null]
lb_method optional	부하 분산 Example : `ROUND_ROBIN`	any of [enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]

6.2.26 - LbServerGroupSetRequest

Name	Description	Schema	Default
lb_server_group required		LbServerGroupSet

6.2.27 - LbServerGroupShowResponse

Name	Description	Schema	Default
lb_server_group required		LbServerGroup

6.2.28 - ListenerForCreate

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description optional	설명 Example :	any of [string, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
loadbalancer_id required	LB 아이디 Example :	string
name required	Listener 명 Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
persistence optional	지속성 유형 Example :	any of [string, null]
protocol required	프로토콜 Example :	string
response_timeout optional	응답 시간 초과 Example :	any of [integer, null]
routing_action required	The routing action of the listener. Example : `LB_SERVER_GROUP`	enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id optional	LB 서버 그룹 아이디 Example :	any of [string, null]
service_port required	서비스 포트 Example : Minimum : `1` Maximum : `65534`	integer
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	SSL 인증서	any of [SslCertificate, null]
support_http2 optional	Whether the HTTP 2.0 is supported Example : `False`	any of [boolean, null]
tags optional	Tag List	array[Tag]
url_handler optional	URL 처리 Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.29 - ListenerForList

Name	Description	Schema
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	Listener 명 Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
protocol required	프로토콜 Example :	string
service_port required	서비스 포트 Example : Minimum : `1` Maximum : `65534`	integer
state optional	Listener 상태 Example :	any of [string, null]

6.2.30 - ListenerForSet

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description optional	설명 Example :	any of [string, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
persistence optional	지속성 유형 Example :	any of [string, null]
response_timeout optional	응답 시간 초과 Example :	any of [integer, null]
server_group_id optional	LB 서버 그룹 아이디 Example :	any of [string, null]
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	SSL 인증서	any of [SslCertificate, null]
support_http2 optional	Whether the HTTP 2.0 is supported Example :	boolean
url_handler optional	URL 처리 Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.31 - ListenerForShow

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
id required	자원 ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Listener 명 Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
persistence optional	지속성 유형 Example :	any of [string, null]
protocol required	프로토콜 Example :	string
response_timeout optional	응답 시간 초과 Example :	any of [integer, null]
routing_action optional	The routing action of the listener. Example : `LB_SERVER_GROUP`	any of [enum (LB_SERVER_GROUP, URL_REDIRECT), null]
server_group_id optional	LB 서버 그룹 아이디 Example :	any of [string, null]
server_group_name optional	LB 서버 그룹 명 Example :	any of [string, null]
service_port required	서비스 포트 Example : Minimum : `1` Maximum : `65534`	integer
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	SSL 인증서	any of [SslCertificate, null]
state required	Listener 상태 Example :	string
support_http2 optional	Whether the HTTP 2.0 is supported Example : `False`	any of [boolean, null]
url_handler optional	URL 처리 Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.32 - Loadbalancer

Name	Description	Schema
account_id required	LoadBalancer account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
firewall_id optional	방화벽 ID Example :	any of [string, null]
health_check_ip required	Health check IP	array[string]
id required	자원 ID Example :	string
layer_type required	계층 타입 Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	이름 Example :	string
public_nat_enabled optional	Public NAT Enabled Status Example :	any of [boolean, null]
service_ip optional	LoadBalancer 서비스 IP Example :	any of [string, null]
source_nat_ip optional	Source NAT IP Example :	any of [string, null]
state required	The state of the load balancer. Example :	string
subnet_id required	Subnet ID Example :	string
vpc_id required	VPC ID Example :	string

6.2.33 - LoadbalancerCreateRequest

Name	Description	Schema	Default
loadbalancer required		LoadbalancerCreateRequestDetail

6.2.34 - LoadbalancerCreateRequestDetail

Name	Description	Schema	Default
description optional	설명 Example :	any of [string, null]
firewall_enabled optional	방화벽 사용 여부 Example : `True`	any of [boolean, null]	True
firewall_logging_enabled optional	방화벽 로깅 여부 Example : `True`	any of [boolean, null]	True
health_check_ip_1 optional	Health check IP Example :	any of [string, null]
health_check_ip_2 optional	Health check IP Example :	any of [string, null]
layer_type required	계층 타입 Example :	string
name required	이름 Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
publicip_id optional	Public IP ID Example :	any of [string, null]
service_ip optional	LoadBalancer 서비스 IP Example :	any of [string, null]
source_nat_ip optional	Source NAT IP Example :	any of [string, null]
subnet_id required	Subnet ID Example :	string
tags optional	Tag List	array[Tag]
vpc_id required	VPC ID Example :	string

6.2.35 - LoadbalancerCreateResponse

Name	Description	Schema	Default
loadbalancer required		LoadbalancerCreateResponseDetail

6.2.36 - LoadbalancerCreateResponseDetail

Name	Description	Schema
account_id required	LoadBalancer account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
id required	자원 ID Example :	string
layer_type required	계층 타입 Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	이름 Example :	string
state required	The state of the load balancer. Example :	string
subnet_id required	Subnet ID Example :	string
vpc_id required	VPC ID Example :	string

6.2.37 - LoadbalancerListResponse

Name	Description	Schema
count required	count Example : `20`	integer
loadbalancers required		array[LoadbalancerListResponseDetail]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

6.2.38 - LoadbalancerListResponseDetail

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
firewall_id optional	방화벽 ID Example :	any of [string, null]
id required	자원 ID Example :	string
layer_type optional	계층 타입 Example :	any of [string, null]
listener_count optional	Listener 개수 Example :	any of [integer, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name optional	LoadBalancer 명 Example :	any of [string, null]
public_nat_enabled optional	Public NAT Enabled Status Example :	any of [boolean, null]
service_ip optional	LoadBalancer 서비스 IP Example :	any of [string, null]
source_nat_ip optional	Source NAT IP Example :	any of [string, null]
state optional	The state of the load balancer. Example :	any of [string, null]
subnet_id optional	Subnet ID Example :	any of [string, null]
vpc_id optional	VPC ID Example :	any of [string, null]

6.2.39 - LoadbalancerShowResponse

Name	Description	Schema	Default
loadbalancer required		Loadbalancer

6.2.40 - LoadbalancerStaticNatResponse

Name	Description	Schema	Default
static_nat required		StaticNat

6.2.41 - LoadbalancerUpdateRequest

Name	Description	Schema	Default
loadbalancer required		LoadbalancerUpdateRequestDetail

6.2.42 - LoadbalancerUpdateRequestDetail

Name	Description	Schema	Default
description required	설명 Example : Maximum length : `255`	string

6.2.43 - Member

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	자원 ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
lb_server_group_id required	Lb Server Group ID Example :	string
member_ip required	Member ID Example :	string
member_port required	Member 포트 Example :	integer
member_state required	Member State of Member Example :	string
member_weight required	Weight of Member Example :	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Member 명 Example :	string
object_id optional	Member 대상 서버의 ID Example :	any of [string, null]
object_type required	Member의 대상 서버 타입 Example : `VM`	enum (VM, BM, MANUAL, MNGC)
state required	State of Member Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
subnet_id required	Sunbet ID Example :	string
uuid required	UUID of Member Example :	string

6.2.44 - MemberCreateRequestV1Dot1

Name	Description	Schema
member_ip required	Member ID Example : `192.168.0.1`	string
member_port required	Member 포트 Example : `80` Minimum : `1` Maximum : `65534`	integer
member_state optional	Member State of Member Example : `ENABLE`	any of [enum (ENABLE, DISABLE), null]
member_weight optional	Weight of Member Example : `100` Minimum : `1` Maximum : `1000`	integer
name required	Member 명 Example : `virtualserver-1` Pattern : `^[a-zA-Z0-9\s\-_\.]$` Minimum length* : `1` Maximum length : `63`	string
object_id optional	Member 대상 서버의 ID Example : `1`	string
object_type required	Member의 대상 서버 타입 Example : `VM`	string

6.2.45 - MemberDeleteBulkRequestV1Dot2

Name	Description	Schema	Default
member_id_list required	ID list of Member	array[string]

6.2.46 - MemberListCreateRequestV1Dot1

Name	Description	Schema	Default
members required		array[MemberCreateRequestV1Dot1]

6.2.47 - MemberListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
members required		array[Member]

6.2.48 - MemberSet

Name	Description	Schema
member_port optional	Member 포트 Example : `80`	any of [integer, null]
member_state optional	Member State of Member Example : `ENABLE`	any of [enum (ENABLE, DISABLE), null]
member_weight optional	Weight of Member Example : `100`	any of [integer, null]

6.2.49 - MemberSetRequest

Name	Description	Schema	Default
member required		MemberSet

6.2.50 - MemberShowResponse

Name	Description	Schema	Default
member required		any of [Member, null]

6.2.51 - MemberWithHealthState

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
health_state required	Member의 Health State Example :	string
id required	자원 ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
lb_server_group_id required	Lb Server Group ID Example :	string
member_ip required	Member ID Example :	string
member_port required	Member 포트 Example :	integer
member_state required	Member State of Member Example :	string
member_weight required	Weight of Member Example :	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Member 명 Example :	string
object_id required	Member 대상 서버의 ID Example :	any of [string, null]
object_type required	Member의 대상 서버 타입 Example : `VM`	enum (VM, BM, MANUAL, MNGC)
state required	State of Member Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)

6.2.52 - MemberWithHealthStateListResponse

Name	Description	Schema
count required	count Example : `20`	integer
members required		array[MemberWithHealthState]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

6.2.53 - SniCertificate

Name	Description	Schema	Default
domain_name optional	Domain name for sni ssl Example : Pattern : `^[a-zA-Z0-9](?:[a-zA-Z0-9.-]{0,61}[a-zA-Z0-9])?$`	any of [string, null]
sni_cert_id optional	Certificate id for sni ssl Example :	any of [string, null]

6.2.54 - SslCertificate

Name	Description	Schema
client_cert_id optional	Certificate id for client ssl Example :	any of [string, null]
client_cert_level optional	Certificate level for client ssl Example :	any of [string, null]
server_cert_level optional	Certificate level for server ssl Example :	any of [string, null]

6.2.55 - StaticNat

Name	Description	Schema
external_ip_address required	Static Nat External Ip Address Example :	string
publicip_id optional	Publicip ID Example :	any of [string, null]
state required	Static Nat State Example :	string

6.2.56 - StaticNatCreateRequest

Name	Description	Schema	Default
static_nat required		StaticNatCreateRequestDetail

6.2.57 - StaticNatCreateRequestDetail

Name	Description	Schema	Default
publicip_id required	publicip_id Example :	string

6.2.58 - StaticNatCreateResponse

Name	Description	Schema	Default
static_nat required		StaticNatCreateResponseDetail

6.2.59 - StaticNatCreateResponseDetail

Name	Description	Schema
account_id optional	account_id Example :	any of [string, null]
action_type optional	action_type Example :	any of [string, null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
external_ip_address optional	external_ip_address Example :	any of [string, null]
id optional	자원 ID Example :	any of [string, null]
internal_ip_address optional	internal_ip_address Example :	any of [string, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name optional	이름 Example :	any of [string, null]
owner_id optional	owner_id Example :	any of [string, null]
owner_name optional	owner_name Example :	any of [string, null]
owner_type optional	owner_type Example :	any of [string, null]
publicip_id optional	publicip_id Example :	any of [string, null]
service_ip_port_id optional	service_ip_port_id Example :	any of [string, null]
state optional	state Example :	any of [string, null]
subnet_id optional	subnet_id Example :	any of [string, null]
type optional	type Example :	any of [string, null]
vpc_id optional	vpc_id Example :	any of [string, null]

6.2.60 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

7 - Security Group

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다. 본 가이드는 Security Group 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://security-group.{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

7.1 - APIs

7.1.1 - Create Security Group

7.1.1.1 - 1.0

post /v1/security-groups

Description

Security Group을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SecurityGroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	SecurityGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/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 = security-group 1.0"

Request body

{
    "description": "",
    "loggable": false,
    "name": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "security_group": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "rule_count": 0,
        "state": ""
    }
}

7.1.2 - Create Security Group Rule

7.1.2.1 - 1.0

post /v1/security-group-rules

Description

Security Group rule을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SecurityGroupRuleCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	SecurityGroupRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/security-group-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.0"

Request body

{
    "description": "",
    "direction": "",
    "ethertype": "IPv4",
    "port_range_max": "",
    "port_range_min": "",
    "protocol": "",
    "remote_group_id": "",
    "remote_ip_prefix": "",
    "security_group_id": ""
}

Example HTTP response

Response 201

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direction": "ingress",
        "ethertype": "IPv4",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": "",
        "port_range_min": "",
        "protocol": "",
        "remote_group_id": "",
        "remote_group_name": "",
        "remote_ip_prefix": "",
        "security_group_id": ""
    }
}

7.1.3 - Delete Security Group

7.1.3.1 - 1.0

delete /v1/security-groups/{security_group_id}

Description

Security Group을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_id required	Security Group ID Example :	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/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 = security-group 1.0"

Example HTTP response

Response 204

7.1.4 - Delete Security Group Rule

7.1.4.1 - 1.0

delete /v1/security-group-rules/{security_group_rule_id}

Description

Security Group rule을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_rule_id required	Security Group Rule ID Example :	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/security-group-rules/{security_group_rule_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 = security-group 1.0"

Example HTTP response

Response 204

7.1.5 - List Security Group Rules

7.1.5.1 - 1.0

get /v1/security-group-rules

Description

Security Group rule 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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	id optional	Security Group Rule ID Example :	string	None
query	security_group_id required	Security Group ID Example :	string	None
query	remote_ip_prefix optional	Security Group Rule IP 주소 Example :	string	None
query	remote_group_id optional	Security Group Rule 원격 그룹 ID Example :	string	None
query	description optional	Security Group Rule 설명 Example :	string	None
query	direction optional	Security Group Rule 방향 (Ingress, Egress) Example :	string	None
query	service optional	Security Group Rule 서비스 Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecurityGroupRuleListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/security-group-rules?security_group_id={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 = security-group 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_group_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "direction": "ingress",
            "ethertype": "IPv4",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "port_range_max": "",
            "port_range_min": "",
            "protocol": "",
            "remote_group_id": "",
            "remote_group_name": "",
            "remote_ip_prefix": "",
            "security_group_id": ""
        }
    ]
}

7.1.6 - List Security Groups

7.1.6.1 - 1.0

get /v1/security-groups

Description

Security Group 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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	id optional	Security Group ID Example :	string	None
query	name optional	Security Group 이름 Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecurityGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/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 = security-group 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_groups": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "loggable": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "rule_count": 0,
            "state": ""
        }
    ]
}

7.1.7 - Set Security Group

7.1.7.1 - 1.0

put /v1/security-groups/{security_group_id}

Description

Security Group을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_id required	Security Group ID Example :	string	None
body	body required		SecurityGroupSetRequest

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/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 = security-group 1.0"

Request body

{
    "description": "",
    "loggable": ""
}

Example HTTP response

Response 200

7.1.8 - Show Security Group

7.1.8.1 - 1.0

get /v1/security-groups/{security_group_id}

Description

Security Group 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_id required	Security Group ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecurityGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/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 = security-group 1.0"

Example HTTP response

Response 200

{
    "security_group": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "rule_count": 0,
        "state": ""
    }
}

7.1.9 - Show Security Group Rule

7.1.9.1 - 1.0

get /v1/security-group-rules/{security_group_rule_id}

Description

Security Group rule을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_rule_id required	Security Group Rule ID Example :	string	None
query	fields optional	필드명 Example :	any of [array[object], string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	SecurityGroupRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/security-group-rules/{security_group_rule_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 = security-group 1.0"

Example HTTP response

Response 200

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direction": "ingress",
        "ethertype": "IPv4",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": "",
        "port_range_min": "",
        "protocol": "",
        "remote_group_id": "",
        "remote_group_name": "",
        "remote_ip_prefix": "",
        "security_group_id": ""
    }
}

7.2 - Models

7.2.1 - SecurityGroup

Name	Description	Schema
account_id required	Security Group Account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	Security Group 설명 Example :	any of [string, null]
id required	Security Group ID Example :	string
loggable required	Security Group 로깅 여부 Example :	boolean
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Security Group 이름 Example :	string
rule_count optional	Security Group Rule 수 Example : `0`	integer
state required	Security Group 상태 Example :	string

7.2.2 - SecurityGroupCreateRequest

Name	Description	Schema
description optional	Security Group 설명 Example :	any of [string, null]
loggable optional	Security Group 로깅 여부 Example : `False`	any of [boolean, null]
name required	Security Group 이름 Example : Maximum length : `255`	string
tags optional	태그 목록	array[Tag]

7.2.3 - SecurityGroupListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
security_groups required		array[SecurityGroup]

7.2.4 - SecurityGroupRule

Name	Description	Schema	Default
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	Security Group Rule 설명 Example :	any of [string, null]
direction required	Security Group Rule 방향 (Ingress, Egress) Example : `ingress`	enum (ingress, egress)
ethertype optional	Security Group Rule Ethertype (IPV4, IPV6) Example : `IPv4`	any of [string, null]	IPv4
id required	Security Group Rule ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
port_range_max required	Security Group Rule 포트 범위 최대값 Example :	any of [integer, null]
port_range_min required	Security Group Rule 포트 범위 최소값 Example :	any of [integer, null]
protocol required	Security Group Rule 프로토콜 Example :	any of [string, null]
remote_group_id required	Security Group Rule 원격 그룹 ID Example :	any of [string, null]
remote_group_name optional	Security Group Rule 원격 그룹 이름 Example :	any of [string, null]
remote_ip_prefix required	Security Group Rule IP 주소 Example :	any of [string, null]
security_group_id required	Security Group ID Example :	string

7.2.5 - SecurityGroupRuleCreateRequest

Name	Description	Schema	Default
description optional	Security Group Rule 설명 Example :	any of [string, null]
direction required	Security Group Rule 방향 (Ingress, Egress) Example :	string
ethertype optional	Security Group Rule Ethertype (IPV4, IPV6) Example : `IPv4`	any of [string, null]	IPv4
port_range_max optional	Security Group Rule 포트 범위 최대값 Example :	any of [integer, null]
port_range_min optional	Security Group Rule 포트 범위 최소값 Example :	any of [integer, null]
protocol optional	Security Group Rule 프로토콜 Example :	any of [string, null]
remote_group_id optional	Security Group Rule 원격 그룹 ID Example :	any of [string, null]
remote_ip_prefix optional	Security Group Rule IP 주소 Example :	any of [string, null]
security_group_id required	Security Group ID Example :	string

7.2.6 - SecurityGroupRuleListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
security_group_rules required		array[SecurityGroupRule]

7.2.7 - SecurityGroupRuleShowResponse

Name	Description	Schema	Default
security_group_rule required		SecurityGroupRule

7.2.8 - SecurityGroupSetRequest

Name	Description	Schema	Default
description optional	Security Group 설명 Example :	any of [string, null]
loggable optional	Security Group 로깅 여부 Example :	any of [boolean, null]

7.2.9 - SecurityGroupShowResponse

Name	Description	Schema	Default
security_group required		SecurityGroup

7.2.10 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

8 - VPC

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 VPC 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

OpenAPI URL

https://vpc.{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

8.1 - APIs

8.1.1 - Approval VPC Peering

8.1.1.1 - 1.1

put /v1/vpc-peerings/{vpc_peering_id}/approval

Description

VPC Peering 승인

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
body	body required		VpcPeeringApprovalRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.1"

Request body

{
    "type": "CREATE_APPROVE"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

8.1.2 - Approve PrivateLink Endpoint

8.1.2.1 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Description

Approve PrivateLink Endpoint

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None
body	body required		PrivateLinkEndpointApprovalRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointSummaryShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_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 = vpc 1.1"

Request body

{
    "type": "APPROVE"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2026-02-11T06:45:10.579Z",
        "id": "",
        "state": "REQUESTING"
    }
}

8.1.3 - Connect PrivateLink Endpoint

8.1.3.1 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Description

Connect PrivateLink Endpoint

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None
body	body required		PrivateLinkEndpointConnectionRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointSummaryShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_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 = vpc 1.1"

Request body

{
    "type": "DISCONNECT"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2026-02-11T06:45:10.579Z",
        "id": "",
        "state": "REQUESTING"
    }
}

8.1.4 - Create Internet Gateway

8.1.4.1 - 1.1

post /v1/internet-gateways

Description

Internet Gateway를 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		InternetGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	InternetGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/internet-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "description": "",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.4.2 - 1.0

post /v1/internet-gateways

Description

Internet Gateway를 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		InternetGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	InternetGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/internet-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "description": "",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.5 - Create NAT Gateway

8.1.5.1 - 1.1

post /v1/nat-gateways

Description

NAT Gateway를 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		NatGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	NatGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "description": "",
    "publicip_id": "",
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.5.2 - 1.0

post /v1/nat-gateways

Description

NAT Gateway를 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		NatGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	NatGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "description": "",
    "publicip_id": "",
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.6 - Create Port

8.1.6.1 - 1.1

post /v1/ports

Description

Port를 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PortCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PortShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/ports

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "description": "",
    "fixed_ip_address": "",
    "name": "",
    "security_groups": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:08.922Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:08.922Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.6.2 - 1.0

post /v1/ports

Description

Port를 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		PortCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PortShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/ports

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "description": "",
    "fixed_ip_address": "",
    "name": "",
    "security_groups": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:08.922Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:08.922Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.7 - Create Private NAT

8.1.7.1 - 1.1

post /v1/private-nats

Description

Private NAT 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateNatCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateNatShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-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 = vpc 1.1"

Request body

{
    "cidr": "",
    "description": "",
    "direct_connect_id": "",
    "name": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.7.2 - 1.0

post /v1/private-nats

Description

Private NAT 생성

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateNatCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateNatShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-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 = vpc 1.0"

Request body

{
    "cidr": "",
    "description": "",
    "direct_connect_id": "",
    "name": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.8 - Create Private NAT IP

8.1.8.1 - 1.1

post /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
body	body required		PrivateNatIpCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PrivateNatIpShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.1"

Request body

{
    "ip_address": ""
}

Example HTTP response

Response 201

{
    "private_nat_ip": {
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_id": "",
        "state": "RESERVED"
    }
}

8.1.8.2 - 1.0

post /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 생성

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
body	body required		PrivateNatIpCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PrivateNatIpShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.0"

Request body

{
    "ip_address": ""
}

Example HTTP response

Response 201

{
    "private_nat_ip": {
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_id": "",
        "state": "RESERVED"
    }
}

8.1.9 - Create PrivateLink Endpoint

8.1.9.1 - 1.1

post /v1/privatelink-endpoints

Description

PrivateLink Endpoint 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateLinkEndpointCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateLinkEndpointShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/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 = vpc 1.1"

Request body

{
    "description": "",
    "endpoint_ip_address": "",
    "name": "",
    "privatelink_service_id": "",
    "security_group_ids": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "privatelink_endpoint": {
        "account_id": "",
        "approval_type": "MANUAL",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "endpoint_ip_port_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "privatelink_service_id": "",
        "security_group_ids": [],
        "state": "REQUESTING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

8.1.10 - Create PrivateLink Service

8.1.10.1 - 1.1

post /v1/privatelink-services

Description

PrivateLink Service 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateLinkServiceCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateLinkServiceShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/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 = vpc 1.1"

Request body

{
    "approval_type": "MANUAL",
    "connected_resource_id": "",
    "connected_resource_ip_address": "",
    "connected_resource_type": "LB",
    "description": "",
    "high_speed_transfer": false,
    "name": "",
    "security_group_ids": [],
    "service_ip_address": "",
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "privatelink_service": {
        "account_id": "",
        "approval_type": "MANUAL",
        "connected_resource_id": "",
        "connected_resource_ip_address": "",
        "connected_resource_name": "",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "high_speed_transfer": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "security_group_ids": [],
        "service_ip_address": "",
        "service_ip_port_id": "",
        "state": "CREATING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

8.1.11 - Create PublicIP

8.1.11.1 - 1.1

post /v1/publicips

Description

PublicIP를 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PublicipCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PublicipShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/publicips

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "description": "",
    "tags": [],
    "type": "IGW"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

8.1.11.2 - 1.0

post /v1/publicips

Description

PublicIP를 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		PublicipCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PublicipShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/publicips

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "description": "",
    "tags": [],
    "type": "IGW"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

8.1.12 - Create Subnet

8.1.12.1 - 1.1

post /v1/subnets

Description

Subnet을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SubnetCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "allocation_pools": "[{\"start\":\"192.167.1.2\", \"end\":\"192.167.1.100\"}]",
    "cidr": "192.167.1.0/24",
    "description": "Subnet Description",
    "dns_nameservers": "[\"1.1.1.1\", \"2.2.2.2\"]",
    "host_routes": "[{\"destination\":\"192.168.10.0/24\", \"nexthop\":\"192.168.10.0\"}]",
    "name": "subnetName",
    "tags": [],
    "type": "GENERAL",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.12.2 - 1.0

post /v1/subnets

Description

Subnet을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		SubnetCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "allocation_pools": "[{\"start\":\"192.167.1.2\", \"end\":\"192.167.1.100\"}]",
    "cidr": "192.167.1.0/24",
    "description": "Subnet Description",
    "dns_nameservers": "[\"1.1.1.1\", \"2.2.2.2\"]",
    "host_routes": "[{\"destination\":\"192.168.10.0/24\", \"nexthop\":\"192.168.10.0\"}]",
    "name": "subnetName",
    "tags": [],
    "type": "GENERAL",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.13 - Create Transit Gateway

8.1.13.1 - 1.1

post /v1/transit-gateways

Description

Transit Gateway 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		TransitGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "description": "",
    "name": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

8.1.13.2 - 1.0

post /v1/transit-gateways

Description

Transit Gateway 생성

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		TransitGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "description": "",
    "name": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

8.1.14 - Create Transit Gateway Rule

8.1.14.1 - 1.1

post /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewayRuleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayRuleShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "description": "",
    "destination_cidr": "",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": ""
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "destination_cidr": "",
        "destination_resource_id": "",
        "destination_resource_name": "",
        "destination_type": "VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_resource_id": "",
        "source_resource_name": "",
        "source_type": "VPC",
        "state": "CREATING",
        "tgw_connection_vpc_id": "",
        "tgw_connection_vpc_name": ""
    }
}

8.1.14.2 - 1.0

post /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 생성

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewayRuleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayRuleShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "description": "",
    "destination_cidr": "",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": ""
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "destination_cidr": "",
        "destination_resource_id": "",
        "destination_resource_name": "",
        "destination_type": "VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_resource_id": "",
        "source_resource_name": "",
        "source_type": "VPC",
        "state": "CREATING",
        "tgw_connection_vpc_id": "",
        "tgw_connection_vpc_name": ""
    }
}

8.1.15 - Create Transit Gateway VPC Connection

8.1.15.1 - 1.1

post /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 생성.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewayVpcConnectionCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayVpcConnectionShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "CREATING",
        "transit_gateway_id": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.15.2 - 1.0

post /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 생성.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewayVpcConnectionCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayVpcConnectionShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "CREATING",
        "transit_gateway_id": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.16 - Create VPC

8.1.16.1 - 1.1

post /v1/vpcs

Description

VPC를 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	VpcShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpcs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "cidr": "192.167.0.0/18",
    "description": "VPC Description",
    "name": "vpcName",
    "tags": []
}

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

8.1.16.2 - 1.0

post /v1/vpcs

Description

VPC를 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	VpcShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpcs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "cidr": "192.167.0.0/18",
    "description": "VPC Description",
    "name": "vpcName",
    "tags": []
}

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

8.1.17 - Create VPC Endpoint

8.1.17.1 - 1.1

post /v1/vpc-endpoints

Description

VPC Endpoint 를 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcEndpointCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcEndpointShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-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 = vpc 1.1"

Request body

{
    "description": "",
    "endpoint_ip_address": "",
    "name": "",
    "resource_info": "",
    "resource_key": "",
    "resource_type": "FS",
    "subnet_id": "",
    "tags": [],
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.17.2 - 1.0

post /v1/vpc-endpoints

Description

VPC Endpoint 를 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcEndpointCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcEndpointShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-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 = vpc 1.0"

Request body

{
    "description": "",
    "endpoint_ip_address": "",
    "name": "",
    "resource_info": "",
    "resource_key": "",
    "resource_type": "FS",
    "subnet_id": "",
    "tags": [],
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.18 - Create VPC Peering

8.1.18.1 - 1.1

post /v1/vpc-peerings

Description

VPC Peering 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcPeeringCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcPeeringShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "approver_vpc_account_id": "",
    "approver_vpc_id": "",
    "description": "",
    "name": "",
    "requester_vpc_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

8.1.18.2 - 1.0

post /v1/vpc-peerings

Description

VPC Peering 생성

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcPeeringCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcPeeringShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "approver_vpc_account_id": "",
    "approver_vpc_id": "",
    "description": "",
    "name": "",
    "requester_vpc_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

8.1.19 - Create Vpc Peering Rule

8.1.19.1 - 1.1

post /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
body	body required		VpcPeeringRuleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcPeeringRuleShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "destination_cidr": "",
    "destination_vpc_type": "REQUESTER_VPC",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "destination_cidr": "",
        "destination_vpc_id": "",
        "destination_vpc_name": "",
        "destination_vpc_type": "REQUESTER_VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_vpc_id": "",
        "source_vpc_name": "",
        "source_vpc_type": "REQUESTER_VPC",
        "state": "CREATING",
        "vpc_peering_id": ""
    }
}

8.1.19.2 - 1.0

post /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 생성

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
body	body required		VpcPeeringRuleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcPeeringRuleShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "destination_cidr": "",
    "destination_vpc_type": "REQUESTER_VPC",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "destination_cidr": "",
        "destination_vpc_id": "",
        "destination_vpc_name": "",
        "destination_vpc_type": "REQUESTER_VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_vpc_id": "",
        "source_vpc_name": "",
        "source_vpc_type": "REQUESTER_VPC",
        "state": "CREATING",
        "vpc_peering_id": ""
    }
}

8.1.20 - Delete Internet Gateway

8.1.20.1 - 1.1

delete /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.20.2 - 1.0

delete /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.0"

Example HTTP response

Response 202

8.1.21 - Delete NAT Gateway

8.1.21.1 - 1.1

delete /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway 명 Example :	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/nat-gateways/{nat_gateway_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.21.2 - 1.0

delete /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway 명 Example :	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/nat-gateways/{nat_gateway_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 = vpc 1.0"

Example HTTP response

Response 202

8.1.22 - Delete Port

8.1.22.1 - 1.1

delete /v1/ports/{port_id}

Description

Port를 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/ports/{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 = vpc 1.1"

Example HTTP response

Response 204

8.1.22.2 - 1.0

delete /v1/ports/{port_id}

Description

Port를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/ports/{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 = vpc 1.0"

Example HTTP response

Response 204

8.1.23 - Delete Private NAT

8.1.23.1 - 1.1

delete /v1/private-nats/{private_nat_id}

Description

Private NAT 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/private-nats/{private_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.23.2 - 1.0

delete /v1/private-nats/{private_nat_id}

Description

Private NAT 삭제

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/private-nats/{private_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 = vpc 1.0"

Example HTTP response

Response 202

8.1.24 - Delete Private NAT IP

8.1.24.1 - 1.1

delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}

Description

Private NAT IP 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
path	private_nat_ip_id required	Private NAT IP ID Example :	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/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_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 = vpc 1.1"

Example HTTP response

Response 204

8.1.24.2 - 1.0

delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}

Description

Private NAT IP 삭제

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
path	private_nat_ip_id required	Private NAT IP ID Example :	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/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_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 = vpc 1.0"

Example HTTP response

Response 204

8.1.25 - Delete PrivateLink Endpoint

8.1.25.1 - 1.1

delete /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	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/privatelink-endpoints/{privatelink_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.26 - Delete PrivateLink Service

8.1.26.1 - 1.1

delete /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.27 - Delete PublicIP

8.1.27.1 - 1.1

delete /v1/publicips/{publicip_id}

Description

PublicIP를 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.1"

Example HTTP response

Response 204

8.1.27.2 - 1.0

delete /v1/publicips/{publicip_id}

Description

PublicIP를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.0"

Example HTTP response

Response 204

8.1.28 - Delete Subnet

8.1.28.1 - 1.1

delete /v1/subnets/{subnet_id}

Description

Subnet을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/subnets/{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 = vpc 1.1"

Example HTTP response

Response 202

8.1.28.2 - 1.0

delete /v1/subnets/{subnet_id}

Description

Subnet을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/subnets/{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 = vpc 1.0"

Example HTTP response

Response 202

8.1.29 - Delete Transit Gateway

8.1.29.1 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.29.2 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 삭제

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.0"

Example HTTP response

Response 202

8.1.30 - Delete Transit Gateway Rule

8.1.30.1 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}

Description

Transit Gateway 규칙 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
path	routing_rule_id required	Routing Rule ID Example :	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/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.30.2 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}

Description

Transit Gateway 규칙 삭제

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
path	routing_rule_id required	Routing Rule ID Example :	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/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_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 = vpc 1.0"

Example HTTP response

Response 202

8.1.31 - Delete Transit Gateway VPC Connection

8.1.31.1 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}

Description

Transit Gateway VPC 연결 삭제.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
path	vpc_connection_id required	Transit Gateway VPC 연결 ID Example :	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/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.31.2 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}

Description

Transit Gateway VPC 연결 삭제.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
path	vpc_connection_id required	Transit Gateway VPC 연결 ID Example :	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/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_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 = vpc 1.0"

Example HTTP response

Response 202

8.1.32 - Delete VPC

8.1.32.1 - 1.1

delete /v1/vpcs/{vpc_id}

Description

VPC를 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.1"

Example HTTP response

Response 204

8.1.32.2 - 1.0

delete /v1/vpcs/{vpc_id}

Description

VPC를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.0"

Example HTTP response

Response 204

8.1.33 - Delete VPC Endpoint

8.1.33.1 - 1.1

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.33.2 - 1.0

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_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 = vpc 1.0"

Example HTTP response

Response 202

8.1.34 - Delete VPC Peering

8.1.34.1 - 1.1

delete /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	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/vpc-peerings/{vpc_peering_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.34.2 - 1.0

delete /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 삭제

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	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/vpc-peerings/{vpc_peering_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 = vpc 1.0"

Example HTTP response

Response 202

8.1.35 - Delete VPC Peering Rule

8.1.35.1 - 1.1

delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}

Description

VPC Peering 규칙 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
path	routing_rule_id required	Routing Rule ID Example :	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/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_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 = vpc 1.1"

Example HTTP response

Response 202

8.1.35.2 - 1.0

delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}

Description

VPC Peering 규칙 삭제

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
path	routing_rule_id required	Routing Rule ID Example :	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/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_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 = vpc 1.0"

Example HTTP response

Response 202

8.1.36 - List Connected PrivateLink Endpoints

8.1.36.1 - 1.1

get /v1/privatelink-services/{privatelink_service_id}/connected-endpoints

Description

연결된 PrivateLink Endpoint 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example :	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

Responses

HTTP Code	Description	Schema
200	OK	ConnectedEndpointListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_id}/connected-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 = vpc 1.1"

Example HTTP response

Response 200

{
    "connected_privatelink_endpoints": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "privatelink_service_id": "",
            "state": "REQUESTING"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.37 - List Internet Gateways

8.1.37.1 - 1.1

get /v1/internet-gateways

Description

Internet Gateway 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Internet Gateway ID Example :	any of [string, null]	None
query	name optional	Internet Gateway 명 Example :	any of [string, null]	None
query	type optional	Internet Gateway 유형 Example :	enum (IGW, GGW, SIGW)
query	state optional	상태 Example :	string
query	vpc_id optional	VPC ID Example :	any of [string, null]
query	vpc_name optional	VPC 명 Example :	any of [string, null]

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/internet-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "internet_gateways": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "firewall_id": "",
            "id": "",
            "loggable": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "",
            "vpc_name": ""
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

8.1.37.2 - 1.0

get /v1/internet-gateways

Description

Internet Gateway 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Internet Gateway ID Example :	any of [string, null]	None
query	name optional	Internet Gateway 명 Example :	any of [string, null]	None
query	type optional	Internet Gateway 유형 Example :	enum (IGW, GGW, SIGW)
query	state optional	상태 Example :	string
query	vpc_id optional	VPC ID Example :	any of [string, null]
query	vpc_name optional	VPC 명 Example :	any of [string, null]

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/internet-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "internet_gateways": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "firewall_id": "",
            "id": "",
            "loggable": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "",
            "vpc_name": ""
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

8.1.38 - List NAT Gateways

8.1.38.1 - 1.1

get /v1/nat-gateways

Description

NAT Gateway 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	NAT Gateway 명 Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	vpc_name optional	VPC 명 Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	subnet_name optional	Subnet 명 Example :	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP 주소 Example :	any of [string, null]	None
query	state optional	NAT Gateway 상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nat_gateways": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "nat_gateway_ip_address": "",
            "publicip_id": "",
            "state": "",
            "subnet_cidr": "",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

8.1.38.2 - 1.0

get /v1/nat-gateways

Description

NAT Gateway 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	NAT Gateway 명 Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	vpc_name optional	VPC 명 Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	subnet_name optional	Subnet 명 Example :	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP 주소 Example :	any of [string, null]	None
query	state optional	NAT Gateway 상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nat_gateways": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "nat_gateway_ip_address": "",
            "publicip_id": "",
            "state": "",
            "subnet_cidr": "",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

8.1.39 - List Ports

8.1.39.1 - 1.1

get /v1/ports

Description

Port 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	Port 제한 Example :	any of [integer, null]	None
query	marker optional	Port 마커 Example :	any of [string, null]	None
query	sort optional	Port 정렬 Example :	any of [string, null]	None
query	name optional	Port 명 Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	subnet_name optional	Subnet 명 Example :	any of [string, null]	None
query	id optional	Port ID Example :	any of [string, null]	None
query	attached_resource_id optional	연결된 자원 ID Example :	any of [string, null]	None
query	fixed_ip_address optional	고정된 IP Example :	any of [string, null]	None
query	mac_address optional	MAC 주소 Example :	any of [string, null]	None
query	state optional	상태 Example :	any of [string, null]	None
query	security_groups optional	Security Group 목록 Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PortListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/ports

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "ports": [
        {
            "account_id": "",
            "attached_resource_id": "",
            "attached_resource_type": "",
            "created_at": "2026-02-11T06:45:08.861Z",
            "description": "",
            "fixed_ip_address": "",
            "id": "",
            "mac_address": "",
            "modified_at": "2026-02-11T06:45:08.862Z",
            "name": "",
            "state": "",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

8.1.39.2 - 1.0

get /v1/ports

Description

Port 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	Port 제한 Example :	any of [integer, null]	None
query	marker optional	Port 마커 Example :	any of [string, null]	None
query	sort optional	Port 정렬 Example :	any of [string, null]	None
query	name optional	Port 명 Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	subnet_name optional	Subnet 명 Example :	any of [string, null]	None
query	id optional	Port ID Example :	any of [string, null]	None
query	attached_resource_id optional	연결된 자원 ID Example :	any of [string, null]	None
query	fixed_ip_address optional	고정된 IP Example :	any of [string, null]	None
query	mac_address optional	MAC 주소 Example :	any of [string, null]	None
query	state optional	상태 Example :	any of [string, null]	None
query	security_groups optional	Security Group 목록 Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PortListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/ports

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "ports": [
        {
            "account_id": "",
            "attached_resource_id": "",
            "attached_resource_type": "",
            "created_at": "2026-02-11T06:45:08.861Z",
            "description": "",
            "fixed_ip_address": "",
            "id": "",
            "mac_address": "",
            "modified_at": "2026-02-11T06:45:08.862Z",
            "name": "",
            "state": "",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

8.1.40 - List Private NAT

8.1.40.1 - 1.1

get /v1/private-nats

Description

Private NAT 목록 조회

상태 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	name optional	Private NAT 명 Example :	any of [string, null]	None
query	cidr optional	Private NAT IP 대역 Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	vpc_name optional	VPC 명 Example :	any of [string, null]	None
query	direct_connect_id optional	Direct Connect ID Example :	any of [string, null]	None
query	direct_connect_name optional	Direct Connect명 Example :	any of [string, null]	None
query	state optional	Private NAT 상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-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 = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nats": [
        {
            "account_id": "",
            "cidr": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "direct_connect_id": "",
            "direct_connect_name": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "vpc_id": "",
            "vpc_name": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.40.2 - 1.0

get /v1/private-nats

Description

Private NAT 목록 조회

상태 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	name optional	Private NAT 명 Example :	any of [string, null]	None
query	cidr optional	Private NAT IP 대역 Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	vpc_name optional	VPC 명 Example :	any of [string, null]	None
query	direct_connect_id optional	Direct Connect ID Example :	any of [string, null]	None
query	direct_connect_name optional	Direct Connect명 Example :	any of [string, null]	None
query	state optional	Private NAT 상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-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 = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nats": [
        {
            "account_id": "",
            "cidr": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "direct_connect_id": "",
            "direct_connect_name": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "vpc_id": "",
            "vpc_name": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.41 - List Private NAT IP

8.1.41.1 - 1.1

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 목록

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	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	ip_address optional	Private NAT IP 주소 Example :	any of [string, null]	None
query	state optional	Private NAT IP 상태 Example :	any of [enum (RESERVED, ATTACHED, DELETED), null]	None
query	attached_resource_type optional	Private NAT IP 연결된 자원 타입 Example :	any of [enum (VM, BM), null]	None
query	attached_resource_id optional	Private NAT IP 연결된 자원 ID Example :	any of [string, null]	None
query	attached_resource_name optional	Private NAT IP 연결된 자원명 Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatIpListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.41.2 - 1.0

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 목록

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	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	ip_address optional	Private NAT IP 주소 Example :	any of [string, null]	None
query	state optional	Private NAT IP 상태 Example :	any of [enum (RESERVED, ATTACHED, DELETED), null]	None
query	attached_resource_type optional	Private NAT IP 연결된 자원 타입 Example :	any of [enum (VM, BM), null]	None
query	attached_resource_id optional	Private NAT IP 연결된 자원 ID Example :	any of [string, null]	None
query	attached_resource_name optional	Private NAT IP 연결된 자원명 Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatIpListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.42 - List PrivateLink Endpoint

8.1.42.1 - 1.1

get /v1/privatelink-endpoints

Description

PrivateLink Endpoint 목록 조회

상태 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	id optional	PrivateLink Endpoint ID Example :	any of [string, null]	None
query	name optional	PrivateLink Endpoint 명 Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	privatelink_service_id optional	PrivateLink Service ID Example :	any of [string, null]	None
query	endpoint_ip_address optional	Endpoint IP 주소 Example :	any of [string, null]	None
query	state optional	PrivateLink Endpoint 상태 Example :	any of [enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/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 = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_endpoints": [
        {
            "account_id": "",
            "approval_type": "MANUAL",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "endpoint_ip_address": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "privatelink_service_id": "",
            "state": "REQUESTING",
            "subnet_id": "",
            "vpc_id": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.43 - List PrivateLink Service

8.1.43.1 - 1.1

get /v1/privatelink-services

Description

PrivateLink Service 목록 조회

상태 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	id optional	PrivateLink Service ID Example :	any of [string, null]	None
query	name optional	PrivateLink Service 명 Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	service_ip_address optional	Service IP 주소 Example :	any of [string, null]	None
query	connected_resource_id optional	연결된 자원 ID Example :	any of [string, null]	None
query	connected_resource_type optional	연결된 자원 Type Example :	any of [string, null]	None
query	connected_resource_name optional	연결된 자원명 Example :	any of [string, null]	None
query	connected_resource_ip_address optional	연결된 자원 IP 주소 Example :	any of [string, null]	None
query	state optional	PrivateLink Service 상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkServiceListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/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 = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_services": [
        {
            "account_id": "",
            "approval_type": "MANUAL",
            "connected_resource_id": "",
            "connected_resource_ip_address": "",
            "connected_resource_name": "",
            "connected_resource_type": "LB",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "service_ip_address": "",
            "state": "CREATING",
            "subnet_id": "",
            "vpc_id": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.44 - List PublicIPs

8.1.44.1 - 1.1

get /v1/publicips

Description

PublicIP 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	ip_address optional	IP 주소 Example :	any of [string, null]	None
query	state optional	PublicIP 상태 Example :	any of [string, null]	None
query	attached_resource_type optional	PublicIP 연결된 자원 타입 Example :	any of [string, null]	None
query	attached_resource_id optional	PublicIP 연결된 자원 ID Example :	any of [string, null]	None
query	attached_resource_name optional	PublicIP 연결된 자원명 Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	type optional	PublicIP 타입 Example :	any of [enum (IGW, GGW, SIGW), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PublicipListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/publicips

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "publicips": [
        {
            "account_id": "",
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "RESERVED",
            "type": "IGW"
        }
    ]
}

8.1.44.2 - 1.0

get /v1/publicips

Description

PublicIP 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	ip_address optional	IP 주소 Example :	any of [string, null]	None
query	state optional	PublicIP 상태 Example :	any of [string, null]	None
query	attached_resource_type optional	PublicIP 연결된 자원 타입 Example :	any of [string, null]	None
query	attached_resource_id optional	PublicIP 연결된 자원 ID Example :	any of [string, null]	None
query	attached_resource_name optional	PublicIP 연결된 자원명 Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	type optional	PublicIP 타입 Example :	any of [enum (IGW, GGW, SIGW), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PublicipListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/publicips

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "publicips": [
        {
            "account_id": "",
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "RESERVED",
            "type": "IGW"
        }
    ]
}

8.1.45 - List SAP Secondary Subnets

8.1.45.1 - 1.1

get /v1/subnets/{subnet_id}/sap-secondary-subnets

Description

List SAP Secondary Subnets

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	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

Responses

HTTP Code	Description	Schema
200	OK	SapSecondarySubnetListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/subnets/{subnet_id}/sap-secondary-subnets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "secondary_subnets": [
        {
            "account_id": "",
            "cidr": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "subnet_id": "",
            "vlan_no_id": "",
            "vpc_id": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.46 - List Subnets

8.1.46.1 - 1.1

get /v1/subnets

Description

Subnet 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Subnet ID Example : `023c57b14f11483689338d085e061492`	string
query	name optional	Subnet 명 Example : `subnetName`	string
query	type optional	Subnet 유형 Example :	any of [enum (GENERAL, LOCAL, VPC_ENDPOINT), array[enum (GENERAL, LOCAL, VPC_ENDPOINT)]]
query	state optional	상태 Example :	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
query	vpc_id optional	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string
query	vpc_name optional	VPC 명 Example : `vpcName`	string

Responses

HTTP Code	Description	Schema
200	OK	SubnetListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/subnets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "subnets": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "CREATING",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.46.2 - 1.0

get /v1/subnets

Description

Subnet 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Subnet ID Example : `023c57b14f11483689338d085e061492`	string
query	name optional	Subnet 명 Example : `subnetName`	string
query	type optional	Subnet 유형 Example :	any of [enum (GENERAL, LOCAL, VPC_ENDPOINT), array[enum (GENERAL, LOCAL, VPC_ENDPOINT)]]
query	state optional	상태 Example :	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
query	vpc_id optional	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string
query	vpc_name optional	VPC 명 Example : `vpcName`	string

Responses

HTTP Code	Description	Schema
200	OK	SubnetListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/subnets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "subnets": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "CREATING",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.47 - List Transit Gateway Rules

8.1.47.1 - 1.1

get /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	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	id optional	Routing Rule ID Example :	any of [string, null]	None
query	tgw_connection_vpc_id optional	Transit Gateway에 연결된 VPC ID. Example :	any of [string, null]	None
query	tgw_connection_vpc_name optional	Transit Gateway에 연결된 VPC명. Example :	any of [string, null]	None
query	source_type optional	출발지 타입 Example :	enum (VPC, TGW)	None
query	destination_type optional	목적지 타입 Example :	enum (VPC, TGW)	None
query	destination_cidr optional	목적지 CIDR Example :	any of [string, null]	None
query	state optional	상태 Example :	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_rules": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination_cidr": "",
            "destination_resource_id": "",
            "destination_resource_name": "",
            "destination_type": "VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_resource_id": "",
            "source_resource_name": "",
            "source_type": "VPC",
            "state": "CREATING",
            "tgw_connection_vpc_id": "",
            "tgw_connection_vpc_name": ""
        }
    ]
}

8.1.47.2 - 1.0

get /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 목록 조회

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	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	id optional	Routing Rule ID Example :	any of [string, null]	None
query	tgw_connection_vpc_id optional	Transit Gateway에 연결된 VPC ID. Example :	any of [string, null]	None
query	tgw_connection_vpc_name optional	Transit Gateway에 연결된 VPC명. Example :	any of [string, null]	None
query	source_type optional	출발지 타입 Example :	enum (VPC, TGW)	None
query	destination_type optional	목적지 타입 Example :	enum (VPC, TGW)	None
query	destination_cidr optional	목적지 CIDR Example :	any of [string, null]	None
query	state optional	상태 Example :	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_rules": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination_cidr": "",
            "destination_resource_id": "",
            "destination_resource_name": "",
            "destination_type": "VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_resource_id": "",
            "source_resource_name": "",
            "source_type": "VPC",
            "state": "CREATING",
            "tgw_connection_vpc_id": "",
            "tgw_connection_vpc_name": ""
        }
    ]
}

8.1.48 - List Transit Gateway VPC Connections

8.1.48.1 - 1.1

get /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 목록 조회.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	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	id optional	Transit Gateway VPC 연결 ID Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	vpc_name optional	VPC 명 Example :	any of [string, null]	None
query	state optional	상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayVpcConnectionListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_vpc_connections": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "CREATING",
            "transit_gateway_id": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

8.1.48.2 - 1.0

get /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 목록 조회.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	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	id optional	Transit Gateway VPC 연결 ID Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	vpc_name optional	VPC 명 Example :	any of [string, null]	None
query	state optional	상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayVpcConnectionListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_vpc_connections": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "CREATING",
            "transit_gateway_id": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

8.1.49 - List Transit Gateways

8.1.49.1 - 1.1

get /v1/transit-gateways

Description

Transit Gateway 목록 조회

상태 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	id optional	Transit Gateway ID Example :	any of [string, null]	None
query	name optional	Transit Gateway 명 Example :	any of [string, null]	None
query	state optional	상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateways": [
        {
            "account_id": "",
            "bandwidth": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "firewall_ids": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "uplink_enabled": false
        }
    ]
}

8.1.49.2 - 1.0

get /v1/transit-gateways

Description

Transit Gateway 목록 조회

상태 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	id optional	Transit Gateway ID Example :	any of [string, null]	None
query	name optional	Transit Gateway 명 Example :	any of [string, null]	None
query	state optional	상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateways": [
        {
            "account_id": "",
            "bandwidth": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "firewall_ids": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "uplink_enabled": false
        }
    ]
}

8.1.50 - List VPC Endpoint

8.1.50.1 - 1.1

get /v1/vpc-endpoints

Description

VPC Endpoint 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC Endpoint ID Example :	any of [string, null]	None
query	name optional	VPC Endpoint 명 Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	vpc_name optional	VPC 명 Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	resource_key optional	VPC Endpoint Resource Key Example :	any of [string, null]	None
query	resource_type optional	VPC Endpoint 자원 타입 Example :	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP 주소 Example :	any of [string, null]	None
query	state optional	VPC Endpoint 상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-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 = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpc_endpoints": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "endpoint_ip_address": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "resource_info": "",
            "resource_key": "",
            "resource_type": "FS",
            "state": "CREATING",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

8.1.50.2 - 1.0

get /v1/vpc-endpoints

Description

VPC Endpoint 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC Endpoint ID Example :	any of [string, null]	None
query	name optional	VPC Endpoint 명 Example :	any of [string, null]	None
query	vpc_id optional	VPC ID Example :	any of [string, null]	None
query	vpc_name optional	VPC 명 Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	resource_key optional	VPC Endpoint Resource Key Example :	any of [string, null]	None
query	resource_type optional	VPC Endpoint 자원 타입 Example :	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP 주소 Example :	any of [string, null]	None
query	state optional	VPC Endpoint 상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-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 = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpc_endpoints": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "endpoint_ip_address": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "resource_info": "",
            "resource_key": "",
            "resource_type": "FS",
            "state": "CREATING",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

8.1.51 - List VPC Endpoint Connectable Resources

8.1.51.1 - 1.1

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	resource_type required	VPC Endpoint 자원 타입 Example :	enum (FS, OBS, SCR, DNS)	None
query	vpc_id optional	VPC ID(resource_type이 DNS인 경우, 필수 입력값입니다) Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointConnectableResourceListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-endpoints/connectable-resources?resource_type={resource_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpc_endpoint_connectable_resources": [
        {
            "resource_info": "",
            "resource_key": "",
            "resource_type": "FS"
        }
    ]
}

8.1.51.2 - 1.0

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	resource_type required	VPC Endpoint 자원 타입 Example :	enum (FS, OBS, SCR, DNS)	None
query	vpc_id optional	VPC ID(resource_type이 DNS인 경우, 필수 입력값입니다) Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointConnectableResourceListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-endpoints/connectable-resources?resource_type={resource_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpc_endpoint_connectable_resources": [
        {
            "resource_info": "",
            "resource_key": "",
            "resource_type": "FS"
        }
    ]
}

8.1.52 - List VPC Peering

8.1.52.1 - 1.1

get /v1/vpc-peerings

Description

VPC Peering 목록 조회

상태 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	id optional	VPC Peering ID Example :	any of [string, null]	None
query	name optional	VPC Peering 명 Example :	any of [string, null]	None
query	requester_vpc_id optional	요청 VPC ID Example :	any of [string, null]	None
query	requester_vpc_name optional	요청 VPC 명 Example :	any of [string, null]	None
query	approver_vpc_id optional	승인 VPC ID Example :	any of [string, null]	None
query	approver_vpc_name optional	승인 VPC 명 Example :	any of [string, null]	None
query	account_type optional	과제 유형 Example :	any of [enum (SAME, DIFFERENT), null]	None
query	state optional	상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peerings": [
        {
            "account_type": "SAME",
            "approver_vpc_account_id": "",
            "approver_vpc_id": "",
            "approver_vpc_name": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_requester_account_id": "",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "requester_vpc_account_id": "",
            "requester_vpc_id": "",
            "requester_vpc_name": "",
            "state": "CREATING"
        }
    ]
}

8.1.52.2 - 1.0

get /v1/vpc-peerings

Description

VPC Peering 목록 조회

상태 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	id optional	VPC Peering ID Example :	any of [string, null]	None
query	name optional	VPC Peering 명 Example :	any of [string, null]	None
query	requester_vpc_id optional	요청 VPC ID Example :	any of [string, null]	None
query	requester_vpc_name optional	요청 VPC 명 Example :	any of [string, null]	None
query	approver_vpc_id optional	승인 VPC ID Example :	any of [string, null]	None
query	approver_vpc_name optional	승인 VPC 명 Example :	any of [string, null]	None
query	account_type optional	과제 유형 Example :	any of [enum (SAME, DIFFERENT), null]	None
query	state optional	상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peerings": [
        {
            "account_type": "SAME",
            "approver_vpc_account_id": "",
            "approver_vpc_id": "",
            "approver_vpc_name": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_requester_account_id": "",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "requester_vpc_account_id": "",
            "requester_vpc_id": "",
            "requester_vpc_name": "",
            "state": "CREATING"
        }
    ]
}

8.1.53 - List VPC Peering Rules

8.1.53.1 - 1.1

get /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 목록 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	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	id optional	VPC Peering 규칙 ID Example :	any of [string, null]	None
query	name optional	VPC Peering 명 Example :	any of [string, null]	None
query	source_vpc_id optional	출발지 VPC ID Example :	any of [string, null]	None
query	source_vpc_type optional	출발지 VPC 유형 Example :	enum (REQUESTER_VPC, APPROVER_VPC)	None
query	destination_vpc_id optional	목적지 VPC ID Example :	any of [string, null]	None
query	destination_vpc_type optional	목적지 VPC 유형 Example :	enum (REQUESTER_VPC, APPROVER_VPC)	None
query	destination_cidr optional	목적지 CIDR Example :	any of [string, null]	None
query	state optional	상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peering_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "destination_cidr": "",
            "destination_vpc_id": "",
            "destination_vpc_name": "",
            "destination_vpc_type": "REQUESTER_VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_vpc_id": "",
            "source_vpc_name": "",
            "source_vpc_type": "REQUESTER_VPC",
            "state": "CREATING",
            "vpc_peering_id": ""
        }
    ]
}

8.1.53.2 - 1.0

get /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 목록 조회

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	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	id optional	VPC Peering 규칙 ID Example :	any of [string, null]	None
query	name optional	VPC Peering 명 Example :	any of [string, null]	None
query	source_vpc_id optional	출발지 VPC ID Example :	any of [string, null]	None
query	source_vpc_type optional	출발지 VPC 유형 Example :	enum (REQUESTER_VPC, APPROVER_VPC)	None
query	destination_vpc_id optional	목적지 VPC ID Example :	any of [string, null]	None
query	destination_vpc_type optional	목적지 VPC 유형 Example :	enum (REQUESTER_VPC, APPROVER_VPC)	None
query	destination_cidr optional	목적지 CIDR Example :	any of [string, null]	None
query	state optional	상태 Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peering_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "destination_cidr": "",
            "destination_vpc_id": "",
            "destination_vpc_name": "",
            "destination_vpc_type": "REQUESTER_VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_vpc_id": "",
            "source_vpc_name": "",
            "source_vpc_type": "REQUESTER_VPC",
            "state": "CREATING",
            "vpc_peering_id": ""
        }
    ]
}

8.1.54 - List VPCs

8.1.54.1 - 1.1

get /v1/vpcs

Description

VPC 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	name optional	VPC 명 Example : `vpcName`	any of [string, null]	None
query	state optional	상태 Example :	enum (CREATING, ACTIVE, DELETED, ERROR)	None
query	cidr optional	VPC Cidr Example : `192.167.0.0/18`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpcs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpcs": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/18",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "vpcDescription",
            "id": "7df8abb4912e4709b1cb237daccca7a8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcName",
            "state": "CREATING"
        }
    ]
}

8.1.54.2 - 1.0

get /v1/vpcs

Description

VPC 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	한도 Example : `20`	any of [integer, null]	None
query	marker optional	마커 Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	name optional	VPC 명 Example : `vpcName`	any of [string, null]	None
query	state optional	상태 Example :	enum (CREATING, ACTIVE, DELETED, ERROR)	None
query	cidr optional	VPC Cidr Example : `192.167.0.0/18`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpcs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpcs": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/18",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "vpcDescription",
            "id": "7df8abb4912e4709b1cb237daccca7a8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcName",
            "state": "CREATING"
        }
    ]
}

8.1.55 - Request PrivateLink Endpoint

8.1.55.1 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Description

Request PrivateLink Endpoint

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None
body	body required		PrivateLinkEndpointRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_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 = vpc 1.1"

Request body

{
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "",
        "approval_type": "MANUAL",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "endpoint_ip_port_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "privatelink_service_id": "",
        "security_group_ids": [],
        "state": "REQUESTING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

8.1.56 - Set Internet Gateway

8.1.56.1 - 1.1

put /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None
body	body required		InternetGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.1"

Request body

{
    "description": "",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.56.2 - 1.0

put /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None
body	body required		InternetGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.0"

Request body

{
    "description": "",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.57 - Set NAT Gateway

8.1.57.1 - 1.1

put /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway 명 Example :	string	None
body	body required		NatGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.1"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.57.2 - 1.0

put /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway 명 Example :	string	None
body	body required		NatGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.58 - Set Port

8.1.58.1 - 1.1

put /v1/ports/{port_id}

Description

Port를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None
body	body required		PortSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PortShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/ports/{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 = vpc 1.1"

Request body

{
    "description": "",
    "security_groups": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:08.922Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:08.922Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.58.2 - 1.0

put /v1/ports/{port_id}

Description

Port를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None
body	body required		PortSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PortShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/ports/{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 = vpc 1.0"

Request body

{
    "description": "",
    "security_groups": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:08.922Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:08.922Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.59 - Set Private NAT

8.1.59.1 - 1.1

put /v1/private-nats/{private_nat_id}

Description

Private NAT 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
body	body required		PrivateNatSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-nats/{private_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 = vpc 1.1"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.59.2 - 1.0

put /v1/private-nats/{private_nat_id}

Description

Private NAT 수정

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
body	body required		PrivateNatSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-nats/{private_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 = vpc 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.60 - Set PrivateLink Endpoint

8.1.60.1 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None
body	body required		PrivateLinkEndpointSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_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 = vpc 1.1"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "",
        "approval_type": "MANUAL",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "endpoint_ip_port_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "privatelink_service_id": "",
        "security_group_ids": [],
        "state": "REQUESTING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

8.1.61 - Set PrivateLink Service

8.1.61.1 - 1.1

put /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example :	string	None
body	body required		PrivateLinkServiceSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkServiceShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.1"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "",
        "approval_type": "MANUAL",
        "connected_resource_id": "",
        "connected_resource_ip_address": "",
        "connected_resource_name": "",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "high_speed_transfer": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "security_group_ids": [],
        "service_ip_address": "",
        "service_ip_port_id": "",
        "state": "CREATING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

8.1.62 - Set PublicIP

8.1.62.1 - 1.1

put /v1/publicips/{publicip_id}

Description

PublicIP를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None
body	body required		PublicipSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicipShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.1"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

8.1.62.2 - 1.0

put /v1/publicips/{publicip_id}

Description

PublicIP를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None
body	body required		PublicipSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicipShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

8.1.63 - Set Subnet

8.1.63.1 - 1.1

put /v1/subnets/{subnet_id}

Description

Subnet을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None
body	body required		SubnetSetRequest

Responses

HTTP Code	Description	Schema
200	OK	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets/{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 = vpc 1.1"

Request body

{
    "description": "Subnet Description"
}

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.63.2 - 1.0

put /v1/subnets/{subnet_id}

Description

Subnet을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None
body	body required		SubnetSetRequest

Responses

HTTP Code	Description	Schema
200	OK	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets/{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 = vpc 1.0"

Request body

{
    "description": "Subnet Description"
}

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.64 - Set Transit Gateway

8.1.64.1 - 1.1

put /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.1"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

8.1.64.2 - 1.0

put /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 수정

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

8.1.65 - Set VPC

8.1.65.1 - 1.1

put /v1/vpcs/{vpc_id}

Description

VPC를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC ID Example :	string	None
body	body required		VpcSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.1"

Request body

{
    "description": "vpcDescription"
}

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

8.1.65.2 - 1.0

put /v1/vpcs/{vpc_id}

Description

VPC를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC ID Example :	string	None
body	body required		VpcSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.0"

Request body

{
    "description": "vpcDescription"
}

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

8.1.66 - Set VPC Endpoint

8.1.66.1 - 1.1

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None
body	body required		VpcEndpointSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_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 = vpc 1.1"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.66.2 - 1.0

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None
body	body required		VpcEndpointSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_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 = vpc 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.67 - Set VPC Peering

8.1.67.1 - 1.1

put /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
body	body required		VpcPeeringSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.1"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

8.1.67.2 - 1.0

put /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 수정

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
body	body required		VpcPeeringSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

8.1.68 - Show Internet Gateway

8.1.68.1 - 1.1

get /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 상세조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.68.2 - 1.0

get /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.69 - Show NAT Gateway

8.1.69.1 - 1.1

get /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 상세조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway 명 Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.69.2 - 1.0

get /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway 명 Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.70 - Show Port

8.1.70.1 - 1.1

get /v1/ports/{port_id}

Description

Port를 상세조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PortShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/ports/{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 = vpc 1.1"

Example HTTP response

Response 200

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:08.922Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:08.922Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.70.2 - 1.0

get /v1/ports/{port_id}

Description

Port를 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PortShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/ports/{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 = vpc 1.0"

Example HTTP response

Response 200

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:08.922Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:08.922Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.71 - Show Private NAT

8.1.71.1 - 1.1

get /v1/private-nats/{private_nat_id}

Description

Private NAT 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-nats/{private_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.71.2 - 1.0

get /v1/private-nats/{private_nat_id}

Description

Private NAT 상세 조회

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-nats/{private_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.72 - Show PrivateLink Endpoint

8.1.72.1 - 1.1

get /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "",
        "approval_type": "MANUAL",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "endpoint_ip_port_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "privatelink_service_id": "",
        "security_group_ids": [],
        "state": "REQUESTING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

8.1.73 - Show PrivateLink Service

8.1.73.1 - 1.1

get /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkServiceShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "",
        "approval_type": "MANUAL",
        "connected_resource_id": "",
        "connected_resource_ip_address": "",
        "connected_resource_name": "",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "high_speed_transfer": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "security_group_ids": [],
        "service_ip_address": "",
        "service_ip_port_id": "",
        "state": "CREATING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

8.1.74 - Show PublicIP

8.1.74.1 - 1.1

get /v1/publicips/{publicip_id}

Description

PublicIP를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PublicipShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

8.1.74.2 - 1.0

get /v1/publicips/{publicip_id}

Description

PublicIP를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PublicipShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

8.1.75 - Show Subnet

8.1.75.1 - 1.1

get /v1/subnets/{subnet_id}

Description

Subnet을 상세조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets/{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 = vpc 1.1"

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.75.2 - 1.0

get /v1/subnets/{subnet_id}

Description

Subnet을 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets/{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 = vpc 1.0"

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.76 - Show Transit Gateway

8.1.76.1 - 1.1

get /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

8.1.76.2 - 1.0

get /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 상세 조회

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

8.1.77 - Show VPC

8.1.77.1 - 1.1

get /v1/vpcs/{vpc_id}

Description

VPC를 상세조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

8.1.77.2 - 1.0

get /v1/vpcs/{vpc_id}

Description

VPC를 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

8.1.78 - Show VPC Endpoint

8.1.78.1 - 1.1

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 상세조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.78.2 - 1.0

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 상세조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

8.1.79 - Show VPC Peering

8.1.79.1 - 1.1

get /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

8.1.79.2 - 1.0

get /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 상세 조회

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

8.2 - Models

8.2.1 - ConnectedEndpointListResponse

Name	Description	Schema
connected_privatelink_endpoints required		array[ConnectedPrivateLinkEndpoint]
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

8.2.2 - ConnectedPrivateLinkEndpoint

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	PrivateLink Endpoint ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
privatelink_service_id required	PrivateLink Service ID Example :	string
state required	PrivateLink Endpoint 상태 Example : `REQUESTING`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)

8.2.3 - InternetGateway

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
firewall_id optional	Firewall ID Example :	any of [string, null]
id required	Internet Gateway ID Example :	string
loggable optional	NAT 로그 저장 여부 Example :	boolean
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Internet Gateway 명 Example :	string
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type required	Internet Gateway 유형 Example : `IGW`	enum (IGW, GGW, SIGW)
vpc_id required	VPC ID Example :	string
vpc_name required	VPC 명 Example :	string

8.2.4 - InternetGatewayCreateRequest

Name	Description	Schema
description optional	설명 Example :	any of [string, null]
firewall_enabled optional	방화벽 사용 Example : `False`	boolean
firewall_loggable optional	방화벽 로깅 가능 Example : `False`	boolean
tags optional	태그 목록	array[Tag]
type required	Internet Gateway 유형 Example : `IGW`	enum (IGW, GGW, SIGW)
vpc_id required	VPC ID Example :	string

8.2.5 - InternetGatewayListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
internet_gateways required		array[InternetGateway]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]

8.2.6 - InternetGatewaySetRequest

Name	Description	Schema	Default
description optional	설명 Example :	any of [string, null]
loggable optional	NAT 로그 저장 여부 Example :	boolean

8.2.7 - InternetGatewayShowResponse

Name	Description	Schema	Default
internet_gateway required		InternetGateway

8.2.8 - NatGateway

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	NAT Gateway 상세설명 Example :	any of [string, null]
id required	NAT Gateway 명 Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	NAT Gateway 명 Example :	string
nat_gateway_ip_address required	NAT Gateway IP 주소 Example :	string
publicip_id optional	PublicIP ID Example :	any of [string, null]
state required	NAT Gateway 상태 Example :	string
subnet_cidr required	Subnet Cidr Example :	string
subnet_id required	Subnet ID Example :	string
subnet_name required	Subnet 명 Example :	string
vpc_id required	VPC ID Example :	string
vpc_name required	VPC 명 Example :	string

8.2.9 - NatGatewayCreateRequest

Name	Description	Schema
description optional	NAT Gateway 상세설명 Example : Maximum length : `50`	string
publicip_id required	PublicIP ID Example :	string
subnet_id required	Subnet CIDR Example :	string
tags optional	태그 목록	array[Tag]

8.2.10 - NatGatewayListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
nat_gateways required		array[NatGateway]

8.2.11 - NatGatewaySetRequest

Name	Description	Schema	Default
description optional	NAT Gateway 상세설명 Example : Maximum length : `50`	string

8.2.12 - NatGatewayShowResponse

Name	Description	Schema	Default
nat_gateway required		NatGateway

8.2.13 - Port

Name	Description	Schema
account_id required	Account ID Example :	string
attached_resource_id required	연결된 자원 ID Example :	string
attached_resource_type required	연결된 자원 유형 Example :	string
created_at required	생성일시 Example : `2026-02-11T06:45:08.922Z`	string (date-time)
description required	설명 Example :	string
fixed_ip_address required	고정된 IP Example :	string
id required	Port ID Example :	string
mac_address required	MAC 주소 Example :	string
modified_at required	수정일시 Example : `2026-02-11T06:45:08.922Z`	string (date-time)
name required	Port 명 Example :	string
security_groups required	Security Group 목록	array[PortSecurityGroup]
state required	상태 Example :	string
subnet_id required	Subnet ID Example :	string
subnet_name required	Subnet 명 Example :	string
vpc_id required	VPC ID Example :	string
vpc_name required	VPC 명 Example :	string

8.2.14 - PortCreateRequest

Name	Description	Schema
description optional	설명 Example :	any of [string, null]
fixed_ip_address optional	고정된 IP Example :	any of [string, null]
name required	Port 명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
security_groups optional	Security Group 목록	array[string]
subnet_id required	Subnet ID Example :	string
tags optional	태그 목록	array[Tag]

8.2.15 - PortList

Name	Description	Schema
account_id required	Account ID Example :	string
attached_resource_id required	연결된 자원 ID Example :	string
attached_resource_type required	연결된 자원 유형 Example :	string
created_at required	생성일시 Example : `2026-02-11T06:45:08.861Z`	string (date-time)
description required	설명 Example :	string
fixed_ip_address required	고정된 IP Example :	string
id required	Port ID Example :	string
mac_address required	MAC 주소 Example :	string
modified_at required	수정일시 Example : `2026-02-11T06:45:08.862Z`	string (date-time)
name required	Port 명 Example :	string
state required	상태 Example :	string
subnet_id required	Subnet ID Example :	string
subnet_name required	Subnet 명 Example :	string
vpc_id required	VPC ID Example :	string
vpc_name required	VPC 명 Example :	string

8.2.16 - PortListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
ports required		array[PortList]

8.2.17 - PortSecurityGroup

Name	Description	Schema	Default
id optional	Security Group ID Example :	any of [string, null]
name optional	Security Group 이름 Example :	any of [string, null]

8.2.18 - PortSetRequest

Name	Description	Schema	Default
description optional	설명 Example :	any of [string, null]
security_groups optional	Security Group 목록 Example :	any of [array[string], null]

8.2.19 - PortShowResponse

Name	Description	Schema	Default
port required		any of [Port, null]

8.2.20 - PrivateLinkEndpoint

Name	Description	Schema
account_id required	Account ID Example :	string
approval_type required	PrivateLink Service 승인 타입 Example : `MANUAL`	enum (MANUAL, AUTO)
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
endpoint_ip_address required	Endpoint IP 주소 Example :	string
id required	PrivateLink Endpoint ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	PrivateLink Endpoint 명 Example :	string
privatelink_service_id required	PrivateLink Service ID Example :	string
state required	PrivateLink Endpoint 상태 Example : `REQUESTING`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)
subnet_id required	Subnet ID Example :	string
vpc_id required	VPC ID Example :	string

8.2.21 - PrivateLinkEndpointApprovalRequest

Name	Description	Schema	Default
type required	PrivateLink Endpoint Action Type Example : `APPROVE`	enum (APPROVE, REJECT)

8.2.22 - PrivateLinkEndpointConnectionRequest

Name	Description	Schema	Default
type required	PrivateLink Endpoint Action Type Example : `DISCONNECT`	enum (DISCONNECT, RECONNECT)

8.2.23 - PrivateLinkEndpointCreateRequest

Name	Description	Schema
description optional	설명 Example : Maximum length : `50`	string
endpoint_ip_address required	Endpoint IP 주소 Example :	string
name required	PrivateLink Endpoint 명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
privatelink_service_id optional	PrivateLink Service ID Example :	string
security_group_ids optional	Security Group 목록	array[string]
subnet_id required	Subnet ID Example :	string
tags optional	태그 목록	array[Tag]

8.2.24 - PrivateLinkEndpointDetail

Name	Description	Schema
account_id required	Account ID Example :	string
approval_type required	PrivateLink Service 승인 타입 Example : `MANUAL`	enum (MANUAL, AUTO)
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
endpoint_ip_address required	Endpoint IP 주소 Example :	string
endpoint_ip_port_id optional	Endpoint IP Port ID Example :	any of [string, null]
id required	PrivateLink Endpoint ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	PrivateLink Endpoint 명 Example :	string
privatelink_service_id required	PrivateLink Service ID Example :	string
security_group_ids optional	Security Group 목록	array[string]
state required	PrivateLink Endpoint 상태 Example : `REQUESTING`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)
subnet_id required	Subnet ID Example :	string
vpc_id required	VPC ID Example :	string

8.2.25 - PrivateLinkEndpointListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
privatelink_endpoints required		array[PrivateLinkEndpoint]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

8.2.26 - PrivateLinkEndpointRequest

Name	Description	Schema	Default
type required	PrivateLink Endpoint Action Type Example : `CANCEL`	enum (CANCEL, RE_REQUEST)

8.2.27 - PrivateLinkEndpointSetRequest

Name	Description	Schema	Default
description optional	설명 Example : Maximum length : `50`	string

8.2.28 - PrivateLinkEndpointShowResponse

Name	Description	Schema	Default
privatelink_endpoint required		PrivateLinkEndpointDetail

8.2.29 - PrivateLinkEndpointSummary

Name	Description	Schema
created_at required	생성일시 Example : `2026-02-11T06:45:10.579Z`	string (date-time)
id required	PrivateLink Endpoint ID Example :	string
state required	PrivateLink Endpoint 상태 Example : `REQUESTING`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)

8.2.30 - PrivateLinkEndpointSummaryShowResponse

Name	Description	Schema	Default
privatelink_endpoint required		PrivateLinkEndpointSummary

8.2.31 - PrivateLinkService

Name	Description	Schema
account_id required	Account ID Example :	string
approval_type required	PrivateLink Service 승인 타입 Example : `MANUAL`	enum (MANUAL, AUTO)
connected_resource_id optional	연결된 자원 ID Example :	any of [string, null]
connected_resource_ip_address required	연결된 자원 IP 주소 Example :	string
connected_resource_name required	연결된 자원명 Example :	string
connected_resource_type required	연결된 자원 Type Example : `LB`	enum (LB, IP)
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	PrivateLink Service ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	PrivateLink Service 명 Example :	string
service_ip_address required	Service IP 주소 Example :	string
state required	PrivateLink Service 상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id required	Subnet ID Example :	string
vpc_id required	VPC ID Example :	string

8.2.32 - PrivateLinkServiceCreateRequest

Name	Description	Schema
approval_type required	PrivateLink Service 승인 타입 Example : `MANUAL`	enum (MANUAL, AUTO)
connected_resource_id optional	연결된 자원 ID Example :	string
connected_resource_ip_address optional	연결된 자원 IP 주소 Example :	string
connected_resource_type required	연결된 자원 Type Example : `LB`	enum (LB, IP)
description optional	설명 Example : Maximum length : `50`	string
high_speed_transfer optional	고속 데이터 전송 사용 Example : `False`	boolean
name required	PrivateLink Service 명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
security_group_ids optional	Security Group 목록	array[string]
service_ip_address required	Service IP 주소 Example :	string
subnet_id required	Subnet ID Example :	string
tags optional	태그 목록	array[Tag]

8.2.33 - PrivateLinkServiceDetail

Name	Description	Schema
account_id required	Account ID Example :	string
approval_type required	PrivateLink Service 승인 타입 Example : `MANUAL`	enum (MANUAL, AUTO)
connected_resource_id optional	연결된 자원 ID Example :	any of [string, null]
connected_resource_ip_address required	연결된 자원 IP 주소 Example :	string
connected_resource_name required	연결된 자원명 Example :	string
connected_resource_type required	연결된 자원 Type Example : `LB`	enum (LB, IP)
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
high_speed_transfer required	고속 데이터 전송 사용 Example :	boolean
id required	PrivateLink Service ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	PrivateLink Service 명 Example :	string
security_group_ids optional	Security Group 목록	array[string]
service_ip_address required	Service IP 주소 Example :	string
service_ip_port_id optional	Service IP Port ID Example :	any of [string, null]
state required	PrivateLink Service 상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id required	Subnet ID Example :	string
vpc_id required	VPC ID Example :	string

8.2.34 - PrivateLinkServiceListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
privatelink_services required		array[PrivateLinkService]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

8.2.35 - PrivateLinkServiceSetRequest

Name	Description	Schema	Default
description optional	설명 Example : Maximum length : `50`	string

8.2.36 - PrivateLinkServiceShowResponse

Name	Description	Schema	Default
privatelink_service required		PrivateLinkServiceDetail

8.2.37 - PrivateNat

Name	Description	Schema
account_id required	Account ID Example :	string
cidr required	Private NAT IP 대역 Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
direct_connect_id required	Direct Connect ID Example :	string
direct_connect_name optional	Direct Connect명 Example :	any of [string, null]
id required	Private NAT ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Private NAT 명 Example :	string
state required	Private NAT 상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
vpc_id required	VPC ID Example :	string
vpc_name optional	VPC 명 Example :	any of [string, null]

8.2.38 - PrivateNatCreateRequest

Name	Description	Schema
cidr required	Private NAT IP 대역 Example :	string
description optional	설명 Example : Maximum length : `50`	string
direct_connect_id required	Direct Connect ID Example :	string
name required	Private NAT 명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	태그 목록	array[Tag]

8.2.39 - PrivateNatIp

Name	Description	Schema
attached_resource_id optional	Private NAT IP 연결된 자원 ID Example :	any of [string, null]
attached_resource_name optional	Private NAT IP 연결된 자원명 Example :	any of [string, null]
attached_resource_type optional	Private NAT IP 연결된 자원 타입 Example : `VM`	any of [enum (VM, BM), null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	Private NAT IP ID Example :	string
ip_address required	Private NAT IP 주소 Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
private_nat_id required	Private NAT ID Example :	string
state required	Private NAT IP 상태 Example : `RESERVED`	enum (RESERVED, ATTACHED, DELETED)

8.2.40 - PrivateNatIpCreateRequest

Name	Description	Schema	Default
ip_address required	Private NAT IP 주소 Example : Minimum length : `7` Maximum length : `15`	string

8.2.41 - PrivateNatIpListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
private_nat_ips required		array[PrivateNatIp]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

8.2.42 - PrivateNatIpShowResponse

Name	Description	Schema	Default
private_nat_ip required		PrivateNatIp

8.2.43 - PrivateNatListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
private_nats required		array[PrivateNat]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

8.2.44 - PrivateNatSetRequest

Name	Description	Schema	Default
description optional	설명 Example : Maximum length : `50`	string

8.2.45 - PrivateNatShowResponse

Name	Description	Schema	Default
private_nat required		PrivateNat

8.2.46 - Publicip

Name	Description	Schema
account_id required	Account ID Example :	string
attached_resource_id optional	PublicIP 연결된 자원 ID Example :	any of [string, null]
attached_resource_name optional	PublicIP 연결된 자원명 Example :	any of [string, null]
attached_resource_type optional	PublicIP 연결된 자원 타입 Example : `VM`	any of [enum (VM, ALB, LB, BM, DB, NAT_GW, GPU_NODE, VPN), null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	PublicIP 상세 설명 Example :	any of [string, null]
id required	PublicIP ID Example :	string
ip_address required	IP 주소 Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
state required	PublicIP 상태 Example : `RESERVED`	enum (RESERVED, ATTACHED, DELETED)
type required	PublicIP 타입 Example : `IGW`	enum (IGW, GGW, SIGW)

8.2.47 - PublicipCreateRequest

Name	Description	Schema
description optional	PublicIP 상세 설명 Example :	any of [string, null]
tags optional	태그 목록	array[Tag]
type required	PublicIP 타입 Example : `IGW`	enum (IGW, GGW, SIGW)

8.2.48 - PublicipListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
publicips required		array[Publicip]

8.2.49 - PublicipSetRequest

Name	Description	Schema	Default
description required	PublicIP 상세 설명 Example : Maximum length : `50`	string

8.2.50 - PublicipShowResponse

Name	Description	Schema	Default
publicip required		Publicip

8.2.51 - SapSecondarySubnet

Name	Description	Schema
account_id required	Account ID Example :	string
cidr required	CIDR Example :	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
state required	Secondary Subnet State Example : `ACTIVE`	enum (ACTIVE, DELETED)
subnet_id required	Primary Subnet Id Example :	string
vlan_no_id required	VLAN ID of Primary Subnet Example :	string
vpc_id required	VPC ID Example :	string

8.2.52 - SapSecondarySubnetListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
secondary_subnets required		array[SapSecondarySubnet]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

8.2.53 - Subnet

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
cidr required	Subnet Cidr Example : `192.167.1.0/24`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
gateway_ip_address required	Gateway IP Example : `192.167.1.1`	any of [string, null]
id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Subnet 명 Example : `subnetName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type required	Subnet 유형 Example : `GENERAL`	enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id required	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name required	VPC 명 Example : `vpcName`	string

8.2.54 - SubnetCreateRequest

Name	Description	Schema
allocation_pools optional	IP 할당 범위 Example : `[{"start":"192.167.1.2", "end":"192.167.1.100"}]`	array[object]
cidr required	Subnet Cidr Example : `192.167.1.0/24`	string
description optional	설명 Example : `Subnet Description`	any of [string, null]
dns_nameservers optional	DNS Name Server Example : `["1.1.1.1", "2.2.2.2"]`	array[string]
host_routes optional	호스트 경로 Example : `[{"destination":"192.168.10.0/24", "nexthop":"192.168.10.0"}]`	array[object]
name required	Subnet 명 Example : `subnetName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	태그 목록	array[Tag]
type required	Subnet 유형 Example : `GENERAL`	enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id required	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string

8.2.55 - SubnetDetail

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
allocation_pools optional	IP 할당 범위	array[object]
cidr required	Subnet Cidr Example : `192.167.1.0/24`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example : `Subnet Description`	any of [string, null]
dns_nameservers optional	DNS Name Server	array[string]
gateway_ip_address required	Gateway IP Example : `192.167.1.1`	any of [string, null]
host_routes optional	호스트 경로	array[object]
id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Subnet 명 Example : `subnetName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type required	Subnet 유형 Example : `GENERAL`	enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id required	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name required	VPC 명 Example : `vpcName`	string

8.2.56 - SubnetListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
subnets required		array[Subnet]

8.2.57 - SubnetSetRequest

Name	Description	Schema	Default
description required	설명 Example : `Subnet Description` Maximum length : `50`	string

8.2.58 - SubnetShowResponse

Name	Description	Schema	Default
subnet required		SubnetDetail

8.2.59 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

8.2.60 - TransitGateway

Name	Description	Schema
account_id required	Account ID Example :	string
bandwidth optional	Transit Gateway 포트 용량 Example :	any of [integer, null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Transit Gateway 상세 설명 Example :	any of [string, null]
firewall_ids optional	Firewall ID Example :	any of [string, null]
id required	Transit Gateway ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Transit Gateway 명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)
uplink_enabled optional	Uplink 사용 Example : `False`	boolean

8.2.61 - TransitGatewayCreateRequest

Name	Description	Schema
description optional	설명 Example :	any of [string, null]
name required	Transit Gateway 명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	태그 목록	array[Tag]

8.2.62 - TransitGatewayListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
transit_gateways required		array[TransitGateway]

8.2.63 - TransitGatewayRule

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	설명 Example :	string
destination_cidr required	목적지 CIDR Example :	string
destination_resource_id required	목적지 자원 ID Example :	any of [string, null]
destination_resource_name optional	목적지 자원명 Example :	any of [string, null]
destination_type required	목적지 타입 Example : `VPC`	enum (VPC, TGW)
id required	Routing Rule ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
source_resource_id required	출발지 자원 ID Example :	any of [string, null]
source_resource_name optional	출발지 자원명 Example :	any of [string, null]
source_type required	출발지 타입 Example : `VPC`	enum (VPC, TGW)
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id required	Transit Gateway에 연결된 VPC ID. Example :	any of [string, null]
tgw_connection_vpc_name optional	Transit Gateway에 연결된 VPC명. Example :	any of [string, null]

8.2.64 - TransitGatewayRuleCreateRequest

Name	Description	Schema
description optional	설명 Example : Maximum length : `50`	string
destination_cidr required	목적지 CIDR Example :	string
destination_type required	목적지 타입 Example : `VPC`	enum (VPC, TGW)
tgw_connection_vpc_id required	Transit Gateway에 연결된 VPC ID. Example :	string

8.2.65 - TransitGatewayRuleListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
transit_gateway_rules required		array[TransitGatewayRule]

8.2.66 - TransitGatewayRuleShowResponse

Name	Description	Schema	Default
transit_gateway_rule required		TransitGatewayRule

8.2.67 - TransitGatewaySetRequest

Name	Description	Schema	Default
description optional	설명 Example : Maximum length : `50`	string

8.2.68 - TransitGatewayShowResponse

Name	Description	Schema	Default
transit_gateway required		TransitGateway

8.2.69 - TransitGatewayVpcConnection

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	Transit Gateway VPC 연결 ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
transit_gateway_id required	Transit Gateway ID Example :	string
vpc_id required	VPC ID Example :	string
vpc_name required	VPC 명 Example :	string

8.2.70 - TransitGatewayVpcConnectionCreateRequest

Name	Description	Schema	Default
vpc_id required	VPC ID Example :	string

8.2.71 - TransitGatewayVpcConnectionListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
transit_gateway_vpc_connections required		array[TransitGatewayVpcConnection]

8.2.72 - TransitGatewayVpcConnectionShowResponse

Name	Description	Schema	Default
transit_gateway_vpc_connection required		TransitGatewayVpcConnection

8.2.73 - Vpc

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
cidr required	VPC Cidr Example : `192.167.0.0/18`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example : `vpcDescription`	any of [string, null]
id required	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	VPC 명 Example : `vpcName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETED, ERROR)

8.2.74 - VpcCreateRequest

Name	Description	Schema
cidr required	VPC Cidr Example : `192.167.0.0/18`	string
description optional	설명 Example : `VPC Description`	any of [string, null]
name required	VPC 명 Example : `vpcName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	태그 목록	array[Tag]

8.2.75 - VpcEndpoint

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example :	any of [string, null]
endpoint_ip_address required	VPC Endpoint IP 주소 Example :	string
id required	VPC Endpoint ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	VPC Endpoint 명 Example :	string
resource_info required	VPC Endpoint Resource Key 정보 Example :	string
resource_key required	VPC Endpoint Resource Key Example :	string
resource_type required	VPC Endpoint 자원 타입 Example : `FS`	enum (FS, OBS, SCR, DNS)
state required	VPC Endpoint 상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id required	Subnet ID Example :	string
subnet_name required	Subnet 명 Example :	string
vpc_id required	VPC ID Example :	string
vpc_name required	VPC 명 Example :	string

8.2.76 - VpcEndpointConnectableResourceDetail

Name	Description	Schema
resource_info required	VPC Endpoint Resource Key 정보 Example :	string
resource_key required	VPC Endpoint Resource Key Example :	string
resource_type required	VPC Endpoint 자원 타입 Example : `FS`	enum (FS, OBS, SCR, DNS)

8.2.77 - VpcEndpointConnectableResourceListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
vpc_endpoint_connectable_resources required		array[VpcEndpointConnectableResourceDetail]

8.2.78 - VpcEndpointCreateRequest

Name	Description	Schema
description optional	설명 Example : Maximum length : `50`	string
endpoint_ip_address required	VPC Endpoint IP 주소 Example :	string
name required	VPC Endpoint 명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
resource_info required	VPC Endpoint Resource Key 정보 Example : Maximum length : `200`	string
resource_key required	VPC Endpoint Resource Key Example :	string
resource_type required	VPC Endpoint 자원 타입 Example : `FS`	enum (FS, OBS, SCR, DNS)
subnet_id required	Subnet ID Example :	string
tags optional	태그 목록	array[Tag]
vpc_id required	VPC ID Example :	string

8.2.79 - VpcEndpointListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
vpc_endpoints required		array[VpcEndpoint]

8.2.80 - VpcEndpointSetRequest

Name	Description	Schema	Default
description optional	설명 Example : Maximum length : `50`	string

8.2.81 - VpcEndpointShowResponse

Name	Description	Schema	Default
vpc_endpoint required		VpcEndpoint

8.2.82 - VpcListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
vpcs required		array[Vpc]

8.2.83 - VpcPeering

Name	Description	Schema
account_type required	과제 유형 Example : `SAME`	enum (SAME, DIFFERENT)
approver_vpc_account_id required	승인 VPC 과제 ID Example :	string
approver_vpc_id required	승인 VPC ID Example :	string
approver_vpc_name required	승인 VPC 명 Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
delete_requester_account_id optional	요청 VPC 과제 ID Example :	any of [string, null]
description optional	VPC Peering 상세설명 Example :	any of [string, null]
id required	VPC Peering ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	VPC Peering 명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
requester_vpc_account_id required	요청 VPC 과제 ID Example :	string
requester_vpc_id required	요청 VPC ID Example :	string
requester_vpc_name required	요청 VPC 명 Example :	string
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING)

8.2.84 - VpcPeeringApprovalRequest

Name	Description	Schema	Default
type required	승인 유형 Example : `CREATE_APPROVE`	enum (CREATE_APPROVE, CREATE_CANCEL, CREATE_REJECT, CREATE_RE_REQUEST, DELETE_APPROVE, DELETE_CANCEL, DELETE_REJECT)

8.2.85 - VpcPeeringCreateRequest

Name	Description	Schema
approver_vpc_account_id required	승인 VPC 과제 ID Example :	string
approver_vpc_id required	승인 VPC ID Example :	string
description optional	설명 Example :	any of [string, null]
name required	VPC Peering 명 Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
requester_vpc_id required	요청 VPC ID Example :	string
tags optional	태그 목록	array[Tag]

8.2.86 - VpcPeeringListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
vpc_peerings required		array[VpcPeering]

8.2.87 - VpcPeeringRule

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
destination_cidr required	목적지 CIDR Example :	string
destination_vpc_id required	목적지 VPC ID Example :	string
destination_vpc_name required	목적지 VPC 명 Example :	string
destination_vpc_type required	목적지 VPC 유형 Example : `REQUESTER_VPC`	enum (REQUESTER_VPC, APPROVER_VPC)
id required	VPC Peering 규칙 ID Example :	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
source_vpc_id required	출발지 VPC ID Example :	string
source_vpc_name required	출발지 VPC 명 Example :	string
source_vpc_type required	출발지 VPC 유형 Example : `REQUESTER_VPC`	enum (REQUESTER_VPC, APPROVER_VPC)
state required	상태 Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
vpc_peering_id required	VPC Peering ID Example :	string

8.2.88 - VpcPeeringRuleCreateRequest

Name	Description	Schema
destination_cidr required	목적지 CIDR Example :	string
destination_vpc_type required	목적지 VPC 유형 Example : `REQUESTER_VPC`	enum (REQUESTER_VPC, APPROVER_VPC)
tags optional	태그 목록	array[Tag]

8.2.89 - VpcPeeringRuleListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
vpc_peering_rules required		array[VpcPeeringRule]

8.2.90 - VpcPeeringRuleShowResponse

Name	Description	Schema	Default
vpc_peering_rule required		VpcPeeringRule

8.2.91 - VpcPeeringSetRequest

Name	Description	Schema	Default
description optional	설명 Example : Maximum length : `50`	string

8.2.92 - VpcPeeringShowResponse

Name	Description	Schema	Default
vpc_peering required		VpcPeering

8.2.93 - VpcSetRequest

Name	Description	Schema	Default
description optional	설명 Example : `vpcDescription`	any of [string, null]

8.2.94 - VpcShowResponse

Name	Description	Schema	Default
vpc required		Vpc

9 - VPN

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 VPN 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

OpenAPI URL

https://vpn.{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

9.1 - APIs

9.1.1 - Create VPN Gateway

9.1.1.1 - 1.1

post /v1/vpn-gateways

Description

VPN gateway 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpnGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpnGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpn 1.1"

Request body

{
    "description": "Example Description for VPN Gateway",
    "ip_address": "123.0.0.1",
    "ip_id": "fcde872f75c145a0893d656cc698f13e",
    "ip_type": "PUBLIC",
    "name": "ExampleVpnGW1",
    "tags": [],
    "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718"
}

Example HTTP response

Response 202

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

9.1.1.2 - 1.0

post /v1/vpn-gateways

Description

VPN gateway 생성

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VpnGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpnGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpn-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpn 1.0"

Request body

{
    "description": "Example Description for VPN Gateway",
    "ip_address": "123.0.0.1",
    "ip_id": "fcde872f75c145a0893d656cc698f13e",
    "ip_type": "PUBLIC",
    "name": "ExampleVpnGW1",
    "tags": [],
    "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718"
}

Example HTTP response

Response 202

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

9.1.2 - Create VPN Tunnel

9.1.2.1 - 1.1

post /v1/vpn-tunnels

Description

VPN tunnel 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpnTunnelCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
202	Accepted	VpnTunnelShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpn 1.1"

Request body

{
    "description": "Example Description for VPN Tunnel",
    "name": "ExampleVpnTunnel1",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnets": [
            "10.1.1.0/24",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ]
    },
    "tags": [],
    "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a"
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnets": [
                "10.1.1.0/24",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ]
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

9.1.2.2 - 1.0

post /v1/vpn-tunnels

Description

VPN tunnel 생성

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VpnTunnelCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpnTunnelShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpn 1.0"

Request body

{
    "description": "Example Description for VPN Tunnel",
    "name": "ExampleVpnTunnel1",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnet": "10.1.0.0/16"
    },
    "tags": [],
    "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a"
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnet": "10.1.0.0/16"
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

9.1.3 - Delete VPN Gateway

9.1.3.1 - 1.1

delete /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.1"

Example HTTP response

Response 202

9.1.3.2 - 1.0

delete /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 삭제

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.0"

Example HTTP response

Response 202

9.1.4 - Delete VPN Tunnel

9.1.4.1 - 1.1

delete /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.1"

Example HTTP response

Response 202

9.1.4.2 - 1.0

delete /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 삭제

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.0"

Example HTTP response

Response 202

9.1.5 - List VPN Gateways

9.1.5.1 - 1.1

get /v1/vpn-gateways

Description

VPN gateway 목록 조회

상태 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	name optional	VPN Gateway Name Example : `ExampleVpnGW1`	string	None
query	ip_address optional	VPN Gateway IP 주소 Example : `123.0.0.1`	string	None
query	vpc_id optional	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string	None
query	vpc_name optional	VPC 명 Example : `ExampleVPC1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpnGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpn-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpn 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_gateways": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Gateway",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "ip_address": "123.0.0.1",
            "ip_id": "fcde872f75c145a0893d656cc698f13e",
            "ip_type": "PUBLIC",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnGW1",
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1"
        }
    ]
}

9.1.5.2 - 1.0

get /v1/vpn-gateways

Description

VPN gateway 목록 조회

상태 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	name optional	VPN Gateway Name Example : `ExampleVpnGW1`	string	None
query	ip_address optional	VPN Gateway IP 주소 Example : `123.0.0.1`	string	None
query	vpc_id optional	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string	None
query	vpc_name optional	VPC 명 Example : `ExampleVPC1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpnGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpn-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpn 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_gateways": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Gateway",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "ip_address": "123.0.0.1",
            "ip_id": "fcde872f75c145a0893d656cc698f13e",
            "ip_type": "PUBLIC",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnGW1",
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1"
        }
    ]
}

9.1.6 - List VPN Tunnels

9.1.6.1 - 1.1

get /v1/vpn-tunnels

Description

VPN tunnel 목록 조회

상태 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	name optional	VPN Tunnel 이름 Example : `ExampleVpnTunnel1`	string	None
query	vpn_gateway_id optional	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
query	vpn_gateway_name optional	VPN Gateway Name Example : `ExampleVpnGW1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpnTunnelListResponseV1Dot1
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpn 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_tunnels": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Tunnel",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnTunnel1",
            "phase1": {
                "dpd_retry_interval": 60,
                "ike_version": 2,
                "life_time": 86400,
                "peer_gateway_ip": "123.0.0.2"
            },
            "phase2": {
                "life_time": 43200,
                "perfect_forward_secrecy": "ENABLE",
                "remote_subnets": [
                    "10.1.1.0/24",
                    "10.1.2.0/24",
                    "10.1.3.0/24"
                ]
            },
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1",
            "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
            "vpn_gateway_ip_address": "123.0.0.1",
            "vpn_gateway_name": "ExampleVpnGW1"
        }
    ]
}

9.1.6.2 - 1.0

get /v1/vpn-tunnels

Description

VPN tunnel 목록 조회

상태 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	name optional	VPN Tunnel 이름 Example : `ExampleVpnTunnel1`	string	None
query	vpn_gateway_id optional	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
query	vpn_gateway_name optional	VPN Gateway Name Example : `ExampleVpnGW1`	string	None
query	peer_gateway_ip optional	VPN Tunnel Peer Gateway IP 주소 Example : `123.0.0.2`	string	None
query	remote_subnet optional	VPN Tunnel IPSec Remote Subnet Example : `10.1.0.0/16`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpnTunnelListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = vpn 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_tunnels": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Tunnel",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnTunnel1",
            "phase1": {
                "dpd_retry_interval": 60,
                "ike_version": 2,
                "life_time": 86400,
                "peer_gateway_ip": "123.0.0.2"
            },
            "phase2": {
                "life_time": 43200,
                "perfect_forward_secrecy": "ENABLE",
                "remote_subnet": "10.1.0.0/16"
            },
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1",
            "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
            "vpn_gateway_ip_address": "123.0.0.1",
            "vpn_gateway_name": "ExampleVpnGW1"
        }
    ]
}

9.1.7 - Set VPN Gateway

9.1.7.1 - 1.1

put /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
body	body required		VpnGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpnGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.1"

Request body

{
    "description": "Example Description for VPN Gateway"
}

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

9.1.7.2 - 1.0

put /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 수정

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
body	body required		VpnGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpnGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.0"

Request body

{
    "description": "Example Description for VPN Gateway"
}

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

9.1.8 - Set VPN Tunnel

9.1.8.1 - 1.1

put /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None
body	body required		VpnTunnelSetRequestV1Dot1

Responses

HTTP Code	Description	Schema
202	Accepted	VpnTunnelShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.1"

Request body

{
    "description": "Example Description for VPN Tunnel",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnets": [
            "10.1.1.0/24",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ]
    }
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnets": [
                "10.1.1.0/24",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ]
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

9.1.8.2 - 1.0

put /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 수정

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None
body	body required		VpnTunnelSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpnTunnelShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.0"

Request body

{
    "description": "Example Description for VPN Tunnel",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnet": "10.1.0.0/16"
    }
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnet": "10.1.0.0/16"
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

9.1.9 - Show VPN Gateway

9.1.9.1 - 1.1

get /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpnGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.1"

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

9.1.9.2 - 1.0

get /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 상세 조회

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpnGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.0"

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

9.1.10 - Show VPN Tunnel

9.1.10.1 - 1.1

get /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpnTunnelShowWithStatusResponseV1Dot1
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.1"

Example HTTP response

Response 200

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnets": [
                "10.1.1.0/24",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ]
        },
        "state": "ACTIVE",
        "status": "UP",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

9.1.10.2 - 1.0

get /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 상세 조회

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpnTunnelShowWithStatusResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.0"

Example HTTP response

Response 200

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnet": "10.1.0.0/16"
        },
        "state": "ACTIVE",
        "status": "UP",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

9.2 - Models

9.2.1 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

9.2.2 - VpnGateway

Name	Description	Schema
account_id required	Account ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	설명 Example : `Example Description for VPN Gateway`	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
ip_address required	VPN Gateway IP 주소 Example : `123.0.0.1`	string
ip_id required	VPN Gateway IP ID Example : `fcde872f75c145a0893d656cc698f13e`	string
ip_type required	VPN Gateway IP 타입 Example : `PUBLIC`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	VPN Gateway Name Example : `ExampleVpnGW1`	string
state required	상태 Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id required	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string
vpc_name required	VPC 명 Example : `ExampleVPC1`	string

9.2.3 - VpnGatewayCreateRequest

Name	Description	Schema
description optional	설명 Example : `Example Description for VPN Gateway`	any of [string, null]
ip_address required	VPN Gateway IP 주소 Example : `123.0.0.1`	string
ip_id required	VPN Gateway IP ID Example : `fcde872f75c145a0893d656cc698f13e`	string
ip_type required	VPN Gateway IP 타입 Example : `PUBLIC`	string
name required	VPN Gateway Name Example : `ExampleVpnGW1`	string
tags optional	태그 목록	array[Tag]
vpc_id required	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string

9.2.4 - VpnGatewayListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
vpn_gateways required		array[VpnGateway]

9.2.5 - VpnGatewaySetRequest

Name	Description	Schema	Default
description optional	설명 Example : `Example Description for VPN Gateway`	string

9.2.6 - VpnGatewayShowResponse

Name	Description	Schema	Default
vpn_gateway required		VpnGateway

9.2.7 - VpnPhase1

Name	Description	Schema
dpd_retry_interval required	VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초) Example : `60`	integer
ike_version required	VPN Tunnel IKE 버전 Example : `2`	integer
life_time required	VPN Tunnel ISAKMP Lifetime (초) Example : `86400`	integer
peer_gateway_ip required	VPN Tunnel Peer Gateway IP 주소 Example : `123.0.0.2`	string

9.2.8 - VpnPhase1CreateRequest

Name	Description	Schema
dpd_retry_interval required	VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초) Example : `60`	integer
ike_version required	VPN Tunnel IKE 버전 Example : `2`	integer
peer_gateway_ip required	VPN Tunnel Peer Gateway IP 주소 Example : `123.0.0.2`	string
phase1_diffie_hellman_groups required	VPN Tunnel ISAKMP Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	array[integer]
phase1_encryptions required	VPN Tunnel ISAKMP Proposal 목록 Example : `['des-md5', 'chacha20poly1305-prfsha256']`	array[string]
phase1_life_time required	VPN Tunnel ISAKMP Lifetime (초) Example : `86400`	integer
pre_shared_key required	VPN Tunnel ISAKMP 인증 : Pre-shared Key Example : `PreSharedKey1`	string

9.2.9 - VpnPhase1CreateRequestV1Dot1

Name	Description	Schema
dpd_retry_interval required	VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초) Example : `60`	integer
ike_version required	VPN Tunnel IKE 버전 Example : `2`	integer
peer_gateway_ip required	VPN Tunnel Peer Gateway IP 주소 Example : `123.0.0.2`	string
phase1_diffie_hellman_groups required	VPN Tunnel ISAKMP Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	array[integer]
phase1_encryptions required	VPN Tunnel ISAKMP Proposal 목록 Example : `['des-md5', 'chacha20poly1305-prfsha256']`	array[string]
phase1_life_time required	VPN Tunnel ISAKMP Lifetime (초) Example : `86400`	integer
pre_shared_key required	VPN Tunnel ISAKMP 인증 : Pre-shared Key Example : `PreSharedKey1`	string

9.2.10 - VpnPhase1Detail

Name	Description	Schema
diffie_hellman_groups required	VPN Tunnel ISAKMP Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	array[integer]
dpd_retry_interval required	VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초) Example : `60`	integer
encryptions required	VPN Tunnel ISAKMP Proposal 목록 Example : `['des-md5', 'chacha20poly1305-prfsha256']`	array[string]
ike_version required	VPN Tunnel IKE 버전 Example : `2`	integer
life_time required	VPN Tunnel ISAKMP Lifetime (초) Example : `86400`	integer
peer_gateway_ip required	VPN Tunnel Peer Gateway IP 주소 Example : `123.0.0.2`	string

9.2.11 - VpnPhase1DetailV1Dot1

Name	Description	Schema
diffie_hellman_groups required	VPN Tunnel ISAKMP Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	array[integer]
dpd_retry_interval required	VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초) Example : `60`	integer
encryptions required	VPN Tunnel ISAKMP Proposal 목록 Example : `['des-md5', 'chacha20poly1305-prfsha256']`	array[string]
ike_version required	VPN Tunnel IKE 버전 Example : `2`	integer
life_time required	VPN Tunnel ISAKMP Lifetime (초) Example : `86400`	integer
peer_gateway_ip required	VPN Tunnel Peer Gateway IP 주소 Example : `123.0.0.2`	string

9.2.12 - VpnPhase1SetRequest

Name	Description	Schema
dpd_retry_interval optional	VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초) Example : `60`	any of [integer, null]
ike_version optional	VPN Tunnel IKE 버전 Example : `2`	any of [integer, null]
peer_gateway_ip optional	VPN Tunnel Peer Gateway IP 주소 Example : `123.0.0.2`	any of [string, null]
phase1_diffie_hellman_groups optional	VPN Tunnel ISAKMP Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	any of [array[integer], null]
phase1_encryptions optional	VPN Tunnel ISAKMP Proposal 목록 Example : `['des-md5', 'chacha20poly1305-prfsha256']`	any of [array[string], null]
phase1_life_time optional	VPN Tunnel ISAKMP Lifetime (초) Example : `86400`	any of [integer, null]
pre_shared_key optional	VPN Tunnel ISAKMP 인증 : Pre-shared Key Example : `PreSharedKey1`	any of [string, null]

9.2.13 - VpnPhase1SetRequestV1Dot1

Name	Description	Schema
dpd_retry_interval optional	VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초) Example : `60`	any of [integer, null]
ike_version optional	VPN Tunnel IKE 버전 Example : `2`	any of [integer, null]
peer_gateway_ip optional	VPN Tunnel Peer Gateway IP 주소 Example : `123.0.0.2`	any of [string, null]
phase1_diffie_hellman_groups optional	VPN Tunnel ISAKMP Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	any of [array[integer], null]
phase1_encryptions optional	VPN Tunnel ISAKMP Proposal 목록 Example : `['des-md5', 'chacha20poly1305-prfsha256']`	any of [array[string], null]
phase1_life_time optional	VPN Tunnel ISAKMP Lifetime (초) Example : `86400`	any of [integer, null]
pre_shared_key optional	VPN Tunnel ISAKMP 인증 : Pre-shared Key Example : `PreSharedKey1`	any of [string, null]

9.2.14 - VpnPhase1V1Dot1

Name	Description	Schema
dpd_retry_interval required	VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초) Example : `60`	integer
ike_version required	VPN Tunnel IKE 버전 Example : `2`	integer
life_time required	VPN Tunnel ISAKMP Lifetime (초) Example : `86400`	integer
peer_gateway_ip required	VPN Tunnel Peer Gateway IP 주소 Example : `123.0.0.2`	string

9.2.15 - VpnPhase2

Name	Description	Schema
life_time required	VPN Tunnel IPSec Lifetime (초) Example : `43200`	integer
perfect_forward_secrecy required	VPN Tunnel IPSec Perfect Forward Secrecy(PFS) Example : `ENABLE`	string
remote_subnet required	VPN Tunnel IPSec Remote Subnet Example : `10.1.0.0/16`	string

9.2.16 - VpnPhase2CreateRequest

Name	Description	Schema
perfect_forward_secrecy required	VPN Tunnel IPSec Perfect Forward Secrecy(PFS) Example : `ENABLE`	enum (ENABLE, DISABLE)
phase2_diffie_hellman_groups required	VPN Tunnel ISAKMP Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	array[integer]
phase2_encryptions required	VPN Tunnel ISAKMP Proposal 목록 Example : `['null-md5', 'aes128gcm', 'chacha20poly1305']`	array[string]
phase2_life_time required	VPN Tunnel IPSec Lifetime (초) Example : `43200`	integer
remote_subnet required	VPN Tunnel IPSec Remote Subnet Example : `10.1.0.0/16`	string

9.2.17 - VpnPhase2CreateRequestV1Dot1

Name	Description	Schema
perfect_forward_secrecy required	VPN Tunnel IPSec Perfect Forward Secrecy(PFS) Example : `ENABLE`	enum (ENABLE, DISABLE)
phase2_diffie_hellman_groups required	VPN Tunnel ISAKMP Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	array[integer]
phase2_encryptions required	VPN Tunnel ISAKMP Proposal 목록 Example : `['null-md5', 'aes128gcm', 'chacha20poly1305']`	array[string]
phase2_life_time required	VPN Tunnel IPSec Lifetime (초) Example : `43200`	integer
remote_subnets required	VPN Tunnel IPSec Remote Subnet Example : `['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']`	array[string]

9.2.18 - VpnPhase2Detail

Name	Description	Schema
diffie_hellman_groups optional	VPN Tunnel IPSec Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	any of [array[integer], null]
encryptions required	VPN Tunnel IPSec Proposal 목록 Example : `['null-md5', 'aes128gcm', 'chacha20poly1305']`	array[string]
life_time required	VPN Tunnel IPSec Lifetime (초) Example : `43200`	integer
perfect_forward_secrecy required	VPN Tunnel IPSec Perfect Forward Secrecy(PFS) Example : `ENABLE`	string
remote_subnet required	VPN Tunnel IPSec Remote Subnet Example : `10.1.0.0/16`	string

9.2.19 - VpnPhase2DetailV1Dot1

Name	Description	Schema
diffie_hellman_groups optional	VPN Tunnel IPSec Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	any of [array[integer], null]
encryptions required	VPN Tunnel IPSec Proposal 목록 Example : `['null-md5', 'aes128gcm', 'chacha20poly1305']`	array[string]
life_time required	VPN Tunnel IPSec Lifetime (초) Example : `43200`	integer
perfect_forward_secrecy required	VPN Tunnel IPSec Perfect Forward Secrecy(PFS) Example : `ENABLE`	string
remote_subnets required	VPN Tunnel IPSec Remote Subnet Example : `['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']`	array[string]

9.2.20 - VpnPhase2SetRequest

Name	Description	Schema
perfect_forward_secrecy optional	VPN Tunnel IPSec Perfect Forward Secrecy(PFS) Example : `ENABLE`	any of [enum (ENABLE, DISABLE), null]
phase2_diffie_hellman_groups optional	VPN Tunnel ISAKMP Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	any of [array[integer], null]
phase2_encryptions optional	VPN Tunnel ISAKMP Proposal 목록 Example : `['null-md5', 'aes128gcm', 'chacha20poly1305']`	any of [array[string], null]
phase2_life_time optional	VPN Tunnel IPSec Lifetime (초) Example : `43200`	any of [integer, null]
remote_subnet optional	VPN Tunnel IPSec Remote Subnet Example : `10.1.0.0/16`	any of [string, null]

9.2.21 - VpnPhase2SetRequestV1Dot1

Name	Description	Schema
perfect_forward_secrecy optional	VPN Tunnel IPSec Perfect Forward Secrecy(PFS) Example : `ENABLE`	any of [enum (ENABLE, DISABLE), null]
phase2_diffie_hellman_groups optional	VPN Tunnel ISAKMP Diffie-Hellman Group 목록 Example : `[30, 31, 32]`	any of [array[integer], null]
phase2_encryptions optional	VPN Tunnel ISAKMP Proposal 목록 Example : `['null-md5', 'aes128gcm', 'chacha20poly1305']`	any of [array[string], null]
phase2_life_time optional	VPN Tunnel IPSec Lifetime (초) Example : `43200`	any of [integer, null]
remote_subnets optional	VPN Tunnel IPSec Remote Subnet Example : `['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']`	any of [array[string], null]

9.2.22 - VpnPhase2V1Dot1

Name	Description	Schema
life_time required	VPN Tunnel IPSec Lifetime (초) Example : `43200`	integer
perfect_forward_secrecy required	VPN Tunnel IPSec Perfect Forward Secrecy(PFS) Example : `ENABLE`	string
remote_subnets required	VPN Tunnel IPSec Remote Subnet Example : `['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']`	array[string]

9.2.23 - VpnTunnel

Name	Description	Schema
account_id required	Account ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	설명 Example : `Example Description for VPN Tunnel`	any of [string, null]
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	VPN Tunnel 이름 Example : `ExampleVpnTunnel1`	string
phase1 required	VPN Tunnel Phase1	VpnPhase1
phase2 required	VPN Tunnel Phase2	VpnPhase2
state required	상태 Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id required	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string
vpc_name required	VPC 명 Example : `ExampleVPC1`	string
vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
vpn_gateway_ip_address required	VPN Gateway IP 주소 Example : `123.0.0.1`	string
vpn_gateway_name required	VPN Gateway Name Example : `ExampleVpnGW1`	string

9.2.24 - VpnTunnelCreateRequest

Name	Description	Schema
description optional	설명 Example : `Example Description for VPN Tunnel`	any of [string, null]
name required	VPN Tunnel 이름 Example : `ExampleVpnTunnel1`	string
phase1 required	VPN Tunnel Phase1	VpnPhase1CreateRequest
phase2 required	VPN Tunnel Phase2	VpnPhase2CreateRequest
tags optional	태그 목록	array[Tag]
vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string

9.2.25 - VpnTunnelCreateRequestV1Dot1

Name	Description	Schema
description optional	설명 Example : `Example Description for VPN Tunnel`	any of [string, null]
name required	VPN Tunnel 이름 Example : `ExampleVpnTunnel1`	string
phase1 required	VPN Tunnel Phase1	VpnPhase1CreateRequestV1Dot1
phase2 required	VPN Tunnel Phase2	VpnPhase2CreateRequestV1Dot1
tags optional	태그 목록	array[Tag]
vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string

9.2.26 - VpnTunnelDetail

Name	Description	Schema
account_id required	Account ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	설명 Example : `Example Description for VPN Tunnel`	any of [string, null]
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	VPN Tunnel 이름 Example : `ExampleVpnTunnel1`	string
phase1 required	VPN Tunnel Phase1	VpnPhase1Detail
phase2 required	VPN Tunnel Phase2	VpnPhase2Detail
state required	상태 Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id required	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string
vpc_name required	VPC 명 Example : `ExampleVPC1`	string
vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
vpn_gateway_ip_address required	VPN Gateway IP 주소 Example : `123.0.0.1`	string
vpn_gateway_name required	VPN Gateway Name Example : `ExampleVpnGW1`	string

9.2.27 - VpnTunnelDetailV1Dot1

Name	Description	Schema
account_id required	Account ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	설명 Example : `Example Description for VPN Tunnel`	any of [string, null]
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	VPN Tunnel 이름 Example : `ExampleVpnTunnel1`	string
phase1 required	VPN Tunnel Phase1	VpnPhase1DetailV1Dot1
phase2 required	VPN Tunnel Phase2	VpnPhase2DetailV1Dot1
state required	상태 Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id required	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string
vpc_name required	VPC 명 Example : `ExampleVPC1`	string
vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
vpn_gateway_ip_address required	VPN Gateway IP 주소 Example : `123.0.0.1`	string
vpn_gateway_name required	VPN Gateway Name Example : `ExampleVpnGW1`	string

9.2.28 - VpnTunnelDetailWithStatus

Name	Description	Schema
account_id required	Account ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	설명 Example : `Example Description for VPN Tunnel`	any of [string, null]
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	VPN Tunnel 이름 Example : `ExampleVpnTunnel1`	string
phase1 required	VPN Tunnel Phase1	VpnPhase1Detail
phase2 required	VPN Tunnel Phase2	VpnPhase2Detail
state required	상태 Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status required	VPN Tunnel 상태 Example : `UP`	enum (UP, DOWN)
vpc_id required	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string
vpc_name required	VPC 명 Example : `ExampleVPC1`	string
vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
vpn_gateway_ip_address required	VPN Gateway IP 주소 Example : `123.0.0.1`	string
vpn_gateway_name required	VPN Gateway Name Example : `ExampleVpnGW1`	string

9.2.29 - VpnTunnelDetailWithStatusV1Dot1

Name	Description	Schema
account_id required	Account ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	설명 Example : `Example Description for VPN Tunnel`	any of [string, null]
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	VPN Tunnel 이름 Example : `ExampleVpnTunnel1`	string
phase1 required	VPN Tunnel Phase1	VpnPhase1DetailV1Dot1
phase2 required	VPN Tunnel Phase2	VpnPhase2DetailV1Dot1
state required	상태 Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status required	VPN Tunnel 상태 Example : `UP`	enum (UP, DOWN)
vpc_id required	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string
vpc_name required	VPC 명 Example : `ExampleVPC1`	string
vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
vpn_gateway_ip_address required	VPN Gateway IP 주소 Example : `123.0.0.1`	string
vpn_gateway_name required	VPN Gateway Name Example : `ExampleVpnGW1`	string

9.2.30 - VpnTunnelListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
vpn_tunnels required		array[VpnTunnel]

9.2.31 - VpnTunnelListResponseV1Dot1

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
vpn_tunnels required		array[VpnTunnelV1Dot1]

9.2.32 - VpnTunnelSetRequest

Name	Description	Schema
description optional	설명 Example : `Example Description for VPN Tunnel`	any of [string, null]
phase1 optional	VPN Tunnel Phase1	any of [VpnPhase1SetRequest, null]
phase2 optional	VPN Tunnel Phase2	any of [VpnPhase2SetRequest, null]

9.2.33 - VpnTunnelSetRequestV1Dot1

Name	Description	Schema
description optional	설명 Example : `Example Description for VPN Tunnel`	any of [string, null]
phase1 optional	VPN Tunnel Phase1	any of [VpnPhase1SetRequestV1Dot1, null]
phase2 optional	VPN Tunnel Phase2	any of [VpnPhase2SetRequestV1Dot1, null]

9.2.34 - VpnTunnelShowResponse

Name	Description	Schema	Default
vpn_tunnel required		VpnTunnelDetail

9.2.35 - VpnTunnelShowResponseV1Dot1

Name	Description	Schema	Default
vpn_tunnel required		VpnTunnelDetailV1Dot1

9.2.36 - VpnTunnelShowWithStatusResponse

Name	Description	Schema	Default
vpn_tunnel required		VpnTunnelDetailWithStatus

9.2.37 - VpnTunnelShowWithStatusResponseV1Dot1

Name	Description	Schema	Default
vpn_tunnel required		VpnTunnelDetailWithStatusV1Dot1

9.2.38 - VpnTunnelV1Dot1

Name	Description	Schema
account_id required	Account ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	설명 Example : `Example Description for VPN Tunnel`	any of [string, null]
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	VPN Tunnel 이름 Example : `ExampleVpnTunnel1`	string
phase1 required	VPN Tunnel Phase1	VpnPhase1V1Dot1
phase2 required	VPN Tunnel Phase2	VpnPhase2V1Dot1
state required	상태 Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id required	VPC ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string
vpc_name required	VPC 명 Example : `ExampleVPC1`	string
vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
vpn_gateway_ip_address required	VPN Gateway IP 주소 Example : `123.0.0.1`	string
vpn_gateway_name required	VPN Gateway Name Example : `ExampleVpnGW1`	string