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

Return to the regular view of this page.

Models

1 - ConnectedEndpointListResponse

NameDescriptionSchemaDefault
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]

2 - ConnectedPortInfo

NameDescriptionSchemaDefault
attached_resource_id
required
Connected resource ID
Example : 9387e8f51de04a03994de8a9c3524935
string
attached_resource_type
required
Connected resource Type
Example : Virtual Server
string
id
required
Connected Port Id
Example : 13e2a5a1acbe4713a9a2c70ce226e822
string
port_id
required
Port ID
Example : 8b4705d3-43b7-4fad-8648-a5a1a90c31d0
string
port_ip_address
required
Port IP Address
Example : 192.168.20.5
string
port_name
required
Port Name
Example : Port name
string

3 - ConnectedPrivateLinkEndpoint

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
privatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
string
state
required
PrivateLink Endpoint State
Example : ACTIVE
enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)

4 - InternetGateway

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
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 : Internet Gateway Description
any of [string, null]
firewall_id
optional
Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
any of [string, null]
id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
string
loggable
optional
NAT Loggable
Example : False
boolean
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Internet Gateway Name
Example : IGW_VPCname
string
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Internet Gateway Type
Example : IGW
enum (IGW, GGW, SIGW)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string

5 - InternetGatewayCreateRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : Internet Gateway Description
any of [string, null]
firewall_enabled
optional
Firewall Enable
Example : False
boolean
firewall_loggable
optional
Firewall Loggable
Example : False
boolean
tags
optional
Tag List
array[Tag]
type
required
Internet Gateway Type
Example : IGW
enum (IGW, GGW, SIGW)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string

6 - InternetGatewayListResponse

NameDescriptionSchemaDefault
count
optional
total count
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]

7 - InternetGatewayListResponseV1Dot2

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
internet_gateways
required

array[InternetGateway]
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 - InternetGatewayListResponseV1Dot3

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
internet_gateways
required

array[InternetGatewayV1Dot3]
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

9 - InternetGatewaySetRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : Internet Gateway Description
any of [string, null]
loggable
optional
NAT Loggable
Example :
boolean

10 - InternetGatewaySetResponse

NameDescriptionSchemaDefault
description
optional
Description
Example : Internet Gateway Description
any of [string, null]
loggable
optional
NAT Loggable
Example :
boolean

11 - InternetGatewayShowResponse

NameDescriptionSchemaDefault
internet_gateway
required

InternetGateway

12 - InternetGatewayShowResponseV1Dot3

NameDescriptionSchemaDefault
internet_gateway
required

InternetGatewayV1Dot3

13 - InternetGatewayV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
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 : Internet Gateway Description
any of [string, null]
firewall_id
optional
Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
any of [string, null]
id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
string
loggable
optional
NAT Loggable
Example : False
boolean
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
multi_zone_enabled
optional
Multi Zone Enabled
Example : True
boolean
name
required
Internet Gateway Name
Example : IGW_VPCname
string
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Internet Gateway Type
Example : IGW
enum (IGW, GGW, SIGW)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string

14 - NatGateway

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
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
NAT Gateway Description
Example : VpcEndpoint Description
any of [string, null]
id
required
NAT Gateway ID
Example : 12f56e27070248a6a240a497e43fbe18
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
NAT Gateway Name
Example : NatGatewayName
string
nat_gateway_ip_address
required
NAT Gateway IP Address
Example : 192.167.0.5
string
publicip_id
optional
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
any of [string, null]
state
required
NAT Gateway State
Example : ACTIVE
string
subnet_cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet Name
Example : subnetName
string
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string

15 - NatGatewayCreateRequest

NameDescriptionSchemaDefault
description
optional
NAT Gateway Description
Example : VpcEndpoint Description
Maximum length : 50
string
publicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
string
subnet_id
required
Subnet CIDR
Example : 023c57b14f11483689338d085e061492
string
tags
optional
Tag List
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

16 - NatGatewayCreateRequestV1Dot3

NameDescriptionSchemaDefault
description
optional
NAT Gateway Description
Example : VpcEndpoint Description
Maximum length : 50
string
multi_zone_enabled
optional
Multi Zone Use
Example : true
any of [boolean, null]
publicip_ids
required
PublicIP IDs
Example : ['12f56e27070248a6a240a497e43fbe18', '24f56e27070248a6a240a497e43fbe18']
array[string]
subnet_id
required
Subnet CIDR
Example : 023c57b14f11483689338d085e061492
string
tags
optional
Tag List
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

17 - NatGatewayIp

NameDescriptionSchemaDefault
ip_address
required
NAT Gateway IP Address
Example : 192.167.0.5
string
publicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
string

18 - NatGatewayListResponse

NameDescriptionSchemaDefault
count
optional
total count
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]

19 - NatGatewayListResponseV1Dot2

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
nat_gateways
required

array[NatGateway]
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

20 - NatGatewayListResponseV1Dot3

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
nat_gateways
required

array[NatGatewayV1Dot3]
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

21 - NatGatewaySetRequest

NameDescriptionSchemaDefault
description
optional
NAT Gateway Description
Example : VpcEndpoint Description
Maximum length : 50
string

22 - NatGatewaySetResponse

NameDescriptionSchemaDefault
description
optional
NAT Gateway Description
Example : VpcEndpoint Description
any of [string, null]

23 - NatGatewayShowResponse

NameDescriptionSchemaDefault
nat_gateway
required

NatGateway

24 - NatGatewayShowResponseV1Dot3

NameDescriptionSchemaDefault
nat_gateway
required

NatGatewayV1Dot3

25 - NatGatewayV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
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
NAT Gateway Description
Example : VpcEndpoint Description
any of [string, null]
id
required
NAT Gateway ID
Example : 12f56e27070248a6a240a497e43fbe18
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
multi_zone_enabled
required
Multi Zone Use
Example : true
boolean
name
required
NAT Gateway Name
Example : NatGatewayName
string
nat_gateway_ips
optional
NAT Gateway IPs
any of [array[NatGatewayIp], null]
state
required
NAT Gateway State
Example : ACTIVE
string
subnet_cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet Name
Example : subnetName
string
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string

26 - Port

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
attached_resource_id
required
Connected resource ID
Example : 9387e8f51de04a03994de8a9c3524935
string
attached_resource_type
required
Connected resource Type
Example :
string
created_at
required
Created date
Example :
string (date-time)
description
required
Description
Example : Port Description
Maximum length : 50
string
fixed_ip_address
required
Fixed IP
Example : 192.168.1.100
string
id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
string
mac_address
required
MAC Address
Example : fa:16:3e:00:00:01
string
modified_at
required
Modified date
Example :
string (date-time)
name
required
Port Name
Example : portName
string
security_groups
required
Security Group List
array[PortSecurityGroup]
state
required
State
Example :
string
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet Name
Example : subnetName
string
vpc_id
required
VPC Id
Example : 071bc63b767444c9afaab1c972d302d5
string
vpc_name
required
VPC Name
Example : vpcName
string

27 - PortCreateRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : Port Description
any of [string, null]
fixed_ip_address
optional
Fixed IP
Example :
any of [string, null]
name
required
Port Name
Example : portName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
security_groups
optional
Security Group List
array[string]
subnet_id
required
Subnet Id
Example :
string
tags
optional
Tag List
array[Tag]

28 - PortList

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
attached_resource_id
required
Connected resource ID
Example : 9387e8f51de04a03994de8a9c3524935
string
attached_resource_type
required
Connected resource Type
Example :
string
created_at
required
Created date
Example :
string (date-time)
description
required
Description
Example : Port Description
Maximum length : 50
string
fixed_ip_address
required
Fixed IP
Example : 192.168.1.100
string
id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
string
mac_address
required
MAC Address
Example : fa:16:3e:00:00:01
string
modified_at
required
Modified date
Example :
string (date-time)
name
required
Port Name
Example : portName
string
state
required
State
Example :
string
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet Name
Example : subnetName
string
vpc_id
required
VPC Id
Example : 071bc63b767444c9afaab1c972d302d5
string
vpc_name
required
VPC Name
Example : vpcName
string

29 - PortListResponse

NameDescriptionSchemaDefault
count
optional
total count
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]

30 - PortSecurityGroup

NameDescriptionSchemaDefault
id
optional
Security Group ID
Example : 02fb574c-f30f-40e1-9f43-4d1572dee5bd
any of [string, null]
name
optional
Security Group Name
Example : sgName
any of [string, null]

31 - PortSetRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : Port Description
any of [string, null]
security_groups
optional
Security Group List
Example :
any of [array[string], null]

32 - PortShowResponse

NameDescriptionSchemaDefault
port
required

any of [Port, null]

33 - PortShowResponseV1Dot2

NameDescriptionSchemaDefault
port
required

any of [PortV1Dot2, null]

34 - PortV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
attached_resource_id
required
Connected resource ID
Example : 9387e8f51de04a03994de8a9c3524935
string
attached_resource_type
required
Connected resource Type
Example :
string
created_at
required
Created date
Example :
string (date-time)
description
required
Description
Example : Port Description
Maximum length : 50
string
fixed_ip_address
required
Fixed IP
Example : 192.168.1.100
string
id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
string
mac_address
required
MAC Address
Example : fa:16:3e:00:00:01
string
modified_at
required
Modified date
Example :
string (date-time)
name
required
Port Name
Example : portName
string
security_groups
required
Security Group List
array[PortSecurityGroup]
state
required
State
Example :
string
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet Name
Example : subnetName
string
virtual_ip_addresses
required
Virtual IP Address
array[string]
vpc_id
required
VPC Id
Example : 071bc63b767444c9afaab1c972d302d5
string
vpc_name
required
VPC Name
Example : vpcName
string

35 - PrivateLinkEndpoint

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approval_type
required
PrivateLink Service Approval Type
Example : AUTO
enum (MANUAL, AUTO)
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
endpoint_ip_address
required
Endpoint IP Address
Example : 192.167.1.5
string
id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
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
PrivateLink Endpoint Name
Example : EndpointName
string
privatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
string
state
required
PrivateLink Endpoint State
Example : ACTIVE
enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string

36 - PrivateLinkEndpointApprovalRequest

NameDescriptionSchemaDefault
type
required
PrivateLink Endpoint Action Type
Example : APPROVE
enum (APPROVE, REJECT)

37 - PrivateLinkEndpointConnectionRequest

NameDescriptionSchemaDefault
type
required
PrivateLink Endpoint Action Type
Example : DISCONNECT
enum (DISCONNECT, RECONNECT)

38 - PrivateLinkEndpointCreateRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : PrivateLink Endpoint Description
Maximum length : 50
string
endpoint_ip_address
required
Endpoint IP Address
Example : 192.167.1.5
string
name
required
PrivateLink Endpoint Name
Example : EndpointName
Pattern : ^[a-zA-Z0-9]([a-zA-Z0-9-])*$
Minimum length : 3
Maximum length : 20
string
privatelink_service_id
optional
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
string
security_group_ids
optional
Security Group List
Example : ['17776b52-0a64-440d-9e93-b4fc37be935b']
array[string]
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
tags
optional
Tag List
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

39 - PrivateLinkEndpointDetail

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approval_type
required
PrivateLink Service Approval Type
Example : AUTO
enum (MANUAL, AUTO)
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 : PrivateLink Endpoint Description
any of [string, null]
endpoint_ip_address
required
Endpoint IP Address
Example : 192.167.1.5
string
endpoint_ip_port_id
optional
Endpoint IP Port ID
Example : b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
any of [string, null]
id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
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
PrivateLink Endpoint Name
Example : EndpointName
string
privatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
string
security_group_ids
optional
Security Group List
Example : ['17776b52-0a64-440d-9e93-b4fc37be935b']
array[string]
state
required
PrivateLink Endpoint State
Example : ACTIVE
enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string

40 - PrivateLinkEndpointListResponse

NameDescriptionSchemaDefault
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]

41 - PrivateLinkEndpointRequest

NameDescriptionSchemaDefault
type
required
PrivateLink Endpoint Action Type
Example : CANCEL
enum (CANCEL, RE_REQUEST)

42 - PrivateLinkEndpointSetRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : PrivateLink Endpoint Description
Maximum length : 50
string

43 - PrivateLinkEndpointShowResponse

NameDescriptionSchemaDefault
privatelink_endpoint
required

PrivateLinkEndpointDetail

44 - PrivateLinkEndpointSummary

NameDescriptionSchemaDefault
created_at
required
Created date
Example : 2024-06-16T02:55:13Z
string (date-time)
id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
string
state
required
PrivateLink Endpoint State
Example : ACTIVE
enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)

45 - PrivateLinkEndpointSummaryShowResponse

NameDescriptionSchemaDefault
privatelink_endpoint
required

PrivateLinkEndpointSummary

46 - PrivateLinkService

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approval_type
required
PrivateLink Service Approval Type
Example : AUTO
enum (MANUAL, AUTO)
connected_resource_id
optional
Connected Resource ID
Example : a3e3a662a4f34442a94166df5ff9f577
any of [string, null]
connected_resource_ip_address
required
Connected Resource IP Address
Example : 192.167.0.10
string
connected_resource_name
required
Connected Resource Name
Example : lbResourceName
string
connected_resource_type
required
Connected Resource Type
Example : LB
enum (LB, IP)
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
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
PrivateLink Service Name
Example : ServiceName
string
service_ip_address
required
Service IP Address
Example : 192.167.0.5
string
state
required
PrivateLink Service State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string

47 - PrivateLinkServiceCreateRequest

NameDescriptionSchemaDefault
approval_type
required
PrivateLink Service Approval Type
Example : AUTO
enum (MANUAL, AUTO)
connected_resource_id
optional
Connected Resource ID
Example : a3e3a662a4f34442a94166df5ff9f577
string
connected_resource_ip_address
optional
Connected Resource IP Address
Example : 192.167.0.10
string
connected_resource_type
required
Connected Resource Type
Example : LB
enum (LB, IP)
description
optional
Description
Example : PrivateLink Service Description
Maximum length : 50
string
high_speed_transfer
optional
High Speed Data Transfer Use
Example : False
boolean
name
required
PrivateLink Service Name
Example : ServiceName
Pattern : ^[a-zA-Z0-9]([a-zA-Z0-9-])*$
Minimum length : 3
Maximum length : 20
string
security_group_ids
optional
Security Group List
Example : ['00b6af37-73b5-4de2-b080-c295a1a0382e']
array[string]
service_ip_address
required
Service IP Address
Example : 192.167.0.5
string
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
tags
optional
Tag List
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

48 - PrivateLinkServiceDetail

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approval_type
required
PrivateLink Service Approval Type
Example : AUTO
enum (MANUAL, AUTO)
connected_resource_id
optional
Connected Resource ID
Example : a3e3a662a4f34442a94166df5ff9f577
any of [string, null]
connected_resource_ip_address
required
Connected Resource IP Address
Example : 192.167.0.10
string
connected_resource_name
required
Connected Resource Name
Example : lbResourceName
string
connected_resource_type
required
Connected Resource Type
Example : LB
enum (LB, IP)
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 : PrivateLink Service Description
any of [string, null]
high_speed_transfer
required
High Speed Data Transfer Use
Example : False
boolean
id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
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
PrivateLink Service Name
Example : ServiceName
string
security_group_ids
optional
Security Group List
Example : ['00b6af37-73b5-4de2-b080-c295a1a0382e']
array[string]
service_ip_address
required
Service IP Address
Example : 192.167.0.5
string
service_ip_port_id
optional
Service IP Port ID
Example : d21a4b81-f52a-43a8-b985-341e763458bb
any of [string, null]
state
required
PrivateLink Service State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string

49 - PrivateLinkServiceListResponse

NameDescriptionSchemaDefault
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]

50 - PrivateLinkServiceSetRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : PrivateLink Service Description
Maximum length : 50
string

51 - PrivateLinkServiceShowResponse

NameDescriptionSchemaDefault
privatelink_service
required

PrivateLinkServiceDetail

52 - PrivateNat

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr
required
Private NAT IP range
Example : 192.167.0.0/24
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 : PrivateNat Description
any of [string, null]
direct_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
direct_connect_name
optional
Direct Connect Name
Example : DirectConnectName
any of [string, null]
id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
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 NAT Name
Example : PrivateNatName
string
state
required
Private NAT State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
optional
VPC Name
Example : vpcName
any of [string, null]

53 - PrivateNatCreateRequest

NameDescriptionSchemaDefault
cidr
required
Private NAT IP range
Example : 192.167.0.0/24
string
description
optional
Description
Example : PrivateNat Description
Maximum length : 50
string
direct_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
name
required
Private NAT Name
Example : PrivateNatName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
Tag List
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

54 - PrivateNatCreateRequestV1Dot2

NameDescriptionSchemaDefault
cidr
required
Private NAT IP range
Example : 192.167.0.0/24
string
description
optional
Description
Example : PrivateNat Description
Maximum length : 50
string
name
required
Private NAT Name
Example : PrivateNatName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
service_resource_id
required
Private NAT connected Service Resource ID
Example : 3f342bf9a557405b997c2cf48c89cbc2
string
service_type
required
Private NAT connected Service Type
Example : DIRECT_CONNECT
enum (DIRECT_CONNECT, TRANSIT_GATEWAY)
tags
optional
Tag List
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

55 - PrivateNatIp

NameDescriptionSchemaDefault
attached_resource_id
optional
Private NAT IP Attached Resource ID
Example :
any of [string, null]
attached_resource_name
optional
Private NAT IP Attached Resource Name
Example :
any of [string, null]
attached_resource_type
optional
Private NAT IP Attached Resource Type
Example : VM
any of [enum (VM, BM, ALB, GPU_SERVER), null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
Private NAT IP ID
Example :
string
ip_address
required
Private NAT IP Address
Example :
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
private_nat_id
required
Private NAT ID
Example :
string
state
required
Private NAT IP State
Example : RESERVED
enum (RESERVED, ATTACHED, DELETED)

56 - PrivateNatIpCreateRequest

NameDescriptionSchemaDefault
ip_address
required
Private NAT IP Address
Example :
Minimum length : 7
Maximum length : 15
string

57 - PrivateNatIpListResponse

NameDescriptionSchemaDefault
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]

58 - PrivateNatIpShowResponse

NameDescriptionSchemaDefault
private_nat_ip
required

PrivateNatIp

59 - PrivateNatListResponse

NameDescriptionSchemaDefault
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]

60 - PrivateNatListResponseV1Dot2

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
private_nats
required

array[PrivateNatV1Dot2]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

61 - PrivateNatSetRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : PrivateNat Description
Maximum length : 50
string

62 - PrivateNatShowResponse

NameDescriptionSchemaDefault
private_nat
required

PrivateNat

63 - PrivateNatShowResponseV1Dot2

NameDescriptionSchemaDefault
private_nat
required

PrivateNatV1Dot2

64 - PrivateNatV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr
required
Private NAT IP range
Example : 192.167.0.0/24
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 : PrivateNat Description
any of [string, null]
id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
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 NAT Name
Example : PrivateNatName
string
service_resource_id
required
Private NAT connected Service Resource ID
Example : 3f342bf9a557405b997c2cf48c89cbc2
string
service_resource_name
required
Private NAT connected Service Resource Name
Example : PrivateNatName
string
service_type
required
Private NAT connected Service Type
Example : DIRECT_CONNECT
enum (DIRECT_CONNECT, TRANSIT_GATEWAY)
state
required
Private NAT State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)

65 - Publicip

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
attached_resource_id
optional
PublicIP Attached Resource ID
Example : 37e6db41f5124184a43251a63124cdc9
any of [string, null]
attached_resource_name
optional
PublicIP Attached Resource Name
Example : Attached NAT Gateway Name
any of [string, null]
attached_resource_type
optional
PublicIP Attached Resource Type
Example : NAT_GW
any of [enum (VM, ALB, LB, BM, DB, NAT_GW, GPU_NODE, VPN, GPU_SERVER, EPAS, POSTGRESQL, MARIADB, SQLSERVER, CACHESTORE, SCALABLEDB, EVENTSTREAMS, SEARCHENGINE, VERTICA, SUBNET, MYSQL), null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
PublicIP Description
Example : Public IP Description
any of [string, null]
id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
string
ip_address
required
IP Address
Example : 192.167.0.5
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
PublicIP State
Example : ATTACHED
enum (RESERVED, ATTACHED, DELETED)
type
required
PublicIP Type
Example : IGW
enum (IGW, GGW, SIGW)

66 - PublicipCreateRequest

NameDescriptionSchemaDefault
description
optional
PublicIP Description
Example : Public IP Description
any of [string, null]
tags
optional
Tag List
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]
type
required
PublicIP Type
Example : IGW
enum (IGW, GGW, SIGW)

67 - PublicipCreateRequestV1Dot3

NameDescriptionSchemaDefault
description
optional
PublicIP Description
Example : Public IP Description
any of [string, null]
tags
optional
Tag List
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]
type
required
PublicIP Type
Example : IGW
enum (IGW, GGW, SIGW)
zone
required
Zone
Example : kr-west1-a
string

68 - PublicipListResponse

NameDescriptionSchemaDefault
count
optional
total count
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]

69 - PublicipListResponseV1Dot2

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
publicips
required

array[Publicip]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

70 - PublicipListResponseV1Dot3

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
publicips
required

array[PublicipV1Dot3]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

71 - PublicipSetRequest

NameDescriptionSchemaDefault
description
required
PublicIP Description
Example : Public IP Description
Maximum length : 50
string

72 - PublicipSetResponse

NameDescriptionSchemaDefault
description
optional
PublicIP Description
Example : Public IP Description
any of [string, null]

73 - PublicipShowResponse

NameDescriptionSchemaDefault
publicip
required

Publicip

74 - PublicipShowResponseV1Dot3

NameDescriptionSchemaDefault
publicip
required

PublicipV1Dot3

75 - PublicipV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
attached_resource_id
optional
PublicIP Attached Resource ID
Example : 37e6db41f5124184a43251a63124cdc9
any of [string, null]
attached_resource_name
optional
PublicIP Attached Resource Name
Example : Attached NAT Gateway Name
any of [string, null]
attached_resource_type
optional
PublicIP Attached Resource Type
Example : NAT_GW
any of [enum (VM, ALB, LB, BM, DB, NAT_GW, GPU_NODE, VPN, GPU_SERVER, EPAS, POSTGRESQL, MARIADB, SQLSERVER, CACHESTORE, SCALABLEDB, EVENTSTREAMS, SEARCHENGINE, VERTICA, SUBNET, MYSQL), null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
PublicIP Description
Example : Public IP Description
any of [string, null]
id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
string
ip_address
required
IP Address
Example : 192.167.0.5
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
PublicIP State
Example : ATTACHED
enum (RESERVED, ATTACHED, DELETED)
type
required
PublicIP Type
Example : IGW
enum (IGW, GGW, SIGW)
zone
required
Zone
Example : kr-west1-a
string

76 - SapSecondarySubnet

NameDescriptionSchemaDefault
account_id
required
Account ID
Example :
string
cidr
required
CIDR
Example :
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
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

77 - SapSecondarySubnetListResponse

NameDescriptionSchemaDefault
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]

78 - StaticNatSummary

NameDescriptionSchemaDefault
external_ip_address
required
Static Nat External Ip Address
Example : 100.112.9.84
string
id
required
Static Nat Id
Example : 0009e49548154745948e9722adefbf40
string
publicip_id
required
Publicip ID
Example : 12f56e27070248a6a240a497e43fbe18
string
state
required
Static Nat State
Example : ACTIVE
string

79 - Subnet

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
gateway_ip_address
required
Gateway IP Address
Example : 192.167.1.1
any of [string, null]
id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
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
Subnet Name
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Subnet Type
Example : GENERAL
enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string

80 - SubnetCreateRequest

NameDescriptionSchemaDefault
allocation_pools
optional
Allocation Pools
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
Description
Example : Subnet Description
any of [string, null]
dns_nameservers
optional
DNS Name Servers
Example : ["1.1.1.1", "2.2.2.2"]
array[string]
host_routes
optional
Host Routes
Example : [{"destination":"192.168.10.0/24", "nexthop":"192.168.10.0"}]
array[object]
name
required
Subnet Name
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
Tag List
array[Tag]
type
required
Subnet Type
Example : GENERAL
enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string

81 - SubnetCreateRequestV1Dot2

NameDescriptionSchemaDefault
allocation_pools
optional
Allocation Pools
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
Description
Example : Subnet Description
any of [string, null]
dns_nameservers
optional
DNS Name Servers
Example : ["1.1.1.1", "2.2.2.2"]
array[string]
gateway_ip_address
optional
Gateway IP Address
Example : 192.167.1.1
any of [string, null]
host_routes
optional
Host Routes
Example : [{"destination":"192.168.10.0/24", "nexthop":"192.168.10.0"}]
array[object]
name
required
Subnet Name
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
Tag List
array[Tag]
type
required
Subnet Type
Example : GENERAL
enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string

82 - SubnetCreateRequestV1Dot3

NameDescriptionSchemaDefault
allocation_pools
optional
Allocation Pools
Example : [{"start":"192.167.1.2", "end":"192.167.1.100"}]
array[object]
category
required
Subnet Category
Example : PRIMARY
enum (PRIMARY, SECONDARY)
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
description
optional
Description
Example : Subnet Description
any of [string, null]
dns_nameservers
optional
DNS Name Servers
Example : ["1.1.1.1", "2.2.2.2"]
array[string]
gateway_ip_address
optional
Gateway IP Address
Example : 192.167.1.1
any of [string, null]
host_routes
optional
Host Routes
Example : [{"destination":"192.168.10.0/24", "nexthop":"192.168.10.0"}]
array[object]
name
required
Subnet Name
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
primary_subnet_id
optional
Primary Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]
tags
optional
Tag List
array[Tag]
type
required
Subnet Type
Example : PUBLIC
enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string

83 - SubnetDetail

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
allocation_pools
optional
Allocation Pools
array[object]
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
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 : Subnet Description
any of [string, null]
dns_nameservers
optional
DNS Name Servers
array[string]
gateway_ip_address
required
Gateway IP Address
Example : 192.167.1.1
any of [string, null]
host_routes
optional
Host Routes
array[object]
id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
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
Subnet Name
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Subnet Type
Example : GENERAL
enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string

84 - SubnetDetailV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
allocation_pools
optional
Allocation Pools
array[object]
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
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 : Subnet Description
any of [string, null]
dhcp_ip_address
optional
DHCP IP Address
Example :
any of [string, null]
dns_nameservers
optional
DNS Name Servers
array[string]
gateway_ip_address
required
Gateway IP Address
Example : 192.167.1.1
any of [string, null]
host_routes
optional
Host Routes
array[object]
id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
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
Subnet Name
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Subnet Type
Example : GENERAL
enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string

85 - SubnetDetailV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
allocation_pools
optional
Allocation Pools
array[object]
category
required
Subnet Category
Example : PRIMARY
string
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
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 : Subnet Description
any of [string, null]
dhcp_ip_address
optional
DHCP IP Address
Example :
any of [string, null]
dns_nameservers
optional
DNS Name Servers
array[string]
gateway_ip_address
required
Gateway IP Address
Example : 192.167.1.1
any of [string, null]
host_routes
optional
Host Routes
array[object]
id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
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
Subnet Name
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
primary_subnet_id
optional
Primary Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]
secondary_subnet_ids
optional
Secondary Subnet ID List
Example : ["522e102f680448a8804d18d4838baa78", "aec40baf53c243c1bb8401a703a2c888"]
any of [array[object], null]
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Subnet Type
Example : PUBLIC
enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string
zones
optional
Subnet Zone List
Example : ["kr-west1-a", "kr-west1-b", "kr-west1-c"]
array[string]

86 - SubnetListResponse

NameDescriptionSchemaDefault
count
optional
total count
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]

87 - SubnetListResponseV1Dot2

NameDescriptionSchemaDefault
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]
subnets
required

array[Subnet]

88 - SubnetListResponseV1Dot3

NameDescriptionSchemaDefault
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]
subnets
required

array[SubnetV1Dot3]

89 - SubnetSetRequest

NameDescriptionSchemaDefault
description
required
Description
Example : Subnet Description
Maximum length : 50
string

90 - SubnetSetRequestV1Dot2

NameDescriptionSchemaDefault
description
optional
Description
Example : Subnet Description
any of [string, null]
dhcp_ip_address
optional
DHCP IP Address
Example : 192.167.1.2
any of [string, null]

91 - SubnetSetResponse

NameDescriptionSchemaDefault
description
optional
Description
Example : Subnet Description
any of [string, null]
dhcp_ip_address
optional
DHCP IP Address
Example : 192.167.1.2
any of [string, null]

92 - SubnetShowResponse

NameDescriptionSchemaDefault
subnet
required

SubnetDetail

93 - SubnetShowResponseV1Dot2

NameDescriptionSchemaDefault
subnet
required

SubnetDetailV1Dot2

94 - SubnetShowResponseV1Dot3

NameDescriptionSchemaDefault
subnet
required

SubnetDetailV1Dot3

95 - SubnetV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
category
required
Subnet Category
Example : PRIMARY
string
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
gateway_ip_address
required
Gateway IP Address
Example : 192.167.1.1
any of [string, null]
id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
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
Subnet Name
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
primary_subnet_id
optional
Primary Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Subnet Type
Example : PUBLIC
enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string
zones
optional
Subnet Zone List
Example : ["kr-west1-a", "kr-west1-b", "kr-west1-c"]
array[string]

96 - SubnetVipDetail

NameDescriptionSchemaDefault
connected_ports
required

array[ConnectedPortInfo]
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 : Subnet VIP Description
any of [string, null]
id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
static_nat
optional
Static NAT Info
any of [StaticNatSummary, null]
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
vip_port_id
required
Vip Port Id
Example : 35268a9f2eda4cde83b1d85c1f61f67d
string
virtual_ip_address
required
Virtual IP Address
Example : 192.168.20.6
string

97 - SubnetVipSummary

NameDescriptionSchemaDefault
connected_port_count
optional
Connected Port Count
Example : 2
integer
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
static_nat
optional
Static NAT Info
any of [StaticNatSummary, null]
virtual_ip_address
required
Virtual IP Address
Example : 192.168.20.6
string

98 - Tag

NameDescriptionSchemaDefault
key
required
tag key
Example :
string
value
required
tag value
Example :
string

99 - TransitGateway

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
bandwidth
optional
Transit Gateway Port Bandwidth
Example : 1
any of [integer, null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
Transit Gateway Description
Example : TransitGateway Description
any of [string, null]
firewall_ids
optional
Firewall IDs
Example : bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
any of [string, null]
id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
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
Transit Gateway Name
Example : TransitGatewayName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)
uplink_enabled
optional
Uplink Enabled
Example : False
boolean

100 - TransitGatewayCreateRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : TransitGateway Description
any of [string, null]
name
required
Transit Gateway Name
Example : TransitGatewayName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
Tag List
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

101 - TransitGatewayFirewallConnectionCreateResponse

NameDescriptionSchemaDefault
firewall_connection_state
optional
Firewall Connection State
Example : INACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null]

102 - TransitGatewayFirewallCreateRequest

NameDescriptionSchemaDefault
product_type
required
Fw Product Type
Example : TGW_DGW
enum (TGW_IGW, TGW_GGW, TGW_DGW, TGW_BM)

103 - TransitGatewayFirewallCreateRequestV1Dot3

NameDescriptionSchemaDefault
product_type
required
Fw Product Type
Example : TGW_DGW
enum (TGW_IGW, TGW_GGW, TGW_DGW, TGW_BM)
uplink_active_zone
optional
Uplink Active Zone
Example : kr-west1-a
any of [string, null]
uplink_standby_zone
optional
Uplink Standby Zone
Example : kr-west1-b
any of [string, null]

104 - TransitGatewayFirewallCreateResponseV1Dot3

NameDescriptionSchemaDefault
state
optional
State
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]
uplink_active_zone
optional
Uplink Active Zone
Example : kr-west1-a
any of [string, null]
uplink_standby_zone
optional
Uplink Standby Zone
Example : kr-west1-b
any of [string, null]
uplink_zone_state
optional
Uplink Zone Connect state
Example : ACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR, EDITING), null]

105 - TransitGatewayFirewallDeleteResponse

NameDescriptionSchemaDefault
state
optional
State
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]
uplink_active_zone
optional
Uplink Active Zone
Example : kr-west1-a
any of [string, null]
uplink_standby_zone
optional
Uplink Standby Zone
Example : kr-west1-b
any of [string, null]
uplink_zone_state
optional
Uplink Zone Connect state
Example : ACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR, EDITING), null]

106 - TransitGatewayListResponse

NameDescriptionSchemaDefault
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]

107 - TransitGatewayListResponseV1Dot2

NameDescriptionSchemaDefault
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[TransitGatewayV1Dot2]

108 - TransitGatewayRule

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
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 : Routing Rule Description
string
destination_cidr
required
Destination CIDR
Example : 192.167.5.0/24
string
destination_resource_id
required
Destination Resource ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
any of [string, null]
destination_resource_name
optional
Destination Resource Name
Example : VpcName
any of [string, null]
destination_type
required
Destination Type
Example : VPC
enum (VPC, TGW, ON_PREMISE)
id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
source_resource_id
required
Source Resource ID
Example : 8582cc5d89994a42ad53282fd4a8d8be
any of [string, null]
source_resource_name
optional
Source Resource Name
Example : TgwName
any of [string, null]
source_type
required
Source Type
Example : TGW
enum (VPC, TGW, ON_PREMISE)
state
required
State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id
required
VPC ID Connected to Transit Gateway.
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]
tgw_connection_vpc_name
optional
VPC Name Connected to Transit Gateway.
Example : ConnectedVpcName
any of [string, null]

109 - TransitGatewayRuleCreateRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : Routing Rule Description
Maximum length : 50
string
destination_cidr
required
Destination CIDR
Example : 192.167.5.0/24
string
destination_type
required
Destination Type
Example : VPC
enum (VPC, TGW)
tgw_connection_vpc_id
required
VPC ID Connected to Transit Gateway.
Example : ffeced8e191c478eabd66b6e2cab8e34
string

110 - TransitGatewayRuleListResponse

NameDescriptionSchemaDefault
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]

111 - TransitGatewayRuleListResponseV1Dot2

NameDescriptionSchemaDefault
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[TransitGatewayRuleV1Dot2]

112 - TransitGatewayRuleShowResponse

NameDescriptionSchemaDefault
transit_gateway_rule
required

TransitGatewayVpcRule

113 - TransitGatewayRuleV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
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 : Routing Rule Description
string
destination_cidr
required
Destination CIDR
Example : 192.167.5.0/24
string
destination_resource_id
required
Destination Resource ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
any of [string, null]
destination_resource_name
optional
Destination Resource Name
Example : VpcName
any of [string, null]
destination_type
required
Destination Type
Example : VPC
enum (VPC, TGW, ON_PREMISE)
id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
rule_type
required
Rule Type
Example : TGW_VPC
enum (TGW_VPC, TGW_UPLINK)
source_resource_id
required
Source Resource ID
Example : 8582cc5d89994a42ad53282fd4a8d8be
any of [string, null]
source_resource_name
optional
Source Resource Name
Example : TgwName
any of [string, null]
source_type
required
Source Type
Example : TGW
enum (VPC, TGW, ON_PREMISE)
state
required
State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id
required
VPC ID Connected to Transit Gateway.
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]
tgw_connection_vpc_name
optional
VPC Name Connected to Transit Gateway.
Example : ConnectedVpcName
any of [string, null]

114 - TransitGatewaySetRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : TransitGateway Description
Maximum length : 50
string

115 - TransitGatewaySetResponse

NameDescriptionSchemaDefault
description
optional
Description
Example : TransitGateway Description
any of [string, null]

116 - TransitGatewayShowResponse

NameDescriptionSchemaDefault
transit_gateway
required

TransitGateway

117 - TransitGatewayShowResponseV1Dot2

NameDescriptionSchemaDefault
transit_gateway
required

TransitGatewayV1Dot2

118 - TransitGatewayShowResponseV1Dot3

NameDescriptionSchemaDefault
transit_gateway
required

TransitGatewayV1Dot3

119 - TransitGatewayUplinkRule

NameDescriptionSchemaDefault
description
required
Description
Example : Routing Rule Description
string
destination_cidr
required
Destination CIDR
Example : 192.167.5.0/24
string
destination_type
required
Destination Type
Example : ON_PREMISE
enum (TGW, ON_PREMISE)
id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
string
state
required
State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)

120 - TransitGatewayUplinkRuleCreateRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : Routing Rule Description
Maximum length : 50
string
destination_cidr
required
Destination CIDR
Example : 192.167.5.0/24
string
destination_type
required
Destination Type
Example : ON_PREMISE
enum (TGW, ON_PREMISE)

121 - TransitGatewayUplinkRuleCreateResponse

NameDescriptionSchemaDefault
transit_gateway_rule
required

TransitGatewayUplinkRule

122 - TransitGatewayV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
bandwidth
optional
Transit Gateway Port Bandwidth
Example : 1
any of [integer, null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
Transit Gateway Description
Example : TransitGateway Description
any of [string, null]
firewall_connection_state
optional
Firewall Connection State
Example : INACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null]
firewall_ids
optional
Firewall IDs
Example : bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
any of [string, null]
id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
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
Transit Gateway Name
Example : TransitGatewayName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)
uplink_enabled
optional
Uplink Enabled
Example : False
boolean

123 - TransitGatewayV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
bandwidth
optional
Transit Gateway Port Bandwidth
Example : 1
any of [integer, null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
Transit Gateway Description
Example : TransitGateway Description
any of [string, null]
firewall_connection_state
optional
Firewall Connection State
Example : INACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null]
firewall_ids
optional
Firewall IDs
Example : bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
any of [string, null]
id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
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
Transit Gateway Name
Example : TransitGatewayName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)
uplink_active_zone
optional
Uplink Active Zone
Example : kr-west1-a
any of [string, null]
uplink_enabled
optional
Uplink Enabled
Example : False
boolean
uplink_standby_zone
optional
Uplink Standby Zone
Example : kr-west1-b
any of [string, null]
uplink_zone_state
optional
Uplink Zone Connect state
Example : ACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR, EDITING), null]

124 - TransitGatewayVpcConnection

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
Transit Gateway VPC Connection ID
Example : ffeced8e191c478eabd66b6e2cab8e34
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
transit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string

125 - TransitGatewayVpcConnectionCreateRequest

NameDescriptionSchemaDefault
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string

126 - TransitGatewayVpcConnectionListResponse

NameDescriptionSchemaDefault
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]

127 - TransitGatewayVpcConnectionShowResponse

NameDescriptionSchemaDefault
transit_gateway_vpc_connection
required

TransitGatewayVpcConnection

128 - TransitGatewayVpcRule

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
description
required
Description
Example : Routing Rule Description
string
destination_cidr
required
Destination CIDR
Example : 192.167.5.0/24
string
destination_resource_id
required
Destination Resource ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
any of [string, null]
destination_resource_name
optional
Destination Resource Name
Example : VpcName
any of [string, null]
destination_type
required
Destination Type
Example : VPC
enum (VPC, TGW)
id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
string
source_resource_id
required
Source Resource ID
Example : 8582cc5d89994a42ad53282fd4a8d8be
any of [string, null]
source_resource_name
optional
Source Resource Name
Example : TgwName
any of [string, null]
source_type
required
Source Type
Example : TGW
enum (VPC, TGW)
state
required
State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id
required
VPC ID Connected to Transit Gateway.
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]
tgw_connection_vpc_name
optional
VPC Name Connected to Transit Gateway.
Example : ConnectedVpcName
any of [string, null]

129 - VipCreateRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : Subnet VIP Description
any of [string, null]
virtual_ip_address
optional
Virtual IP Address
Example : 192.168.20.6
any of [string, null]

130 - VipCreateResponse

NameDescriptionSchemaDefault
subnet_vip
required

SubnetVipDetail

131 - VipListResponse

NameDescriptionSchemaDefault
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]
subnet_vips
required

array[SubnetVipSummary]

132 - VipNatCreateRequest

NameDescriptionSchemaDefault
nat_type
required
NAT Type
Example : PUBLIC
string
publicip_id
required
Publicip ID
Example : 12f56e27070248a6a240a497e43fbe18
string

133 - VipNatCreateResponse

NameDescriptionSchemaDefault
id
required
Static Nat Id
Example : 0009e49548154745948e9722adefbf40
string
publicip_id
required
Publicip ID
Example : 12f56e27070248a6a240a497e43fbe18
string
state
required
Static Nat State
Example : ACTIVE
string

134 - VipPortRequest

NameDescriptionSchemaDefault
port_id
required
Port ID
Example : 35268a9f2eda4cde83b1d85c1f61f67d
string

135 - VipPortResponse

NameDescriptionSchemaDefault
id
required
Connected Port Id
Example : 35268a9f2eda4cde83b1d85c1f61f67d
string
subnet_vip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
string

136 - VipSetRequest

NameDescriptionSchemaDefault
description
required
Description
Example : Subnet VIP Description
Maximum length : 50
string

137 - VipShowResponse

NameDescriptionSchemaDefault
subnet_vip
required

SubnetVipDetail

138 - Vpc

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr
required
VPC Cidr
Example : 192.167.0.0/18
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 : vpcDescription
any of [string, null]
id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
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
VPC Name
Example : vpcName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETED, ERROR)

139 - VpcCidr

NameDescriptionSchemaDefault
cidr
required
VPC Cidr
Example : 192.167.0.0/18
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 7df8abb4912e4709b1cb237daccca7a8
string
id
required
Cidr ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

140 - VpcCidrCreateRequest

NameDescriptionSchemaDefault
cidr
required
VPC Cidr
Example : 192.167.0.0/18
string

141 - VpcCidrCreateResponse

NameDescriptionSchemaDefault
cidr
optional
VPC Cidr
Example : 192.167.0.0/18
any of [string, null]

142 - VpcCreateRequest

NameDescriptionSchemaDefault
cidr
required
VPC Cidr
Example : 192.167.0.0/18
string
description
optional
Description
Example : VPC Description
any of [string, null]
name
required
VPC Name
Example : vpcName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
Tag List
array[Tag]

143 - VpcEndpoint

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
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 : VpcEndpoint Description
any of [string, null]
endpoint_ip_address
required
VPC Endpoint IP Address
Example : 192.167.0.5
string
id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
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
VPC Endpoint Name
Example : VpcEndpointName
string
resource_info
required
VPC Endpoint Resource Key Info
Example : x.samsungsdscloud.com(Registry)
string
resource_key
required
VPC Endpoint Resource Key
Example : 07c5364702384471b650147321b52173
string
resource_type
required
VPC Endpoint Resource Type
Example : FS
enum (FS, OBS, SCR, DNS)
state
required
VPC Endpoint State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet Name
Example : subnetName
string
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC Name
Example : vpcName
string

144 - VpcEndpointConnectableResourceDetail

NameDescriptionSchemaDefault
resource_info
required
VPC Endpoint Resource Key Info
Example : x.samsungsdscloud.com(Registry)
string
resource_key
required
VPC Endpoint Resource Key
Example : 07c5364702384471b650147321b52173
string
resource_type
required
VPC Endpoint Resource Type
Example : FS
enum (FS, OBS, SCR, DNS)

145 - VpcEndpointConnectableResourceListResponse

NameDescriptionSchemaDefault
count
optional
total count
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]

146 - VpcEndpointConnectableResourceListResponseV1Dot2

NameDescriptionSchemaDefault
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_endpoint_connectable_resources
required

array[VpcEndpointConnectableResourceDetail]

147 - VpcEndpointCreateRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : VpcEndpoint Description
Maximum length : 50
string
endpoint_ip_address
required
VPC Endpoint IP Address
Example : 192.167.0.5
string
name
required
VPC Endpoint Name
Example : VpcEndpointName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
resource_info
required
VPC Endpoint Resource Key Info
Example : x.samsungsdscloud.com(Registry)
Maximum length : 200
string
resource_key
required
VPC Endpoint Resource Key
Example : 07c5364702384471b650147321b52173
string
resource_type
required
VPC Endpoint Resource Type
Example : FS
enum (FS, OBS, SCR, DNS)
subnet_id
required
Subnet Id
Example : 023c57b14f11483689338d085e061492
string
tags
optional
Tag List
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]
vpc_id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
string

148 - VpcEndpointListResponse

NameDescriptionSchemaDefault
count
optional
total count
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]

149 - VpcEndpointListResponseV1Dot2

NameDescriptionSchemaDefault
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_endpoints
required

array[VpcEndpoint]

150 - VpcEndpointSetRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : VpcEndpoint Description
Maximum length : 50
string

151 - VpcEndpointShowResponse

NameDescriptionSchemaDefault
vpc_endpoint
required

VpcEndpoint

152 - VpcListResponse

NameDescriptionSchemaDefault
count
optional
total count
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]

153 - VpcListResponseV1Dot2

NameDescriptionSchemaDefault
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]
vpcs
required

array[VpcV1Dot2]

154 - VpcListResponseV1Dot3

NameDescriptionSchemaDefault
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]
vpcs
required

array[VpcV1Dot3]

155 - VpcPeering

NameDescriptionSchemaDefault
account_type
required
Account Type
Example : SAME
enum (SAME, DIFFERENT)
approver_vpc_account_id
required
Approver VPC Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approver_vpc_id
required
Approver VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
approver_vpc_name
required
Approver VPC Name
Example : vpcName
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
delete_requester_account_id
optional
Requester VPC Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
any of [string, null]
description
optional
VPC Peering Description
Example : vpcPeering Description
any of [string, null]
id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
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
VPC Peering Name
Example : vpcPeeringName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
requester_vpc_account_id
required
Requester VPC Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
requester_vpc_id
required
Requester VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
requester_vpc_name
required
Requester VPC Name
Example : vpcName
string
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING)

156 - VpcPeeringApprovalRequest

NameDescriptionSchemaDefault
type
required
Approval Type
Example : CREATE_APPROVE
enum (CREATE_APPROVE, CREATE_CANCEL, CREATE_REJECT, CREATE_RE_REQUEST, DELETE_APPROVE, DELETE_CANCEL, DELETE_REJECT)

157 - VpcPeeringCreateRequest

NameDescriptionSchemaDefault
approver_vpc_account_id
required
Approver VPC Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approver_vpc_id
required
Approver VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
description
optional
Description
Example : vpcPeering Description
any of [string, null]
name
required
VPC Peering Name
Example : vpcPeeringName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
requester_vpc_id
required
Requester VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
tags
optional
Tag List
array[Tag]

158 - VpcPeeringListResponse

NameDescriptionSchemaDefault
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]

159 - VpcPeeringRule

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
destination_cidr
required
Destination CIDR
Example :
string
destination_vpc_id
required
Destination VPC ID
Example :
string
destination_vpc_name
required
Destination VPC Name
Example :
string
destination_vpc_type
required
Destination VPC Type
Example : REQUESTER_VPC
enum (REQUESTER_VPC, APPROVER_VPC)
id
required
VPC Peering Rule 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
source_vpc_id
required
Source VPC ID
Example :
string
source_vpc_name
required
Source VPC Name
Example :
string
source_vpc_type
required
Source VPC Type
Example : REQUESTER_VPC
enum (REQUESTER_VPC, APPROVER_VPC)
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
vpc_peering_id
required
VPC Peering ID
Example :
string

160 - VpcPeeringRuleCreateRequest

NameDescriptionSchemaDefault
destination_cidr
required
Destination CIDR
Example :
string
destination_vpc_type
required
Destination VPC Type
Example : REQUESTER_VPC
enum (REQUESTER_VPC, APPROVER_VPC)
tags
optional
Tag List
array[Tag]

161 - VpcPeeringRuleListResponse

NameDescriptionSchemaDefault
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]

162 - VpcPeeringRuleShowResponse

NameDescriptionSchemaDefault
vpc_peering_rule
required

VpcPeeringRule

163 - VpcPeeringSetRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : vpcPeering Description
Maximum length : 50
string

164 - VpcPeeringShowResponse

NameDescriptionSchemaDefault
vpc_peering
required

VpcPeering

165 - VpcSetRequest

NameDescriptionSchemaDefault
description
optional
Description
Example : vpcDescription
any of [string, null]

166 - VpcSetResponse

NameDescriptionSchemaDefault
description
optional
Description
Example : vpcDescription
any of [string, null]

167 - VpcShowResponse

NameDescriptionSchemaDefault
vpc
required

Vpc

168 - VpcShowResponseV1Dot2

NameDescriptionSchemaDefault
vpc
required

VpcV1Dot2

169 - VpcShowResponseV1Dot3

NameDescriptionSchemaDefault
vpc
required

VpcV1Dot3

170 - VpcV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr_count
required
Cidr Count
Example : 20
integer
cidrs
required

array[VpcCidr]
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 : vpcDescription
any of [string, null]
id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
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
VPC Name
Example : vpcName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETED, ERROR)

171 - VpcV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr_count
required
Cidr Count
Example : 20
integer
cidrs
required

array[VpcCidr]
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 : vpcDescription
any of [string, null]
id
required
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
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
VPC Name
Example : vpcName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
State
Example : CREATING
enum (CREATING, ACTIVE, DELETED, ERROR)
zone_type
optional
Vpc Zone Type Information
Example : PUBLIC
any of [string, null]
zones
required
Vpc Zones Information
Example : ['zone-a', 'zone-b', 'zone-c']
array[string]