This is the multi-page printable view of this section. Click here to print.
Networking
- 1: Cloud Secured SD-LAN
- 2: Direct Connect
- 2.1: APIs
- 2.1.1: Create Direct Connect
- 2.1.2: Create Routing Rule
- 2.1.3: Delete Direct Connect
- 2.1.4: Delete Routing Rule
- 2.1.5: List Direct Connects
- 2.1.6: List Routing Rules
- 2.1.7: Set Direct Connect
- 2.1.8: Show Direct Connect
- 2.2: Models
- 2.2.1: DirectConnect
- 2.2.2: DirectConnectCreateRequest
- 2.2.3: DirectConnectCreateRequestV1Dot2
- 2.2.4: DirectConnectListResponse
- 2.2.5: DirectConnectListResponseV1Dot1
- 2.2.6: DirectConnectSetRequest
- 2.2.7: DirectConnectSetResponse
- 2.2.8: DirectConnectShowResponse
- 2.2.9: DirectConnectShowResponseV1Dot2
- 2.2.10: DirectConnectV1Dot2
- 2.2.11: RoutingRule
- 2.2.12: RoutingRuleCreateRequest
- 2.2.13: RoutingRuleListResponse
- 2.2.14: RoutingRuleListResponseV1Dot1
- 2.2.15: RoutingRuleShowResponse
- 2.2.16: Tag
- 3: DNS
- 3.1: APIs
- 3.1.1: Activate Private DNS
- 3.1.1.1: 1.3
- 3.1.2: Create Hosted Zone
- 3.1.2.1: 1.3
- 3.1.3: Create Hosted Zone Record
- 3.1.3.1: 1.3
- 3.1.4: Create Private DNS
- 3.1.4.1: 1.3
- 3.1.5: Create Public Domain Name
- 3.1.5.1: 1.3
- 3.1.6: Delete Hosted Zone
- 3.1.6.1: 1.3
- 3.1.7: Delete Hosted Zone Record
- 3.1.7.1: 1.3
- 3.1.8: Delete Private DNS
- 3.1.8.1: 1.3
- 3.1.9: List Hosted Zone Records
- 3.1.9.1: 1.3
- 3.1.10: List Hosted Zones
- 3.1.10.1: 1.3
- 3.1.11: List Private DNS
- 3.1.11.1: 1.3
- 3.1.12: List Public Domain Names
- 3.1.12.1: 1.3
- 3.1.13: Set Hosted Zone
- 3.1.13.1: 1.3
- 3.1.14: Set Hosted Zone Record
- 3.1.14.1: 1.3
- 3.1.15: Set Private DNS
- 3.1.15.1: 1.3
- 3.1.16: Set Public Domain Name
- 3.1.16.1: 1.3
- 3.1.17: Set Public Domain Name Whois Info
- 3.1.17.1: 1.3
- 3.1.18: Show Hosted Zone
- 3.1.18.1: 1.3
- 3.1.19: Show Hosted Zone Record
- 3.1.19.1: 1.3
- 3.1.20: Show Private DNS
- 3.1.20.1: 1.3
- 3.1.21: Show Public Domain Name
- 3.1.21.1: 1.3
- 3.1.22: Transfer Public Domain Name
- 3.1.22.1: 1.3
- 3.2: Models
- 3.2.1: CreatePublicDomainRequest
- 3.2.2: CreatePublicDomainResponse
- 3.2.3: HostedZoneCreateRequestV1Dot3
- 3.2.4: HostedZoneListResponseV1Dot3
- 3.2.5: HostedZoneSetRequestV1Dot3
- 3.2.6: HostedZoneShowResponseV1Dot3
- 3.2.7: HostedZoneV1Dot3
- 3.2.8: PrivateDns
- 3.2.9: PrivateDnsActivateRequest
- 3.2.10: PrivateDnsCreateRequest
- 3.2.11: PrivateDnsListResponse
- 3.2.12: PrivateDnsSetRequest
- 3.2.13: PrivateDnsShowResponse
- 3.2.14: PubblicDomainWhoisInfoUpdateRequest
- 3.2.15: PublicDomainDetail
- 3.2.16: PublicDomainDetailResponse
- 3.2.17: PublicDomainListItem
- 3.2.18: PublicDomainListResponse
- 3.2.19: PublicDomainPartialUpdateRequest
- 3.2.20: PublicDomainPartialUpdateResponse
- 3.2.21: PublicDomainTransferRequest
- 3.2.22: PublicDomainTransferResponse
- 3.2.23: PublicDomainWhoisInfoUpdateResponse
- 3.2.24: Record
- 3.2.25: RecordCreateRequest
- 3.2.26: RecordCreateResponse
- 3.2.27: RecordListResponse
- 3.2.28: RecordSetRequest
- 3.2.29: RecordSetResponse
- 3.2.30: RecordShowResponse
- 3.2.31: Tag
- 4: Firewall
- 4.1: APIs
- 4.1.1: Create Firewall Rule
- 4.1.2: Delete Firewall Rule
- 4.1.3: List Firewall Rules
- 4.1.4: List Firewalls
- 4.1.5: Set Firewall
- 4.1.6: Set Firewall Rule
- 4.1.7: Show Firewall
- 4.1.8: Show Firewall Rule
- 4.2: Models
- 4.2.1: Firewall
- 4.2.2: FirewallListResponse
- 4.2.3: FirewallListResponseV1Dot1
- 4.2.4: FirewallPort
- 4.2.5: FirewallRule
- 4.2.6: FirewallRuleCreateRequest
- 4.2.7: FirewallRuleCreateSingleRequest
- 4.2.8: FirewallRuleListResponse
- 4.2.9: FirewallRuleListResponseV1Dot1
- 4.2.10: FirewallRuleSetRequest
- 4.2.11: FirewallRuleShowResponse
- 4.2.12: FirewallRuleShowResponseV1Dot1
- 4.2.13: FirewallRuleUpdateSingleRequest
- 4.2.14: FirewallRuleV1Dot1
- 4.2.15: FirewallSetRequest
- 4.2.16: FirewallShowResponse
- 4.2.17: FirewallShowResponseV1Dot1
- 4.2.18: FirewallV1Dot1
- 4.2.19: ZoneResource
- 5: Global CDN
- 5.1: APIs
- 5.1.1: Create Cdn Service
- 5.1.1.1: 1.0
- 5.1.2: Delete Cdn Service
- 5.1.2.1: 1.0
- 5.1.3: Detail Cdn Service
- 5.1.3.1: 1.0
- 5.1.4: List Cdn Service
- 5.1.4.1: 1.0
- 5.1.5: Purge Cdn Service
- 5.1.5.1: 1.0
- 5.1.6: Start Cdn Service
- 5.1.6.1: 1.0
- 5.1.7: Stop Cdn Service
- 5.1.7.1: 1.0
- 5.1.8: Update Cdn Service
- 5.1.8.1: 1.0
- 5.1.9: Update Description of Cdn Service
- 5.1.9.1: 1.0
- 5.2: Models
- 5.2.1: CdnServiceCreateRequest
- 5.2.2: CdnServiceDetail
- 5.2.3: CdnServiceDetailResponse
- 5.2.4: CdnServiceListResponse
- 5.2.5: CdnServiceModifyDescriptionRequest
- 5.2.6: CdnServicePurgeRequest
- 5.2.7: CdnServiceResponse
- 5.2.8: CdnServiceResponseResult
- 5.2.9: CdnServiceResult
- 5.2.10: CdnServiceUpdateRequest
- 5.2.11: Tag
- 6: GSLB
- 6.1: APIs
- 6.1.1: CreateGslb
- 6.1.2: DeleteGslb
- 6.1.3: ListGslbResources
- 6.1.4: ListGslbs
- 6.1.5: ListGslbsRegionalRoutingControl
- 6.1.5.1: 1.1
- 6.1.6: SetGslb
- 6.1.7: SetGslbHealthCheck
- 6.1.8: SetGslbRegionalRoutingControl
- 6.1.8.1: 1.1
- 6.1.9: SetGslbResources
- 6.1.10: ShowGslb
- 6.2: Models
- 6.2.1: GslbCreateRequest
- 6.2.2: GslbCreateRequestV1Dot1
- 6.2.3: GslbDetail
- 6.2.4: GslbHealthCheck
- 6.2.5: GslbHeathCheckShowResponse
- 6.2.6: GslbListResponse
- 6.2.7: GslbResource
- 6.2.8: GslbResourceListResponse
- 6.2.9: GslbResourceListResponseV1Dot1
- 6.2.10: GslbResourceResponse
- 6.2.11: GslbResourceResponseV1Dot1
- 6.2.12: GslbResourceSetRequest
- 6.2.13: GslbResourceSetRequestV1Dot1
- 6.2.14: GslbResourcesSetRequest
- 6.2.15: GslbResourcesSetResponse
- 6.2.16: GslbResourceV1Dot1
- 6.2.17: GslbResourceWithStatus
- 6.2.18: GslbResponseCommon
- 6.2.19: GslbRoutingControlListResponse
- 6.2.20: GslbRoutingControlRequest
- 6.2.21: GslbRoutingControlResponse
- 6.2.22: GslbRoutingControlResponseCommon
- 6.2.23: GslbSetRequest
- 6.2.24: GslbShowResponse
- 6.2.25: GslbShowResponseV1Dot1
- 6.2.26: GslbV1Dot1
- 6.2.27: Tag
- 7: Load Balancer
- 7.1: APIs
- 7.1.1: AddLbServerGroupMembers
- 7.1.2: CreateLBHealthCheck
- 7.1.3: CreateLbListener
- 7.1.4: CreateLBServerGroup
- 7.1.5: CreateLoadbalancer
- 7.1.6: CreateLoadbalancerPrivateNatIp
- 7.1.7: CreateLoadbalancerPublicNatIp
- 7.1.8: DeleteLBHealthCheck
- 7.1.9: DeleteLbListener
- 7.1.10: DeleteLBServerGroup
- 7.1.11: DeleteLoadbalancer
- 7.1.12: DeleteLoadbalancerPrivateNatIp
- 7.1.13: DeleteLoadbalancerPublicNatIp
- 7.1.14: ListLBHealthChecks
- 7.1.15: ListLbListeners
- 7.1.16: ListLbServerGroupMembers
- 7.1.17: ListLBServerGroups
- 7.1.18: ListLoadbalancerCertificates
- 7.1.19: ListLoadbalancers
- 7.1.20: RemoveLbServerGroupMember
- 7.1.21: RemoveLbServerGroupMembers
- 7.1.22: SetLBHealthCheck
- 7.1.23: SetLbListener
- 7.1.23.1: 1.3
- 7.1.24: SetLbListenerCertificate
- 7.1.24.1: 1.4
- 7.1.25: SetLbListenerResource
- 7.1.25.1: 1.4
- 7.1.26: SetLbListenerRule
- 7.1.26.1: 1.4
- 7.1.27: SetLBServerGroup
- 7.1.28: SetLbServerGroupMember
- 7.1.29: SetLoadbalancer
- 7.1.30: ShowLBHealthCheck
- 7.1.31: ShowLbListener
- 7.1.32: ShowLBServerGroup
- 7.1.33: ShowLbServerGroupMember
- 7.1.34: ShowLoadbalancer
- 7.1.35: ShowLoadbalancerCertificate
- 7.1.36: ShowLoadbalancerPrivateNatIp
- 7.1.37: ShowLoadbalancerPublicNatIp
- 7.2: Models
- 7.2.1: HstsConfig
- 7.2.2: HttpsRedirection
- 7.2.3: LbCertificateForShow
- 7.2.4: LbCertificateListResponse
- 7.2.5: LbCertificateListResponseDetail
- 7.2.6: LbCertificateShowResponse
- 7.2.7: LbHealthCheckCreate
- 7.2.8: LbHealthCheckCreateRequest
- 7.2.9: LbHealthCheckList
- 7.2.10: LbHealthCheckListResponse
- 7.2.11: LbHealthCheckSet
- 7.2.12: LbHealthCheckSetRequest
- 7.2.13: LbHealthCheckShow
- 7.2.14: LbHealthCheckShowResponse
- 7.2.15: LbListenerCertificateBase
- 7.2.16: LbListenerCertificateSetRequest
- 7.2.17: LbListenerCreateRequestV1Dot3
- 7.2.18: LbListenerCreateRequestV1Dot4
- 7.2.19: LbListenerDistinctBase
- 7.2.20: LbListenerListResponse
- 7.2.21: LbListenerResourceSetRequest
- 7.2.22: LbListenerRuleBase
- 7.2.23: LbListenerRuleSetRequest
- 7.2.24: LbListenerSetRequestV1Dot3
- 7.2.25: LbListenerShowResponseV1Dot3
- 7.2.26: LbListenerShowResponseV1Dot4
- 7.2.27: LbListenerSslCertificate
- 7.2.28: LbServerGroup
- 7.2.29: LbServerGroupCreate
- 7.2.30: LbServerGroupCreateRequest
- 7.2.31: LbServerGroupList
- 7.2.32: LbServerGroupListResponse
- 7.2.33: LbServerGroupSet
- 7.2.34: LbServerGroupSetRequest
- 7.2.35: LbServerGroupShowResponse
- 7.2.36: ListenerForCreateV1Dot3
- 7.2.37: ListenerForCreateV1Dot4
- 7.2.38: ListenerForList
- 7.2.39: ListenerForSetV1Dot3
- 7.2.40: ListenerForShow
- 7.2.41: ListenerForShowV1Dot3
- 7.2.42: Loadbalancer
- 7.2.43: LoadbalancerCreateRequest
- 7.2.44: LoadbalancerCreateRequestDetail
- 7.2.45: LoadbalancerCreateRequestDetailV1Dot4
- 7.2.46: LoadbalancerCreateRequestV1Dot4
- 7.2.47: LoadbalancerCreateResponse
- 7.2.48: LoadbalancerCreateResponseDetail
- 7.2.49: LoadbalancerListResponse
- 7.2.50: LoadbalancerListResponseDetail
- 7.2.51: LoadbalancerListResponseDetailV1Dot4
- 7.2.52: LoadbalancerListResponseV1Dot4
- 7.2.53: LoadbalancerShowResponse
- 7.2.54: LoadbalancerShowResponseV1Dot4
- 7.2.55: LoadbalancerStaticNatResponse
- 7.2.56: LoadbalancerUpdateRequest
- 7.2.57: LoadbalancerUpdateRequestDetail
- 7.2.58: LoadbalancerV1Dot4
- 7.2.59: Member
- 7.2.60: MemberCreateRequestV1Dot1
- 7.2.61: MemberDeleteBulkRequestV1Dot2
- 7.2.62: MemberListCreateRequestV1Dot1
- 7.2.63: MemberListResponse
- 7.2.64: MemberSet
- 7.2.65: MemberSetRequest
- 7.2.66: MemberShowResponse
- 7.2.67: MemberWithHealthState
- 7.2.68: MemberWithHealthStateListResponse
- 7.2.69: MemberWithHealthStateListResponseV1Dot4
- 7.2.70: MemberWithHealthStateV1Dot4
- 7.2.71: PrivateStaticNatCreateRequest
- 7.2.72: PrivateStaticNatCreateRequestDetail
- 7.2.73: PrivateStaticNatCreateResponse
- 7.2.74: PrivateStaticNatCreateResponseDetail
- 7.2.75: PrivateStaticNatShowResponse
- 7.2.76: PrivateStaticNatShowResponseDetail
- 7.2.77: SniCertificate
- 7.2.78: SniCertificateResponse
- 7.2.79: SslCertificate
- 7.2.80: StaticNat
- 7.2.81: StaticNatCreateRequest
- 7.2.82: StaticNatCreateRequestDetail
- 7.2.83: StaticNatCreateResponse
- 7.2.84: StaticNatCreateResponseDetail
- 7.2.85: Tag
- 7.2.86: UrlHandler
- 7.2.87: UrlHandlerResponse
- 8: Security Group
- 8.1: APIs
- 8.1.1: Add Address Group IPs
- 8.1.1.1: 1.1
- 8.1.2: Create Address Group
- 8.1.2.1: 1.1
- 8.1.3: Create Security Group
- 8.1.4: Create Security Group Rule
- 8.1.5: Delete Address Group
- 8.1.5.1: 1.1
- 8.1.6: Delete Security Group
- 8.1.7: Delete Security Group Rule
- 8.1.8: List Address Group IPs
- 8.1.8.1: 1.1
- 8.1.9: List Address Groups
- 8.1.9.1: 1.1
- 8.1.10: List Security Group Rules
- 8.1.11: List Security Groups
- 8.1.12: Remove Address Group IPs
- 8.1.12.1: 1.1
- 8.1.13: Set Address Group
- 8.1.13.1: 1.1
- 8.1.14: Set Security Group
- 8.1.15: Show Address Group
- 8.1.15.1: 1.1
- 8.1.16: Show Security Group
- 8.1.17: Show Security Group Rule
- 8.2: Models
- 8.2.1: AddressGroup
- 8.2.2: AddressGroupCidrListResponse
- 8.2.3: AddressGroupCidrsAddRequest
- 8.2.4: AddressGroupCreateRequest
- 8.2.5: AddressGroupListResponse
- 8.2.6: AddressGroupSetRequest
- 8.2.7: AddressGroupShowResponse
- 8.2.8: SecurityGroup
- 8.2.9: SecurityGroupCreateRequest
- 8.2.10: SecurityGroupListResponse
- 8.2.11: SecurityGroupRule
- 8.2.12: SecurityGroupRuleCreateRequest
- 8.2.13: SecurityGroupRuleCreateRequestV1Dot1
- 8.2.14: SecurityGroupRuleListResponse
- 8.2.15: SecurityGroupRuleListResponseV1Dot1
- 8.2.16: SecurityGroupRuleShowResponse
- 8.2.17: SecurityGroupRuleShowResponseV1Dot1
- 8.2.18: SecurityGroupRuleV1Dot1
- 8.2.19: SecurityGroupSetRequest
- 8.2.20: SecurityGroupShowResponse
- 8.2.21: Tag
- 9: VPC
- 9.1: APIs
- 9.1.1: Add VPC CIDR
- 9.1.2: Approval VPC Peering
- 9.1.3: Approve PrivateLink Endpoint
- 9.1.4: Connect PrivateLink Endpoint
- 9.1.5: Connect Subnet VIP Port
- 9.1.6: Create Internet Gateway
- 9.1.7: Create NAT Gateway
- 9.1.8: Create Port
- 9.1.9: Create Private NAT
- 9.1.10: Create Private NAT IP
- 9.1.11: Create PrivateLink Endpoint
- 9.1.12: Create PrivateLink Service
- 9.1.13: Create PublicIP
- 9.1.14: Create Subnet
- 9.1.15: Create Subnet VIP
- 9.1.16: Create Subnet VIP NAT IP
- 9.1.17: Create Transit Gateway
- 9.1.18: Create Transit Gateway Firewall
- 9.1.19: Create Transit Gateway Firewall Connection
- 9.1.20: Create Transit Gateway Rule
- 9.1.21: Create Transit Gateway Uplink Rule
- 9.1.22: Create Transit Gateway VPC Connection
- 9.1.23: Create VPC
- 9.1.24: Create VPC Endpoint
- 9.1.25: Create VPC Peering
- 9.1.26: Create Vpc Peering Rule
- 9.1.27: Delete Internet Gateway
- 9.1.28: Delete NAT Gateway
- 9.1.29: Delete Port
- 9.1.30: Delete Private NAT
- 9.1.31: Delete Private NAT IP
- 9.1.32: Delete PrivateLink Endpoint
- 9.1.33: Delete PrivateLink Service
- 9.1.34: Delete PublicIP
- 9.1.35: Delete Subnet
- 9.1.36: Delete Subnet Vip
- 9.1.37: Delete Subnet Vip Connected Port
- 9.1.38: Delete Subnet VIP NAT IP
- 9.1.39: Delete Transit Gateway
- 9.1.40: Delete Transit Gateway Firewall
- 9.1.41: Delete Transit Gateway Firewall Connection
- 9.1.42: Delete Transit Gateway Rule
- 9.1.43: Delete Transit Gateway Uplink Rule
- 9.1.44: Delete Transit Gateway VPC Connection
- 9.1.45: Delete VPC
- 9.1.46: Delete VPC Endpoint
- 9.1.47: Delete VPC Peering
- 9.1.48: Delete VPC Peering Rule
- 9.1.49: List Connected PrivateLink Endpoints
- 9.1.50: List Internet Gateways
- 9.1.51: List NAT Gateways
- 9.1.52: List Ports
- 9.1.53: List Private NAT
- 9.1.54: List Private NAT IP
- 9.1.55: List PrivateLink Endpoint
- 9.1.56: List PrivateLink Service
- 9.1.57: List PublicIPs
- 9.1.58: List SAP Secondary Subnets
- 9.1.59: List Subnet Vips
- 9.1.60: List Subnets
- 9.1.61: List Transit Gateway Rules
- 9.1.62: List Transit Gateway VPC Connections
- 9.1.63: List Transit Gateways
- 9.1.64: List VPC Endpoint
- 9.1.65: List VPC Endpoint Connectable Resources
- 9.1.66: List VPC Peering
- 9.1.67: List VPC Peering Rules
- 9.1.68: List VPCs
- 9.1.69: Request PrivateLink Endpoint
- 9.1.70: Set Internet Gateway
- 9.1.71: Set NAT Gateway
- 9.1.72: Set Port
- 9.1.73: Set Private NAT
- 9.1.74: Set PrivateLink Endpoint
- 9.1.75: Set PrivateLink Service
- 9.1.76: Set PublicIP
- 9.1.77: Set Subnet
- 9.1.78: Set Subnet Vip
- 9.1.79: Set Transit Gateway
- 9.1.80: Set VPC
- 9.1.81: Set VPC Endpoint
- 9.1.82: Set VPC Peering
- 9.1.83: Show Internet Gateway
- 9.1.84: Show NAT Gateway
- 9.1.85: Show Port
- 9.1.86: Show Private NAT
- 9.1.87: Show PrivateLink Endpoint
- 9.1.88: Show PrivateLink Service
- 9.1.89: Show PublicIP
- 9.1.90: Show Subnet
- 9.1.91: Show Subnet Vip
- 9.1.92: Show Transit Gateway
- 9.1.93: Show VPC
- 9.1.94: Show VPC Endpoint
- 9.1.95: Show VPC Peering
- 9.2: Models
- 9.2.1: ConnectedEndpointListResponse
- 9.2.2: ConnectedPortInfo
- 9.2.3: ConnectedPrivateLinkEndpoint
- 9.2.4: InternetGateway
- 9.2.5: InternetGatewayCreateRequest
- 9.2.6: InternetGatewayListResponse
- 9.2.7: InternetGatewayListResponseV1Dot2
- 9.2.8: InternetGatewayListResponseV1Dot3
- 9.2.9: InternetGatewaySetRequest
- 9.2.10: InternetGatewaySetResponse
- 9.2.11: InternetGatewayShowResponse
- 9.2.12: InternetGatewayShowResponseV1Dot3
- 9.2.13: InternetGatewayV1Dot3
- 9.2.14: NatGateway
- 9.2.15: NatGatewayCreateRequest
- 9.2.16: NatGatewayCreateRequestV1Dot3
- 9.2.17: NatGatewayIp
- 9.2.18: NatGatewayListResponse
- 9.2.19: NatGatewayListResponseV1Dot2
- 9.2.20: NatGatewayListResponseV1Dot3
- 9.2.21: NatGatewaySetRequest
- 9.2.22: NatGatewaySetResponse
- 9.2.23: NatGatewayShowResponse
- 9.2.24: NatGatewayShowResponseV1Dot3
- 9.2.25: NatGatewayV1Dot3
- 9.2.26: Port
- 9.2.27: PortCreateRequest
- 9.2.28: PortList
- 9.2.29: PortListResponse
- 9.2.30: PortSecurityGroup
- 9.2.31: PortSetRequest
- 9.2.32: PortShowResponse
- 9.2.33: PortShowResponseV1Dot2
- 9.2.34: PortV1Dot2
- 9.2.35: PrivateLinkEndpoint
- 9.2.36: PrivateLinkEndpointApprovalRequest
- 9.2.37: PrivateLinkEndpointConnectionRequest
- 9.2.38: PrivateLinkEndpointCreateRequest
- 9.2.39: PrivateLinkEndpointDetail
- 9.2.40: PrivateLinkEndpointListResponse
- 9.2.41: PrivateLinkEndpointRequest
- 9.2.42: PrivateLinkEndpointSetRequest
- 9.2.43: PrivateLinkEndpointShowResponse
- 9.2.44: PrivateLinkEndpointSummary
- 9.2.45: PrivateLinkEndpointSummaryShowResponse
- 9.2.46: PrivateLinkService
- 9.2.47: PrivateLinkServiceCreateRequest
- 9.2.48: PrivateLinkServiceDetail
- 9.2.49: PrivateLinkServiceListResponse
- 9.2.50: PrivateLinkServiceSetRequest
- 9.2.51: PrivateLinkServiceShowResponse
- 9.2.52: PrivateNat
- 9.2.53: PrivateNatCreateRequest
- 9.2.54: PrivateNatCreateRequestV1Dot2
- 9.2.55: PrivateNatIp
- 9.2.56: PrivateNatIpCreateRequest
- 9.2.57: PrivateNatIpListResponse
- 9.2.58: PrivateNatIpShowResponse
- 9.2.59: PrivateNatListResponse
- 9.2.60: PrivateNatListResponseV1Dot2
- 9.2.61: PrivateNatSetRequest
- 9.2.62: PrivateNatShowResponse
- 9.2.63: PrivateNatShowResponseV1Dot2
- 9.2.64: PrivateNatV1Dot2
- 9.2.65: Publicip
- 9.2.66: PublicipCreateRequest
- 9.2.67: PublicipCreateRequestV1Dot3
- 9.2.68: PublicipListResponse
- 9.2.69: PublicipListResponseV1Dot2
- 9.2.70: PublicipListResponseV1Dot3
- 9.2.71: PublicipSetRequest
- 9.2.72: PublicipSetResponse
- 9.2.73: PublicipShowResponse
- 9.2.74: PublicipShowResponseV1Dot3
- 9.2.75: PublicipV1Dot3
- 9.2.76: SapSecondarySubnet
- 9.2.77: SapSecondarySubnetListResponse
- 9.2.78: StaticNatSummary
- 9.2.79: Subnet
- 9.2.80: SubnetCreateRequest
- 9.2.81: SubnetCreateRequestV1Dot2
- 9.2.82: SubnetCreateRequestV1Dot3
- 9.2.83: SubnetDetail
- 9.2.84: SubnetDetailV1Dot2
- 9.2.85: SubnetDetailV1Dot3
- 9.2.86: SubnetListResponse
- 9.2.87: SubnetListResponseV1Dot2
- 9.2.88: SubnetListResponseV1Dot3
- 9.2.89: SubnetSetRequest
- 9.2.90: SubnetSetRequestV1Dot2
- 9.2.91: SubnetSetResponse
- 9.2.92: SubnetShowResponse
- 9.2.93: SubnetShowResponseV1Dot2
- 9.2.94: SubnetShowResponseV1Dot3
- 9.2.95: SubnetV1Dot3
- 9.2.96: SubnetVipDetail
- 9.2.97: SubnetVipSummary
- 9.2.98: Tag
- 9.2.99: TransitGateway
- 9.2.100: TransitGatewayCreateRequest
- 9.2.101: TransitGatewayFirewallConnectionCreateResponse
- 9.2.102: TransitGatewayFirewallCreateRequest
- 9.2.103: TransitGatewayFirewallCreateRequestV1Dot3
- 9.2.104: TransitGatewayFirewallCreateResponseV1Dot3
- 9.2.105: TransitGatewayFirewallDeleteResponse
- 9.2.106: TransitGatewayListResponse
- 9.2.107: TransitGatewayListResponseV1Dot2
- 9.2.108: TransitGatewayRule
- 9.2.109: TransitGatewayRuleCreateRequest
- 9.2.110: TransitGatewayRuleListResponse
- 9.2.111: TransitGatewayRuleListResponseV1Dot2
- 9.2.112: TransitGatewayRuleShowResponse
- 9.2.113: TransitGatewayRuleV1Dot2
- 9.2.114: TransitGatewaySetRequest
- 9.2.115: TransitGatewaySetResponse
- 9.2.116: TransitGatewayShowResponse
- 9.2.117: TransitGatewayShowResponseV1Dot2
- 9.2.118: TransitGatewayShowResponseV1Dot3
- 9.2.119: TransitGatewayUplinkRule
- 9.2.120: TransitGatewayUplinkRuleCreateRequest
- 9.2.121: TransitGatewayUplinkRuleCreateResponse
- 9.2.122: TransitGatewayV1Dot2
- 9.2.123: TransitGatewayV1Dot3
- 9.2.124: TransitGatewayVpcConnection
- 9.2.125: TransitGatewayVpcConnectionCreateRequest
- 9.2.126: TransitGatewayVpcConnectionListResponse
- 9.2.127: TransitGatewayVpcConnectionShowResponse
- 9.2.128: TransitGatewayVpcRule
- 9.2.129: VipCreateRequest
- 9.2.130: VipCreateResponse
- 9.2.131: VipListResponse
- 9.2.132: VipNatCreateRequest
- 9.2.133: VipNatCreateResponse
- 9.2.134: VipPortRequest
- 9.2.135: VipPortResponse
- 9.2.136: VipSetRequest
- 9.2.137: VipShowResponse
- 9.2.138: Vpc
- 9.2.139: VpcCidr
- 9.2.140: VpcCidrCreateRequest
- 9.2.141: VpcCidrCreateResponse
- 9.2.142: VpcCreateRequest
- 9.2.143: VpcEndpoint
- 9.2.144: VpcEndpointConnectableResourceDetail
- 9.2.145: VpcEndpointConnectableResourceListResponse
- 9.2.146: VpcEndpointConnectableResourceListResponseV1Dot2
- 9.2.147: VpcEndpointCreateRequest
- 9.2.148: VpcEndpointListResponse
- 9.2.149: VpcEndpointListResponseV1Dot2
- 9.2.150: VpcEndpointSetRequest
- 9.2.151: VpcEndpointShowResponse
- 9.2.152: VpcListResponse
- 9.2.153: VpcListResponseV1Dot2
- 9.2.154: VpcListResponseV1Dot3
- 9.2.155: VpcPeering
- 9.2.156: VpcPeeringApprovalRequest
- 9.2.157: VpcPeeringCreateRequest
- 9.2.158: VpcPeeringListResponse
- 9.2.159: VpcPeeringRule
- 9.2.160: VpcPeeringRuleCreateRequest
- 9.2.161: VpcPeeringRuleListResponse
- 9.2.162: VpcPeeringRuleShowResponse
- 9.2.163: VpcPeeringSetRequest
- 9.2.164: VpcPeeringShowResponse
- 9.2.165: VpcSetRequest
- 9.2.166: VpcSetResponse
- 9.2.167: VpcShowResponse
- 9.2.168: VpcShowResponseV1Dot2
- 9.2.169: VpcShowResponseV1Dot3
- 9.2.170: VpcV1Dot2
- 9.2.171: VpcV1Dot3
- 10: VPN
- 10.1: APIs
- 10.1.1: Create VPN Gateway
- 10.1.2: Create VPN Tunnel
- 10.1.3: Delete VPN Gateway
- 10.1.4: Delete VPN Tunnel
- 10.1.5: List VPN Gateways
- 10.1.6: List VPN Tunnels
- 10.1.7: Set VPN Gateway
- 10.1.8: Set VPN Tunnel
- 10.1.9: Show VPN Gateway
- 10.1.10: Show VPN Tunnel
- 10.2: Models
- 10.2.1: Tag
- 10.2.2: VpnGateway
- 10.2.3: VpnGatewayCreateRequest
- 10.2.4: VpnGatewayListResponse
- 10.2.5: VpnGatewaySetRequest
- 10.2.6: VpnGatewayShowResponse
- 10.2.7: VpnPhase1
- 10.2.8: VpnPhase1CreateRequest
- 10.2.9: VpnPhase1CreateRequestV1Dot1
- 10.2.10: VpnPhase1Detail
- 10.2.11: VpnPhase1DetailV1Dot1
- 10.2.12: VpnPhase1SetRequest
- 10.2.13: VpnPhase1SetRequestV1Dot1
- 10.2.14: VpnPhase1V1Dot1
- 10.2.15: VpnPhase2
- 10.2.16: VpnPhase2CreateRequest
- 10.2.17: VpnPhase2CreateRequestV1Dot1
- 10.2.18: VpnPhase2Detail
- 10.2.19: VpnPhase2DetailV1Dot1
- 10.2.20: VpnPhase2SetRequest
- 10.2.21: VpnPhase2SetRequestV1Dot1
- 10.2.22: VpnPhase2V1Dot1
- 10.2.23: VpnTunnel
- 10.2.24: VpnTunnelCreateRequest
- 10.2.25: VpnTunnelCreateRequestV1Dot1
- 10.2.26: VpnTunnelDetail
- 10.2.27: VpnTunnelDetailV1Dot1
- 10.2.28: VpnTunnelDetailWithStatus
- 10.2.29: VpnTunnelDetailWithStatusV1Dot1
- 10.2.30: VpnTunnelListResponse
- 10.2.31: VpnTunnelListResponseV1Dot1
- 10.2.32: VpnTunnelSetRequest
- 10.2.33: VpnTunnelSetRequestV1Dot1
- 10.2.34: VpnTunnelShowResponse
- 10.2.35: VpnTunnelShowResponseV1Dot1
- 10.2.36: VpnTunnelShowWithStatusResponse
- 10.2.37: VpnTunnelShowWithStatusResponseV1Dot1
- 10.2.38: VpnTunnelV1Dot1
1 - Cloud Secured SD-LAN
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Cloud Secured SD-LAN service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.0 | CURRENT | - |
OpenAPI URL
https://cssdlan.{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 - SetExternalCSSDLANNetworkChangeInfo
1.2 - Models
2 - Direct Connect
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Direct Connect service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.2 | CURRENT | - |
| 1.1 | SUPPORTED | 20270131 |
| 1.0 | SUPPORTED | 20261130 |
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 |
API Version History
1.2
Multi AZ feature has been added.
Changes
- [Updated]
POST /v1/direct-connects- The following field has been added to the parameters and response.uplink_active_zoneuplink_standby_zone
- [Updated]
GET /v1/direct-connects/{direct_connect_id}- The following field has been added to the response.uplink_active_zoneuplink_standby_zone
- [Updated]
PUT /v1/direct-connects/{direct_connect_id}- The response is being trimmed for compatibility (changed to include only the requested values).
1.1
The pagination method for the list API has been changed.
Changes
- [Updated]
GET /v1/direct-connects- The following field has been changed to the parameters and response.- Deleted :
limit,marker - Added :
size,page
- Deleted :
- [Updated]
GET /v1/direct-connects/{direct_connect_id}/routing-rules- The following field has been changed to the parameters and response.- Deleted :
limit,marker - Added :
size,page
- Deleted :
1.0
Direct Connect API has been released.
Changes
- [New]
GET /v1/direct-connects- API has been added. - [New]
POST /v1/direct-connects- API has been added. - [New]
GET /v1/direct-connects/{direct_connect_id}- API has been added. - [New]
PUT /v1/direct-connects/{direct_connect_id}- API has been added. - [New]
DELETE /v1/direct-connects/{direct_connect_id}- API has been added. - [New]
GET /v1/direct-connects/{direct_connect_id}/routing-rules- API has been added. - [New]
POST /v1/direct-connects/{direct_connect_id}/routing-rules- API has been added. - [New]
DELETE /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id}- API has been added.
2.1 - APIs
2.1.1 - Create Direct Connect
2.1.1.1 - 1.2
post /v1/direct-connects
Description
Create direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | DirectConnectCreateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | DirectConnectShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = direct-connect 1.2"
Request body
{
"bandwidth": 1,
"description": "Direct-connect Description",
"firewall_enabled": true,
"firewall_loggable": true,
"name": "DirectConnectName",
"tags": "[{'key': 'key', 'value': 'value'}]",
"uplink_active_zone": "kr-west1-a",
"uplink_standby_zone": "kr-west1-b",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"direct_connect": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"uplink_active_zone": "kr-west1-a",
"uplink_standby_zone": "kr-west1-b",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
2.1.1.2 - 1.1
post /v1/direct-connects
Description
Create direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
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 = en-US",
"Scp-Api-Version = direct-connect 1.1"
Request body
{
"bandwidth": 1,
"description": "Direct-connect Description",
"firewall_enabled": true,
"firewall_loggable": true,
"name": "DirectConnectName",
"tags": "[{'key': 'key', 'value': 'value'}]",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"direct_connect": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
2.1.1.3 - 1.0
post /v1/direct-connects
Description
Create direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
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 = en-US",
"Scp-Api-Version = direct-connect 1.0"
Request body
{
"bandwidth": 1,
"description": "Direct-connect Description",
"firewall_enabled": true,
"firewall_loggable": true,
"name": "DirectConnectName",
"tags": "[{'key': 'key', 'value': 'value'}]",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"direct_connect": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
2.1.2 - Create Routing Rule
2.1.2.1 - 1.2
post /v1/direct-connects/{direct_connect_id}/routing-rules
Description
Create a routing rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.2"
Request body
{
"description": "TransitGateway Description",
"destination_cidr": "11.11.11.0/24",
"destination_resource_id": "be3c84238562488e81e4e0675f86be62",
"destination_type": "ON_PREMISE"
}
Example HTTP response
Response 202
{
"routing_rule": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"destination_cidr": "11.11.11.0/24",
"destination_resource_id": "be3c84238562488e81e4e0675f86be62",
"destination_resource_name": "ResourceName",
"destination_type": "ON_PREMISE",
"id": "c8980aa2bf1e43c9998682f7baaf1c46",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"owner_id": "cd1610830b9046418e4bc67831c533e6",
"owner_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
}
2.1.2.2 - 1.1
post /v1/direct-connects/{direct_connect_id}/routing-rules
Description
Create a routing rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.1"
Request body
{
"description": "TransitGateway Description",
"destination_cidr": "11.11.11.0/24",
"destination_resource_id": "be3c84238562488e81e4e0675f86be62",
"destination_type": "ON_PREMISE"
}
Example HTTP response
Response 202
{
"routing_rule": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"destination_cidr": "11.11.11.0/24",
"destination_resource_id": "be3c84238562488e81e4e0675f86be62",
"destination_resource_name": "ResourceName",
"destination_type": "ON_PREMISE",
"id": "c8980aa2bf1e43c9998682f7baaf1c46",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"owner_id": "cd1610830b9046418e4bc67831c533e6",
"owner_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
}
2.1.2.3 - 1.0
post /v1/direct-connects/{direct_connect_id}/routing-rules
Description
Create a routing rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.0"
Request body
{
"description": "TransitGateway Description",
"destination_cidr": "11.11.11.0/24",
"destination_resource_id": "be3c84238562488e81e4e0675f86be62",
"destination_type": "ON_PREMISE"
}
Example HTTP response
Response 202
{
"routing_rule": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"destination_cidr": "11.11.11.0/24",
"destination_resource_id": "be3c84238562488e81e4e0675f86be62",
"destination_resource_name": "ResourceName",
"destination_type": "ON_PREMISE",
"id": "c8980aa2bf1e43c9998682f7baaf1c46",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"owner_id": "cd1610830b9046418e4bc67831c533e6",
"owner_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
}
2.1.3 - Delete Direct Connect
2.1.3.1 - 1.2
delete /v1/direct-connects/{direct_connect_id}
Description
Delete direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.2"
Example HTTP response
Response 202
2.1.3.2 - 1.1
delete /v1/direct-connects/{direct_connect_id}
Description
Delete direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.1"
Example HTTP response
Response 202
2.1.3.3 - 1.0
delete /v1/direct-connects/{direct_connect_id}
Description
Delete direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.0"
Example HTTP response
Response 202
2.1.4 - Delete Routing Rule
2.1.4.1 - 1.2
delete /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id}
Description
Delete a routing rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : c8980aa2bf1e43c9998682f7baaf1c46 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.2"
Example HTTP response
Response 202
2.1.4.2 - 1.1
delete /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id}
Description
Delete a routing rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : c8980aa2bf1e43c9998682f7baaf1c46 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.1"
Example HTTP response
Response 202
2.1.4.3 - 1.0
delete /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id}
Description
Delete a routing rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : c8980aa2bf1e43c9998682f7baaf1c46 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.0"
Example HTTP response
Response 202
2.1.5 - List Direct Connects
2.1.5.1 - 1.2
get /v1/direct-connects
Description
Get direct connect list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | id optional | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | |
| query | name optional | Direct Connect Name Example : DirectConnectName | string | |
| query | state optional | State Example : ACTIVE | enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR) | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| query | vpc_name optional | VPC Name Example : vpcName | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DirectConnectListResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = direct-connect 1.2"
Example HTTP response
Response 200
{
"count": 20,
"direct_connects": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
2.1.5.2 - 1.1
get /v1/direct-connects
Description
Get direct connect list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
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 | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | |
| query | name optional | Direct Connect Name Example : DirectConnectName | string | |
| query | state optional | State Example : ACTIVE | enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR) | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| query | vpc_name optional | VPC Name Example : vpcName | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DirectConnectListResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = direct-connect 1.1"
Example HTTP response
Response 200
{
"count": 20,
"direct_connects": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
2.1.5.3 - 1.0
get /v1/direct-connects
Description
Get direct connect list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 : fe860e0af0c04dcd8182b84f907f31f4 | string | |
| query | name optional | Direct Connect Name Example : DirectConnectName | string | |
| query | state optional | State Example : ACTIVE | enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR) | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| query | vpc_name optional | VPC Name Example : vpcName | 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 = en-US",
"Scp-Api-Version = direct-connect 1.0"
Example HTTP response
Response 200
{
"count": 20,
"direct_connects": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
2.1.6 - List Routing Rules
2.1.6.1 - 1.2
get /v1/direct-connects/{direct_connect_id}/routing-rules
Description
Get routing rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 : c8980aa2bf1e43c9998682f7baaf1c46 | any of [string, null] | None |
| query | destination_type optional | Destination Type Example : ON_PREMISE | enum (VPC, ON_PREMISE) | None |
| query | destination_cidr optional | Destination CIDR Example : 11.11.11.0/24 | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR) | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoutingRuleListResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = direct-connect 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"routing_rules": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"destination_cidr": "11.11.11.0/24",
"destination_resource_id": "be3c84238562488e81e4e0675f86be62",
"destination_resource_name": "ResourceName",
"destination_type": "ON_PREMISE",
"id": "c8980aa2bf1e43c9998682f7baaf1c46",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"owner_id": "cd1610830b9046418e4bc67831c533e6",
"owner_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
2.1.6.2 - 1.1
get /v1/direct-connects/{direct_connect_id}/routing-rules
Description
Get routing rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 : c8980aa2bf1e43c9998682f7baaf1c46 | any of [string, null] | None |
| query | destination_type optional | Destination Type Example : ON_PREMISE | enum (VPC, ON_PREMISE) | None |
| query | destination_cidr optional | Destination CIDR Example : 11.11.11.0/24 | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR) | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoutingRuleListResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = direct-connect 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"routing_rules": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"destination_cidr": "11.11.11.0/24",
"destination_resource_id": "be3c84238562488e81e4e0675f86be62",
"destination_resource_name": "ResourceName",
"destination_type": "ON_PREMISE",
"id": "c8980aa2bf1e43c9998682f7baaf1c46",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"owner_id": "cd1610830b9046418e4bc67831c533e6",
"owner_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
2.1.6.3 - 1.0
get /v1/direct-connects/{direct_connect_id}/routing-rules
Description
Get routing rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 : c8980aa2bf1e43c9998682f7baaf1c46 | any of [string, null] | None |
| query | destination_type optional | Destination Type Example : ON_PREMISE | enum (VPC, ON_PREMISE) | None |
| query | destination_cidr optional | Destination CIDR Example : 11.11.11.0/24 | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"destination_cidr": "11.11.11.0/24",
"destination_resource_id": "be3c84238562488e81e4e0675f86be62",
"destination_resource_name": "ResourceName",
"destination_type": "ON_PREMISE",
"id": "c8980aa2bf1e43c9998682f7baaf1c46",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"owner_id": "cd1610830b9046418e4bc67831c533e6",
"owner_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
]
}
2.1.7 - Set Direct Connect
2.1.7.1 - 1.2
put /v1/direct-connects/{direct_connect_id}
Description
Set direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| body | body required | DirectConnectSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DirectConnectSetResponse |
| 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 = en-US",
"Scp-Api-Version = direct-connect 1.2"
Request body
{
"description": "Direct-connect Description"
}
Example HTTP response
Response 200
{
"description": "Direct-connect Description"
}
2.1.7.2 - 1.1
put /v1/direct-connects/{direct_connect_id}
Description
Set direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.1"
Request body
{
"description": "Direct-connect Description"
}
Example HTTP response
Response 200
{
"direct_connect": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
2.1.7.3 - 1.0
put /v1/direct-connects/{direct_connect_id}
Description
Set direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.0"
Request body
{
"description": "Direct-connect Description"
}
Example HTTP response
Response 200
{
"direct_connect": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
2.1.8 - Show Direct Connect
2.1.8.1 - 1.2
get /v1/direct-connects/{direct_connect_id}
Description
Show direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DirectConnectShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = direct-connect 1.2"
Example HTTP response
Response 200
{
"direct_connect": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"uplink_active_zone": "kr-west1-a",
"uplink_standby_zone": "kr-west1-b",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
2.1.8.2 - 1.1
get /v1/direct-connects/{direct_connect_id}
Description
Show direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.1"
Example HTTP response
Response 200
{
"direct_connect": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
2.1.8.3 - 1.0
get /v1/direct-connects/{direct_connect_id}
Description
Show direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = direct-connect 1.0"
Example HTTP response
Response 200
{
"direct_connect": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "fe860e0af0c04dcd8182b84f907f31f4",
"firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "DirectConnectName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
2.2 - Models
2.2.1 - DirectConnect
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f1e6c81a2b054582878cb9724dc2ce9f | string | |
| bandwidth required | Port Bandwidth Example : 1 | integer | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | Direct Connect Description Example : fe860e0af0c04dcd8182b84f907f31f4 | any of [string, null] | |
| firewall_id optional | Firewall ID Example : dffc455f1bd14e0594e4faa638aac3a1 | any of [string, null] | |
| id required | Direct Connect 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 | Direct Connect Name Example : DirectConnectNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR) | |
| vpc_id required | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| vpc_name required | VPC Name Example : vpcName | string |
2.2.2 - DirectConnectCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| bandwidth required | Port Bandwidth Example : 1 | integer | |
| description optional | Direct Connect Description Example : Direct-connect DescriptionMaximum length : 50 | string | |
| firewall_enabled optional | Firewall Use Example : True | boolean | |
| firewall_loggable optional | Firewall Loggable Example : True | boolean | |
| name required | Direct Connect Name Example : DirectConnectNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| tags optional | Tag List Example : [{'key': 'key', 'value': 'value'}] | array[Tag] | |
| vpc_id required | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string |
2.2.3 - DirectConnectCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| bandwidth required | Port Bandwidth Example : 1 | integer | |
| description optional | Direct Connect Description Example : Direct-connect DescriptionMaximum length : 50 | string | |
| firewall_enabled optional | Firewall Use Example : True | boolean | |
| firewall_loggable optional | Firewall Loggable Example : True | boolean | |
| name required | Direct Connect Name Example : DirectConnectNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| tags optional | Tag List Example : [{'key': 'key', 'value': 'value'}] | array[Tag] | |
| 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] | |
| vpc_id required | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string |
2.2.4 - DirectConnectListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | total count 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] |
2.2.5 - DirectConnectListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| direct_connects required | array[DirectConnect] | ||
| 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.6 - DirectConnectSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Direct Connect Description Example : Direct-connect DescriptionMaximum length : 50 | string |
2.2.7 - DirectConnectSetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Direct Connect Description Example : Direct-connect Description | any of [string, null] |
2.2.8 - DirectConnectShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| direct_connect required | DirectConnect |
2.2.9 - DirectConnectShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| direct_connect required | DirectConnectV1Dot2 |
2.2.10 - DirectConnectV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f1e6c81a2b054582878cb9724dc2ce9f | string | |
| bandwidth required | Port Bandwidth Example : 1 | integer | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | Direct Connect Description Example : fe860e0af0c04dcd8182b84f907f31f4 | any of [string, null] | |
| firewall_id optional | Firewall ID Example : dffc455f1bd14e0594e4faa638aac3a1 | any of [string, null] | |
| id required | Direct Connect 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 | Direct Connect Name Example : DirectConnectNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR) | |
| 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] | |
| vpc_id required | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| vpc_name required | VPC Name Example : vpcName | string |
2.2.11 - RoutingRule
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : TransitGateway Description | string | |
| destination_cidr required | Destination CIDR Example : 11.11.11.0/24 | string | |
| destination_resource_id required | Destination Resource ID Example : be3c84238562488e81e4e0675f86be62 | any of [string, null] | |
| destination_resource_name optional | Destination Resource Name Example : ResourceName | any of [string, null] | |
| destination_type required | Destination Type Example : ON_PREMISE | enum (VPC, ON_PREMISE, INTERNET, TGW) | |
| id required | Routing Rule ID Example : c8980aa2bf1e43c9998682f7baaf1c46 | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| owner_id required | Routing Rule Owner ID Example : cd1610830b9046418e4bc67831c533e6 | string | |
| owner_type required | Routing Rule Owner Type Example : DIRECT_CONNECT | enum (INTERNET_GATEWAY, GROUP_GATEWAY, DIRECT_CONNECT, SUBNET, PRIVATE_NAT, TRANSIT_GATEWAY, VPC_PEERING, SECURE_INTERNET_GATEWAY) | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR) |
2.2.12 - RoutingRuleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : TransitGateway DescriptionMaximum length : 50 | string | |
| destination_cidr required | Destination CIDR Example : 11.11.11.0/24 | string | |
| destination_resource_id optional | Destination Resource ID Example : be3c84238562488e81e4e0675f86be62 | any of [string, null] | |
| destination_type required | Destination Type Example : ON_PREMISE | enum (VPC, ON_PREMISE) |
2.2.13 - RoutingRuleListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] | |
| routing_rules required | array[RoutingRule] |
2.2.14 - RoutingRuleListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| routing_rules required | array[RoutingRule] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
2.2.15 - RoutingRuleShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| routing_rule required | RoutingRule |
2.2.16 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |
3 - DNS
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of DNS service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 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 |
API Version History
1.3
- DNS API has been updated to version 1.3.
- DNS API versions 1.0 to 1.2 have been deprecated.
Changes
- [Changed]
POST /dns/1.1/hosted-zones- CreateHostedZone API has been changed.- The
emailfield has been removed from the request.
- The
- [Changed]
GET /dns/1.1/hosted-zones/{hosted_zone_id}- ShowHostedZone API has been changed.- The
emailfield has been removed from the response.
- The
- [Changed]
PUT /dns/1.1/hosted-zones/{hosted_zone_id}- SetHostedZone API has been changed.- The
emailfield has been removed from the request.
- The
- [Changed]
GET /dns/1.1/hosted-zones/{hosted_zone_id}/records- ListHostedZoneRecords API has been changed.- Zone apex record name is displayed as-is (without
@.notation).
- Zone apex record name is displayed as-is (without
- [Changed]
GET /dns/1.1/public-domain-names- ListPublicDomainNames API has been changed.- Operation ID has been changed to
listPublicDomainNames.
- Operation ID has been changed to
- [Changed]
POST /dns/1.1/public-domain-names- CreatePublicDomainName API has been changed.- Operation ID has been changed to
createPublicDomainName.
- Operation ID has been changed to
- [Changed]
GET /dns/1.1/public-domain-names/{public_domain_id}- ShowPublicDomainName API has been changed.- Operation ID has been changed to
showPublicDomainName.
- Operation ID has been changed to
- [Changed]
PUT /dns/1.1/public-domain-names/{public_domain_id}- SetPublicDomainName API has been changed.- Operation ID has been changed to
setPublicDomainName.
- Operation ID has been changed to
- [New]
POST /dns/1.3/public-domain-names/{public_domain_id}/transfer- TransferPublicDomainName 1.3 API has been added.
1.2
DNS API has been updated to version 1.2.
Changes
- [Changed]
GET /dns/1.1/hosted-zones- ListHostedZones API has been changed.- The following field has been added to the response:
private_dns_name(Private DNS name lookup)
- The following field has been added to the response:
- [Changed]
GET /dns/1.1/hosted-zones/{hosted_zone_id}- ShowHostedZone API has been changed.- The following field has been added to the response:
private_dns_name(Private DNS name lookup)
- The following field has been added to the response:
1.1
DNS API has been updated to version 1.1.
Changes
- [Changed]
PATCH /dns/1.0/hosted-zones/{zone_id}- SetHostedZone 1.0 API has been changed.- Replaced by
PUT /dns/1.0/hosted-zones/{hosted_zone_id}API.
- Replaced by
- [Deleted]
POST /dns/1.0/public-domain-names/{public_domain_id}/renew- RenewPublicDomainName 1.0 API has been deleted.- This API is no longer available.
- [Changed]
GET /dns/1.1/hosted-zones/{hosted_zone_id}/records- ListHostedZoneRecords API has been changed.- Zone apex record name is displayed using
@.notation.
- Zone apex record name is displayed using
- [Changed]
POST /dns/1.0/private-dns- CreatePrivateDns API has been changed.- The following fields have been added to the request:
registered_regionprivate_dns_cr_id
- The following fields have been added to the request:
1.0
DNS API has been released.
Changes
- [New]
GET /dns/1.0/hosted-zones- ListHostedZones 1.0 API has been added. - [New]
POST /dns/1.0/hosted-zones- CreateHostedZone 1.0 API has been added. - [New]
GET /dns/1.0/hosted-zones/{zone_id}- ShowHostedZone 1.0 API has been added. - [New]
PATCH /dns/1.0/hosted-zones/{zone_id}- SetHostedZone 1.0 API has been added. - [New]
DELETE /dns/1.0/hosted-zones/{zone_id}- DeleteHostedZone 1.0 API has been added. - [New]
GET /dns/1.0/hosted-zones/{zone_id}/records- ListHostedZoneRecords 1.0 API has been added. - [New]
POST /dns/1.0/hosted-zones/{zone_id}/records- CreateHostedZoneRecord 1.0 API has been added. - [New]
GET /dns/1.0/hosted-zones/{zone_id}/records/{recordset_id}- ShowHostedZoneRecord 1.0 API has been added. - [New]
PUT /dns/1.0/hosted-zones/{zone_id}/records/{recordset_id}- SetHostedZoneRecord 1.0 API has been added. - [New]
DELETE /dns/1.0/hosted-zones/{zone_id}/records/{recordset_id}- DeleteHostedZoneRecord 1.0 API has been added. - [New]
GET /dns/1.0/private-dns- ListPrivateDns 1.0 API has been added. - [New]
POST /dns/1.0/private-dns- CreatePrivateDns 1.0 API has been added. - [New]
GET /dns/1.0/private-dns/{private_dns_id}- ShowPrivateDns 1.0 API has been added. - [New]
PUT /dns/1.0/private-dns/{private_dns_id}- SetPrivateDns 1.0 API has been added. - [New]
DELETE /dns/1.0/private-dns/{private_dns_id}- DeletePrivateDns 1.0 API has been added. - [New]
POST /dns/1.0/private-dns/activate- ActivatePrivateDns 1.0 API has been added. - [New]
GET /dns/1.0/public-domain-names- ListPublicDomainNames 1.0 API has been added. - [New]
POST /dns/1.0/public-domain-names- CreatePublicDomainName 1.0 API has been added. - [New]
GET /dns/1.0/public-domain-names/{public_domain_id}- ShowPublicDomainName 1.0 API has been added. - [New]
PUT /dns/1.0/public-domain-names/{public_domain_id}- SetPublicDomainName 1.0 API has been added. - [New]
PUT /dns/1.0/public-domain-names/{public_domain_id}/information- SetPublicDomainNameWhoisInfo 1.0 API has been added. - [New]
POST /dns/1.0/public-domain-names/{public_domain_id}/renew- RenewPublicDomainName 1.0 API has been added.
3.1 - APIs
3.1.1 - Activate Private DNS
3.1.1.1 - 1.3
post /v1/private-dns/activate
Description
Activate Private DNS
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = dns 1.3"
Request body
{
"name": "private-dns01"
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "authdns-a1b2c3d4e5f6789012345678abcdef90",
"connected_vpc_ids": [
"1234567890abcdef1234567890abcdef",
"fedcba0987654321fedcba0987654321"
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "fedcba9876543210fedcba9876543210",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "12345678-90ab-cdef-1234-567890abcdef",
"pool_name": "private01-a1b2c3d4e5f6789012345678abcdef90",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "resolver-a1b2c3d4e5f6789012345678abcdef90",
"state": "ACTIVE"
}
}
3.1.2 - Create Hosted Zone
3.1.2.1 - 1.3
post /v1/hosted-zones
Description
Create a hosted zone that contains DNS records for managing domain name resolution.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = dns 1.3"
Request body
{
"description": "This is description",
"name": "my-zone.com",
"private_dns_id": "fedcba9876543210fedcba9876543210",
"tags": [],
"type": "private"
}
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": "12345678-90ab-cdef-1234-567890abcdef",
"private_dns_id": "fedcba9876543210fedcba9876543210",
"private_dns_name": "private-dns01",
"status": "CREATING",
"ttl": 3600
}
3.1.3 - Create Hosted Zone Record
3.1.3.1 - 1.3
post /v1/hosted-zones/{hosted_zone_id}/records
Description
Create a DNS record resource for managing domain name resolution.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | hosted_zone_id required | The unique identifier of the hosted zone. Example : 3432012nfdksdf03ktrld9234lgfg | string | None |
| body | body required | RecordCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | RecordCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
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 = en-US",
"Scp-Api-Version = dns 1.3"
Request body
{
"description": "This is description",
"name": "test.app",
"records": [
"12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
],
"ttl": 3600,
"type": "A"
}
Example HTTP response
Response 202
{
"action": "CREATE",
"created_at": "2025-09-08T03:43:57Z",
"description": "This is description",
"id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
"links": "",
"name": "test.app",
"project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
"records": [
"12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
],
"status": "ACTIVE",
"ttl": 3600,
"type": "A",
"updated_at": "2026-02-09T08:00:40Z",
"version": 1,
"zone_id": "3432012nfdksdf03ktrld9234lgfg",
"zone_name": "my-zone.com"
}
3.1.4 - Create Private DNS
3.1.4.1 - 1.3
post /v1/private-dns
Description
Create a private DNS instance for managing internal DNS resolution.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = dns 1.3"
Request body
{
"connected_vpc_ids": [
"1234567890abcdef1234567890abcdef",
"fedcba0987654321fedcba0987654321"
],
"description": "This is description",
"name": "private-dns01",
"tags": [
{
"key": "env",
"value": "prod"
}
]
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "authdns-a1b2c3d4e5f6789012345678abcdef90",
"connected_vpc_ids": [
"1234567890abcdef1234567890abcdef",
"fedcba0987654321fedcba0987654321"
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "fedcba9876543210fedcba9876543210",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "12345678-90ab-cdef-1234-567890abcdef",
"pool_name": "private01-a1b2c3d4e5f6789012345678abcdef90",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "resolver-a1b2c3d4e5f6789012345678abcdef90",
"state": "ACTIVE"
}
}
3.1.5 - Create Public Domain Name
3.1.5.1 - 1.3
post /v1/public-domain-names
Description
Create a public domain name registration resource.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CreatePublicDomainRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | CreatePublicDomainResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
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 = en-US",
"Scp-Api-Version = dns 1.3"
Request body
{
"address_type": "",
"auto_extension": true,
"description": "This is description",
"domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
"domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
"domestic_second_address_en": "West Campus 1F",
"domestic_second_address_ko": "서관 1층",
"name": "example.com",
"overseas_first_address": "123 Main St",
"overseas_second_address": "New York",
"overseas_third_address": "NY 10001",
"postal_code": "12345",
"register_email": "admin@example.com",
"register_name_en": "Hong Gildong",
"register_name_ko": "홍길동",
"register_telno": "",
"tags": [
{
"key": "env",
"value": "prod"
}
]
}
Example HTTP response
Response 201
{
"public_domain_name": {
"address_type": "DOMESTIC",
"auto_extension": true,
"created_at": "2025-09-08T03:43:57Z",
"created_by": "504f24f8111e42e0578f367acd2a149f",
"description": "This is description",
"domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
"domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
"domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
"domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
"domestic_second_address_en": "West Campus 1F",
"domestic_second_address_ko": "서관 1층",
"expired_date": "2026-09-09T00:00:00Z",
"id": "10fjkeweffpublicdomain3193rud543",
"modified_at": "2026-02-09T08:00:40Z",
"modified_by": "504f24f8111e42e0578f367acd2a149f",
"name": "example.com",
"overseas_address": "123 Main St, New York, NY 10001",
"overseas_first_address": "123 Main St",
"overseas_second_address": "New York",
"overseas_third_address": "NY 10001",
"postal_code": "12345",
"register_email": "admin@example.com",
"register_name_en": "Hong Gildong",
"register_name_ko": "홍길동",
"register_telno": "",
"start_date": "2025-09-09T00:00:00Z",
"status": "REGISTERED"
}
}
3.1.6 - Delete Hosted Zone
3.1.6.1 - 1.3
delete /v1/hosted-zones/{hosted_zone_id}
Description
Delete the hosted zone.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | hosted_zone_id required | The unique identifier of the hosted zone. Example : 3432012nfdksdf03ktrld9234lgfg | 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/hosted-zones/{hosted_zone_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 202
3.1.7 - Delete Hosted Zone Record
3.1.7.1 - 1.3
delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Delete the DNS record resource.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | hosted_zone_id required | The identifier of the hosted zone that contains this DNS record. Example : 3432012nfdksdf03ktrld9234lgfg | string | None |
| path | record_id required | The unique identifier of the DNS record. Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | RecordCreateResponse |
| 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}/records/{record_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 202
{
"action": "CREATE",
"created_at": "2025-09-08T03:43:57Z",
"description": "This is description",
"id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
"links": "",
"name": "test.app",
"project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
"records": [
"12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
],
"status": "ACTIVE",
"ttl": 3600,
"type": "A",
"updated_at": "2026-02-09T08:00:40Z",
"version": 1,
"zone_id": "3432012nfdksdf03ktrld9234lgfg",
"zone_name": "my-zone.com"
}
3.1.8 - Delete Private DNS
3.1.8.1 - 1.3
delete /v1/private-dns/{private_dns_id}
Description
Delete the private DNS instance.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_dns_id required | The unique identifier of the private DNS. Example : fedcba9876543210fedcba9876543210 | 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 = en-US",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 202
3.1.9 - List Hosted Zone Records
3.1.9.1 - 1.3
get /v1/hosted-zones/{hosted_zone_id}/records
Description
Provides a list of DNS records.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | hosted_zone_id required | The unique identifier of the hosted zone. Example : 3432012nfdksdf03ktrld9234lgfg | string | None |
| query | limit optional | The maximum number of items to return. Example : | any of [integer, null] | None |
| query | marker optional | The last record ID of the previous page. Example : | any of [string, null] | None |
| query | sort_dir optional | The sort direction for the list (ASC or DESC). Example : | any of [string, null] | None |
| query | sort_key optional | The field to sort by. Example : | any of [string, null] | None |
| query | name optional | The name of the DNS record. Example : test.app | any of [string, null] | None |
| query | exact_name optional | The name of the DNS record. Example : test.app | any of [string, null] | None |
| query | type optional | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). Example : A | any of [string, null] | None |
| query | data optional | The data to filter DNS records by. Example : 12345.ns.private.kr-west1.dev2.samsungsdscloud.com | any of [string, null] | None |
| query | status optional | The current status of the DNS record. Example : ACTIVE | any of [string, null] | None |
| query | description optional | Description Example : This is description | any of [string, null] | None |
| query | ttl optional | The Time-To-Live (TTL) value in seconds for the DNS record. Example : 3600 | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RecordListResponse |
| 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}/records
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"count": 20,
"links": "",
"metadata": "",
"records": [
{
"action": "CREATE",
"created_at": "2025-09-08T03:43:57Z",
"description": "This is description",
"id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
"links": "",
"name": "test.app",
"project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
"records": [
"12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
],
"status": "ACTIVE",
"ttl": 3600,
"type": "A",
"updated_at": "2026-02-09T08:00:40Z",
"version": 1,
"zone_id": "3432012nfdksdf03ktrld9234lgfg",
"zone_name": "my-zone.com"
}
]
}
3.1.10 - List Hosted Zones
3.1.10.1 - 1.3
get /v1/hosted-zones
Description
Provides a list of hosted zones.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | The domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone. Example : my-zone.com | any of [string, null] | None |
| query | type optional | The type of the hosted zone (e.g., public or private). Example : | any of [enum (public, private), null] | None |
| query | status optional | The current status of the hosted zone (e.g., ACTIVE, CREATING, DELETING). 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 = en-US",
"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": "12345678-90ab-cdef-1234-567890abcdef",
"private_dns_id": "fedcba9876543210fedcba9876543210",
"private_dns_name": "private-dns01",
"status": "CREATING",
"ttl": 3600
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.11 - List Private DNS
3.1.11.1 - 1.3
get /v1/private-dns
Description
Provides a list of private DNS instances.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | The unique identifier of the private DNS. Example : fedcba9876543210fedcba9876543210 | any of [string, null] | None |
| query | name optional | The name of the private DNS. Example : private-dns01 | any of [string, null] | None |
| query | vpc_id optional | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR, PENDING), 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 = en-US",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"private_dns": [
{
"auth_dns_name": "authdns-a1b2c3d4e5f6789012345678abcdef90",
"connected_vpc_ids": [
"1234567890abcdef1234567890abcdef",
"fedcba0987654321fedcba0987654321"
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "fedcba9876543210fedcba9876543210",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "12345678-90ab-cdef-1234-567890abcdef",
"pool_name": "private01-a1b2c3d4e5f6789012345678abcdef90",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "resolver-a1b2c3d4e5f6789012345678abcdef90",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.12 - List Public Domain Names
3.1.12.1 - 1.3
get /v1/public-domain-names
Description
Provides a list of public domain names.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | The name of the public domain name. Example : example.com | any of [string, null] | None |
| query | created_by optional | The user id that created the resource. Example : 504f24f8111e42e0578f367acd2a149f | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PublicDomainListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
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 = en-US",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"public_domain_names": [
{
"created_at": "2025-09-08T03:43:57Z",
"created_by": "504f24f8111e42e0578f367acd2a149f",
"expired_date": "2026-09-09T00:00:00Z",
"id": "10fjkeweffpublicdomain3193rud543",
"modified_at": "2026-02-09T08:00:40Z",
"modified_by": "504f24f8111e42e0578f367acd2a149f",
"name": "example.com",
"register_email": "admin@example.com",
"start_date": "2025-09-09T00:00:00Z",
"status": "REGISTERED"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.13 - Set Hosted Zone
3.1.13.1 - 1.3
put /v1/hosted-zones/{hosted_zone_id}
Description
Update the hosted zone.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | hosted_zone_id required | The unique identifier of the hosted zone. Example : 3432012nfdksdf03ktrld9234lgfg | 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 = en-US",
"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": "12345678-90ab-cdef-1234-567890abcdef",
"private_dns_id": "fedcba9876543210fedcba9876543210",
"private_dns_name": "private-dns01",
"status": "CREATING",
"ttl": 3600
}
3.1.14 - Set Hosted Zone Record
3.1.14.1 - 1.3
put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Update the DNS record values.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | hosted_zone_id required | The identifier of the hosted zone that contains this DNS record. Example : 3432012nfdksdf03ktrld9234lgfg | string | None |
| path | record_id required | The unique identifier of the DNS record. Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 | string | None |
| body | body required | RecordSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | RecordSetResponse |
| 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}/records/{record_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"
Request body
{
"records": [
"12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
],
"ttl": 3600
}
Example HTTP response
Response 202
{
"action": "CREATE",
"created_at": "2025-09-08T03:43:57Z",
"description": "This is description",
"id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
"links": "",
"name": "test.app",
"project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
"records": [
"12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
],
"status": "ACTIVE",
"ttl": 3600,
"type": "A",
"updated_at": "2026-02-09T08:00:40Z",
"version": 1,
"zone_id": "3432012nfdksdf03ktrld9234lgfg",
"zone_name": "my-zone.com"
}
3.1.15 - Set Private DNS
3.1.15.1 - 1.3
put /v1/private-dns/{private_dns_id}
Description
Update the private DNS connected VPC List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_dns_id required | The unique identifier of the private DNS. Example : fedcba9876543210fedcba9876543210 | 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 = en-US",
"Scp-Api-Version = dns 1.3"
Request body
{
"connected_vpc_ids": [
"1234567890abcdef1234567890abcdef",
"fedcba0987654321fedcba0987654321"
],
"description": "This is description"
}
Example HTTP response
Response 202
{
"private_dns": {
"auth_dns_name": "authdns-a1b2c3d4e5f6789012345678abcdef90",
"connected_vpc_ids": [
"1234567890abcdef1234567890abcdef",
"fedcba0987654321fedcba0987654321"
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "fedcba9876543210fedcba9876543210",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "12345678-90ab-cdef-1234-567890abcdef",
"pool_name": "private01-a1b2c3d4e5f6789012345678abcdef90",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "resolver-a1b2c3d4e5f6789012345678abcdef90",
"state": "ACTIVE"
}
}
3.1.16 - Set Public Domain Name
3.1.16.1 - 1.3
put /v1/public-domain-names/{public_domain_id}
Description
Update the public domain name.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | public_domain_id required | The unique identifier of the public domain name. Example : 10fjkeweffpublicdomain3193rud543 | 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 = en-US",
"Scp-Api-Version = dns 1.3"
Request body
{
"auto_extension": true,
"description": "This is description"
}
Example HTTP response
Response 200
{
"auto_extension": true,
"description": "This is description",
"id": "10fjkeweffpublicdomain3193rud543"
}
3.1.17 - Set Public Domain Name Whois Info
3.1.17.1 - 1.3
put /v1/public-domain-names/{public_domain_id}/information
Description
Update Public Domain Name Whois Info
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | public_domain_id required | The unique identifier of the public domain name. Example : 10fjkeweffpublicdomain3193rud543 | string | None |
| body | body required | PubblicDomainWhoisInfoUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PublicDomainWhoisInfoUpdateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 500 | Internal Server Error | None |
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 = en-US",
"Scp-Api-Version = dns 1.3"
Request body
{
"address_type": "",
"domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
"domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
"domestic_second_address_en": "West Campus 1F",
"domestic_second_address_ko": "서관 1층",
"overseas_first_address": "123 Main St",
"overseas_second_address": "New York",
"overseas_third_address": "NY 10001",
"postal_code": "12345",
"register_email": "admin@example.com",
"register_telno": ""
}
Example HTTP response
Response 200
{
"address_type": "",
"domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
"domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
"domestic_second_address_en": "West Campus 1F",
"domestic_second_address_ko": "서관 1층",
"name": "example.com",
"overseas_first_address": "123 Main St",
"overseas_second_address": "New York",
"overseas_third_address": "NY 10001",
"postal_code": "12345",
"register_email": "admin@example.com",
"register_name_en": "Hong Gildong",
"register_name_ko": "홍길동",
"register_telno": ""
}
3.1.18 - Show Hosted Zone
3.1.18.1 - 1.3
get /v1/hosted-zones/{hosted_zone_id}
Description
Provides details about a specific hosted zone.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | hosted_zone_id required | The unique identifier of the hosted zone. Example : 3432012nfdksdf03ktrld9234lgfg | 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 = en-US",
"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": "12345678-90ab-cdef-1234-567890abcdef",
"private_dns_id": "fedcba9876543210fedcba9876543210",
"private_dns_name": "private-dns01",
"status": "CREATING",
"ttl": 3600
}
3.1.19 - Show Hosted Zone Record
3.1.19.1 - 1.3
get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}
Description
Provides details about a specific DNS record.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | hosted_zone_id required | The identifier of the hosted zone that contains this DNS record. Example : 3432012nfdksdf03ktrld9234lgfg | string | None |
| path | record_id required | The unique identifier of the DNS record. Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RecordShowResponse |
| 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}/records/{record_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"action": "CREATE",
"created_at": "2025-09-08T03:43:57Z",
"description": "This is description",
"id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
"links": "",
"name": "test.app",
"project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
"records": [
"12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
],
"status": "ACTIVE",
"ttl": 3600,
"type": "A",
"updated_at": "2026-02-09T08:00:40Z",
"version": 1,
"zone_id": "3432012nfdksdf03ktrld9234lgfg",
"zone_name": "my-zone.com"
}
3.1.20 - Show Private DNS
3.1.20.1 - 1.3
get /v1/private-dns/{private_dns_id}
Description
Provides details about a specific private DNS.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_dns_id required | The unique identifier of the private DNS. Example : fedcba9876543210fedcba9876543210 | 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 = en-US",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"private_dns": {
"auth_dns_name": "authdns-a1b2c3d4e5f6789012345678abcdef90",
"connected_vpc_ids": [
"1234567890abcdef1234567890abcdef",
"fedcba0987654321fedcba0987654321"
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"id": "fedcba9876543210fedcba9876543210",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "private-dns01",
"pool_id": "12345678-90ab-cdef-1234-567890abcdef",
"pool_name": "private01-a1b2c3d4e5f6789012345678abcdef90",
"registered_region": "KR-WEST1",
"resolver_ip": "198.19.0.101",
"resolver_name": "resolver-a1b2c3d4e5f6789012345678abcdef90",
"state": "ACTIVE"
}
}
3.1.21 - Show Public Domain Name
3.1.21.1 - 1.3
get /v1/public-domain-names/{public_domain_id}
Description
Provides details about a specific public domain name.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | public_domain_id required | The unique identifier of the public domain name. Example : 10fjkeweffpublicdomain3193rud543 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PublicDomainDetailResponse |
| 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 = en-US",
"Scp-Api-Version = dns 1.3"
Example HTTP response
Response 200
{
"public_domain_name": {
"address_type": "DOMESTIC",
"auto_extension": true,
"created_at": "2025-09-08T03:43:57Z",
"created_by": "504f24f8111e42e0578f367acd2a149f",
"description": "This is description",
"domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
"domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
"domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
"domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
"domestic_second_address_en": "West Campus 1F",
"domestic_second_address_ko": "서관 1층",
"expired_date": "2026-09-09T00:00:00Z",
"id": "10fjkeweffpublicdomain3193rud543",
"modified_at": "2026-02-09T08:00:40Z",
"modified_by": "504f24f8111e42e0578f367acd2a149f",
"name": "example.com",
"overseas_address": "123 Main St, New York, NY 10001",
"overseas_first_address": "123 Main St",
"overseas_second_address": "New York",
"overseas_third_address": "NY 10001",
"postal_code": "12345",
"register_email": "admin@example.com",
"register_name_en": "Hong Gildong",
"register_name_ko": "홍길동",
"register_telno": "",
"start_date": "2025-09-09T00:00:00Z",
"status": "REGISTERED"
}
}
3.1.22 - Transfer Public Domain Name
3.1.22.1 - 1.3
post /v1/public-domain-names/{public_domain_id}/transfer
Description
Transfer The Public Domain Name to other Account
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | public_domain_id required | The unique identifier of the public domain name. Example : 10fjkeweffpublicdomain3193rud543 | string | None |
| body | body required | PublicDomainTransferRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PublicDomainTransferResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
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 = en-US",
"Scp-Api-Version = dns 1.3"
Request body
{
"target_account_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
"type": "REQUEST"
}
Example HTTP response
Response 200
{
"auto_extension": true,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "This is description",
"expired_date": "2026-09-09T00:00:00Z",
"id": "10fjkeweffpublicdomain3193rud543",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "example.com",
"start_date": "2025-09-09T00:00:00Z",
"state": "TRANSFER_REQUESTED"
}
3.2 - Models
3.2.1 - CreatePublicDomainRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| address_type required | The type of address for the domain registration. Example : | string | |
| auto_extension optional | Indicates whether automatic extension is enabled for the domain. Example : True | any of [boolean, null] | True |
| description optional | Description Example : This is description | any of [string, null] | |
| domestic_first_address_en required | The first line of domestic address in English. Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul | string | |
| domestic_first_address_ko required | The first line of domestic address in Korean. Example : 서울특별시 송파구 올림픽로35길 125 (신천동) | string | |
| domestic_second_address_en required | The second line of domestic address in English. Example : West Campus 1F | any of [string, null] | |
| domestic_second_address_ko required | The second line of domestic address in Korean. Example : 서관 1층Maximum length : 16 | string | |
| name required | The name of the public domain name. Example : example.comMinimum length : 2Maximum length : 63 | string | |
| overseas_first_address required | The first line of overseas address. Example : 123 Main St | any of [string, null] | |
| overseas_second_address required | The second line of overseas address. Example : New York | any of [string, null] | |
| overseas_third_address required | The third line of overseas address. Example : NY 10001 | any of [string, null] | |
| postal_code required | The postal code for the domain registration. Example : 12345Maximum length : 6 | string | |
| register_email required | The email address of the domain registrant. Example : admin@example.comPattern : ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$Minimum length : 6Maximum length : 64 | string | |
| register_name_en required | The name of the domain registrant in English. Example : Hong GildongMinimum length : 1Maximum length : 30 | string | |
| register_name_ko required | The name of the domain registrant in Korean. Example : 홍길동Minimum length : 1Maximum length : 30 | string | |
| register_telno required | The telephone number of the domain registrant. Example : | string | |
| tags optional | Tag List Example : [{'key': 'env', 'value': 'prod'}] | array[Tag] |
3.2.2 - CreatePublicDomainResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| public_domain_name required | PublicDomainDetail |
3.2.3 - HostedZoneCreateRequestV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : This is description | any of [string, null] | |
| name required | The domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone. Example : my-zone.comMinimum length : 2Maximum length : 69 | string | |
| private_dns_id optional | The DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. Example : fedcba9876543210fedcba9876543210 | any of [string, null] | |
| tags optional | Tag List | array[Tag] | |
| type required | The type of the hosted zone (e.g., public or private). Example : private | enum (public, private) |
3.2.4 - HostedZoneListResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
3.2.5 - HostedZoneSetRequestV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : This is description | any of [string, null] |
3.2.6 - HostedZoneShowResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | The type of the hosted zone (e.g., public or private). Example : public | enum (public, private) | |
| id required | The unique identifier of the hosted zone. 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 | The domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone. Example : my-zone.com | string | |
| pool_id required | The resource pool identifier associated with the hosted zone. Example : 12345678-90ab-cdef-1234-567890abcdef | string | |
| private_dns_id optional | The DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. Example : fedcba9876543210fedcba9876543210 | any of [string, null] | |
| private_dns_name optional | The DNS server name for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. Example : private-dns01 | any of [string, null] | |
| status required | State Example : CREATING | enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN) | |
| ttl optional | The Time-To-Live (TTL) value in seconds for DNS records in this zone. Example : 3600 | any of [integer, null] |
3.2.7 - HostedZoneV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | The type of the hosted zone (e.g., public or private). Example : public | enum (public, private) | |
| id required | The unique identifier of the hosted zone. 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 | The domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone. Example : my-zone.com | string | |
| pool_id required | The resource pool identifier associated with the hosted zone. Example : 12345678-90ab-cdef-1234-567890abcdef | string | |
| private_dns_id optional | The DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. Example : fedcba9876543210fedcba9876543210 | any of [string, null] | |
| private_dns_name optional | The DNS server name for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value. Example : private-dns01 | any of [string, null] | |
| status required | State Example : CREATING | enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN) | |
| ttl optional | The Time-To-Live (TTL) value in seconds for DNS records in this zone. Example : 3600 | any of [integer, null] |
3.2.8 - PrivateDns
| Name | Description | Schema | Default |
|---|---|---|---|
| auth_dns_name required | The authoritative DNS name of the private DNS. Example : authdns-a1b2c3d4e5f6789012345678abcdef90 | any of [string, null] | |
| connected_vpc_ids optional | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. Example : ['1234567890abcdef1234567890abcdef', 'fedcba0987654321fedcba0987654321'] | 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 | The unique identifier of the private DNS. Example : fedcba9876543210fedcba9876543210 | 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 | The name of the private DNS. Example : private-dns01 | string | |
| pool_id required | The resource pool identifier associated with the private DNS. Example : 12345678-90ab-cdef-1234-567890abcdef | any of [string, null] | |
| pool_name required | The name of the resource pool. Example : private01-a1b2c3d4e5f6789012345678abcdef90 | any of [string, null] | |
| registered_region required | The region where the private DNS is registered. Example : KR-WEST1 | any of [string, null] | |
| resolver_ip required | The IP address of the DNS resolver. Example : 198.19.0.101 | any of [string, null] | |
| resolver_name required | The name of the DNS resolver. Example : resolver-a1b2c3d4e5f6789012345678abcdef90 | any of [string, null] | |
| state required | State Example : ACTIVE | enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR, PENDING) |
3.2.9 - PrivateDnsActivateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | The name of the private DNS. Example : private-dns01Pattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string |
3.2.10 - PrivateDnsCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| connected_vpc_ids optional | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. Example : ['1234567890abcdef1234567890abcdef', 'fedcba0987654321fedcba0987654321'] | array[string] | |
| description optional | Description Example : This is description | any of [string, null] | |
| name required | The name of the private DNS. Example : private-dns01Pattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| tags optional | Tag List Example : [{'key': 'env', 'value': 'prod'}] | any of [array[Tag], null] |
3.2.11 - PrivateDnsListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
3.2.12 - PrivateDnsSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| connected_vpc_ids optional | The list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it. Example : ['1234567890abcdef1234567890abcdef', 'fedcba0987654321fedcba0987654321'] | any of [array[string], null] | |
| description optional | Description Example : This is description | any of [string, null] |
3.2.13 - PrivateDnsShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| private_dns required | PrivateDns |
3.2.14 - PubblicDomainWhoisInfoUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| address_type required | The type of address for the domain registration. Example : | string | |
| domestic_first_address_en required | The first line of domestic address in English. Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul | string | |
| domestic_first_address_ko required | The first line of domestic address in Korean. Example : 서울특별시 송파구 올림픽로35길 125 (신천동) | string | |
| domestic_second_address_en required | The second line of domestic address in English. Example : West Campus 1F | any of [string, null] | |
| domestic_second_address_ko required | The second line of domestic address in Korean. Example : 서관 1층Maximum length : 16 | string | |
| overseas_first_address required | The first line of overseas address. Example : 123 Main St | any of [string, null] | |
| overseas_second_address required | The second line of overseas address. Example : New York | any of [string, null] | |
| overseas_third_address required | The third line of overseas address. Example : NY 10001 | any of [string, null] | |
| postal_code required | The postal code for the domain registration. Example : 12345Maximum length : 6 | string | |
| register_email required | The email address of the domain registrant. Example : admin@example.comPattern : ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$Minimum length : 6Maximum length : 64 | string | |
| register_telno required | The telephone number of the domain registrant. Example : | string |
3.2.15 - PublicDomainDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| address_type required | The type of address for the domain registration. Example : DOMESTIC | string | |
| auto_extension required | Indicates whether automatic extension is enabled for the domain. Example : True | boolean | |
| created_at required | The timestamp when the resource was created, in ISO 8601 format. Example : 2025-09-08T03:43:57Z | string | |
| created_by required | The user id that created the resource. Example : 504f24f8111e42e0578f367acd2a149f | string | |
| description optional | Description Example : This is description | any of [string, null] | |
| domestic_address_en required | The domestic address in English for the domain registration. Example : West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul | string | |
| domestic_address_ko required | The domestic address in Korean for the domain registration. Example : 서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층 | string | |
| domestic_first_address_en required | The first line of domestic address in English. Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul | string | |
| domestic_first_address_ko required | The first line of domestic address in Korean. Example : 서울특별시 송파구 올림픽로35길 125 (신천동) | string | |
| domestic_second_address_en required | The second line of domestic address in English. Example : West Campus 1F | string | |
| domestic_second_address_ko required | The second line of domestic address in Korean. Example : 서관 1층 | string | |
| expired_date required | The expiration date of the domain registration. Example : 2026-09-09T00:00:00Z | string | |
| id required | The unique identifier of the public domain name. Example : 10fjkeweffpublicdomain3193rud543 | string | |
| modified_at required | The timestamp when the resource was last modified, in ISO 8601 format. Example : 2026-02-09T08:00:40Z | string | |
| modified_by required | The user id that last modified the resource. Example : 504f24f8111e42e0578f367acd2a149f | string | |
| name required | The name of the public domain name. Example : example.com | string | |
| overseas_address optional | The overseas address for the domain registration. Example : 123 Main St, New York, NY 10001 | string | |
| overseas_first_address required | The first line of overseas address. Example : 123 Main St | string | |
| overseas_second_address required | The second line of overseas address. Example : New York | string | |
| overseas_third_address required | The third line of overseas address. Example : NY 10001 | string | |
| postal_code required | The postal code for the domain registration. Example : 12345 | string | |
| register_email required | The email address of the domain registrant. Example : admin@example.com | string | |
| register_name_en required | The name of the domain registrant in English. Example : Hong Gildong | string | |
| register_name_ko required | The name of the domain registrant in Korean. Example : 홍길동 | string | |
| register_telno required | The telephone number of the domain registrant. Example : | string | |
| start_date required | The start date of the domain registration. Example : 2025-09-09T00:00:00Z | string | |
| status required | The current status of the public domain name. Example : REGISTERED | string |
3.2.16 - PublicDomainDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| public_domain_name required | PublicDomainDetail |
3.2.17 - PublicDomainListItem
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | The timestamp when the resource was created, in ISO 8601 format. Example : 2025-09-08T03:43:57Z | string | |
| created_by required | The user id that created the resource. Example : 504f24f8111e42e0578f367acd2a149f | string | |
| expired_date required | The expiration date of the domain registration. Example : 2026-09-09T00:00:00Z | string | |
| id required | The unique identifier of the public domain name. Example : 10fjkeweffpublicdomain3193rud543 | string | |
| modified_at required | The timestamp when the resource was last modified, in ISO 8601 format. Example : 2026-02-09T08:00:40Z | string | |
| modified_by required | The user id that last modified the resource. Example : 504f24f8111e42e0578f367acd2a149f | string | |
| name required | The name of the public domain name. Example : example.com | string | |
| register_email required | The email address of the domain registrant. Example : admin@example.com | string | |
| start_date required | The start date of the domain registration. Example : 2025-09-09T00:00:00Z | string | |
| status required | The current status of the public domain name. Example : REGISTERED | string |
3.2.18 - PublicDomainListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
3.2.19 - PublicDomainPartialUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| auto_extension optional | Indicates whether automatic extension is enabled for the domain. Example : True | any of [boolean, null] | |
| description optional | Description Example : This is description | any of [string, null] |
3.2.20 - PublicDomainPartialUpdateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| auto_extension optional | Indicates whether automatic extension is enabled for the domain. Example : True | any of [boolean, null] | |
| description optional | Description Example : This is description | any of [string, null] | |
| id required | The unique identifier of the public domain name. Example : 10fjkeweffpublicdomain3193rud543 | string |
3.2.21 - PublicDomainTransferRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| target_account_id optional | Target account id (required when type=REQUEST) Example : 003dffc50eb123a1cbf4f2e5c71d4f15 | any of [string, null] | |
| type required | Transfer operation type Example : REQUEST | enum (REQUEST, CANCEL, APPROVE, REJECT) |
3.2.22 - PublicDomainTransferResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| auto_extension required | Indicates whether automatic extension is enabled for the domain. Example : True | 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 : This is description | any of [string, null] | |
| expired_date required | The expiration date of the domain registration. Example : 2026-09-09T00:00:00Z | string (date-time) | |
| id required | The unique identifier of the public domain name. Example : 10fjkeweffpublicdomain3193rud543 | 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 | The name of the public domain name. Example : example.com | string | |
| start_date required | The start date of the domain registration. Example : 2025-09-09T00:00:00Z | string (date-time) | |
| state required | State Example : TRANSFER_REQUESTED | enum (CREATING, REGISTERED, EXPIRED, DELETED, TRANSFER_REQUESTING, TRANSFER_REQUESTED, DELETING) |
3.2.23 - PublicDomainWhoisInfoUpdateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| address_type required | The type of address for the domain registration. Example : | string | |
| domestic_first_address_en required | The first line of domestic address in English. Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul | string | |
| domestic_first_address_ko required | The first line of domestic address in Korean. Example : 서울특별시 송파구 올림픽로35길 125 (신천동) | string | |
| domestic_second_address_en required | The second line of domestic address in English. Example : West Campus 1F | any of [string, null] | |
| domestic_second_address_ko required | The second line of domestic address in Korean. Example : 서관 1층Maximum length : 16 | string | |
| name required | The name of the public domain name. Example : example.com | string | |
| overseas_first_address required | The first line of overseas address. Example : 123 Main St | any of [string, null] | |
| overseas_second_address required | The second line of overseas address. Example : New York | any of [string, null] | |
| overseas_third_address required | The third line of overseas address. Example : NY 10001 | any of [string, null] | |
| postal_code required | The postal code for the domain registration. Example : 12345Maximum length : 6 | string | |
| register_email required | The email address of the domain registrant. Example : admin@example.comPattern : ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$Minimum length : 6Maximum length : 64 | string | |
| register_name_en required | The name of the domain registrant in English. Example : Hong Gildong | string | |
| register_name_ko required | The name of the domain registrant in Korean. Example : 홍길동 | string | |
| register_telno required | The telephone number of the domain registrant. Example : | string |
3.2.24 - Record
| Name | Description | Schema | Default |
|---|---|---|---|
| action optional | The action performed on the DNS record. Example : CREATE | any of [string, null] | |
| created_at optional | The timestamp when the resource was created, in ISO 8601 format. Example : 2025-09-08T03:43:57Z | any of [string, null] | |
| description optional | Description Example : This is description | any of [string, null] | |
| id optional | The unique identifier of the DNS record. Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 | any of [string, null] | |
| links optional | The links related to the DNS record. Example : | any of [object, null] | |
| name optional | The name of the DNS record. Example : test.app | any of [string, null] | |
| project_id optional | The project identifier associated with the DNS record. Example : 003dffc50eb123a1cbf4f2e5c71d4f15 | any of [string, null] | |
| records optional | A list of data for this record Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com'] | any of [array[string], null] | |
| status optional | The current status of the DNS record. Example : ACTIVE | any of [string, null] | |
| ttl optional | The Time-To-Live (TTL) value in seconds for the DNS record. Example : 3600 | any of [integer, null] | |
| type optional | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). Example : A | any of [string, null] | |
| updated_at optional | The timestamp when the resource was last updated, in ISO 8601 format. Example : 2026-02-09T08:00:40Z | any of [string, null] | |
| version optional | The version of the DNS record. Example : 1 | any of [integer, null] | |
| zone_id optional | ID for the zone that contains this record Example : 3432012nfdksdf03ktrld9234lgfg | any of [string, null] | |
| zone_name optional | The name of the zone that contains this record Example : my-zone.com | any of [string, null] |
3.2.25 - RecordCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : This is description | any of [string, null] | |
| name required | The name of the DNS record. Example : test.appMinimum length : 1Maximum length : 253 | string | |
| records required | A list of data for this record Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com'] | array[object] | |
| ttl optional | The Time-To-Live (TTL) value in seconds for the DNS record. Example : 3600 | any of [integer, null] | |
| type required | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). Example : A | enum (A, AAAA, CNAME, TXT, SPF, MX) |
3.2.26 - RecordCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| action optional | The action performed on the DNS record. Example : CREATE | any of [string, null] | |
| created_at optional | The timestamp when the resource was created, in ISO 8601 format. Example : 2025-09-08T03:43:57Z | any of [string, null] | |
| description optional | Description Example : This is description | any of [string, null] | |
| id optional | The unique identifier of the DNS record. Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 | any of [string, null] | |
| links optional | The links related to the DNS record. Example : | any of [object, null] | |
| name optional | The name of the DNS record. Example : test.app | any of [string, null] | |
| project_id optional | The project identifier associated with the DNS record. Example : 003dffc50eb123a1cbf4f2e5c71d4f15 | any of [string, null] | |
| records optional | A list of data for this record Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com'] | any of [array[string], null] | |
| status optional | The current status of the DNS record. Example : ACTIVE | any of [string, null] | |
| ttl optional | The Time-To-Live (TTL) value in seconds for the DNS record. Example : 3600 | any of [integer, null] | |
| type optional | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). Example : A | any of [string, null] | |
| updated_at optional | The timestamp when the resource was last updated, in ISO 8601 format. Example : 2026-02-09T08:00:40Z | any of [string, null] | |
| version optional | The version of the DNS record. Example : 1 | any of [integer, null] | |
| zone_id optional | ID for the zone that contains this record Example : 3432012nfdksdf03ktrld9234lgfg | any of [string, null] | |
| zone_name optional | The name of the zone that contains this record Example : my-zone.com | any of [string, null] |
3.2.27 - RecordListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | total count Example : 20 | any of [integer, null] | |
| links optional | The links related to the DNS record. Example : | any of [object, null] | |
| metadata optional | Total Count Example : | any of [object, null] | |
| records required | Record list | array[Record] |
3.2.28 - RecordSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| records optional | A list of data for this record Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com'] | any of [array[object], null] | |
| ttl optional | The Time-To-Live (TTL) value in seconds for the DNS record. Example : 3600 | any of [integer, null] |
3.2.29 - RecordSetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| action optional | The action performed on the DNS record. Example : CREATE | any of [string, null] | |
| created_at optional | The timestamp when the resource was created, in ISO 8601 format. Example : 2025-09-08T03:43:57Z | any of [string, null] | |
| description optional | Description Example : This is description | any of [string, null] | |
| id optional | The unique identifier of the DNS record. Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 | any of [string, null] | |
| links optional | The links related to the DNS record. Example : | any of [object, null] | |
| name optional | The name of the DNS record. Example : test.app | any of [string, null] | |
| project_id optional | The project identifier associated with the DNS record. Example : 003dffc50eb123a1cbf4f2e5c71d4f15 | any of [string, null] | |
| records optional | A list of data for this record Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com'] | any of [array[string], null] | |
| status optional | The current status of the DNS record. Example : ACTIVE | any of [string, null] | |
| ttl optional | The Time-To-Live (TTL) value in seconds for the DNS record. Example : 3600 | any of [integer, null] | |
| type optional | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). Example : A | any of [string, null] | |
| updated_at optional | The timestamp when the resource was last updated, in ISO 8601 format. Example : 2026-02-09T08:00:40Z | any of [string, null] | |
| version optional | The version of the DNS record. Example : 1 | any of [integer, null] | |
| zone_id optional | ID for the zone that contains this record Example : 3432012nfdksdf03ktrld9234lgfg | any of [string, null] | |
| zone_name optional | The name of the zone that contains this record Example : my-zone.com | any of [string, null] |
3.2.30 - RecordShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| action optional | The action performed on the DNS record. Example : CREATE | any of [string, null] | |
| created_at optional | The timestamp when the resource was created, in ISO 8601 format. Example : 2025-09-08T03:43:57Z | any of [string, null] | |
| description optional | Description Example : This is description | any of [string, null] | |
| id optional | The unique identifier of the DNS record. Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 | any of [string, null] | |
| links optional | The links related to the DNS record. Example : | any of [object, null] | |
| name optional | The name of the DNS record. Example : test.app | any of [string, null] | |
| project_id optional | The project identifier associated with the DNS record. Example : 003dffc50eb123a1cbf4f2e5c71d4f15 | any of [string, null] | |
| records optional | A list of data for this record Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com'] | any of [array[string], null] | |
| status optional | The current status of the DNS record. Example : ACTIVE | any of [string, null] | |
| ttl optional | The Time-To-Live (TTL) value in seconds for the DNS record. Example : 3600 | any of [integer, null] | |
| type optional | The type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF). Example : A | any of [string, null] | |
| updated_at optional | The timestamp when the resource was last updated, in ISO 8601 format. Example : 2026-02-09T08:00:40Z | any of [string, null] | |
| version optional | The version of the DNS record. Example : 1 | any of [integer, null] | |
| zone_id optional | ID for the zone that contains this record Example : 3432012nfdksdf03ktrld9234lgfg | any of [string, null] | |
| zone_name optional | The name of the zone that contains this record Example : my-zone.com | any of [string, null] |
3.2.31 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |
4 - Firewall
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP. This guide provides a brief description of Firewall service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | SUPPORTED | 20270131 |
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 |
API Version History
1.1
Firewall API version 1.1 has been released.
Changes
- [Changed]
GET /v1/firewalls- List Firewalls API has been changed.- Response model has been changed to FirewallListResponseV1Dot1.
- The following fields have been added to the response.
zone_resources
- The following fields have been removed from the response.
fw_resource_id
- The following fields have been added to the response.
- Response model has been changed to FirewallListResponseV1Dot1.
- [Changed]
GET /v1/firewalls/{firewall_id}- Show Firewall API has been changed.- Response model has been changed to FirewallShowResponseV1Dot1.
- The following fields have been added to the response.
zone_resources
- The following fields have been removed from the response.
fw_resource_id
- The following fields have been added to the response.
- Response model has been changed to FirewallShowResponseV1Dot1.
- [Changed]
PUT /v1/firewalls/{firewall_id}- Set Firewall API has been changed.- Response model has been changed to FirewallShowResponseV1Dot1.
- The following fields have been added to the response.
zone_resources
- The following fields have been removed from the response.
fw_resource_id
- The following fields have been added to the response.
- Response model has been changed to FirewallShowResponseV1Dot1.
- [Changed]
GET /v1/firewalls/rules- List Firewall Rules API has been changed.- The following query parameter has been removed from the request.
fetch_all
- Response model has been changed to FirewallRuleListResponseV1Dot1.
- The following fields have been removed from the response.
destination_interface,name,source_interface,vendor_rule_id
- The following fields have been removed from the response.
- The following query parameter has been removed from the request.
- [Changed]
GET /v1/firewalls/rules/{firewall_rule_id}- Show Firewall Rule API has been changed.- Response model has been changed to FirewallRuleShowResponseV1Dot1.
- The following fields have been removed from the response.
destination_interface,name,source_interface,vendor_rule_id
- The following fields have been removed from the response.
- Response model has been changed to FirewallRuleShowResponseV1Dot1.
- [Changed]
POST /v1/firewalls/rules- Create Firewall Rule API has been changed.- Changed to asynchronous processing.
- Response code has been changed from
201 Createdto202 Accepted, and response body is not returned. - Request model has been changed to FirewallRuleCreateSingleRequest.
- The following fields have been removed from the request.
destination_interface,name,source_interface
- The following fields have been removed from the request.
- [Changed]
PUT /v1/firewalls/rules/{firewall_rule_id}- Set Firewall Rule API has been changed.- Changed to asynchronous processing.
- Response code has been changed from
200 OKto202 Accepted, and response body is not returned. - Request model has been changed to FirewallRuleUpdateSingleRequest.
- The following fields have been added to the request.
order_direction,order_rule_id,status
- The following fields have been added to the request.
- [Changed]
DELETE /v1/firewalls/rules/{firewall_rule_id}- Delete Firewall Rule API has been changed.- Changed to asynchronous processing.
- Response code has been changed from
204 No Contentto202 Accepted.
1.0
Firewall API has been released.
Changes
- [New]
GET /v1/firewalls- API has been added. - [New]
GET /v1/firewalls/{firewall_id}- API has been added. - [New]
PUT /v1/firewalls/{firewall_id}- API has been added. - [New]
GET /v1/firewalls/rules- API has been added. - [New]
POST /v1/firewalls/rules- API has been added. - [New]
GET /v1/firewalls/rules/{firewall_rule_id}- API has been added. - [New]
PUT /v1/firewalls/rules/{firewall_rule_id}- API has been added. - [New]
DELETE /v1/firewalls/rules/{firewall_rule_id}- API has been added.
4.1 - APIs
4.1.1 - Create Firewall Rule
4.1.1.1 - 1.1
post /v1/firewalls/rules
Description
Create firewall rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | FirewallRuleCreateSingleRequest |
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/firewalls/rules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"
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 202
4.1.1.2 - 1.0
post /v1/firewalls/rules
Description
Create firewall rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"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"
}
}
4.1.2 - Delete Firewall Rule
4.1.2.1 - 1.1
delete /v1/firewalls/rules/{firewall_rule_id}
Description
Delete firewall rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | firewall_rule_id required | Firewall Rule ID Example : b156740b6335468d8354eb9ef8eddf5a | 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/firewalls/rules/{firewall_rule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"
Example HTTP response
Response 202
4.1.2.2 - 1.0
delete /v1/firewalls/rules/{firewall_rule_id}
Description
Delete firewall rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"Scp-Api-Version = firewall 1.0"
Example HTTP response
Response 204
4.1.3 - List Firewall Rules
4.1.3.1 - 1.1
get /v1/firewalls/rules
Description
Get firewall rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | firewall_id required | Firewall ID Example : b156740b6335468d8354eb9ef8eddf5a | string | None |
| query | src_ip optional | Source IP Example : 192.168.1.1 | string | None |
| query | dst_ip optional | Destination IP Example : 192.168.1.1 | string | None |
| query | description optional | Firewall Rule Description Example : Firewall rule description example | string | None |
| query | state optional | Firewall Rule State | array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)] | [] |
| query | status optional | Firewall Rule Status Example : | enum (ENABLE, DISABLE) | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FirewallRuleListResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = firewall 1.1"
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"
],
"direction": "INBOUND",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "b156740b6335468d8354eb9ef8eddf5a",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"sequence": 100,
"service": [
{
"service_type": "TCP",
"service_value": "443"
}
],
"source_address": [
"192.168.1.1",
"192.168.1.2"
],
"state": "CREATING",
"status": "ENABLE"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.3.2 - 1.0
get /v1/firewalls/rules
Description
Get firewall rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 | Source IP Example : 192.168.1.1 | string | None |
| query | dst_ip optional | Destination IP Example : 192.168.1.1 | string | None |
| query | description optional | Firewall Rule Description Example : Firewall rule description example | string | None |
| query | state optional | Firewall Rule State | array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)] | [] |
| query | status optional | Firewall Rule Status Example : | enum (ENABLE, DISABLE) | None |
| query | fetch_all optional | Firewall Rule Fetch ALL 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 = en-US",
"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"
]
}
4.1.4 - List Firewalls
4.1.4.1 - 1.1
get /v1/firewalls
Description
Get firewall list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | Firewall Name Example : FW_IGW_secuVPC | string | None |
| query | vpc_name optional | VPC Name Example : secuVPC | string | None |
| query | product_type optional | Firewall Product Type | array[enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)] | [] |
| query | state optional | Firewall State | array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)] | [] |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FirewallListResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = firewall 1.1"
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,
"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",
"zone_resources": [
{
"allocate_state": "SUCCESS",
"fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
"zone": "kr-west1-a"
}
]
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.4.2 - 1.0
get /v1/firewalls
Description
Get firewall list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 Name Example : FW_IGW_secuVPC | string | None |
| query | vpc_name optional | VPC Name Example : secuVPC | string | None |
| query | product_type optional | Firewall Product Type | array[enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)] | [] |
| query | state optional | Firewall State | 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 = en-US",
"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"
]
}
4.1.5 - Set Firewall
4.1.5.1 - 1.1
put /v1/firewalls/{firewall_id}
Description
Set firewall.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 | FirewallShowResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = firewall 1.1"
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,
"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",
"zone_resources": [
{
"allocate_state": "SUCCESS",
"fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
"zone": "kr-west1-a"
}
]
}
}
4.1.5.2 - 1.0
put /v1/firewalls/{firewall_id}
Description
Set firewall.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"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"
}
}
4.1.6 - Set Firewall Rule
4.1.6.1 - 1.1
put /v1/firewalls/rules/{firewall_rule_id}
Description
Set firewall rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | firewall_rule_id required | Firewall Rule ID Example : b156740b6335468d8354eb9ef8eddf5a | string | None |
| body | body required | FirewallRuleUpdateSingleRequest |
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/firewalls/rules/{firewall_rule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"
Request body
{
"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 202
4.1.6.2 - 1.0
put /v1/firewalls/rules/{firewall_rule_id}
Description
Set firewall rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"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"
}
}
4.1.7 - Show Firewall
4.1.7.1 - 1.1
get /v1/firewalls/{firewall_id}
Description
Show firewall.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | firewall_id required | Firewall ID Example : b156740b6335468d8354eb9ef8eddf5a | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | FirewallShowResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = firewall 1.1"
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,
"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",
"zone_resources": [
{
"allocate_state": "SUCCESS",
"fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
"zone": "kr-west1-a"
}
]
}
}
4.1.7.2 - 1.0
get /v1/firewalls/{firewall_id}
Description
Show firewall.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"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"
}
}
4.1.8 - Show Firewall Rule
4.1.8.1 - 1.1
get /v1/firewalls/rules/{firewall_rule_id}
Description
Show firewall rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 | FirewallRuleShowResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = firewall 1.1"
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"
],
"direction": "INBOUND",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "b156740b6335468d8354eb9ef8eddf5a",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"sequence": 100,
"service": [
{
"service_type": "TCP",
"service_value": "443"
}
],
"source_address": [
"192.168.1.1",
"192.168.1.2"
],
"state": "CREATING",
"status": "ENABLE"
}
}
4.1.8.2 - 1.0
get /v1/firewalls/rules/{firewall_rule_id}
Description
Show firewall rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"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"
}
}
4.2 - Models
4.2.1 - Firewall
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| flavor_name optional | Firewall Size Name Example : SMALL | string | |
| flavor_rule_quota optional | Firewall Rule Quota Example : 100 | integer | |
| fw_resource_id required | Fw Resource ID Example : 005fd1d30dea11f08a2c56773bef875b | string | |
| id required | Firewall ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| loggable required | Logging Use 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 | Firewall Name Example : FW_IGW_secuVPC | string | |
| pre_product_id optional | Pre Product ID Example : 76479b7ffee1431198d9beb4502cda08 | string | |
| product_type required | Firewall Product Type Example : IGW | enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM) | |
| state required | Firewall State Example : CREATING | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING) | |
| status required | Firewall Status Example : ENABLE | enum (ENABLE, DISABLE) | |
| total_rule_count optional | Total Rule Count Example : 8 | integer | |
| vpc_id required | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | any of [string, null] | |
| vpc_name required | VPC Name Example : secuVPC | any of [string, null] |
4.2.2 - FirewallListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
4.2.3 - FirewallListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| firewalls required | array[FirewallV1Dot1] | ||
| 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.4 - FirewallPort
| Name | Description | Schema | Default |
|---|---|---|---|
| service_type required | Service Protocol Type Example : TCP | enum (TCP, UDP, ICMP, IP, TCP_ALL, UDP_ALL, ICMP_ALL, ALL) | |
| service_value optional | Service Port Value Example : 443 | string |
4.2.5 - FirewallRule
| Name | Description | Schema | Default |
|---|---|---|---|
| action required | Firewall Rule Action Example : ALLOW | enum (ALLOW, DENY) | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | Firewall Rule Description Example : Firewall rule description example | any of [string, null] | |
| destination_address required | Destination Address Example : ['10.0.0.1', '10.0.0.2'] | array[string] | |
| destination_interface required | Destination Interface Name Example : IFW1-v1001dn | string | |
| direction required | Firewall Rule Direction Example : INBOUND | enum (INBOUND, OUTBOUND) | |
| firewall_id required | Firewall ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| id required | Firewall Rule ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | Firewall Rule Name Example : b156740b6335468d8354eb9ef8eddf5a | any of [string, null] | |
| sequence required | Firewall Rule Sequence Example : 100 | integer | |
| service required | Service Port | array[FirewallPort] | |
| source_address required | Source Address Example : ['192.168.1.1', '192.168.1.2'] | array[string] | |
| source_interface required | Source Interface Name Example : IFW1-v2501up | string | |
| state required | Firewall Rule State Example : CREATING | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
| status required | Firewall Rule Status Example : ENABLE | enum (ENABLE, DISABLE) | |
| vendor_rule_id required | Vendor Rule ID Example : 72 | string |
4.2.6 - FirewallRuleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| action required | Firewall Rule Action Example : ALLOW | enum (ALLOW, DENY) | |
| description optional | Firewall Rule Description Example : Firewall rule description example | any of [string, null] | |
| destination_address required | Destination Address Example : ['10.0.0.1', '10.0.0.2'] | array[string] | |
| direction required | Firewall Rule Direction Example : INBOUND | enum (INBOUND, OUTBOUND) | |
| order_direction optional | Order Direction Example : BEFORE | enum (BEFORE, AFTER, BOTTOM) | |
| order_rule_id optional | Order Rule ID Example : 043aa63459da466faad71fe4fe587031 | string | |
| service required | Service Port | array[FirewallPort] | |
| source_address required | Source Address Example : ['192.168.1.1', '192.168.1.2'] | array[string] | |
| status required | Firewall Rule Status Example : ENABLE | enum (ENABLE, DISABLE) |
4.2.7 - FirewallRuleCreateSingleRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| firewall_id required | Firewall ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| firewall_rule required | Firewall Request Rule | FirewallRuleCreateRequest |
4.2.8 - FirewallRuleListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
4.2.9 - FirewallRuleListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| firewall_rules required | array[FirewallRuleV1Dot1] | ||
| 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.10 - FirewallRuleSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| action required | Firewall Rule Action Example : ALLOW | enum (ALLOW, DENY) | |
| description optional | Firewall Rule Description Example : Firewall rule description example | any of [string, null] | |
| destination_address required | Destination Address Example : ['10.0.0.1', '10.0.0.2'] | array[string] | |
| direction required | Firewall Rule Direction Example : INBOUND | enum (INBOUND, OUTBOUND) | |
| service required | Service Port | array[FirewallPort] | |
| source_address required | Source Address Example : ['192.168.1.1', '192.168.1.2'] | array[string] |
4.2.11 - FirewallRuleShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| firewall_rule required | FirewallRule |
4.2.12 - FirewallRuleShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| firewall_rule required | FirewallRuleV1Dot1 |
4.2.13 - FirewallRuleUpdateSingleRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| firewall_rule required | Firewall Request Rule | FirewallRuleCreateRequest |
4.2.14 - FirewallRuleV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| action required | Firewall Rule Action Example : ALLOW | enum (ALLOW, DENY) | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | Firewall Rule Description Example : Firewall rule description example | any of [string, null] | |
| destination_address required | Destination Address Example : ['10.0.0.1', '10.0.0.2'] | array[string] | |
| direction required | Firewall Rule Direction Example : INBOUND | enum (INBOUND, OUTBOUND) | |
| firewall_id required | Firewall ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| id required | Firewall Rule ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| sequence required | Firewall Rule Sequence Example : 100 | integer | |
| service required | Service Port | array[FirewallPort] | |
| source_address required | Source Address Example : ['192.168.1.1', '192.168.1.2'] | array[string] | |
| state required | Firewall Rule State Example : CREATING | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
| status required | Firewall Rule Status Example : ENABLE | enum (ENABLE, DISABLE) |
4.2.15 - FirewallSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| flavor_name optional | Firewall Size Name Example : EXSMALL | enum (EXSMALL, SMALL, MEDIUM, LARGE, EXLARGE) | |
| loggable optional | Logging Use Example : False | boolean |
4.2.16 - FirewallShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| firewall required | Firewall |
4.2.17 - FirewallShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| firewall required | FirewallV1Dot1 |
4.2.18 - FirewallV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| flavor_name optional | Firewall Size Name Example : SMALL | string | |
| flavor_rule_quota optional | Firewall Rule Quota Example : 100 | integer | |
| id required | Firewall ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| loggable required | Logging Use 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 | Firewall Name Example : FW_IGW_secuVPC | string | |
| pre_product_id optional | Pre Product ID Example : 76479b7ffee1431198d9beb4502cda08 | string | |
| product_type required | Firewall Product Type Example : IGW | enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM) | |
| state required | Firewall State Example : CREATING | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING) | |
| status required | Firewall Status Example : ENABLE | enum (ENABLE, DISABLE) | |
| total_rule_count optional | Total Rule Count Example : 8 | integer | |
| vpc_id required | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | any of [string, null] | |
| vpc_name required | VPC Name Example : secuVPC | any of [string, null] | |
| zone_resources required | Firewall Zone Resources | array[ZoneResource] |
4.2.19 - ZoneResource
| Name | Description | Schema | Default |
|---|---|---|---|
| allocate_state required | Firewall Allocate Type Example : SUCCESS | enum (SUCCESS, FAIL, DELETED) | |
| fw_resource_id required | Fw Resource ID Example : 005fd1d30dea11f08a2c56773bef875b | string | |
| zone required | Firewall Zone Example : kr-west1-a | string |
5 - Global CDN
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Global CDN service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 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 |
API Version History
1.0
CDN API has been released.
Changes
- [New]
GET /cdn/1.0/cdns- ListCdnService API has been added. - [New]
POST /cdn/1.0/cdns- CreateCdnService API has been added. - [New]
GET /cdn/1.0/cdns/{id}- DetailCdnService API has been added. - [New]
PUT /cdn/1.0/cdns/{id}- UpdateCdnService API has been added. - [New]
DELETE /cdn/1.0/cdns/{id}- DeleteCdnService API has been added. - [New]
PUT /cdn/1.0/cdns/{id}/description- UpdateDescriptionOfCdnService API has been added. - [New]
POST /cdn/1.0/cdns/{id}/start- StartCdnService API has been added. - [New]
POST /cdn/1.0/cdns/{id}/stop- StopCdnService API has been added. - [New]
POST /cdn/1.0/cdns/{id}/purge- PurgeCdnService API has been added.
5.1 - APIs
5.1.1 - Create Cdn Service
5.1.1.1 - 1.0
post /v1/cdns
Description
Create CDN service resource for caching and delivering content from an origin server through edge locations.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = cdn 1.0"
Request body
{
"cache_expiry_time": 86400,
"cache_key_hostname": "REQUEST_HOST_HEADER",
"caching_option": "CACHE",
"cdn_origin_hostname": "test.example.com",
"cdn_origin_port": 443,
"cdn_origin_protocol": "HTTPS",
"cdn_service_domain_prefix": "global1",
"cdn_service_origin_path": "/test/global/",
"content_policy": "ONLY_VALIDATED_CONTENTS",
"custom_forward_host_header": "",
"description": "추가 정보 입력 - 설명",
"forward_host_header": "REQUEST_HOST_HEADER",
"name": "test1",
"origin_hostname_type": "DOMAIN",
"query_string_ignored": true,
"range_request_allowed": true,
"request_custom_headers": "",
"response_custom_headers": "",
"tags": []
}
Example HTTP response
Response 202
{
"cdn": {
"account_id": "",
"resource_id": "",
"workflow_id": ""
}
}
5.1.2 - Delete Cdn Service
5.1.2.1 - 1.0
delete /v1/cdns/{id}
Description
Delete CDN service resource
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | id required | The unique identifier of the CDN service. Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CdnServiceResponseResult |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | 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 = en-US",
"Scp-Api-Version = cdn 1.0"
Example HTTP response
Response 202
{
"cdn": {
"account_id": "",
"resource_id": "",
"workflow_id": ""
}
}
5.1.3 - Detail Cdn Service
5.1.3.1 - 1.0
get /v1/cdns/{id}
Description
Provides details about a specific CDN service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | id required | The unique identifier of the CDN service. Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CdnServiceDetailResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | 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 = en-US",
"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": ""
}
}
5.1.4 - List Cdn Service
5.1.4.1 - 1.0
get /v1/cdns
Description
Provides a list of CDN services.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | The user id that created the resource. Example : | any of [string, null] | None |
| query | name optional | The name of the CDN service. Example : | any of [string, null] | None |
| query | cdn_service_domain optional | The domain name through which the CDN service delivers content. Example : | any of [string, null] | None |
| query | cdn_origin_hostname optional | The hostname of the origin server from which the CDN retrieves content. 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 = en-US",
"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"
]
}
5.1.5 - Purge Cdn Service
5.1.5.1 - 1.0
post /v1/cdns/{id}/purge
Description
Purges cached content from the CDN service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | id required | The unique identifier of the CDN service. Example : | string | None |
| body | body required | CdnServicePurgeRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CdnServiceResponseResult |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | 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 = en-US",
"Scp-Api-Version = cdn 1.0"
Request body
{
"custom_url": "/test/",
"target_content": "INVALIDATED_CONTENT",
"target_url": "CUSTOM"
}
Example HTTP response
Response 202
{
"cdn": {
"account_id": "",
"resource_id": "",
"workflow_id": ""
}
}
5.1.6 - Start Cdn Service
5.1.6.1 - 1.0
post /v1/cdns/{id}/start
Description
Starts the CDN service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | id required | The unique identifier of the CDN service. Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CdnServiceResponseResult |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | 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 = en-US",
"Scp-Api-Version = cdn 1.0"
Example HTTP response
Response 202
{
"cdn": {
"account_id": "",
"resource_id": "",
"workflow_id": ""
}
}
5.1.7 - Stop Cdn Service
5.1.7.1 - 1.0
post /v1/cdns/{id}/stop
Description
Stops the CDN service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | id required | The unique identifier of the CDN service. Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CdnServiceResponseResult |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | 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 = en-US",
"Scp-Api-Version = cdn 1.0"
Example HTTP response
Response 202
{
"cdn": {
"account_id": "",
"resource_id": "",
"workflow_id": ""
}
}
5.1.8 - Update Cdn Service
5.1.8.1 - 1.0
put /v1/cdns/{id}
Description
Update a CDN service resource
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | id required | The unique identifier of the CDN service. Example : | string | None |
| body | body required | CdnServiceUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CdnServiceResponseResult |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | 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 = en-US",
"Scp-Api-Version = cdn 1.0"
Request body
{
"cache_expiry_time": 86400,
"cache_key_hostname": "REQUEST_HOST_HEADER",
"caching_option": "CACHE",
"cdn_origin_hostname": "test.example.com",
"cdn_origin_port": 443,
"cdn_origin_protocol": "HTTPS",
"cdn_service_origin_path": "/test/global/",
"content_policy": "ONLY_VALIDATED_CONTENTS",
"custom_forward_host_header": "",
"forward_host_header": "REQUEST_HOST_HEADER",
"origin_hostname_type": "DOMAIN",
"query_string_ignored": true,
"range_request_allowed": true,
"request_custom_headers": "",
"response_custom_headers": ""
}
Example HTTP response
Response 202
{
"cdn": {
"account_id": "",
"resource_id": "",
"workflow_id": ""
}
}
5.1.9 - Update Description of Cdn Service
5.1.9.1 - 1.0
put /v1/cdns/{id}/description
Description
Updates the description of the CDN service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | id required | The unique identifier of the CDN service. Example : | string | None |
| body | body required | CdnServiceModifyDescriptionRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CdnServiceDetailResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | 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 = en-US",
"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": ""
}
}
5.2 - Models
5.2.1 - CdnServiceCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cache_expiry_time required | The cache expiry time in seconds for content stored at edge locations. Example : 86400Minimum : 3600Maximum : 2592000 | integer | |
| cache_key_hostname required | The hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER). Example : REQUEST_HOST_HEADER | enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME) | |
| caching_option required | The caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE). Example : CACHE | string | |
| cdn_origin_hostname required | The hostname of the origin server from which the CDN retrieves content. Example : test.example.comPattern : ^(([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 | The port used to connect to the origin server. Example : 443Minimum : 1Maximum : 65535 | integer | |
| cdn_origin_protocol required | The protocol used to connect to the origin server (e.g., HTTP, HTTPS). Example : HTTPS | string | |
| cdn_service_domain_prefix required | The prefix of the CDN service domain. Example : global1Pattern : ^[a-z0-9]*$Minimum length : 4Maximum length : 40 | string | |
| cdn_service_origin_path optional | The path on the origin server from which the CDN retrieves content. Example : /test/global/Pattern : ^/$|^(/[a-zA-Z0-9-._]+)+/$ | any of [string, null] | |
| content_policy required | The content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS). Example : ONLY_VALIDATED_CONTENTS | string | |
| custom_forward_host_header optional | The custom host header forwarded to the origin when forward host header is set to CUSTOM. Example : | any of [string, null] | |
| description optional | Description Example : 추가 정보 입력 - 설명 | any of [string, null] | |
| forward_host_header required | The host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM). Example : REQUEST_HOST_HEADER | enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM) | |
| name required | The name of the CDN service. Example : test1Pattern : ^[a-zA-Z0-9]*$Minimum length : 3Maximum length : 20 | string | |
| origin_hostname_type required | The type of the origin hostname (e.g., DOMAIN, IP). Example : DOMAIN | enum (DOMAIN, IP) | |
| query_string_ignored required | Indicates whether the query string is ignored when caching content. Example : True | boolean | |
| range_request_allowed required | Indicates whether range requests are allowed for content delivery. Example : True | boolean | |
| request_custom_headers optional | The custom headers added to requests forwarded to the origin server. Example : | object | |
| response_custom_headers optional | The custom headers added to responses returned to the client. Example : | object | |
| tags optional | Tag List | array[Tag] |
5.2.2 - CdnServiceDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| cache_expiry_time required | The cache expiry time in seconds for content stored at edge locations. Example : | integer | |
| cache_key_hostname required | The hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER). Example : | string | |
| caching_option required | The caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE). Example : | string | |
| cdn_origin_hostname required | The hostname of the origin server from which the CDN retrieves content. Example : | string | |
| cdn_origin_port required | The port used to connect to the origin server. Example : | integer | |
| cdn_origin_protocol required | The protocol used to connect to the origin server (e.g., HTTP, HTTPS). Example : | string | |
| cdn_service_activation_state required | The activation state of the CDN service. Example : | string | |
| cdn_service_config_version required | The configuration version of the CDN service. Example : | integer | |
| cdn_service_domain required | The domain name through which the CDN service delivers content. Example : | string | |
| cdn_service_origin_path required | The path on the origin server from which the CDN retrieves content. Example : | string | |
| cdn_service_state required | The current state of the CDN service (e.g., RUNNING, STOPPED, CREATING, DELETING). Example : | string | |
| content_policy required | The content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS). Example : | string | |
| created_at required | The timestamp when the resource was created, in ISO 8601 format. Example : | string | |
| created_by required | The user id that created the resource. Example : | string | |
| custom_forward_host_header required | The custom host header forwarded to the origin when forward host header is set to CUSTOM. Example : | string | |
| description required | Description Example : | string | |
| forward_host_header required | The host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM). Example : | string | |
| id required | The unique identifier of the CDN service. Example : | string | |
| modified_at required | The timestamp when the resource was last modified, in ISO 8601 format. Example : | string | |
| modified_by required | The user id that last modified the resource. Example : | string | |
| name required | The name of the CDN service. Example : | string | |
| origin_hostname_type required | The type of the origin hostname (e.g., DOMAIN, IP). Example : | string | |
| query_string_ignored required | Indicates whether the query string is ignored when caching content. Example : | boolean | |
| range_request_allowed required | Indicates whether range requests are allowed for content delivery. Example : | boolean | |
| region required | The region where the CDN service is provided. Example : | string | |
| request_custom_headers required | The custom headers added to requests forwarded to the origin server. Example : | object | |
| response_custom_headers required | The custom headers added to responses returned to the client. Example : | object |
5.2.3 - CdnServiceDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cdn required | CdnServiceDetail |
5.2.4 - CdnServiceListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
5.2.5 - CdnServiceModifyDescriptionRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Description Example : 추가 정보 입력 - 설명Maximum length : 50 | string |
5.2.6 - CdnServicePurgeRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| custom_url optional | The custom URL to purge when the target URL is set to CUSTOM. Example : /test/Pattern : ^/[a-zA-Z0-9-._/]*$ | any of [string, null] | |
| target_content required | The target content type to purge (e.g., ALL_CONTENT, INVALIDATED_CONTENT). Example : INVALIDATED_CONTENT | string | |
| target_url required | The target URL scope for the purge operation (e.g., ALL, CUSTOM). Example : CUSTOM | string |
5.2.7 - CdnServiceResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| cdn_origin_hostname required | The hostname of the origin server from which the CDN retrieves content. Example : | string | |
| cdn_service_domain required | The domain name through which the CDN service delivers content. Example : | string | |
| cdn_service_state required | The current state of the CDN service (e.g., RUNNING, STOPPED, CREATING, DELETING). 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 | The unique identifier of the CDN service. 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 | The name of the CDN service. Example : | string | |
| region required | The region where the CDN service is provided. Example : | string |
5.2.8 - CdnServiceResponseResult
| Name | Description | Schema | Default |
|---|---|---|---|
| cdn required | CdnServiceResult |
5.2.9 - CdnServiceResult
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| resource_id required | The identifier of the resource. Example : | string | |
| workflow_id required | The identifier of the workflow processing the request. Example : | string |
5.2.10 - CdnServiceUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cache_expiry_time required | The cache expiry time in seconds for content stored at edge locations. Example : 86400Minimum : 3600Maximum : 2592000 | integer | |
| cache_key_hostname required | The hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER). Example : REQUEST_HOST_HEADER | enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME) | |
| caching_option required | The caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE). Example : CACHE | string | |
| cdn_origin_hostname required | The hostname of the origin server from which the CDN retrieves content. Example : test.example.comPattern : ^(([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 | The port used to connect to the origin server. Example : 443Minimum : 1Maximum : 65535 | integer | |
| cdn_origin_protocol required | The protocol used to connect to the origin server (e.g., HTTP, HTTPS). Example : HTTPS | string | |
| cdn_service_origin_path optional | The path on the origin server from which the CDN retrieves content. Example : /test/global/Pattern : ^/$|^(/[a-zA-Z0-9-._]+)+/$ | any of [string, null] | |
| content_policy required | The content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS). Example : ONLY_VALIDATED_CONTENTS | string | |
| custom_forward_host_header optional | The custom host header forwarded to the origin when forward host header is set to CUSTOM. Example : | any of [string, null] | |
| forward_host_header required | The host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM). Example : REQUEST_HOST_HEADER | enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM) | |
| origin_hostname_type required | The type of the origin hostname (e.g., DOMAIN, IP). Example : DOMAIN | enum (DOMAIN, IP) | |
| query_string_ignored required | Indicates whether the query string is ignored when caching content. Example : True | boolean | |
| range_request_allowed required | Indicates whether range requests are allowed for content delivery. Example : True | boolean | |
| request_custom_headers optional | The custom headers added to requests forwarded to the origin server. Example : | any of [object, null] | |
| response_custom_headers optional | The custom headers added to responses returned to the client. Example : | any of [object, null] |
5.2.11 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |
6 - GSLB
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of GSLB service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20260531 |
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 |
API Version History
1.1
GSLB API has been updated to version 1.1.
Changes
- [Changed]
POST /gslb/1.1/gslbs- CreateGslb API has been changed.- The following field has been added to the request:
routing_control_enabled
- The following field has been added to the request:
- [New]
GET /gslb/1.1/gslbs/routing-control- ListGslbsRegionalRoutingControl API has been added. - [New]
PUT /gslb/1.1/gslbs/{gslb_id}/routing-control- SetGslbRegionalRoutingControl API has been added.
1.0
GSLB API has been released.
Changes
- [New]
GET /gslb/1.0/gslbs- ListGslbs API has been added. - [New]
POST /gslb/1.0/gslbs- CreateGslb API has been added. - [New]
GET /gslb/1.0/gslbs/{gslb_id}- ShowGslb API has been added. - [New]
PUT /gslb/1.0/gslbs/{gslb_id}- SetGslb API has been added. - [New]
DELETE /gslb/1.0/gslbs/{gslb_id}- DeleteGslb API has been added. - [New]
PUT /gslb/1.0/gslbs/{gslb_id}/health-check- SetGslbHealthCheck API has been added. - [New]
GET /gslb/1.0/gslbs/{gslb_id}/resources- ListGslbResources API has been added. - [New]
PUT /gslb/1.0/gslbs/{gslb_id}/resources- SetGslbResources API has been added.
6.1 - APIs
6.1.1 - CreateGslb
6.1.1.1 - 1.1
post /v1/gslbs
Description
Create a global Server Load Balancer resource for distributing traffic across multiple regions.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GslbCreateRequestV1Dot1 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | GslbShowResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = gslb 1.1"
Request body
{
"algorithm": "ROUND_ROBIN",
"description": "Example Description for GSLB",
"env_usage": "PUBLIC",
"health_check": {
"health_check_interval": 5,
"health_check_probe_timeout": 5,
"health_check_user_id": "user",
"health_check_user_password": "Passw0rd!",
"protocol": "https",
"receive_string": "OK",
"send_string": "GET /",
"service_port": 1,
"timeout": 6
},
"name": "example.gslb.e.samsungsdscloud.com",
"resources": [
{
"description": "",
"destination": "192.168.1.100",
"region": "KR-WEST-1",
"weight": 10
}
],
"tags": []
}
Example HTTP response
Response 202
{
"gslb": {
"algorithm": "ROUND_ROBIN",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for GSLB",
"env_usage": "PUBLIC",
"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": 2,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "example.gslb.e.samsungsdscloud.com",
"state": "ACTIVE"
}
}
6.1.1.2 - 1.0
post /v1/gslbs
Description
Create a global Server Load Balancer resource for distributing traffic across multiple regions.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = gslb 1.0"
Request body
{
"algorithm": "",
"description": "",
"env_usage": "",
"health_check": {
"health_check_interval": 5,
"health_check_probe_timeout": 5,
"health_check_user_id": "user",
"health_check_user_password": "Passw0rd!",
"protocol": "https",
"receive_string": "OK",
"send_string": "GET /",
"service_port": 1,
"timeout": 6
},
"name": "",
"resources": [
{
"description": "",
"destination": "192.168.1.100",
"disabled": false,
"region": "KR-WEST-1",
"weight": 10
}
],
"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": ""
}
}
6.1.2 - DeleteGslb
6.1.2.1 - 1.1
delete /v1/gslbs/{gslb_id}
Description
Delete the Global Server Load Balancer resource.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"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": ""
}
}
6.1.2.2 - 1.0
delete /v1/gslbs/{gslb_id}
Description
Delete the Global Server Load Balancer resource.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"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": ""
}
}
6.1.3 - ListGslbResources
6.1.3.1 - 1.1
get /v1/gslbs/{gslb_id}/resources
Description
The list of resources for the GSLB.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"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": "192.168.1.100",
"health_check_status": "CONNECTED",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region": "KR-WEST-1",
"status": "ENABLE",
"weight": 10
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
6.1.3.2 - 1.0
get /v1/gslbs/{gslb_id}/resources
Description
The list of resources for the GSLB.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"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": "192.168.1.100",
"disabled": false,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region": "KR-WEST-1",
"weight": 10
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
6.1.4 - ListGslbs
6.1.4.1 - 1.1
get /v1/gslbs
Description
Gets a list of Global Server Load Balancers.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). Example : | any of [string, null] | None |
| query | name optional | The name of the 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 = en-US",
"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"
]
}
6.1.4.2 - 1.0
get /v1/gslbs
Description
Gets a list of Global Server Load Balancers.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). Example : | any of [string, null] | None |
| query | name optional | The name of the 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 = en-US",
"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"
]
}
6.1.5 - ListGslbsRegionalRoutingControl
6.1.5.1 - 1.1
get /v1/gslbs/routing-control
Description
Gets a list of GSLB regional routing controls.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | The region where the GSLB resource is located. Example : | any of [string, null] | None |
| query | status optional | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) Example : | any of [enum (ENABLE, DISABLE), null] | None |
| query | name optional | The name of the 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 = en-US",
"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": "ENABLE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
6.1.6 - SetGslb
6.1.6.1 - 1.1
put /v1/gslbs/{gslb_id}
Description
Update the Global Server Load Balancer resource.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"Scp-Api-Version = gslb 1.1"
Request body
{
"algorithm": "ROUND_ROBIN",
"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": ""
}
}
6.1.6.2 - 1.0
put /v1/gslbs/{gslb_id}
Description
Update the Global Server Load Balancer resource.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"Scp-Api-Version = gslb 1.0"
Request body
{
"algorithm": "ROUND_ROBIN",
"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": ""
}
}
6.1.7 - SetGslbHealthCheck
6.1.7.1 - 1.1
put /v1/gslbs/{gslb_id}/health-check
Description
Set GSLB Health Checks.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"Scp-Api-Version = gslb 1.1"
Request body
{
"health_check_interval": 5,
"health_check_probe_timeout": 5,
"health_check_user_id": "user",
"health_check_user_password": "Passw0rd!",
"protocol": "https",
"receive_string": "OK",
"send_string": "GET /",
"service_port": 1,
"timeout": 6
}
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": ""
}
}
6.1.7.2 - 1.0
put /v1/gslbs/{gslb_id}/health-check
Description
Set GSLB Health Checks.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"Scp-Api-Version = gslb 1.0"
Request body
{
"health_check_interval": 5,
"health_check_probe_timeout": 5,
"health_check_user_id": "user",
"health_check_user_password": "Passw0rd!",
"protocol": "https",
"receive_string": "OK",
"send_string": "GET /",
"service_port": 1,
"timeout": 6
}
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": ""
}
}
6.1.8 - SetGslbRegionalRoutingControl
6.1.8.1 - 1.1
put /v1/gslbs/{gslb_id}/routing-control
Description
Updates GSLB regional routing control settings.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"Scp-Api-Version = gslb 1.1"
Request body
{
"region": "KR-WEST-1",
"status": "ENABLE"
}
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": "ENABLE"
}
}
6.1.9 - SetGslbResources
6.1.9.1 - 1.1
put /v1/gslbs/{gslb_id}/resources
Description
Set GSLB Resources.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. Example : | string | None |
| body | body required | GslbResourcesSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | GslbResourcesSetResponse |
| 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 = en-US",
"Scp-Api-Version = gslb 1.1"
Request body
{
"resources": [
{
"description": "",
"destination": "192.168.1.100",
"region": "KR-WEST-1",
"weight": 10
}
]
}
Example HTTP response
Response 202
{
"gslb_resources": [
{
"description": "",
"destination": "192.168.1.100",
"region": "KR-WEST-1",
"status": "ENABLE",
"weight": 10
}
]
}
6.1.9.2 - 1.0
put /v1/gslbs/{gslb_id}/resources
Description
Set GSLB Resources.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"Scp-Api-Version = gslb 1.0"
Request body
{
"resources": [
{
"description": "",
"destination": "192.168.1.100",
"disabled": false,
"region": "KR-WEST-1",
"weight": 10
}
]
}
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": ""
}
}
6.1.10 - ShowGslb
6.1.10.1 - 1.1
get /v1/gslbs/{gslb_id}
Description
Shows details of a specific Global Server Load Balancer.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"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": ""
}
}
6.1.10.2 - 1.0
get /v1/gslbs/{gslb_id}
Description
Shows details of a specific Global Server Load Balancer.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | gslb_id required | The unique identifier of the GSLB. 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 = en-US",
"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": ""
}
}
6.2 - Models
6.2.1 - GslbCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). Example : | string | |
| description optional | Description Example : | any of [string, null] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : | string | |
| health_check optional | Health check configuration for monitoring GSLB endpoint availability. | any of [GslbHealthCheck, null] | |
| name required | The name of the GSLB. Example : | string | |
| resources required | array[GslbResource] | ||
| tags optional | Tag List | array[Tag] |
6.2.2 - GslbCreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). Example : ROUND_ROBIN | enum (RATIO, ROUND_ROBIN) | |
| description optional | Description Example : Example Description for GSLB | any of [string, null] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : PUBLIC | enum (PUBLIC, PRIVATE) | |
| health_check optional | Health check configuration for monitoring GSLB endpoint availability. | any of [GslbHealthCheck, null] | |
| name required | The name of the GSLB. Example : example.gslb.e.samsungsdscloud.com | string | |
| resources required | The list of resources for the GSLB. | array[GslbResourceV1Dot1] | |
| tags optional | Tag List | array[Tag] |
6.2.3 - GslbDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). 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] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : | string | |
| health_check required | any of [GslbHeathCheckShowResponse, null] | ||
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| linked_resource_count required | The number of resources linked to this GSLB. Example : | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | The name of the GSLB. Example : | string | |
| state required | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). Example : | string |
6.2.4 - GslbHealthCheck
| Name | Description | Schema | Default |
|---|---|---|---|
| health_check_interval optional | The GSLB Health Check Interval. Example : 5 | any of [integer, null] | |
| health_check_probe_timeout optional | The GSLB Health Check Probe Timeout. Example : 5 | any of [integer, null] | |
| health_check_user_id optional | The GSLB Health Check User Name. Example : user | any of [string, null] | |
| health_check_user_password optional | The GSLB Health Check Password. Example : Passw0rd! | any of [string, null] | |
| protocol required | The protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS). Example : https | string | |
| receive_string optional | The GSLB Health Check Receive String. Example : OKPattern : ^[a-zA-Z\d]+$ | any of [string, null] | |
| send_string optional | The GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request. Example : GET /Pattern : ^[^\u1100-\u11FF\uAC00-\uD7A3\uA960-\uA97C\uD7B0-\uD7FF\u3130-\u318F#<>]*$ | any of [string, null] | |
| service_port optional | The GSLB Health Check Service Port. Example : 1 | any of [integer, null] | |
| timeout optional | The GSLB Health Check Timeout. It must be greater than the Interval. Example : 6 | any of [integer, null] |
6.2.5 - GslbHeathCheckShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By 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 | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| protocol required | The protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS). 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. If no input is provided, it operates as a “GET /” request. 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. It must be greater than the Interval. Example : | any of [integer, null] |
6.2.6 - GslbListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
6.2.7 - GslbResource
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : | any of [string, null] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| disabled optional | The GSLB Resource disabled. Example : False | any of [boolean, null] | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
6.2.8 - GslbResourceListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
6.2.9 - GslbResourceListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
6.2.10 - GslbResourceResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| disabled optional | The GSLB Resource disabled. Example : False | any of [boolean, null] | |
| 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 | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
6.2.11 - GslbResourceResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| health_check_status required | The health check status of the GSLB resource (e.g., CONNECTED, DISCONNECTED). Example : CONNECTED | enum (CONNECTED, DISCONNECTED) | |
| 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 | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| status required | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) Example : ENABLE | enum (ENABLE, DISABLE) | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
6.2.12 - GslbResourceSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| resources required | array[GslbResource] |
6.2.13 - GslbResourceSetRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : | any of [string, null] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
6.2.14 - GslbResourcesSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| resources required | The list of resources for the GSLB. | array[GslbResourceSetRequestV1Dot1] |
6.2.15 - GslbResourcesSetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| gslb_resources required | array[GslbResourceWithStatus] |
6.2.16 - GslbResourceV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : | any of [string, null] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
6.2.17 - GslbResourceWithStatus
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : | any of [string, null] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| status required | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) Example : ENABLE | enum (ENABLE, DISABLE) | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
6.2.18 - GslbResponseCommon
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). 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] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| linked_resource_count required | The number of resources linked to this GSLB. Example : | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | The name of the GSLB. Example : | string | |
| state required | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). Example : | string |
6.2.19 - GslbRoutingControlListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
6.2.20 - GslbRoutingControlRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| status required | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) Example : ENABLE | enum (ENABLE, DISABLE) |
6.2.21 - GslbRoutingControlResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| regional_gslb required | GslbRoutingControlResponseCommon |
6.2.22 - GslbRoutingControlResponseCommon
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). 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] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| linked_regional_resource_count required | The number of resources linked to this GSLB in the region. Example : | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | The name of the GSLB. Example : | string | |
| region required | The region where the GSLB resource is located. Example : | string | |
| status required | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) Example : ENABLE | enum (ENABLE, DISABLE) |
6.2.23 - GslbSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm optional | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). Example : ROUND_ROBIN | any of [string, null] | |
| description optional | Description Example : | any of [string, null] |
6.2.24 - GslbShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| gslb required | GslbDetail |
6.2.25 - GslbShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| gslb required | GslbV1Dot1 |
6.2.26 - GslbV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). Example : ROUND_ROBIN | enum (RATIO, ROUND_ROBIN) | |
| 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 : Example Description for GSLB | any of [string, null] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : PUBLIC | enum (PUBLIC, PRIVATE) | |
| health_check optional | Health check configuration for monitoring GSLB endpoint availability. | any of [GslbHeathCheckShowResponse, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| linked_resource_count required | The number of resources linked to this GSLB. Example : 2 | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | The name of the GSLB. Example : example.gslb.e.samsungsdscloud.com | string | |
| state required | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING) |
6.2.27 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |
7 - Load Balancer
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of LOADBALANCER service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.4 | CURRENT | - |
| 1.3 | SUPPORTED | 20261031 |
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 |
7.1 - APIs
7.1.1 - AddLbServerGroupMembers
7.1.1.1 - 1.4
post /v1/lb-server-groups/{lb_server_group_id}/members
Description
Add Lb Server Group Member bulk
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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": ""
}
]
}
7.1.1.2 - 1.3
post /v1/lb-server-groups/{lb_server_group_id}/members
Description
Add Lb Server Group Member bulk
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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": ""
}
]
}
7.1.2 - CreateLBHealthCheck
7.1.2.1 - 1.4
post /v1/lb-health-checks
Description
Create LB Health Check
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LbHealthCheckCreateRequest |
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
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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 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"
}
}
7.1.2.2 - 1.3
post /v1/lb-health-checks
Description
Create LB Health Check
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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"
}
}
7.1.3 - CreateLbListener
7.1.3.1 - 1.4
post /v1/lb-listeners
Description
create LB listener
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LbListenerCreateRequestV1Dot4 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LbListenerShowResponseV1Dot4 |
| 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Request body
{
"listener": {
"condition_type": "URL_PATH",
"description": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"idle_timeout": "",
"insert_client_ip": "",
"loadbalancer_id": "",
"name": "",
"persistence": "",
"protocol": "TCP",
"response_timeout": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"service_port": "",
"session_duration_time": "",
"ssl_certificate": {
"client_cert_id": "",
"client_cert_level": "",
"server_cert_level": ""
},
"support_http2": false,
"tags": [],
"url_handler": [
{
"seq": "",
"server_group_id": "",
"url_pattern": ""
}
],
"url_redirection": "",
"x_forwarded_for": "",
"x_forwarded_port": "",
"x_forwarded_proto": ""
}
}
Example HTTP response
Response 202
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"hsts_config": {
"include_sub_domains": "",
"max_age": ""
},
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"loadbalancer_id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"response_timeout": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"server_group_name": "",
"service_port": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"sni_cert_id": ""
}
],
"ssl_certificate": {
"client_cert_id": "",
"client_cert_level": "",
"server_cert_level": ""
},
"state": "",
"support_http2": "",
"tags": [],
"url_handler": [
{
"seq": "",
"server_group_id": "",
"server_group_name": "",
"url_pattern": ""
}
],
"url_redirection": "",
"x_forwarded_for": "",
"x_forwarded_port": "",
"x_forwarded_proto": ""
}
}
7.1.3.2 - 1.3
post /v1/lb-listeners
Description
create LB listener
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LbListenerCreateRequestV1Dot3 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | LbListenerShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"listener": {
"condition_type": "URL_PATH",
"description": "",
"hsts_max_age": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"idle_timeout": "",
"insert_client_ip": "",
"loadbalancer_id": "",
"name": "",
"persistence": "",
"protocol": "TCP",
"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": "",
"hsts_max_age": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"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": ""
}
}
7.1.4 - CreateLBServerGroup
7.1.4.1 - 1.4
post /v1/lb-server-groups
Description
Create LB Server Group
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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"
}
}
7.1.4.2 - 1.3
post /v1/lb-server-groups
Description
Create LB Server Group
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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"
}
}
7.1.5 - CreateLoadbalancer
7.1.5.1 - 1.4
post /v1/loadbalancers
Description
create Load Balancer
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LoadbalancerCreateRequestV1Dot4 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Request body
{
"loadbalancer": {
"description": "",
"firewall_enabled": true,
"firewall_logging_enabled": true,
"health_check_ips": [
""
],
"layer_type": "",
"name": "",
"publicip_id": "",
"service_ip": "",
"source_nat_ip": "",
"subnet_id": "",
"tags": [],
"vpc_id": "",
"zones": []
}
}
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": ""
}
}
7.1.5.2 - 1.3
post /v1/loadbalancers
Description
create Load Balancer
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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": ""
}
}
7.1.6 - CreateLoadbalancerPrivateNatIp
7.1.6.1 - 1.4
post /v1/loadbalancers/{loadbalancer_id}/private-static-nats
Description
create Load Balancer Private NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | loadbalancer_id required | ID Example : | string | None |
| body | body required | PrivateStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | PrivateStaticNatCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Request body
{
"static_nat": {
"private_nat_id": "",
"private_nat_ip_id": ""
}
}
Example HTTP response
Response 202
{
"static_nat": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"external_ip_address": "",
"id": "",
"internal_ip_address": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"private_nat_ip_id": "",
"state": "",
"subnet_id": ""
}
}
7.1.6.2 - 1.3
post /v1/loadbalancers/{loadbalancer_id}/private-static-nats
Description
create Load Balancer Private NAT IP
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | loadbalancer_id required | ID Example : | string | None |
| body | body required | PrivateStaticNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | PrivateStaticNatCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"static_nat": {
"private_nat_id": "",
"private_nat_ip_id": ""
}
}
Example HTTP response
Response 202
{
"static_nat": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"external_ip_address": "",
"id": "",
"internal_ip_address": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"private_nat_ip_id": "",
"state": "",
"subnet_id": ""
}
}
7.1.7 - CreateLoadbalancerPublicNatIp
7.1.7.1 - 1.4
post /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
create Load Balancer Public NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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": ""
}
}
7.1.7.2 - 1.3
post /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
create Load Balancer Public NAT IP
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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": ""
}
}
7.1.8 - DeleteLBHealthCheck
7.1.8.1 - 1.4
delete /v1/lb-health-checks/{lb_health_check_id}
Description
Delete LB Health Check
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_health_check_id required | LB Health Check ID Example : e3cd678b11784734bc366148aa37580e | 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-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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 202
7.1.8.2 - 1.3
delete /v1/lb-health-checks/{lb_health_check_id}
Description
Delete LB Health Check
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_health_check_id required | LB Health Check 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 204
7.1.9 - DeleteLbListener
7.1.9.1 - 1.4
delete /v1/lb-listeners/{listener_id}
Description
delete LB listener
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | listener_id required | The ID of the listener. 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-listeners/{listener_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 202
7.1.9.2 - 1.3
delete /v1/lb-listeners/{listener_id}
Description
delete LB listener
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | listener_id required | The ID of the 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 204
7.1.10 - DeleteLBServerGroup
7.1.10.1 - 1.4
delete /v1/lb-server-groups/{lb_server_group_id}
Description
Delete LB Server Group
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 202
7.1.10.2 - 1.3
delete /v1/lb-server-groups/{lb_server_group_id}
Description
Delete LB Server Group
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 202
7.1.11 - DeleteLoadbalancer
7.1.11.1 - 1.4
delete /v1/loadbalancers/{loadbalancer_id}
Description
delete Load Balancer
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 202
7.1.11.2 - 1.3
delete /v1/loadbalancers/{loadbalancer_id}
Description
delete Load Balancer
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 202
7.1.12 - DeleteLoadbalancerPrivateNatIp
7.1.12.1 - 1.4
delete /v1/loadbalancers/{loadbalancer_id}/private-static-nats
Description
delete Load Balancer Private NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 202
7.1.12.2 - 1.3
delete /v1/loadbalancers/{loadbalancer_id}/private-static-nats
Description
delete Load Balancer Private NAT IP
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 202
7.1.13 - DeleteLoadbalancerPublicNatIp
7.1.13.1 - 1.4
delete /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
delete Load Balancer Public NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 204
7.1.13.2 - 1.3
delete /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
delete Load Balancer Public NAT IP
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 204
7.1.14 - ListLBHealthChecks
7.1.14.1 - 1.4
get /v1/lb-health-checks
Description
List LB Health Checks
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 Health Check name Example : Test-LbMonitor-01 | any of [string, null] | None |
| query | protocol optional | LB Health Check Protocol 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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"
]
}
7.1.14.2 - 1.3
get /v1/lb-health-checks
Description
List LB Health Checks
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 Health Check name Example : Test-LbMonitor-01 | any of [string, null] | None |
| query | protocol optional | LB Health Check Protocol 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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"
]
}
7.1.15 - ListLbListeners
7.1.15.1 - 1.4
get /v1/lb-listeners
Description
get LB listener list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 | The ID of the load balancer. Example : | any of [string, null] | None |
| query | state optional | The State of the listener. Example : | any of [string, null] | None |
| query | name optional | The name of the listener. Example : | any of [string, null] | None |
| query | service_port optional | The port of the listener. Example : | any of [integer, null] | None |
| query | protocol optional | Protocol Example : ['TCP', 'UDP'] | any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)], enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null] | None |
| query | not_protocol optional | The protocol of the listener to exclude. Example : TCP | any of [enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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": "TCP",
"service_port": "",
"state": ""
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.15.2 - 1.3
get /v1/lb-listeners
Description
get LB listener list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 | The ID of the load balancer. Example : | any of [string, null] | None |
| query | state optional | The State of the listener. Example : | any of [string, null] | None |
| query | name optional | The name of the listener. Example : | any of [string, null] | None |
| query | service_port optional | The port of the listener. Example : | any of [integer, null] | None |
| query | protocol optional | Protocol Example : ['TCP', 'UDP'] | any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)], enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null] | None |
| query | not_protocol optional | The protocol of the listener to exclude. Example : TCP | any of [enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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": "TCP",
"service_port": "",
"state": ""
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.16 - ListLbServerGroupMembers
7.1.16.1 - 1.4
get /v1/lb-server-groups/{lb_server_group_id}/members
Description
Get Lb Server Group Member List
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 | Name of Member Example : | any of [string, null] | None |
| query | member_ip optional | IP of Member Example : | any of [string, null] | None |
| query | member_port optional | Protocol port of Member Example : | any of [integer, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MemberWithHealthStateListResponseV1Dot4 |
| 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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_az": "",
"object_id": "",
"object_type": "VM",
"state": "CREATING"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.16.2 - 1.3
get /v1/lb-server-groups/{lb_server_group_id}/members
Description
Get Lb Server Group Member List
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 | Name of Member Example : | any of [string, null] | None |
| query | member_ip optional | IP of Member Example : | any of [string, null] | None |
| query | member_port optional | Protocol port of 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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"
]
}
7.1.17 - ListLBServerGroups
7.1.17.1 - 1.4
get /v1/lb-server-groups
Description
Get LB Server Group list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 Server Group name Example : ServerGroup01 | any of [string, null] | None |
| query | state optional | LB Server Group state Example : ACTIVE | any of [string, null] | None |
| query | protocol optional | Protocol 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 Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | string | None |
| query | lb_method optional | LB Method Example : ROUND_ROBIN | any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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"
]
}
7.1.17.2 - 1.3
get /v1/lb-server-groups
Description
Get LB Server Group list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 Server Group name Example : ServerGroup01 | any of [string, null] | None |
| query | state optional | LB Server Group state Example : ACTIVE | any of [string, null] | None |
| query | protocol optional | Protocol 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 Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | string | None |
| query | lb_method optional | LB Method Example : ROUND_ROBIN | any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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"
]
}
7.1.18 - ListLoadbalancerCertificates
7.1.18.1 - 1.4
get /v1/loadbalancers/certificates
Description
get Load Balancer certificate list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 200
{
"certificates": [
{
"cert_kind": "",
"cn": "",
"created_at": "",
"created_by": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"not_after_dt": "2024-01-15T10:30:00.000Z",
"not_before_dt": "2024-01-15T10:30:00.000Z",
"state": ""
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
7.1.18.2 - 1.3
get /v1/loadbalancers/certificates
Description
get Load Balancer certificate list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"certificates": [
{
"cert_kind": "",
"cn": "",
"created_at": "",
"created_by": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"not_after_dt": "2024-01-15T10:30:00.000Z",
"not_before_dt": "2024-01-15T10:30:00.000Z",
"state": ""
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
7.1.19 - ListLoadbalancers
7.1.19.1 - 1.4
get /v1/loadbalancers
Description
get Load Balancer list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 | The name of the load balancer. 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 | The service IP of the load balancer. Example : | any of [string, null] | None |
| query | subnet_id optional | Subnet ID Example : | any of [string, null] | None |
| query | layer_type optional | Layer type 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 | LoadbalancerListResponseV1Dot4 |
| 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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": "",
"zones": []
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.19.2 - 1.3
get /v1/loadbalancers
Description
get Load Balancer list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 | The name of the load balancer. 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 | The service IP of the load balancer. Example : | any of [string, null] | None |
| query | subnet_id optional | Subnet ID Example : | any of [string, null] | None |
| query | layer_type optional | Layer type 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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"
]
}
7.1.20 - RemoveLbServerGroupMember
7.1.20.1 - 1.4
delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Remove Lb Server Group Member
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 202
7.1.20.2 - 1.3
delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Remove Lb Server Group Member
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 202
7.1.21 - RemoveLbServerGroupMembers
7.1.21.1 - 1.4
delete /v1/lb-server-groups/{lb_server_group_id}/members
Description
Remove Lb Server Group Members
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Request body
{
"member_id_list": [
""
]
}
Example HTTP response
Response 202
7.1.21.2 - 1.3
delete /v1/lb-server-groups/{lb_server_group_id}/members
Description
Remove Lb Server Group Members
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"member_id_list": [
""
]
}
Example HTTP response
Response 202
7.1.22 - SetLBHealthCheck
7.1.22.1 - 1.4
put /v1/lb-health-checks/{lb_health_check_id}
Description
Set LB Health Check
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_health_check_id required | LB Health Check 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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"
}
}
7.1.22.2 - 1.3
put /v1/lb-health-checks/{lb_health_check_id}
Description
Set LB Health Check
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_health_check_id required | LB Health Check 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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"
}
}
7.1.23 - SetLbListener
7.1.23.1 - 1.3
put /v1/lb-listeners/{listener_id}
Description
set loadbalancer listener
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | listener_id required | The ID of the listener. Example : | string | None |
| body | body required | LbListenerSetRequestV1Dot3 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LbListenerShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"listener": {
"condition_type": "URL_PATH",
"description": "",
"hsts_max_age": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"idle_timeout": "",
"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": "",
"hsts_max_age": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"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": ""
}
}
7.1.24 - SetLbListenerCertificate
7.1.24.1 - 1.4
put /v1/lb-listeners/{listener_id}/certificate
Description
set loadbalancer listener certificate
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | listener_id required | The ID of the listener. Example : | string | None |
| body | body required | LbListenerCertificateSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LbListenerShowResponseV1Dot4 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-listeners/{listener_id}/certificate
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Request body
{
"listener": {
"sni_certificate": [
{
"domain_name": "",
"sni_cert_id": ""
}
],
"ssl_certificate": {
"client_cert_id": "",
"client_cert_level": "",
"server_cert_level": ""
}
}
}
Example HTTP response
Response 202
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"hsts_config": {
"include_sub_domains": "",
"max_age": ""
},
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"loadbalancer_id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"response_timeout": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"server_group_name": "",
"service_port": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"sni_cert_id": ""
}
],
"ssl_certificate": {
"client_cert_id": "",
"client_cert_level": "",
"server_cert_level": ""
},
"state": "",
"support_http2": "",
"tags": [],
"url_handler": [
{
"seq": "",
"server_group_id": "",
"server_group_name": "",
"url_pattern": ""
}
],
"url_redirection": "",
"x_forwarded_for": "",
"x_forwarded_port": "",
"x_forwarded_proto": ""
}
}
7.1.25 - SetLbListenerResource
7.1.25.1 - 1.4
put /v1/lb-listeners/{listener_id}/resource
Description
set loadbalancer listener resource
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | listener_id required | The ID of the listener. Example : | string | None |
| body | body required | LbListenerResourceSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LbListenerShowResponseV1Dot4 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-listeners/{listener_id}/resource
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Request body
{
"listener": {
"description": "",
"hsts_config": {
"include_sub_domains": "",
"max_age": ""
},
"idle_timeout": "",
"insert_client_ip": "",
"persistence": "",
"response_timeout": "",
"session_duration_time": "",
"support_http2": "",
"x_forwarded_for": "",
"x_forwarded_port": "",
"x_forwarded_proto": ""
}
}
Example HTTP response
Response 202
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"hsts_config": {
"include_sub_domains": "",
"max_age": ""
},
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"loadbalancer_id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"response_timeout": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"server_group_name": "",
"service_port": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"sni_cert_id": ""
}
],
"ssl_certificate": {
"client_cert_id": "",
"client_cert_level": "",
"server_cert_level": ""
},
"state": "",
"support_http2": "",
"tags": [],
"url_handler": [
{
"seq": "",
"server_group_id": "",
"server_group_name": "",
"url_pattern": ""
}
],
"url_redirection": "",
"x_forwarded_for": "",
"x_forwarded_port": "",
"x_forwarded_proto": ""
}
}
7.1.26 - SetLbListenerRule
7.1.26.1 - 1.4
put /v1/lb-listeners/{listener_id}/rule
Description
set loadbalancer listener rule
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | listener_id required | The ID of the listener. Example : | string | None |
| body | body required | LbListenerRuleSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | LbListenerShowResponseV1Dot4 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-listeners/{listener_id}/rule
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Request body
{
"listener": {
"condition_type": "URL_PATH",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"server_group_id": "",
"url_handler": [
{
"seq": "",
"server_group_id": "",
"url_pattern": ""
}
],
"url_redirection": ""
}
}
Example HTTP response
Response 202
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"hsts_config": {
"include_sub_domains": "",
"max_age": ""
},
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"loadbalancer_id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"response_timeout": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"server_group_name": "",
"service_port": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"sni_cert_id": ""
}
],
"ssl_certificate": {
"client_cert_id": "",
"client_cert_level": "",
"server_cert_level": ""
},
"state": "",
"support_http2": "",
"tags": [],
"url_handler": [
{
"seq": "",
"server_group_id": "",
"server_group_name": "",
"url_pattern": ""
}
],
"url_redirection": "",
"x_forwarded_for": "",
"x_forwarded_port": "",
"x_forwarded_proto": ""
}
}
7.1.27 - SetLBServerGroup
7.1.27.1 - 1.4
put /v1/lb-server-groups/{lb_server_group_id}
Description
Set LB Server Group
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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"
}
}
7.1.27.2 - 1.3
put /v1/lb-server-groups/{lb_server_group_id}
Description
Set LB Server Group
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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"
}
}
7.1.28 - SetLbServerGroupMember
7.1.28.1 - 1.4
put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Set Lb Server Group Member
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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": ""
}
}
7.1.28.2 - 1.3
put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Set Lb Server Group Member
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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": ""
}
}
7.1.29 - SetLoadbalancer
7.1.29.1 - 1.4
put /v1/loadbalancers/{loadbalancer_id}
Description
Set Load Balancer
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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": ""
}
}
7.1.29.2 - 1.3
put /v1/loadbalancers/{loadbalancer_id}
Description
Set Load Balancer
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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": ""
}
}
7.1.30 - ShowLBHealthCheck
7.1.30.1 - 1.4
get /v1/lb-health-checks/{lb_health_check_id}
Description
Get LB Health Check
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_health_check_id required | LB Health Check 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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"
}
}
7.1.30.2 - 1.3
get /v1/lb-health-checks/{lb_health_check_id}
Description
Get LB Health Check
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_health_check_id required | LB Health Check 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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"
}
}
7.1.31 - ShowLbListener
7.1.31.1 - 1.4
get /v1/lb-listeners/{listener_id}
Description
show LB listener
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | listener_id required | The ID of the listener. Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LbListenerShowResponseV1Dot4 |
| 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 200
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"hsts_config": {
"include_sub_domains": "",
"max_age": ""
},
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"loadbalancer_id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"response_timeout": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"server_group_name": "",
"service_port": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"sni_cert_id": ""
}
],
"ssl_certificate": {
"client_cert_id": "",
"client_cert_level": "",
"server_cert_level": ""
},
"state": "",
"support_http2": "",
"tags": [],
"url_handler": [
{
"seq": "",
"server_group_id": "",
"server_group_name": "",
"url_pattern": ""
}
],
"url_redirection": "",
"x_forwarded_for": "",
"x_forwarded_port": "",
"x_forwarded_proto": ""
}
}
7.1.31.2 - 1.3
get /v1/lb-listeners/{listener_id}
Description
show LB listener
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | listener_id required | The ID of the listener. Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LbListenerShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"hsts_max_age": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"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": ""
}
}
7.1.32 - ShowLBServerGroup
7.1.32.1 - 1.4
get /v1/lb-server-groups/{lb_server_group_id}
Description
Show LB Server Group
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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"
}
}
7.1.32.2 - 1.3
get /v1/lb-server-groups/{lb_server_group_id}
Description
Show LB Server Group
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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"
}
}
7.1.33 - ShowLbServerGroupMember
7.1.33.1 - 1.4
get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Show Lb Server Group Member
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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": ""
}
}
7.1.33.2 - 1.3
get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Show Lb Server Group Member
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_server_group_id required | ID of Lb Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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": ""
}
}
7.1.34 - ShowLoadbalancer
7.1.34.1 - 1.4
get /v1/loadbalancers/{loadbalancer_id}
Description
show Load Balancer
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | loadbalancer_id required | ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LoadbalancerShowResponseV1Dot4 |
| 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 200
{
"loadbalancer": {
"account_id": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"firewall_id": "",
"health_check_ips": [
""
],
"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": "",
"zones": []
}
}
7.1.34.2 - 1.3
get /v1/loadbalancers/{loadbalancer_id}
Description
show Load Balancer
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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": ""
}
}
7.1.35 - ShowLoadbalancerCertificate
7.1.35.1 - 1.4
get /v1/loadbalancers/certificates/{lb_certificate_id}
Description
show Load Balancer certificate
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_certificate_id required | The ID of the certificate 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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
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": "2024-01-15T10:30:00.000Z",
"not_before_dt": "2024-01-15T10:30:00.000Z",
"organization": "",
"private_key": "",
"state": ""
}
}
7.1.35.2 - 1.3
get /v1/loadbalancers/certificates/{lb_certificate_id}
Description
show Load Balancer certificate
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | lb_certificate_id required | The ID of the certificate 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
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": "2024-01-15T10:30:00.000Z",
"not_before_dt": "2024-01-15T10:30:00.000Z",
"organization": "",
"private_key": "",
"state": ""
}
}
7.1.36 - ShowLoadbalancerPrivateNatIp
7.1.36.1 - 1.4
get /v1/loadbalancers/{loadbalancer_id}/private-static-nats
Description
Show Load Balancer Private NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | loadbalancer_id required | ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateStaticNatShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 200
{
"static_nat": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"external_ip_address": "",
"id": "",
"internal_ip_address": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"private_nat_ip_id": "",
"state": ""
}
}
7.1.36.2 - 1.3
get /v1/loadbalancers/{loadbalancer_id}/private-static-nats
Description
Show Load Balancer Private NAT IP
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | loadbalancer_id required | ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateStaticNatShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/private-static-nats
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"static_nat": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"external_ip_address": "",
"id": "",
"internal_ip_address": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"private_nat_ip_id": "",
"state": ""
}
}
7.1.37 - ShowLoadbalancerPublicNatIp
7.1.37.1 - 1.4
get /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
Show Load Balancer Public NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.4 | - |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.4"
Example HTTP response
Response 200
{
"static_nat": {
"external_ip_address": "",
"publicip_id": "",
"state": ""
}
}
7.1.37.2 - 1.3
get /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
Show Load Balancer Public NAT IP
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.3 | 20261031 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"static_nat": {
"external_ip_address": "",
"publicip_id": "",
"state": ""
}
}
7.2 - Models
7.2.1 - HstsConfig
| Name | Description | Schema | Default |
|---|---|---|---|
| include_sub_domains optional | The hsts include_sub_domains of the listener. Example : | any of [boolean, null] | |
| max_age optional | The hsts max_age of the listener. Example : | any of [integer, null] |
7.2.2 - HttpsRedirection
| Name | Description | Schema | Default |
|---|---|---|---|
| port optional | port Example : | any of [string, null] | |
| protocol optional | protocol Example : | any of [string, null] | |
| response_code optional | response_code Example : | any of [string, null] |
7.2.3 - LbCertificateForShow
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | 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 | |
| name optional | Example : | string | |
| not_after_dt optional | Example : | string (date-time) | |
| not_before_dt optional | Example : | string (date-time) | |
| organization required | The organization of the certificate Example : | string | |
| private_key required | The private key of the certificate Example : | string | |
| state optional | Example : | string |
7.2.4 - LbCertificateListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| certificates required | array[LbCertificateListResponseDetail] | ||
| 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] |
7.2.5 - LbCertificateListResponseDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| cert_kind required | Kind of certificate Example : | string | |
| cn required | Common Name of certificate Example : | string | |
| created_at optional | Created At Example : | any of [string (date-time), null] | |
| created_by optional | Created By Example : | any of [string, null] | |
| id required | ID of the certificate Example : | string | |
| modified_at optional | Modified At Example : | any of [string (date-time), null] | |
| modified_by optional | Modified By Example : | any of [string, null] | |
| name required | Name of the certificate Example : | string | |
| not_after_dt required | Expiration date and time of the certificate Example : | string (date-time) | |
| not_before_dt required | Start date and time when the certificate becomes valid Example : | string (date-time) | |
| state required | State of the certificate Example : | string |
7.2.6 - LbCertificateShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| certificate required | LbCertificateForShow |
7.2.7 - LbHealthCheckCreate
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : this is an lb server group | any of [string, null] | |
| health_check_count optional | LB Health Check count Example : 3Minimum : 1Maximum : 10 | integer | 3 |
| health_check_interval optional | LB Health Check interval Example : 5Minimum : 1Maximum : 180 | integer | 5 |
| health_check_port optional | LB Health Check port Example : 80 | any of [integer, null] | |
| health_check_timeout optional | LB Health Check timeout Example : 5Minimum : 1Maximum : 180 | integer | 5 |
| health_check_url optional | LB Health Check URL Example : /testPattern : ^\/[A-Za-z0-9/._?&=-]*$ | any of [string, null] | |
| http_method optional | LB Health Check HTTP Method Example : GET | any of [enum (GET, POST), null] | |
| name required | LB Health Check name Example : ServerGroup01Pattern : ^[a-zA-Z0-9][-a-zA-Z0-9_]*[a-zA-Z0-9]$Minimum length : 3Maximum length : 63 | string | |
| protocol required | LB Health Check Protocol Example : TCP | enum (TCP, HTTP, HTTPS) | |
| request_data optional | LB Health Check Request data Example : username=admin&password=1234Pattern : ^[a-zA-Z0-9_\W]*$ | any of [string, null] | |
| response_code optional | LB Health Check Response code 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 |
7.2.8 - LbHealthCheckCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_health_check required | LbHealthCheckCreate |
7.2.9 - LbHealthCheckList
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| health_check_type required | LB Health Check type Example : DEFAULT | enum (DEFAULT, CUSTOM) | |
| id required | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | string | |
| lb_server_group_count required | LB Server Group count Example : 2 | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | LB Health Check name Example : Test-LbMonitor-01 | string | |
| protocol required | LB Health Check Protocol Example : TCP | enum (TCP, HTTP, HTTPS) | |
| state required | LB Health Check state Example : ACTIVE | string | |
| subnet_id required | Service Subnet ID Example : 60fba45cb6c811efba41ba92e4fe7200 | string |
7.2.10 - LbHealthCheckListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
7.2.11 - LbHealthCheckSet
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : this is an lb server group | any of [string, null] | |
| health_check_count optional | LB Health Check count Example : 3 | any of [integer, null] | |
| health_check_interval optional | LB Health Check interval Example : 5 | any of [integer, null] | |
| health_check_port optional | LB Health Check port Example : 80 | any of [integer, null] | |
| health_check_timeout optional | LB Health Check timeout Example : 5 | any of [integer, null] | |
| health_check_url optional | LB Health Check URL Example : /testPattern : ^\/[A-Za-z0-9/._?&=-]*$ | any of [string, null] | |
| http_method optional | LB Health Check HTTP Method Example : GET | any of [enum (GET, POST), null] | |
| protocol optional | LB Health Check Protocol Example : TCP | any of [enum (TCP, HTTP, HTTPS), null] | |
| request_data optional | LB Health Check Request data Example : username=admin&password=1234Pattern : ^[a-zA-Z0-9_\W]*$ | any of [string, null] | |
| response_code optional | LB Health Check Response code Example : 200 | any of [string, null] |
7.2.12 - LbHealthCheckSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_health_check required | LbHealthCheckSet |
7.2.13 - LbHealthCheckShow
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : e3cd678b11784734bc366148aa37580e | any of [string, 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 | Description Example : this is an lb server group | any of [string, null] | |
| health_check_count optional | LB Health Check count Example : 3 | integer | 3 |
| health_check_interval optional | LB Health Check interval Example : 5 | integer | 5 |
| health_check_port required | LB Health Check port Example : 80 | any of [integer, null] | |
| health_check_timeout optional | LB Health Check timeout Example : 5 | integer | 5 |
| health_check_type required | LB Health Check type Example : DEFAULT | enum (DEFAULT, CUSTOM) | |
| health_check_url required | LB Health Check URL Example : /test | any of [string, null] | |
| http_method required | LB Health Check HTTP Method Example : GET | any of [string, null] | |
| id required | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | 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 | LB Health Check name Example : Test-LbMonitor-01 | string | |
| protocol optional | LB Health Check Protocol Example : TCP | enum (TCP, HTTP, HTTPS) | TCP |
| request_data required | LB Health Check Request data Example : username=admin&password=1234 | any of [string, null] | |
| response_code required | LB Health Check Response code 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] |
7.2.14 - LbHealthCheckShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_health_check required | LbHealthCheckShow |
7.2.15 - LbListenerCertificateBase
| Name | Description | Schema | Default |
|---|---|---|---|
| sni_certificate optional | The sni certificate of the listener. | any of [array[SniCertificate], null] | |
| ssl_certificate optional | The ssl certificate of the listener. | any of [SslCertificate, null] |
7.2.16 - LbListenerCertificateSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | LbListenerCertificateBase |
7.2.17 - LbListenerCreateRequestV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | ListenerForCreateV1Dot3 |
7.2.18 - LbListenerCreateRequestV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | ListenerForCreateV1Dot4 |
7.2.19 - LbListenerDistinctBase
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | description Example : | any of [string, null] | |
| hsts_config optional | The hsts response header of the listener. | any of [HstsConfig, null] | |
| idle_timeout optional | The idle timeout(L7) of the listener. Example : | any of [integer, null] | |
| insert_client_ip optional | Whether the client IP should be inserted. Example : | any of [boolean, null] | |
| persistence optional | The persistence of the listener. Example : | any of [string, null] | |
| response_timeout optional | The response timeout of the listener. Example : | any of [integer, null] | |
| session_duration_time optional | The session duration time. Example : | any of [integer, null] | |
| support_http2 optional | Whether the HTTP 2.0 is supported Example : | any of [boolean, 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] |
7.2.20 - LbListenerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| listeners required | The list of the listener. | 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] |
7.2.21 - LbListenerResourceSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | LbListenerDistinctBase |
7.2.22 - LbListenerRuleBase
| Name | Description | Schema | Default |
|---|---|---|---|
| condition_type optional | The condition type of the listener. Example : URL_PATH | any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null] | |
| https_redirection optional | The https redirection of the listener. | any of [HttpsRedirection, null] | |
| server_group_id optional | The ID of the server group. Example : | any of [string, null] | |
| url_handler optional | The URL handler of the listener. | any of [array[UrlHandler], null] | |
| url_redirection optional | The URL redirect of the listener. Example : | any of [string, null] |
7.2.23 - LbListenerRuleSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | LbListenerRuleBase |
7.2.24 - LbListenerSetRequestV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | ListenerForSetV1Dot3 |
7.2.25 - LbListenerShowResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | ListenerForShowV1Dot3 |
7.2.26 - LbListenerShowResponseV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | ListenerForShow |
7.2.27 - LbListenerSslCertificate
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
7.2.28 - LbServerGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : e3cd678b11784734bc366148aa37580e | 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 : this is an lb server group | any of [string, null] | |
| id required | LB Server Group ID Example : 3d8d8754d0d54683a29f3dcc3dd95d5b | string | |
| lb_health_check_id required | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | any of [string, null] | |
| lb_method required | LB Method Example : ROUND_ROBIN | enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION) | |
| lb_name optional | Load Balancer name Example : Test-LB-01 | any of [string, null] | |
| loadbalancer_id optional | Load Balancer ID Example : 82efa35c88834bc083020443e57faa10 | any of [string, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | LB Server Group name Example : ServerGroup01 | string | |
| protocol required | Protocol Example : TCP | enum (TCP, UDP) | |
| state required | LB Server Group state Example : ACTIVE | string | |
| subnet_id required | Service Subnet ID Example : 60fba45cb6c811efba41ba92e4fe7200 | string | |
| vpc_id required | VPC ID Example : 8acceeb6920c4fc494490d864f67f0b5 | string |
7.2.29 - LbServerGroupCreate
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : this is an lb server group | any of [string, null] | |
| lb_health_check_id optional | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | any of [string, null] | |
| lb_method required | LB Method Example : ROUND_ROBIN | enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION) | |
| name required | LB Health Check name Example : ServerGroup01Pattern : ^[a-zA-Z0-9][-a-zA-Z0-9_]*[a-zA-Z0-9]$Minimum length : 3Maximum length : 63 | string | |
| protocol required | Protocol 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 |
7.2.30 - LbServerGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_server_group required | LbServerGroupCreate |
7.2.31 - LbServerGroupList
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | LB Server Group ID Example : 3d8d8754d0d54683a29f3dcc3dd95d5b | string | |
| lb_health_check_id required | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | any of [string, null] | |
| lb_name optional | Load Balancer name Example : Test-LB-01 | any of [string, null] | |
| lb_server_group_member_count required | LB Server Group Member count Example : 2 | integer | |
| loadbalancer_id optional | Load Balancer ID Example : 82efa35c88834bc083020443e57faa10 | any of [string, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | LB Server Group name Example : ServerGroup01 | string | |
| protocol required | Protocol Example : TCP | enum (TCP, UDP) | |
| state required | LB Server Group state Example : ACTIVE | string | |
| vpc_id required | VPC ID Example : 8acceeb6920c4fc494490d864f67f0b5 | string |
7.2.32 - LbServerGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
7.2.33 - LbServerGroupSet
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : this is an lb server group | any of [string, null] | |
| lb_health_check_id optional | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | any of [string, null] | |
| lb_method optional | LB Method Example : ROUND_ROBIN | any of [enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null] |
7.2.34 - LbServerGroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_server_group required | LbServerGroupSet |
7.2.35 - LbServerGroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_server_group required | LbServerGroup |
7.2.36 - ListenerForCreateV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| condition_type optional | The condition type of the listener. Example : URL_PATH | any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null] | |
| description optional | description Example : | any of [string, null] | |
| hsts_max_age optional | The hsts max_age of the listener. Example : | any of [integer, null] | |
| https_redirection optional | The https redirection of the listener. | any of [HttpsRedirection, null] | |
| idle_timeout optional | The idle timeout(L7) of the listener. Example : | any of [integer, null] | |
| insert_client_ip optional | Whether the client IP should be inserted. Example : | any of [boolean, null] | |
| loadbalancer_id required | The ID of the load balancer. Example : | string | |
| name required | The name of the listener. Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum length : 63 | string | |
| persistence optional | The persistence of the listener. Example : | any of [string, null] | |
| protocol required | The protocol of the listener. Example : TCP | enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY) | |
| response_timeout optional | The response timeout of the listener. 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 | The ID of the server group. Example : | any of [string, null] | |
| service_port required | The port of the listener. Example : Minimum : 1Maximum : 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 | The ssl certificate of the listener. | 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 | The URL handler of the listener. 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] |
7.2.37 - ListenerForCreateV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| condition_type optional | The condition type of the listener. Example : URL_PATH | any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null] | |
| description optional | description Example : | any of [string, null] | |
| https_redirection optional | The https redirection of the listener. | any of [HttpsRedirection, null] | |
| idle_timeout optional | The idle timeout(L7) of the listener. Example : | any of [integer, null] | |
| insert_client_ip optional | Whether the client IP should be inserted. Example : | any of [boolean, null] | |
| loadbalancer_id required | The ID of the load balancer. Example : | string | |
| name required | The name of the listener. Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum length : 63 | string | |
| persistence optional | The persistence of the listener. Example : | any of [string, null] | |
| protocol required | The protocol of the listener. Example : TCP | enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY) | |
| response_timeout optional | The response timeout of the listener. 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 | The ID of the server group. Example : | any of [string, null] | |
| service_port required | The port of the listener. Example : Minimum : 1Maximum : 65534 | integer | |
| session_duration_time optional | The session duration time. Example : | any of [integer, null] | |
| ssl_certificate optional | The ssl certificate of the listener. | 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 | The URL handler of the listener. | any of [array[UrlHandler], 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] |
7.2.38 - ListenerForList
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | |
| name required | The name of the listener. Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum length : 63 | string | |
| protocol required | The protocol of the listener. Example : TCP | enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY) | |
| service_port required | The port of the listener. Example : Minimum : 1Maximum : 65534 | integer | |
| state optional | The State of the listener. Example : | any of [string, null] |
7.2.39 - ListenerForSetV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| condition_type optional | The condition type of the listener. Example : URL_PATH | any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null] | |
| description optional | description Example : | any of [string, null] | |
| hsts_max_age optional | The hsts max_age of the listener. Example : | any of [integer, null] | |
| https_redirection optional | The https redirection of the listener. | any of [HttpsRedirection, null] | |
| idle_timeout optional | The idle timeout(L7) of the listener. Example : | any of [integer, null] | |
| insert_client_ip optional | Whether the client IP should be inserted. Example : | any of [boolean, null] | |
| persistence optional | The persistence of the listener. Example : | any of [string, null] | |
| response_timeout optional | The response timeout of the listener. Example : | any of [integer, null] | |
| server_group_id optional | The ID of the server group. 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 | The ssl certificate of the listener. | any of [LbListenerSslCertificate, null] | |
| support_http2 optional | Whether the HTTP 2.0 is supported Example : | boolean | |
| url_handler optional | The URL handler of the listener. 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] |
7.2.40 - ListenerForShow
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | 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] | |
| hsts_config optional | The hsts response header of the listener. | any of [HstsConfig, null] | |
| https_redirection optional | The https redirection of the listener. | any of [HttpsRedirection, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| idle_timeout optional | The idle timeout(L7) of the listener. Example : | any of [integer, null] | |
| insert_client_ip optional | Whether the client IP should be inserted. Example : | any of [boolean, null] | |
| loadbalancer_id required | The ID of the load balancer. 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 | The name of the listener. Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum length : 63 | string | |
| persistence optional | The persistence of the listener. Example : | any of [string, null] | |
| protocol required | The protocol of the listener. Example : TCP | enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY) | |
| response_timeout optional | The response timeout of the listener. 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 | The ID of the server group. Example : | any of [string, null] | |
| server_group_name optional | The Name of the server group. Example : | any of [string, null] | |
| service_port required | The port of the listener. Example : Minimum : 1Maximum : 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[SniCertificateResponse], null] | |
| ssl_certificate optional | The ssl certificate of the listener. | any of [SslCertificate, null] | |
| state required | The State of the listener. Example : | string | |
| support_http2 optional | Whether the HTTP 2.0 is supported Example : | any of [boolean, null] | |
| tags optional | Tag List | array[Tag] | |
| url_handler optional | URL handler list | any of [array[UrlHandlerResponse], 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] |
7.2.41 - ListenerForShowV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | 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] | |
| hsts_max_age optional | The hsts max_age of the listener. Example : | any of [integer, null] | |
| https_redirection optional | The https redirection of the listener. | any of [HttpsRedirection, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| idle_timeout optional | The idle timeout(L7) of the listener. Example : | any of [integer, null] | |
| insert_client_ip optional | Whether the client IP should be inserted. Example : | any of [boolean, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | The name of the listener. Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum length : 63 | string | |
| persistence optional | The persistence of the listener. Example : | any of [string, null] | |
| protocol required | The protocol of the listener. Example : TCP | enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY) | |
| response_timeout optional | The response timeout of the listener. 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 | The ID of the server group. Example : | any of [string, null] | |
| server_group_name optional | The Name of the server group. Example : | any of [string, null] | |
| service_port required | The port of the listener. Example : Minimum : 1Maximum : 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 | The ssl certificate of the listener. | any of [SslCertificate, null] | |
| state required | The State of the listener. Example : | string | |
| support_http2 optional | Whether the HTTP 2.0 is supported Example : False | any of [boolean, null] | |
| url_handler optional | The URL handler of the listener. 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] |
7.2.42 - Loadbalancer
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | The account ID of the load balancer. 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] | |
| firewall_id optional | Firewall ID Example : | any of [string, null] | |
| health_check_ip required | Health check IP | array[string] | |
| id required | ID Example : | string | |
| layer_type required | Layer type 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 | name Example : | string | |
| public_nat_enabled optional | Public NAT Enabled Status Example : | any of [boolean, null] | |
| service_ip optional | The service IP of the load balancer. 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 |
7.2.43 - LoadbalancerCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| loadbalancer required | LoadbalancerCreateRequestDetail |
7.2.44 - LoadbalancerCreateRequestDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | description Example : | any of [string, null] | |
| firewall_enabled optional | Firewall enabled Example : True | any of [boolean, null] | True |
| firewall_logging_enabled optional | Firewall logging enabled 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 | Layer type Example : | string | |
| name required | name Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum length : 63 | string | |
| publicip_id optional | Public IP ID Example : | any of [string, null] | |
| service_ip optional | The service IP of the load balancer. 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 |
7.2.45 - LoadbalancerCreateRequestDetailV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | description Example : | any of [string, null] | |
| firewall_enabled optional | Firewall enabled Example : True | any of [boolean, null] | True |
| firewall_logging_enabled optional | Firewall logging enabled Example : True | any of [boolean, null] | True |
| health_check_ips optional | The list of Health check IPs Example : | any of [array[string], null] | |
| layer_type required | Layer type Example : | string | |
| name required | name Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum length : 63 | string | |
| publicip_id optional | Public IP ID Example : | any of [string, null] | |
| service_ip optional | The service IP of the load balancer. 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 | |
| zones optional | Availability Zones | array[string] |
7.2.46 - LoadbalancerCreateRequestV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| loadbalancer required | LoadbalancerCreateRequestDetailV1Dot4 |
7.2.47 - LoadbalancerCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| loadbalancer required | LoadbalancerCreateResponseDetail |
7.2.48 - LoadbalancerCreateResponseDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | The account ID of the load balancer. 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 | ID Example : | string | |
| layer_type required | Layer type 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 | name 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 |
7.2.49 - LoadbalancerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
7.2.50 - LoadbalancerListResponseDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| firewall_id optional | Firewall ID Example : | any of [string, null] | |
| id required | ID Example : | string | |
| layer_type optional | Layer type Example : | any of [string, null] | |
| listener_count optional | The number of listeners. Example : | any of [integer, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | The name of the load balancer. Example : | any of [string, null] | |
| public_nat_enabled optional | Public NAT Enabled Status Example : | any of [boolean, null] | |
| service_ip optional | The service IP of the load balancer. 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] |
7.2.51 - LoadbalancerListResponseDetailV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| firewall_id optional | Firewall ID Example : | any of [string, null] | |
| id required | ID Example : | string | |
| layer_type optional | Layer type Example : | any of [string, null] | |
| listener_count optional | The number of listeners. Example : | any of [integer, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | The name of the load balancer. Example : | any of [string, null] | |
| public_nat_enabled optional | Public NAT Enabled Status Example : | any of [boolean, null] | |
| service_ip optional | The service IP of the load balancer. 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] | |
| zones optional | Availability Zones | array[string] |
7.2.52 - LoadbalancerListResponseV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| loadbalancers required | array[LoadbalancerListResponseDetailV1Dot4] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
7.2.53 - LoadbalancerShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| loadbalancer required | Loadbalancer |
7.2.54 - LoadbalancerShowResponseV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| loadbalancer required | LoadbalancerV1Dot4 |
7.2.55 - LoadbalancerStaticNatResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| static_nat required | StaticNat |
7.2.56 - LoadbalancerUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| loadbalancer required | LoadbalancerUpdateRequestDetail |
7.2.57 - LoadbalancerUpdateRequestDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | description Example : Maximum length : 255 | string |
7.2.58 - LoadbalancerV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | The account ID of the load balancer. 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] | |
| firewall_id optional | Firewall ID Example : | any of [string, null] | |
| health_check_ips required | Health check IP | array[string] | |
| id required | ID Example : | string | |
| layer_type required | Layer type 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 | name Example : | string | |
| public_nat_enabled optional | Public NAT Enabled Status Example : | any of [boolean, null] | |
| service_ip optional | The service IP of the load balancer. 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 | |
| zones optional | Availability Zones | array[string] |
7.2.59 - Member
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | |
| lb_server_group_id required | ID of Lb Server Group Example : | string | |
| member_ip required | IP of Member Example : | string | |
| member_port required | Protocol port of Member Example : | integer | |
| member_state required | Member State of Member Example : | string | |
| member_weight required | Weight of Member Example : | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Name of Member Example : | string | |
| object_id optional | Object ID of Member Example : | any of [string, null] | |
| object_type required | Object Type of 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 | ID of Subnet Example : | string | |
| uuid required | UUID of Member Example : | string |
7.2.60 - MemberCreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| member_ip required | IP of Member Example : 192.168.0.1 | string | |
| member_port required | Protocol port of Member Example : 80Minimum : 1Maximum : 65534 | integer | |
| member_state optional | Member State of Member Example : ENABLE | any of [enum (ENABLE, DISABLE), null] | |
| member_weight optional | Weight of Member Example : 100Minimum : 1Maximum : 1000 | integer | |
| name required | Name of Member Example : virtualserver-1Pattern : ^[a-zA-Z0-9\s\-_\.]*$Minimum length : 1Maximum length : 63 | string | |
| object_id optional | Object ID of Member Example : 1 | string | |
| object_type required | Object Type of Member Example : VM | string |
7.2.61 - MemberDeleteBulkRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| member_id_list required | ID list of Member | array[string] |
7.2.62 - MemberListCreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| members required | array[MemberCreateRequestV1Dot1] |
7.2.63 - MemberListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] | |
| members required | array[Member] |
7.2.64 - MemberSet
| Name | Description | Schema | Default |
|---|---|---|---|
| member_port optional | Protocol port of 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] |
7.2.65 - MemberSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| member required | MemberSet |
7.2.66 - MemberShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| member required | any of [Member, null] |
7.2.67 - MemberWithHealthState
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| health_state required | Health State of Member Example : | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| lb_server_group_id required | ID of Lb Server Group Example : | string | |
| member_ip required | IP of Member Example : | string | |
| member_port required | Protocol port of Member Example : | integer | |
| member_state required | Member State of Member Example : | string | |
| member_weight required | Weight of Member Example : | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Name of Member Example : | string | |
| object_id required | Object ID of Member Example : | any of [string, null] | |
| object_type required | Object Type of Member Example : VM | enum (VM, BM, MANUAL, MNGC) | |
| state required | State of Member Example : CREATING | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) |
7.2.68 - MemberWithHealthStateListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
7.2.69 - MemberWithHealthStateListResponseV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| members required | array[MemberWithHealthStateV1Dot4] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
7.2.70 - MemberWithHealthStateV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| health_state required | Health State of Member Example : | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| lb_server_group_id required | ID of Lb Server Group Example : | string | |
| member_ip required | IP of Member Example : | string | |
| member_port required | Protocol port of Member Example : | integer | |
| member_state required | Member State of Member Example : | string | |
| member_weight required | Weight of Member Example : | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Name of Member Example : | string | |
| object_az optional | Object AZ of Member Example : | any of [string, null] | |
| object_id required | Object ID of Member Example : | any of [string, null] | |
| object_type required | Object Type of Member Example : VM | enum (VM, BM, MANUAL, MNGC) | |
| state required | State of Member Example : CREATING | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) |
7.2.71 - PrivateStaticNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| static_nat required | PrivateStaticNatCreateRequestDetail |
7.2.72 - PrivateStaticNatCreateRequestDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| private_nat_id required | private_nat_id Example : | string | |
| private_nat_ip_id required | private_nat_ip_id Example : | string |
7.2.73 - PrivateStaticNatCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| static_nat required | PrivateStaticNatCreateResponseDetail |
7.2.74 - PrivateStaticNatCreateResponseDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| 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 | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| private_nat_ip_id optional | private_nat_ip_id Example : | any of [string, null] | |
| state optional | state Example : | any of [string, null] | |
| subnet_id optional | subnet_id Example : | any of [string, null] |
7.2.75 - PrivateStaticNatShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| static_nat required | any of [PrivateStaticNatShowResponseDetail, null] |
7.2.76 - PrivateStaticNatShowResponseDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| 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 | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| private_nat_ip_id optional | private_nat_ip_id Example : | any of [string, null] | |
| state optional | state Example : | any of [string, null] |
7.2.77 - 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] |
7.2.78 - SniCertificateResponse
| 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] | |
| not_after_dt optional | The expiration date and time of the certificate Example : | any of [string (date-time), null] | |
| sni_cert_id optional | Certificate id for sni ssl Example : | any of [string, null] |
7.2.79 - SslCertificate
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
7.2.80 - StaticNat
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
7.2.81 - StaticNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| static_nat required | StaticNatCreateRequestDetail |
7.2.82 - StaticNatCreateRequestDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| publicip_id required | publicip_id Example : | string |
7.2.83 - StaticNatCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| static_nat required | StaticNatCreateResponseDetail |
7.2.84 - StaticNatCreateResponseDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | account_id Example : | any of [string, null] | |
| action_type optional | action_type Example : | any of [string, 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 | description 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 | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | name 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] |
7.2.85 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |
7.2.86 - UrlHandler
| Name | Description | Schema | Default |
|---|---|---|---|
| seq required | Sequence number for ordering Example : | integer | |
| server_group_id optional | The ID of the server group. Example : | any of [string, null] | |
| url_pattern required | URL pattern for routing action Example : Minimum length : 1Maximum length : 63 | string |
7.2.87 - UrlHandlerResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| seq optional | Sequence number for ordering Example : | any of [integer, null] | |
| server_group_id optional | The ID of the server group. Example : | any of [string, null] | |
| server_group_name optional | The Name of the server group. Example : | any of [string, null] | |
| url_pattern required | URL pattern for routing Example : | string |
8 - Security Group
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP. This guide provides a brief description of Security Group service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | SUPPORTED | 20270131 |
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 |
API Version History
1.1
API version 1.1 release for Security Group
Changes
- [Changed]
GET /v1/security-group-rules- API has been changed.- Response model has been changed to SecurityGroupRuleListResponseV1Dot1.
- The following fields are added to the response.
- remote_address_group_id, remote_address_group_name
- Response model has been changed to SecurityGroupRuleListResponseV1Dot1.
- [Changed]
POST /v1/security-group-rules- API has been changed.- Request model has been changed to SecurityGroupRuleCreateRequestV1Dot1.
- The following field is added to the request.
- remote_address_group_id
- Response model has been changed to SecurityGroupRuleShowResponseV1Dot1.
- The following fields are added to the response.
- remote_address_group_id, remote_address_group_name
- Request model has been changed to SecurityGroupRuleCreateRequestV1Dot1.
- [Changed]
GET /v1/security-group-rules/{security_group_rule_id}- API has been changed.- Response model has been changed to SecurityGroupRuleShowResponseV1Dot1.
- The following fields are added to the response.
- remote_address_group_id, remote_address_group_name
- Response model has been changed to SecurityGroupRuleShowResponseV1Dot1.
- [New]
GET /v1/address-groups- API has been added. - [New]
POST /v1/address-groups- API has been added. - [New]
GET /v1/address-groups/{address_group_id}- API has been added. - [New]
PUT /v1/address-groups/{address_group_id}- API has been added. - [New]
DELETE /v1/address-groups/{address_group_id}- API has been added. - [New]
GET /v1/address-groups/{address_group_id}/addresses- API has been added. - [New]
PUT /v1/address-groups/{address_group_id}/add_addresses- API has been added. - [New]
PUT /v1/address-groups/{address_group_id}/remove_addresses- API has been added.
1.0
Initial API release for Security Group
Changes
- [New]
GET /v1/security-groups- API has been added. - [New]
POST /v1/security-groups- API has been added. - [New]
SHOW /v1/security-groups/{security_group_id}- API has been added. - [New]
PUT /v1/security-groups/{security_group_id}- API has been added. - [New]
DELETE /v1/security-groups/{security_group_id}- API has been added. - [New]
GET /v1/security-group-rules- API has been added. - [New]
POST /v1/security-group-rules- API has been added. - [New]
GET /v1/security-group-rules/{security_group_rule_id}- API has been added. - [New]
DELETE /v1/security-group-rules/{security_group_rule_id}- API has been added.
8.1 - APIs
8.1.1 - Add Address Group IPs
8.1.1.1 - 1.1
put /v1/address-groups/{address_group_id}/add_addresses
Description
Add IP addresses to address group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | address_group_id required | Address Group ID Example : 4b18494930bf4c5dbb97a9eb2ef68fe1 | string | None |
| body | body required | AddressGroupCidrsAddRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AddressGroupCidrsAddRequest |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/address-groups/{address_group_id}/add_addresses
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = security-group 1.1"
Request body
{
"addresses": [
"10.1.1.1/32",
"10.1.2.0/24",
"10.1.3.0/24"
]
}
Example HTTP response
Response 200
{
"addresses": [
"10.1.1.1/32",
"10.1.2.0/24",
"10.1.3.0/24"
]
}
8.1.2 - Create Address Group
8.1.2.1 - 1.1
post /v1/address-groups
Description
Create Address Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AddressGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AddressGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/address-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = security-group 1.1"
Request body
{
"addresses": [
"10.1.1.1/32",
"10.1.2.0/24",
"10.1.3.0/24"
],
"description": "Example Description for Address Group",
"name": "ExampleAG1",
"tags": []
}
Example HTTP response
Response 201
{
"address_group": {
"account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"address_count": 10,
"address_limit": 1000,
"addresses": [
"10.1.1.1/32",
"10.1.2.0/24",
"10.1.3.0/24"
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Address Group",
"id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ExampleAG1",
"state": "ACTIVE"
}
}
8.1.3 - Create Security Group
8.1.3.1 - 1.1
post /v1/security-groups
Description
Create Security Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 = en-US",
"Scp-Api-Version = security-group 1.1"
Request body
{
"description": "Example Description for Security Group",
"loggable": false,
"name": "ExampleSG1",
"tags": []
}
Example HTTP response
Response 201
{
"security_group": {
"account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Security Group",
"id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ExampleSG1",
"rule_count": 200,
"state": "ACTIVE"
}
}
8.1.3.2 - 1.0
post /v1/security-groups
Description
Create Security Group.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"Scp-Api-Version = security-group 1.0"
Request body
{
"description": "Example Description for Security Group",
"loggable": false,
"name": "ExampleSG1",
"tags": []
}
Example HTTP response
Response 201
{
"security_group": {
"account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Security Group",
"id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ExampleSG1",
"rule_count": 200,
"state": "ACTIVE"
}
}
8.1.4 - Create Security Group Rule
8.1.4.1 - 1.1
post /v1/security-group-rules
Description
Create Security Group rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SecurityGroupRuleCreateRequestV1Dot1 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | SecurityGroupRuleShowResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = security-group 1.1"
Request body
{
"description": "Example Description for Security Group Rule",
"direction": "Ingress",
"ethertype": "IPv4",
"port_range_max": 22,
"port_range_min": 22,
"protocol": "TCP",
"remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
"remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"remote_ip_prefix": "1.1.1.1/32",
"security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}
Example HTTP response
Response 201
{
"security_group_rule": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Security Group Rule",
"direction": "Ingress",
"ethertype": "IPv4",
"id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"port_range_max": 22,
"port_range_min": 22,
"protocol": "TCP",
"remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
"remote_address_group_name": "ExampleAG1",
"remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"remote_group_name": "ExampleSG2",
"remote_ip_prefix": "1.1.1.1/32",
"security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}
}
8.1.4.2 - 1.0
post /v1/security-group-rules
Description
Create Security Group rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"Scp-Api-Version = security-group 1.0"
Request body
{
"description": "Example Description for Security Group Rule",
"direction": "Ingress",
"ethertype": "IPv4",
"port_range_max": 22,
"port_range_min": 22,
"protocol": "TCP",
"remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"remote_ip_prefix": "1.1.1.1/32",
"security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}
Example HTTP response
Response 201
{
"security_group_rule": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Security Group Rule",
"direction": "Ingress",
"ethertype": "IPv4",
"id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"port_range_max": 22,
"port_range_min": 22,
"protocol": "TCP",
"remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"remote_group_name": "ExampleSG2",
"remote_ip_prefix": "1.1.1.1/32",
"security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}
}
8.1.5 - Delete Address Group
8.1.5.1 - 1.1
delete /v1/address-groups/{address_group_id}
Description
Delete Address Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | address_group_id required | Address Group ID Example : 4b18494930bf4c5dbb97a9eb2ef68fe1 | 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/address-groups/{address_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = security-group 1.1"
Example HTTP response
Response 204
8.1.6 - Delete Security Group
8.1.6.1 - 1.1
delete /v1/security-groups/{security_group_id}
Description
Delete Security Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 = en-US",
"Scp-Api-Version = security-group 1.1"
Example HTTP response
Response 204
8.1.6.2 - 1.0
delete /v1/security-groups/{security_group_id}
Description
Delete Security Group.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"Scp-Api-Version = security-group 1.0"
Example HTTP response
Response 204
8.1.7 - Delete Security Group Rule
8.1.7.1 - 1.1
delete /v1/security-group-rules/{security_group_rule_id}
Description
Delete Security Group rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | security_group_rule_id required | Security Group Rule ID Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a | 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 = en-US",
"Scp-Api-Version = security-group 1.1"
Example HTTP response
Response 204
8.1.7.2 - 1.0
delete /v1/security-group-rules/{security_group_rule_id}
Description
Delete Security Group rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | security_group_rule_id required | Security Group Rule ID Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a | 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 = en-US",
"Scp-Api-Version = security-group 1.0"
Example HTTP response
Response 204
8.1.8 - List Address Group IPs
8.1.8.1 - 1.1
get /v1/address-groups/{address_group_id}/addresses
Description
Get Address Group IP list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | address_group_id required | Address Group ID Example : 4b18494930bf4c5dbb97a9eb2ef68fe1 | 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 | address optional | Address Group IP Address Example : 10.1.1.1/32 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AddressGroupCidrListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/address-groups/{address_group_id}/addresses
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = security-group 1.1"
Example HTTP response
Response 200
{
"addresses": [
"10.1.1.1/32",
"10.1.2.0/24",
"10.1.3.0/24"
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
8.1.9 - List Address Groups
8.1.9.1 - 1.1
get /v1/address-groups
Description
Get Address Group list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | Address Group ID Example : 4b18494930bf4c5dbb97a9eb2ef68fe1 | string | None |
| query | name optional | Address Group Name Example : ExampleAG1 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AddressGroupListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/address-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = security-group 1.1"
Example HTTP response
Response 200
{
"address_groups": [
{
"account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"address_count": 10,
"address_limit": 1000,
"addresses": [
"10.1.1.1/32",
"10.1.2.0/24",
"10.1.3.0/24"
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Address Group",
"id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ExampleAG1",
"state": "ACTIVE"
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
8.1.10 - List Security Group Rules
8.1.10.1 - 1.1
get /v1/security-group-rules
Description
Get Security Group rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | Security Group Rule ID Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a | string | None |
| query | security_group_id required | Security Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | string | None |
| query | remote_ip_prefix optional | Security Group Rule Remote IP Address Example : 1.1.1.1/32 | string | None |
| query | remote_group_id optional | Security Group Rule Remote Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | string | None |
| query | description optional | Security Group Rule Description Example : Example Description for Security Group Rule | string | None |
| query | direction optional | Security Group Rule Direction (Ingress, Egress) Example : Ingress | string | None |
| query | service optional | Security Group Rule Service Example : TCP 22 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SecurityGroupRuleListResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = security-group 1.1"
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": "Example Description for Security Group Rule",
"direction": "Ingress",
"ethertype": "IPv4",
"id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"port_range_max": 22,
"port_range_min": 22,
"protocol": "TCP",
"remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
"remote_address_group_name": "ExampleAG1",
"remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"remote_group_name": "ExampleSG2",
"remote_ip_prefix": "1.1.1.1/32",
"security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}
]
}
8.1.10.2 - 1.0
get /v1/security-group-rules
Description
Get Security Group rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 : 10d8250e-f4eb-453a-96af-b50b5b514a1a | string | None |
| query | security_group_id required | Security Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | string | None |
| query | remote_ip_prefix optional | Security Group Rule Remote IP Address Example : 1.1.1.1/32 | string | None |
| query | remote_group_id optional | Security Group Rule Remote Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | string | None |
| query | description optional | Security Group Rule Description Example : Example Description for Security Group Rule | string | None |
| query | direction optional | Security Group Rule Direction (Ingress, Egress) Example : Ingress | string | None |
| query | service optional | Security Group Rule Service Example : TCP 22 | 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 = en-US",
"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": "Example Description for Security Group Rule",
"direction": "Ingress",
"ethertype": "IPv4",
"id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"port_range_max": 22,
"port_range_min": 22,
"protocol": "TCP",
"remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"remote_group_name": "ExampleSG2",
"remote_ip_prefix": "1.1.1.1/32",
"security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}
]
}
8.1.11 - List Security Groups
8.1.11.1 - 1.1
get /v1/security-groups
Description
Get Security Group list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | Security Group ID Example : | string | None |
| query | name optional | Security Group Name 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 = en-US",
"Scp-Api-Version = security-group 1.1"
Example HTTP response
Response 200
{
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"security_groups": [
{
"account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Security Group",
"id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ExampleSG1",
"rule_count": 200,
"state": "ACTIVE"
}
]
}
8.1.11.2 - 1.0
get /v1/security-groups
Description
Get Security Group list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 Name 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 = en-US",
"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": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Security Group",
"id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ExampleSG1",
"rule_count": 200,
"state": "ACTIVE"
}
]
}
8.1.12 - Remove Address Group IPs
8.1.12.1 - 1.1
put /v1/address-groups/{address_group_id}/remove_addresses
Description
Remove IP addresses to address group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | address_group_id required | Address Group ID Example : 4b18494930bf4c5dbb97a9eb2ef68fe1 | string | None |
| body | body required | AddressGroupCidrsAddRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AddressGroupCidrsAddRequest |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/address-groups/{address_group_id}/remove_addresses
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = security-group 1.1"
Request body
{
"addresses": [
"10.1.1.1/32",
"10.1.2.0/24",
"10.1.3.0/24"
]
}
Example HTTP response
Response 200
{
"addresses": [
"10.1.1.1/32",
"10.1.2.0/24",
"10.1.3.0/24"
]
}
8.1.13 - Set Address Group
8.1.13.1 - 1.1
put /v1/address-groups/{address_group_id}
Description
Set Address Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | address_group_id required | Address Group ID Example : 4b18494930bf4c5dbb97a9eb2ef68fe1 | string | None |
| body | body required | AddressGroupSetRequest |
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/address-groups/{address_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = security-group 1.1"
Request body
{
"description": "Example Description for Address Group"
}
Example HTTP response
Response 200
8.1.14 - Set Security Group
8.1.14.1 - 1.1
put /v1/security-groups/{security_group_id}
Description
Set Security Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 = en-US",
"Scp-Api-Version = security-group 1.1"
Request body
{
"description": "Example Description for Security Group",
"loggable": false
}
Example HTTP response
Response 200
8.1.14.2 - 1.0
put /v1/security-groups/{security_group_id}
Description
Set Security Group.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"Scp-Api-Version = security-group 1.0"
Request body
{
"description": "Example Description for Security Group",
"loggable": false
}
Example HTTP response
Response 200
8.1.15 - Show Address Group
8.1.15.1 - 1.1
get /v1/address-groups/{address_group_id}
Description
Show Address Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | address_group_id required | Address Group ID Example : 4b18494930bf4c5dbb97a9eb2ef68fe1 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AddressGroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/address-groups/{address_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = security-group 1.1"
Example HTTP response
Response 200
{
"address_group": {
"account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"address_count": 10,
"address_limit": 1000,
"addresses": [
"10.1.1.1/32",
"10.1.2.0/24",
"10.1.3.0/24"
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Address Group",
"id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ExampleAG1",
"state": "ACTIVE"
}
}
8.1.16 - Show Security Group
8.1.16.1 - 1.1
get /v1/security-groups/{security_group_id}
Description
Show Security Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
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 = en-US",
"Scp-Api-Version = security-group 1.1"
Example HTTP response
Response 200
{
"security_group": {
"account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Security Group",
"id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ExampleSG1",
"rule_count": 200,
"state": "ACTIVE"
}
}
8.1.16.2 - 1.0
get /v1/security-groups/{security_group_id}
Description
Show Security Group.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
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 = en-US",
"Scp-Api-Version = security-group 1.0"
Example HTTP response
Response 200
{
"security_group": {
"account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Security Group",
"id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ExampleSG1",
"rule_count": 200,
"state": "ACTIVE"
}
}
8.1.17 - Show Security Group Rule
8.1.17.1 - 1.1
get /v1/security-group-rules/{security_group_rule_id}
Description
Show Security Group rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | security_group_rule_id required | Security Group Rule ID Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a | string | None |
| query | fields optional | Field Name Example : | any of [array[object], string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SecurityGroupRuleShowResponseV1Dot1 |
| 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 = en-US",
"Scp-Api-Version = security-group 1.1"
Example HTTP response
Response 200
{
"security_group_rule": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Example Description for Security Group Rule",
"direction": "Ingress",
"ethertype": "IPv4",
"id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"port_range_max": 22,
"port_range_min": 22,
"protocol": "TCP",
"remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
"remote_address_group_name": "ExampleAG1",
"remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"remote_group_name": "ExampleSG2",
"remote_ip_prefix": "1.1.1.1/32",
"security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}
}
8.1.17.2 - 1.0
get /v1/security-group-rules/{security_group_rule_id}
Description
Show Security Group rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | security_group_rule_id required | Security Group Rule ID Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a | string | None |
| query | fields optional | Field Name 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 = en-US",
"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": "Example Description for Security Group Rule",
"direction": "Ingress",
"ethertype": "IPv4",
"id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"port_range_max": 22,
"port_range_min": 22,
"protocol": "TCP",
"remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
"remote_group_name": "ExampleSG2",
"remote_ip_prefix": "1.1.1.1/32",
"security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}
}
8.2 - Models
8.2.1 - AddressGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | string | |
| address_count optional | Address Group Address Count Example : 10 | integer | |
| address_limit required | Address Group Address Limit Example : 1000 | integer | |
| addresses required | Address Group IP Address Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24'] | 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 : Example Description for Address Group | any of [string, null] | |
| id required | Address Group ID Example : 4b18494930bf4c5dbb97a9eb2ef68fe1 | 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 | Address Group Name Example : ExampleAG1 | string | |
| state required | Address Group State Example : ACTIVE | string |
8.2.2 - AddressGroupCidrListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| addresses required | Address Group IP Address List Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24'] | array[string] | |
| 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] |
8.2.3 - AddressGroupCidrsAddRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| addresses required | Address Group IP Address List Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24'] | array[string] |
8.2.4 - AddressGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| addresses optional | Address Group IP Address Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24'] | any of [array[string], null] | |
| description optional | Address Group Description Example : Example Description for Address Group | any of [string, null] | |
| name required | Address Group Name Example : ExampleAG1 | string | |
| tags optional | Tag List | array[Tag] |
8.2.5 - AddressGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| address_groups required | array[AddressGroup] | ||
| 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] |
8.2.6 - AddressGroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Address Group Description Example : Example Description for Address Group | any of [string, null] |
8.2.7 - AddressGroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| address_group required | AddressGroup |
8.2.8 - SecurityGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Security Group Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | 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 | Security Group Description Example : Example Description for Security Group | any of [string, null] | |
| id required | Security Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | string | |
| loggable required | Security Group 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 | Security Group Name Example : ExampleSG1 | string | |
| rule_count optional | Security Group Rule Count Example : 200 | integer | |
| state required | Security Group State Example : ACTIVE | string |
8.2.9 - SecurityGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Security Group Description Example : Example Description for Security Group | any of [string, null] | |
| loggable optional | Security Group Loggable Example : False | any of [boolean, null] | |
| name required | Security Group Name Example : ExampleSG1Maximum length : 255 | string | |
| tags optional | Tag List | array[Tag] |
8.2.10 - SecurityGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] | |
| security_groups required | array[SecurityGroup] |
8.2.11 - SecurityGroupRule
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description required | Security Group Rule Description Example : Example Description for Security Group Rule | any of [string, null] | |
| direction required | Security Group Rule Direction (Ingress, Egress) Example : Ingress | enum (ingress, egress) | |
| ethertype optional | Security Group Rule Ethertype (IPV4) Example : IPv4 | any of [string, null] | IPv4 |
| id required | Security Group Rule ID Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| port_range_max required | Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None Example : 22 | any of [integer, null] | |
| port_range_min required | Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None Example : 22 | any of [integer, null] | |
| protocol required | Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254) Example : TCP | any of [string, null] | |
| remote_group_id required | Security Group Rule Remote Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | any of [string, null] | |
| remote_group_name optional | Security Group Rule Remote Group Name Example : ExampleSG2 | any of [string, null] | |
| remote_ip_prefix required | Security Group Rule Remote IP Address Example : 1.1.1.1/32 | any of [string, null] | |
| security_group_id required | Security Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | string |
8.2.12 - SecurityGroupRuleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Security Group Rule Description Example : Example Description for Security Group Rule | any of [string, null] | |
| direction required | Security Group Rule Direction (Ingress, Egress) Example : Ingress | string | |
| ethertype optional | Security Group Rule Ethertype (IPV4) Example : IPv4 | any of [string, null] | IPv4 |
| port_range_max optional | Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None Example : 22 | any of [integer, null] | |
| port_range_min optional | Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None Example : 22 | any of [integer, null] | |
| protocol optional | Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254) Example : TCP | any of [string, null] | |
| remote_group_id optional | Security Group Rule Remote Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | any of [string, null] | |
| remote_ip_prefix optional | Security Group Rule Remote IP Address Example : 1.1.1.1/32 | any of [string, null] | |
| security_group_id required | Security Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | string |
8.2.13 - SecurityGroupRuleCreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Security Group Rule Description Example : Example Description for Security Group Rule | any of [string, null] | |
| direction required | Security Group Rule Direction (Ingress, Egress) Example : Ingress | string | |
| ethertype optional | Security Group Rule Ethertype (IPV4) Example : IPv4 | any of [string, null] | IPv4 |
| port_range_max optional | Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None Example : 22 | any of [integer, null] | |
| port_range_min optional | Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None Example : 22 | any of [integer, null] | |
| protocol optional | Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254) Example : TCP | any of [string, null] | |
| remote_address_group_id optional | Security Group Rule Address Group ID Example : 4b18494930bf4c5dbb97a9eb2ef68fe1 | any of [string, null] | |
| remote_group_id optional | Security Group Rule Remote Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | any of [string, null] | |
| remote_ip_prefix optional | Security Group Rule Remote IP Address Example : 1.1.1.1/32 | any of [string, null] | |
| security_group_id required | Security Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | string |
8.2.14 - SecurityGroupRuleListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] | |
| security_group_rules required | array[SecurityGroupRule] |
8.2.15 - SecurityGroupRuleListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] | |
| security_group_rules required | array[SecurityGroupRuleV1Dot1] |
8.2.16 - SecurityGroupRuleShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| security_group_rule required | SecurityGroupRule |
8.2.17 - SecurityGroupRuleShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| security_group_rule required | SecurityGroupRuleV1Dot1 |
8.2.18 - SecurityGroupRuleV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description required | Security Group Rule Description Example : Example Description for Security Group Rule | any of [string, null] | |
| direction required | Security Group Rule Direction (Ingress, Egress) Example : Ingress | enum (ingress, egress) | |
| ethertype optional | Security Group Rule Ethertype (IPV4) Example : IPv4 | any of [string, null] | IPv4 |
| id required | Security Group Rule ID Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| port_range_max required | Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None Example : 22 | any of [integer, null] | |
| port_range_min required | Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None Example : 22 | any of [integer, null] | |
| protocol required | Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254) Example : TCP | any of [string, null] | |
| remote_address_group_id required | Address Group ID Example : 4b18494930bf4c5dbb97a9eb2ef68fe1 | any of [string, null] | |
| remote_address_group_name required | Address Group Name Example : ExampleAG1 | any of [string, null] | |
| remote_group_id required | Security Group Rule Remote Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | any of [string, null] | |
| remote_group_name optional | Security Group Rule Remote Group Name Example : ExampleSG2 | any of [string, null] | |
| remote_ip_prefix required | Security Group Rule Remote IP Address Example : 1.1.1.1/32 | any of [string, null] | |
| security_group_id required | Security Group ID Example : 06e5d676-f330-485a-94e9-47ac91cce09a | string |
8.2.19 - SecurityGroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Security Group Description Example : Example Description for Security Group | any of [string, null] | |
| loggable optional | Security Group Loggable Example : False | any of [boolean, null] |
8.2.20 - SecurityGroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| security_group required | SecurityGroup |
8.2.21 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |
9 - VPC
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of VPC service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.3 | CURRENT | - |
| 1.2 | SUPPORTED | 20270131 |
| 1.1 | SUPPORTED | 20261130 |
| 1.0 | DEPRECATED | 20251231 |
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 |
API Version History
1.3
Multi AZ feature has been added.
Changes
- [Updated]
POST /v1/vpcs- The following field has been added to the response.- Added :
zones,zone_type
- Added :
- [Updated]
GET /v1/vpcs- The following field has been added to the parameters and response.- Added :
zone,zones,zone_type
- Added :
- [Updated]
GET /v1/vpcs/{vpc_id}- The following field has been added to the response.- Added :
zones,zone_type
- Added :
- [Updated]
PUT /v1/vpcs/{vpc_id}- When responding, everything except thedescriptionfield will be removed. - [Updated]
POST /v1/vpcs/{vpc_id}/cidrs- When responding, everything except thecidrfield will be removed. - [Updated]
POST /v1/subnets- The following field has been changed to the parameters and response.- Added :
zones,role,primary_subnet_id,secondary_subnet_ids - Changed : The boundary value of
typehas been changed and added (General → Public changed, Private newly added).
- Added :
- [Updated]
GET /v1/subnets- The following field has been changed to the parameters and response.- Added :
zones,role,primary_subnet_id - Changed : The boundary value of
typehas been changed and added (General → Public changed, Private newly added).
- Added :
- [Updated]
GET /v1/subnets/{subnet_id}- The following field has been changed to the response.- Added :
zones,role,primary_subnet_id,secondary_subnet_ids - Changed : The boundary value of
typehas been changed and added (General → Public changed, Private newly added).
- Added :
- [Updated]
PUT /v1/subnets/{subnet_id}- When responding, everything except thedescriptionanddhcp_ip_addressfields will be removed. - [Updated]
POST /v1/internet-gateways- The following field has been added to the response.- Added :
multi_zone_enabled
- Added :
- [Updated]
GET /v1/internet-gateways- The following field has been added to the response.- Added :
multi_zone_enabled
- Added :
- [Updated]
GET /v1/internet-gateways/{internet_gateway_id}- The following field has been added to the response.- Added :
multi_zone_enabled
- Added :
- [Updated]
PUT /v1/internet-gateways/{internet_gateway_id}- When responding, everything except thedescriptionandloggablefields will be removed. - [Updated]
POST /v1/nat-gateways- The following field has been changed to the parameters and response.- Added :
publicip_ids,multi_zone_enabled,nat_gateway_ip_addresses - Removed :
publicip_id,nat_gateway_ip_address
- Added :
- [Updated]
GET /v1/nat-gateways- The following field has been changed to the response.- Added :
multi_zone_enabled,nat_gateway_ip_addresses - Removed :
nat_gateway_ip_address
- Added :
- [Updated]
GET /v1/nat-gateways/{nat_gateway_id}- The following field has been changed to the response.- Added :
multi_zone_enabled,nat_gateway_ip_addresses - Removed :
nat_gateway_ip_address
- Added :
- [Updated]
PUT /v1/nat-gateways/{nat_gateway_id}- When responding, everything except thedescriptionfield will be removed. - [Updated]
POST /v1/publicips- The following field has been added to the parameters and response.- Added :
zone
- Added :
- [Updated]
GET /v1/publicips- The following field has been added to the parameters and response.- Added :
zone
- Added :
- [Updated]
GET /v1/publicips/{publicip_id}- The following field has been added to the response.- Added :
zone
- Added :
- [Updated]
PUT /v1/publicips/{publicip_id}- When responding, everything except thedescriptionfield will be removed. - [Updated]
GET /v1/transit-gateways- The following field has been added to the parameters.- Added :
uplink_zone_state
- Added :
- [Updated]
POST /v1/transit-gateways- The following field has been added to the response.- Added :
uplink_active_zone,uplink_standby_zone,uplink_zone_state
- Added :
- [Updated]
GET /v1/transit-gateways/{transit_gateway_id}- The following field has been added to the response.- Added :
uplink_active_zone,uplink_standby_zone,uplink_zone_state
- Added :
- [Updated]
PUT /v1/transit-gateways/{transit_gateway_id}- When responding, everything except thedescriptionfield will be removed. - [Updated]
POST /v1/transit-gateways/{transit_gateway_id}/firewall-connections- When responding, everything except thefirewall_connection_statefield will be removed. - [Updated]
DELETE /v1/transit-gateways/{transit_gateway_id}/firewall-connections- When responding, everything except thefirewall_connection_statefield will be removed. - [Updated]
POST /v1/transit-gateways/{transit_gateway_id}/firewalls- The following field has been added to the parameters and response.- Added :
uplink_active_zone,uplink_standby_zone,uplink_zone_state
- Added :
- [Updated]
DELETE /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id}- The following field has been added to the response.- Added :
uplink_active_zone,uplink_standby_zone,uplink_zone_state
- Added :
1.2
Virtual IP functionality and Transit Gateway Firewall connection capability have been added.
Changes
- [New]
GET /v1/subnets/{subnet_id}/vips- API has been added. - [New]
POST /v1/subnets/{subnet_id}/vips- API has been added. - [New]
GET /v1/subnets/{subnet_id}/vips/{vip_id}- API has been added. - [New]
PUT /v1/subnets/{subnet_id}/vips/{vip_id}- API has been added. - [New]
DELETE /v1/subnets/{subnet_id}/vips/{vip_id}- API has been added. - [New]
POST /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports- API has been added. - [New]
DELETE /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_id}- API has been added. - [New]
POST /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips- API has been added. - [New]
DELETE /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_id}- API has been added. - [New]
POST /v1/transit-gateways/{transit_gateway_id}/firewall-connections- API has been added. - [New]
DELETE /v1/transit-gateways/{transit_gateway_id}/firewall-connections- API has been added. - [New]
POST /v1/transit-gateways/{transit_gateway_id}/firewalls- API has been added. - [New]
DELETE /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id}- API has been added. - [New]
POST /v1/vpcs/{vpc_id}/cidrs- API has been added. - [Updated]
GET /v1/vpcs- The following field has been changed to the parameters and response.- Added :
size,page,cidr_count,cidrs - Removed :
limit,marker,cidr
- Added :
- [Updated]
GET /v1/vpcs/{vpc_id}- The following field has been changed to the response.- Added :
cidr_count,cidrs - Removed :
cidr
- Added :
- [Updated] :
POST /v1/vpcs- The following field has been changed to the response.- Added :
cidr_count,cidrs - Removed :
cidr
- Added :
- [Updated] :
PUT /v1/vpcs/{vpc_id}- The following field has been changed to the response.- Added :
cidr_count,cidrs - Removed :
cidr
- Added :
- [Updated] :
GET /v1/subnets- The following field has been changed to the parameters and response.- Added :
size,page - Removed :
limit,marker
- Added :
- [Updated] :
GET /v1/subnets/{subnet_id}- The following field has been changed to the response.- Added :
dhcp_ip_addres
- Added :
- [Updated] :
POST /v1/subnets- The following field has been changed to the parameters.- Added :
gateway_ip_address
- Added :
- [Updated] :
PUT /v1/subnets/{subnet_id}- The following field has been changed to the parameters.- Added :
dhcp_ip_address
- Added :
- [Updated] :
GET /v1/ports- The following field has been changed to the parameters.- Added :
attached_resource_types
- Added :
- [Updated] :
GET /v1/ports/{port_id}- The following field has been changed to the response.- Added :
virtual_ip_addresses
- Added :
- [Updated] :
POST /v1/ports- The following field has been changed to the response.- Added :
virtual_ip_addresses
- Added :
- [Updated] :
PUT /v1/ports/{port_id}- The following field has been changed to the response.- Added :
virtual_ip_addresses
- Added :
- [Updated] :
GET /v1/internet-gateways- The following field has been changed to the parameters and response.- Added :
size,page - Removed :
limit,marker
- Added :
- [Updated] :
GET /v1/nat-gateways- The following field has been changed to the parameters and response.- Added :
size,page - Removed :
limit,marker
- Added :
- [Updated] :
GET /v1/publicips- The following field has been changed to the parameters and response.- Added :
size,page - Removed :
limit,marker
- Added :
- [Updated] :
GET /v1/publicips/{publicip_id}- The boundary values for theattached_resource_typefield have been expanded. - [Updated] :
GET /v1/vpc-endpoints- The following field has been changed to the parameters and response.- Added :
size,page - Removed :
limit,marker
- Added :
- [Updated] :
GET /v1/private-nats- The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.- Added :
service_type,service_resource_id,service_resource_name
- Added :
- [Updated] :
GET /v1/private-nats/{private_nat_id}- The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.- Added :
service_type,service_resource_id,service_resource_name
- Added :
- [Updated] :
POST /v1/private-nats- The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.- Added :
service_type,service_resource_id,service_resource_name
- Added :
- [Updated] :
PUT /v1/private-nats/{private_nat_id}- The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.- Added :
service_type,service_resource_id,service_resource_name
- Added :
- [Updated] :
GET /v1/vpc-peerings/{vpc_peering_id}/routing-rules- The following field has been changed to the parameters.- Removed :
name
- Removed :
- [Updated] :
GET /v1/transit-gateways- The following field has been changed to the parameters and response.- Added :
firewall_connection_state
- Added :
- [Updated] :
GET /v1/transit-gateways/{transit_gateway_id}- The following field has been changed to the response.- Added :
firewall_connection_state
- Added :
- [Updated] :
POST /v1/transit-gateways- The following field has been changed to the response.- Added :
firewall_connection_state
- Added :
- [Updated] :
PUT /v1/transit-gateways/{transit_gateway_id}- The following field has been changed to the response.- Added :
firewall_connection_state
- Added :
- [Updated] :
GET /v1/transit-gateways/{transit_gateway_id}/routing-rules- The following field has been changed to the parameters and response.- Added :
rule_type
- Added :
1.1
VPC API has been released.
Changes
- [New]
GET /v1/privatelink-endpoints- API has been added. - [New]
POST /v1/privatelink-endpoints- API has been added. - [New]
GET /v1/privatelink-endpoints/{privatelink_endpoint_id}- API has been added. - [New]
PUT /v1/privatelink-endpoints/{privatelink_endpoint_id}- API has been added. - [New]
DELETE /v1/privatelink-endpoints/{privatelink_endpoint_id}- API has been added. - [New]
PUT /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval- API has been added. - [New]
PUT /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection- API has been added. - [New]
PUT /v1/privatelink-endpoints/{privatelink_endpoint_id}/request- API has been added. - [New]
GET /v1/privatelink-services- API has been added. - [New]
POST /v1/privatelink-services- API has been added. - [New]
GET /v1/privatelink-services/{privatelink_service_id}- API has been added. - [New]
PUT /v1/privatelink-services/{privatelink_service_id}- API has been added. - [New]
DELETE /v1/privatelink-services/{privatelink_service_id}- API has been added. - [New]
GET /v1/privatelink-services/{privatelink_service_id}/connected-endpoints- API has been added. - [New]
PUT /v1/vpc-peerings/{vpc_peering_id}/approval- API has been added. - [New]
GET /v1/subnets/{subnet_id}/sap-secondary-subnets- API has been added.
1.0
VPC API has been released.
Changes
- [New]
GET /v1/internet-gateways- API has been added. - [New]
POST /v1/internet-gateways- API has been added. - [New]
GET /v1/internet-gateways/{internet_gateway_id}- API has been added. - [New]
PUT /v1/internet-gateways/{internet_gateway_id}- API has been added. - [New]
DELETE /v1/internet-gateways/{internet_gateway_id}- API has been added. - [New]
GET /v1/nat-gateways- API has been added. - [New]
POST /v1/nat-gateways- API has been added. - [New]
GET /v1/nat-gateways/{nat_gateway_id}- API has been added. - [New]
PUT /v1/nat-gateways/{nat_gateway_id}- API has been added. - [New]
DELETE /v1/nat-gateways/{nat_gateway_id}- API has been added. - [New]
GET /v1/ports- API has been added. - [New]
POST /v1/ports- API has been added. - [New]
GET /v1/ports/{port_id}- API has been added. - [New]
PUT /v1/ports/{port_id}- API has been added. - [New]
DELETE /v1/ports/{port_id}- API has been added. - [New]
GET /v1/private-nats- API has been added. - [New]
POST /v1/private-nats- API has been added. - [New]
GET /v1/private-nats/{private_nat_id}- API has been added. - [New]
PUT /v1/private-nats/{private_nat_id}- API has been added. - [New]
DELETE /v1/private-nats/{private_nat_id}- API has been added. - [New]
GET /v1/private-nats/{private_nat_id}/private-nat-ips- API has been added. - [New]
POST /v1/private-nats/{private_nat_id}/private-nat-ips- API has been added. - [New]
DELETE /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}- API has been added. - [New]
GET /v1/publicips- API has been added. - [New]
POST /v1/publicips- API has been added. - [New]
GET /v1/publicips/{publicip_id}- API has been added. - [New]
PUT /v1/publicips/{publicip_id}- API has been added. - [New]
DELETE /v1/publicips/{publicip_id}- API has been added. - [New]
GET /v1/subnets- API has been added. - [New]
POST /v1/subnets- API has been added. - [New]
GET /v1/subnets/{subnet_id}- API has been added. - [New]
PUT /v1/subnets/{subnet_id}- API has been added. - [New]
DELETE /v1/subnets/{subnet_id}- API has been added. - [New]
GET /v1/transit-gateways- API has been added. - [New]
POST /v1/transit-gateways- API has been added. - [New]
GET /v1/transit-gateways/{transit_gateway_id}- API has been added. - [New]
PUT /v1/transit-gateways/{transit_gateway_id}- API has been added. - [New]
DELETE /v1/transit-gateways/{transit_gateway_id}- API has been added. - [New]
GET /v1/transit-gateways/{transit_gateway_id}/routing-rules- API has been added. - [New]
POST /v1/transit-gateways/{transit_gateway_id}/routing-rules- API has been added. - [New]
DELETE /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}- API has been added. - [New]
POST /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules- API has been added. - [New]
DELETE /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id}- API has been added. - [New]
GET /v1/transit-gateways/{transit_gateway_id}/vpc-connections- API has been added. - [New]
POST /v1/transit-gateways/{transit_gateway_id}/vpc-connections- API has been added. - [New]
DELETE /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}- API has been added. - [New]
GET /v1/vpc-endpoints- API has been added. - [New]
POST /v1/vpc-endpoints- API has been added. - [New]
GET /v1/vpc-endpoints/connectable-resources- API has been added. - [New]
GET /v1/vpc-endpoints/{vpc_endpoint_id}- API has been added. - [New]
PUT /v1/vpc-endpoints/{vpc_endpoint_id}- API has been added. - [New]
DELETE /v1/vpc-endpoints/{vpc_endpoint_id}- API has been added. - [New]
GET /v1/vpc-peerings- API has been added. - [New]
POST /v1/vpc-peerings- API has been added. - [New]
GET /v1/vpc-peerings/{vpc_peering_id}- API has been added. - [New]
PUT /v1/vpc-peerings/{vpc_peering_id}- API has been added. - [New]
DELETE /v1/vpc-peerings/{vpc_peering_id}- API has been added. - [New]
GET /v1/vpc-peerings/{vpc_peering_id}/routing-rules- API has been added. - [New]
POST /v1/vpc-peerings/{vpc_peering_id}/routing-rules- API has been added. - [New]
DELETE /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}- API has been added. - [New]
GET /v1/vpcs- API has been added. - [New]
POST /v1/vpcs- API has been added. - [New]
GET /v1/vpcs/{vpc_id}- API has been added. - [New]
PUT /v1/vpcs/{vpc_id}- API has been added. - [New]
DELETE /v1/vpcs/{vpc_id}- API has been added.
9.1 - APIs
9.1.1 - Add VPC CIDR
9.1.1.1 - 1.3
post /v1/vpcs/{vpc_id}/cidrs
Description
Add VPC CIDR.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_id required | VPC Id Example : | string | None |
| body | body required | VpcCidrCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | VpcCidrCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/vpcs/{vpc_id}/cidrs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"cidr": "192.167.0.0/18"
}
Example HTTP response
Response 201
{
"cidr": "192.167.0.0/18"
}
9.1.1.2 - 1.2
post /v1/vpcs/{vpc_id}/cidrs
Description
Add VPC CIDR.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_id required | VPC Id Example : | string | None |
| body | body required | VpcCidrCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | VpcShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/vpcs/{vpc_id}/cidrs
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"cidr": "192.167.0.0/18"
}
Example HTTP response
Response 201
{
"vpc": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr_count": 20,
"cidrs": [
{
"cidr": "192.167.0.0/18",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "7df8abb4912e4709b1cb237daccca7a8",
"id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"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"
}
}
9.1.2 - Approval VPC Peering
9.1.2.1 - 1.3
put /v1/vpc-peerings/{vpc_peering_id}/approval
Description
Approval VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"type": "CREATE_APPROVE"
}
Example HTTP response
Response 200
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.2.2 - 1.2
put /v1/vpc-peerings/{vpc_peering_id}/approval
Description
Approval VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"type": "CREATE_APPROVE"
}
Example HTTP response
Response 200
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.2.3 - 1.1
put /v1/vpc-peerings/{vpc_peering_id}/approval
Description
Approval VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.3 - Approve PrivateLink Endpoint
9.1.3.1 - 1.3
put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval
Description
Approve PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"type": "APPROVE"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"created_at": "2024-06-16T02:55:13Z",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"state": "ACTIVE"
}
}
9.1.3.2 - 1.2
put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval
Description
Approve PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"type": "APPROVE"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"created_at": "2024-06-16T02:55:13Z",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"state": "ACTIVE"
}
}
9.1.3.3 - 1.1
put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval
Description
Approve PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"type": "APPROVE"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"created_at": "2024-06-16T02:55:13Z",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"state": "ACTIVE"
}
}
9.1.4 - Connect PrivateLink Endpoint
9.1.4.1 - 1.3
put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection
Description
Connect PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"type": "DISCONNECT"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"created_at": "2024-06-16T02:55:13Z",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"state": "ACTIVE"
}
}
9.1.4.2 - 1.2
put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection
Description
Connect PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"type": "DISCONNECT"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"created_at": "2024-06-16T02:55:13Z",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"state": "ACTIVE"
}
}
9.1.4.3 - 1.1
put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection
Description
Connect PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"type": "DISCONNECT"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"created_at": "2024-06-16T02:55:13Z",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"state": "ACTIVE"
}
}
9.1.5 - Connect Subnet VIP Port
9.1.5.1 - 1.3
post /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports
Description
Connect Subnet Vip Port
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
| body | body required | VipPortRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | VipPortResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"port_id": "35268a9f2eda4cde83b1d85c1f61f67d"
}
Example HTTP response
Response 201
{
"id": "35268a9f2eda4cde83b1d85c1f61f67d",
"subnet_vip_id": "0466a9448d9a4411a86055939e451c8f"
}
9.1.5.2 - 1.2
post /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports
Description
Connect Subnet Vip Port
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
| body | body required | VipPortRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | VipPortResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"port_id": "35268a9f2eda4cde83b1d85c1f61f67d"
}
Example HTTP response
Response 201
{
"id": "35268a9f2eda4cde83b1d85c1f61f67d",
"subnet_vip_id": "0466a9448d9a4411a86055939e451c8f"
}
9.1.6 - Create Internet Gateway
9.1.6.1 - 1.3
post /v1/internet-gateways
Description
Create Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | InternetGatewayCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | InternetGatewayShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Internet Gateway Description",
"firewall_enabled": false,
"firewall_loggable": false,
"tags": [],
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"multi_zone_enabled": true,
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.6.2 - 1.2
post /v1/internet-gateways
Description
Create Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Internet Gateway Description",
"firewall_enabled": false,
"firewall_loggable": false,
"tags": [],
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.6.3 - 1.1
post /v1/internet-gateways
Description
Create Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "Internet Gateway Description",
"firewall_enabled": false,
"firewall_loggable": false,
"tags": [],
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.6.4 - 1.0
post /v1/internet-gateways
Description
Create Internet Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "Internet Gateway Description",
"firewall_enabled": false,
"firewall_loggable": false,
"tags": [],
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.7 - Create NAT Gateway
9.1.7.1 - 1.3
post /v1/nat-gateways
Description
Create NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | NatGatewayCreateRequestV1Dot3 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | NatGatewayShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "VpcEndpoint Description",
"multi_zone_enabled": "true",
"publicip_ids": [
"12f56e27070248a6a240a497e43fbe18",
"24f56e27070248a6a240a497e43fbe18"
],
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"multi_zone_enabled": "true",
"name": "NatGatewayName",
"nat_gateway_ips": [
{
"ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18"
}
],
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.7.2 - 1.2
post /v1/nat-gateways
Description
Create NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "VpcEndpoint Description",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.7.3 - 1.1
post /v1/nat-gateways
Description
Create NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "VpcEndpoint Description",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.7.4 - 1.0
post /v1/nat-gateways
Description
Create NAT Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "VpcEndpoint Description",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.8 - Create Port
9.1.8.1 - 1.3
post /v1/ports
Description
Create port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PortCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | PortShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Port Description",
"fixed_ip_address": "",
"name": "portName",
"security_groups": [],
"subnet_id": "",
"tags": []
}
Example HTTP response
Response 201
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"virtual_ip_addresses": [
""
],
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.8.2 - 1.2
post /v1/ports
Description
Create port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PortCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | PortShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Port Description",
"fixed_ip_address": "",
"name": "portName",
"security_groups": [],
"subnet_id": "",
"tags": []
}
Example HTTP response
Response 201
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"virtual_ip_addresses": [
""
],
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.8.3 - 1.1
post /v1/ports
Description
Create port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "Port Description",
"fixed_ip_address": "",
"name": "portName",
"security_groups": [],
"subnet_id": "",
"tags": []
}
Example HTTP response
Response 201
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.8.4 - 1.0
post /v1/ports
Description
Create port.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "Port Description",
"fixed_ip_address": "",
"name": "portName",
"security_groups": [],
"subnet_id": "",
"tags": []
}
Example HTTP response
Response 201
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.9 - Create Private NAT
9.1.9.1 - 1.3
post /v1/private-nats
Description
Create Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PrivateNatCreateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | PrivateNatShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"cidr": "192.167.0.0/24",
"description": "PrivateNat Description",
"name": "PrivateNatName",
"service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
"service_type": "DIRECT_CONNECT",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
"service_resource_name": "PrivateNatName",
"service_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
}
9.1.9.2 - 1.2
post /v1/private-nats
Description
Create Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PrivateNatCreateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | PrivateNatShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"cidr": "192.167.0.0/24",
"description": "PrivateNat Description",
"name": "PrivateNatName",
"service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
"service_type": "DIRECT_CONNECT",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
"service_resource_name": "PrivateNatName",
"service_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
}
9.1.9.3 - 1.1
post /v1/private-nats
Description
Create Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"cidr": "192.167.0.0/24",
"description": "PrivateNat Description",
"direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
"name": "PrivateNatName",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
"direct_connect_name": "DirectConnectName",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.9.4 - 1.0
post /v1/private-nats
Description
Create Private NAT.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"cidr": "192.167.0.0/24",
"description": "PrivateNat Description",
"direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
"name": "PrivateNatName",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
"direct_connect_name": "DirectConnectName",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.10 - Create Private NAT IP
9.1.10.1 - 1.3
post /v1/private-nats/{private_nat_id}/private-nat-ips
Description
Create Private NAT IP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
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"
}
}
9.1.10.2 - 1.2
post /v1/private-nats/{private_nat_id}/private-nat-ips
Description
Create Private NAT IP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
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"
}
}
9.1.10.3 - 1.1
post /v1/private-nats/{private_nat_id}/private-nat-ips
Description
Create Private NAT IP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"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"
}
}
9.1.10.4 - 1.0
post /v1/private-nats/{private_nat_id}/private-nat-ips
Description
Create Private NAT IP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"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"
}
}
9.1.11 - Create PrivateLink Endpoint
9.1.11.1 - 1.3
post /v1/privatelink-endpoints
Description
Create PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.11.2 - 1.2
post /v1/privatelink-endpoints
Description
Create PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.11.3 - 1.1
post /v1/privatelink-endpoints
Description
Create PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.12 - Create PrivateLink Service
9.1.12.1 - 1.3
post /v1/privatelink-services
Description
Create PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_type": "LB",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"privatelink_service": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.12.2 - 1.2
post /v1/privatelink-services
Description
Create PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_type": "LB",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"privatelink_service": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.12.3 - 1.1
post /v1/privatelink-services
Description
Create PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_type": "LB",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"privatelink_service": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.13 - Create PublicIP
9.1.13.1 - 1.3
post /v1/publicips
Description
Create PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PublicipCreateRequestV1Dot3 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | PublicipShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Public IP Description",
"tags": "[{'key': 'key', 'value': 'value'}]",
"type": "IGW",
"zone": "kr-west1-a"
}
Example HTTP response
Response 201
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW",
"zone": "kr-west1-a"
}
}
9.1.13.2 - 1.2
post /v1/publicips
Description
Create PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Public IP Description",
"tags": "[{'key': 'key', 'value': 'value'}]",
"type": "IGW"
}
Example HTTP response
Response 201
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
}
9.1.13.3 - 1.1
post /v1/publicips
Description
Create PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "Public IP Description",
"tags": "[{'key': 'key', 'value': 'value'}]",
"type": "IGW"
}
Example HTTP response
Response 201
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
}
9.1.13.4 - 1.0
post /v1/publicips
Description
Create PublicIP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "Public IP Description",
"tags": "[{'key': 'key', 'value': 'value'}]",
"type": "IGW"
}
Example HTTP response
Response 201
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
}
9.1.14 - Create Subnet
9.1.14.1 - 1.3
post /v1/subnets
Description
Create subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SubnetCreateRequestV1Dot3 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | SubnetShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"allocation_pools": "[{\"start\":\"192.167.1.2\", \"end\":\"192.167.1.100\"}]",
"category": "PRIMARY",
"cidr": "192.167.1.0/24",
"description": "Subnet Description",
"dns_nameservers": "[\"1.1.1.1\", \"2.2.2.2\"]",
"gateway_ip_address": "192.167.1.1",
"host_routes": "[{\"destination\":\"192.168.10.0/24\", \"nexthop\":\"192.168.10.0\"}]",
"name": "subnetName",
"primary_subnet_id": "023c57b14f11483689338d085e061492",
"tags": [],
"type": "PUBLIC",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"subnet": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"allocation_pools": [],
"category": "PRIMARY",
"cidr": "192.167.1.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Subnet Description",
"dhcp_ip_address": "",
"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",
"primary_subnet_id": "023c57b14f11483689338d085e061492",
"secondary_subnet_ids": "[\"522e102f680448a8804d18d4838baa78\", \"aec40baf53c243c1bb8401a703a2c888\"]",
"state": "CREATING",
"type": "PUBLIC",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName",
"zones": "[\"kr-west1-a\", \"kr-west1-b\", \"kr-west1-c\"]"
}
}
9.1.14.2 - 1.2
post /v1/subnets
Description
Create subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SubnetCreateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | SubnetShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
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\"]",
"gateway_ip_address": "192.167.1.1",
"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",
"dhcp_ip_address": "",
"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"
}
}
9.1.14.3 - 1.1
post /v1/subnets
Description
Create subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"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"
}
}
9.1.14.4 - 1.0
post /v1/subnets
Description
Create subnet.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
9.1.15 - Create Subnet VIP
9.1.15.1 - 1.3
post /v1/subnets/{subnet_id}/vips
Description
Create Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet Id Example : 023c57b14f11483689338d085e061492 | string | None |
| body | body required | VipCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | VipCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Subnet VIP Description",
"virtual_ip_address": "192.168.20.6"
}
Example HTTP response
Response 201
{
"subnet_vip": {
"connected_ports": [
{
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "Virtual Server",
"id": "13e2a5a1acbe4713a9a2c70ce226e822",
"port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
"port_ip_address": "192.168.20.5",
"port_name": "Port name"
}
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Subnet VIP Description",
"id": "0466a9448d9a4411a86055939e451c8f",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"static_nat": {
"external_ip_address": "100.112.9.84",
"id": "0009e49548154745948e9722adefbf40",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE"
},
"subnet_id": "023c57b14f11483689338d085e061492",
"vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
"virtual_ip_address": "192.168.20.6"
}
}
9.1.15.2 - 1.2
post /v1/subnets/{subnet_id}/vips
Description
Create Subnet Vip
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet Id Example : 023c57b14f11483689338d085e061492 | string | None |
| body | body required | VipCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | VipCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Subnet VIP Description",
"virtual_ip_address": "192.168.20.6"
}
Example HTTP response
Response 201
{
"subnet_vip": {
"connected_ports": [
{
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "Virtual Server",
"id": "13e2a5a1acbe4713a9a2c70ce226e822",
"port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
"port_ip_address": "192.168.20.5",
"port_name": "Port name"
}
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Subnet VIP Description",
"id": "0466a9448d9a4411a86055939e451c8f",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"static_nat": {
"external_ip_address": "100.112.9.84",
"id": "0009e49548154745948e9722adefbf40",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE"
},
"subnet_id": "023c57b14f11483689338d085e061492",
"vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
"virtual_ip_address": "192.168.20.6"
}
}
9.1.16 - Create Subnet VIP NAT IP
9.1.16.1 - 1.3
post /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips
Description
Create Subnet Vip Nat Ip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
| body | body required | VipNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VipNatCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"nat_type": "PUBLIC",
"publicip_id": "12f56e27070248a6a240a497e43fbe18"
}
Example HTTP response
Response 202
{
"id": "0009e49548154745948e9722adefbf40",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE"
}
9.1.16.2 - 1.2
post /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips
Description
Create Subnet Vip Nat Ip
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
| body | body required | VipNatCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VipNatCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"nat_type": "PUBLIC",
"publicip_id": "12f56e27070248a6a240a497e43fbe18"
}
Example HTTP response
Response 202
{
"id": "0009e49548154745948e9722adefbf40",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE"
}
9.1.17 - Create Transit Gateway
9.1.17.1 - 1.3
post /v1/transit-gateways
Description
Create Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | TransitGatewayCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "TransitGateway Description",
"name": "TransitGatewayName",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_connection_state": "INACTIVE",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_active_zone": "kr-west1-a",
"uplink_enabled": "False",
"uplink_standby_zone": "kr-west1-b",
"uplink_zone_state": "ACTIVE"
}
}
9.1.17.2 - 1.2
post /v1/transit-gateways
Description
Create Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | TransitGatewayCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "TransitGateway Description",
"name": "TransitGatewayName",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_connection_state": "INACTIVE",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.17.3 - 1.1
post /v1/transit-gateways
Description
Create Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "TransitGateway Description",
"name": "TransitGatewayName",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.17.4 - 1.0
post /v1/transit-gateways
Description
Create Transit Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "TransitGateway Description",
"name": "TransitGatewayName",
"tags": "[{'key': 'key', 'value': 'value'}]"
}
Example HTTP response
Response 202
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.18 - Create Transit Gateway Firewall
9.1.18.1 - 1.3
post /v1/transit-gateways/{transit_gateway_id}/firewalls
Description
Create Transit Gateway Firewall.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| body | body required | TransitGatewayFirewallCreateRequestV1Dot3 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayFirewallCreateResponseV1Dot3 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/firewalls
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"product_type": "TGW_DGW",
"uplink_active_zone": "kr-west1-a",
"uplink_standby_zone": "kr-west1-b"
}
Example HTTP response
Response 202
{
"state": "ACTIVE",
"uplink_active_zone": "kr-west1-a",
"uplink_standby_zone": "kr-west1-b",
"uplink_zone_state": "ACTIVE"
}
9.1.18.2 - 1.2
post /v1/transit-gateways/{transit_gateway_id}/firewalls
Description
Create Transit Gateway Firewall.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| body | body required | TransitGatewayFirewallCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | TransitGatewayShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/firewalls
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"product_type": "TGW_DGW"
}
Example HTTP response
Response 201
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_connection_state": "INACTIVE",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.19 - Create Transit Gateway Firewall Connection
9.1.19.1 - 1.3
post /v1/transit-gateways/{transit_gateway_id}/firewall-connections
Description
Create Transit Gateway Firewall Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayFirewallConnectionCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/firewall-connections
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
{
"firewall_connection_state": "INACTIVE"
}
9.1.19.2 - 1.2
post /v1/transit-gateways/{transit_gateway_id}/firewall-connections
Description
Create Transit Gateway Firewall Connection.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/firewall-connections
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_connection_state": "INACTIVE",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.20 - Create Transit Gateway Rule
9.1.20.1 - 1.3
post /v1/transit-gateways/{transit_gateway_id}/routing-rules
Description
Create Transit Gateway Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "VPC",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}
Example HTTP response
Response 202
{
"transit_gateway_rule": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
"destination_resource_name": "VpcName",
"destination_type": "VPC",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
"source_resource_name": "TgwName",
"source_type": "TGW",
"state": "ACTIVE",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
"tgw_connection_vpc_name": "ConnectedVpcName"
}
}
9.1.20.2 - 1.2
post /v1/transit-gateways/{transit_gateway_id}/routing-rules
Description
Create Transit Gateway Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "VPC",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}
Example HTTP response
Response 202
{
"transit_gateway_rule": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
"destination_resource_name": "VpcName",
"destination_type": "VPC",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
"source_resource_name": "TgwName",
"source_type": "TGW",
"state": "ACTIVE",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
"tgw_connection_vpc_name": "ConnectedVpcName"
}
}
9.1.20.3 - 1.1
post /v1/transit-gateways/{transit_gateway_id}/routing-rules
Description
Create Transit Gateway Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "VPC",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}
Example HTTP response
Response 202
{
"transit_gateway_rule": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
"destination_resource_name": "VpcName",
"destination_type": "VPC",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
"source_resource_name": "TgwName",
"source_type": "TGW",
"state": "ACTIVE",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
"tgw_connection_vpc_name": "ConnectedVpcName"
}
}
9.1.20.4 - 1.0
post /v1/transit-gateways/{transit_gateway_id}/routing-rules
Description
Create Transit Gateway Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "VPC",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}
Example HTTP response
Response 202
{
"transit_gateway_rule": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
"destination_resource_name": "VpcName",
"destination_type": "VPC",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
"source_resource_name": "TgwName",
"source_type": "TGW",
"state": "ACTIVE",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
"tgw_connection_vpc_name": "ConnectedVpcName"
}
}
9.1.21 - Create Transit Gateway Uplink Rule
9.1.21.1 - 1.3
post /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules
Description
Create Transit Gateway Uplink Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| body | body required | TransitGatewayUplinkRuleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayUplinkRuleCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "ON_PREMISE"
}
Example HTTP response
Response 202
{
"transit_gateway_rule": {
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "ON_PREMISE",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"state": "ACTIVE"
}
}
9.1.21.2 - 1.2
post /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules
Description
Create Transit Gateway Uplink Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| body | body required | TransitGatewayUplinkRuleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayUplinkRuleCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "ON_PREMISE"
}
Example HTTP response
Response 202
{
"transit_gateway_rule": {
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "ON_PREMISE",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"state": "ACTIVE"
}
}
9.1.21.3 - 1.1
post /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules
Description
Create Transit Gateway Uplink Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| body | body required | TransitGatewayUplinkRuleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayUplinkRuleCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "ON_PREMISE"
}
Example HTTP response
Response 202
{
"transit_gateway_rule": {
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "ON_PREMISE",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"state": "ACTIVE"
}
}
9.1.21.4 - 1.0
post /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules
Description
Create Transit Gateway Uplink Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| body | body required | TransitGatewayUplinkRuleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayUplinkRuleCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "ON_PREMISE"
}
Example HTTP response
Response 202
{
"transit_gateway_rule": {
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_type": "ON_PREMISE",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"state": "ACTIVE"
}
}
9.1.22 - Create Transit Gateway VPC Connection
9.1.22.1 - 1.3
post /v1/transit-gateways/{transit_gateway_id}/vpc-connections
Description
Create Transit Gateway VPC Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"transit_gateway_vpc_connection": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "ffeced8e191c478eabd66b6e2cab8e34",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.22.2 - 1.2
post /v1/transit-gateways/{transit_gateway_id}/vpc-connections
Description
Create Transit Gateway VPC Connection.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"transit_gateway_vpc_connection": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "ffeced8e191c478eabd66b6e2cab8e34",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.22.3 - 1.1
post /v1/transit-gateways/{transit_gateway_id}/vpc-connections
Description
Create Transit Gateway VPC Connection.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"transit_gateway_vpc_connection": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "ffeced8e191c478eabd66b6e2cab8e34",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.22.4 - 1.0
post /v1/transit-gateways/{transit_gateway_id}/vpc-connections
Description
Create Transit Gateway VPC Connection.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"transit_gateway_vpc_connection": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "ffeced8e191c478eabd66b6e2cab8e34",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.23 - Create VPC
9.1.23.1 - 1.3
post /v1/vpcs
Description
Create VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VpcCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | VpcShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"cidr": "192.167.0.0/18",
"description": "VPC Description",
"name": "vpcName",
"tags": []
}
Example HTTP response
Response 201
{
"vpc": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr_count": 20,
"cidrs": [
{
"cidr": "192.167.0.0/18",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "7df8abb4912e4709b1cb237daccca7a8",
"id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"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",
"zone_type": "PUBLIC",
"zones": [
"zone-a",
"zone-b",
"zone-c"
]
}
}
9.1.23.2 - 1.2
post /v1/vpcs
Description
Create VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VpcCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | VpcShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"cidr": "192.167.0.0/18",
"description": "VPC Description",
"name": "vpcName",
"tags": []
}
Example HTTP response
Response 201
{
"vpc": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr_count": 20,
"cidrs": [
{
"cidr": "192.167.0.0/18",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "7df8abb4912e4709b1cb237daccca7a8",
"id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"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"
}
}
9.1.23.3 - 1.1
post /v1/vpcs
Description
Create VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"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"
}
}
9.1.23.4 - 1.0
post /v1/vpcs
Description
Create VPC.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
9.1.24 - Create VPC Endpoint
9.1.24.1 - 1.3
post /v1/vpc-endpoints
Description
Create VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.24.2 - 1.2
post /v1/vpc-endpoints
Description
Create VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.24.3 - 1.1
post /v1/vpc-endpoints
Description
Create VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.24.4 - 1.0
post /v1/vpc-endpoints
Description
Create VPC Endpoint.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"subnet_id": "023c57b14f11483689338d085e061492",
"tags": "[{'key': 'key', 'value': 'value'}]",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
Example HTTP response
Response 202
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.25 - Create VPC Peering
9.1.25.1 - 1.3
post /v1/vpc-peerings
Description
Create VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"description": "vpcPeering Description",
"name": "vpcPeeringName",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"tags": []
}
Example HTTP response
Response 202
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.25.2 - 1.2
post /v1/vpc-peerings
Description
Create VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"description": "vpcPeering Description",
"name": "vpcPeeringName",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"tags": []
}
Example HTTP response
Response 202
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.25.3 - 1.1
post /v1/vpc-peerings
Description
Create VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"description": "vpcPeering Description",
"name": "vpcPeeringName",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"tags": []
}
Example HTTP response
Response 202
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.25.4 - 1.0
post /v1/vpc-peerings
Description
Create VPC Peering.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"description": "vpcPeering Description",
"name": "vpcPeeringName",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"tags": []
}
Example HTTP response
Response 202
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.26 - Create Vpc Peering Rule
9.1.26.1 - 1.3
post /v1/vpc-peerings/{vpc_peering_id}/routing-rules
Description
Create a VPC Peering Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
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": ""
}
}
9.1.26.2 - 1.2
post /v1/vpc-peerings/{vpc_peering_id}/routing-rules
Description
Create a VPC Peering Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
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": ""
}
}
9.1.26.3 - 1.1
post /v1/vpc-peerings/{vpc_peering_id}/routing-rules
Description
Create a VPC Peering Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"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": ""
}
}
9.1.26.4 - 1.0
post /v1/vpc-peerings/{vpc_peering_id}/routing-rules
Description
Create a VPC Peering Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"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": ""
}
}
9.1.27 - Delete Internet Gateway
9.1.27.1 - 1.3
delete /v1/internet-gateways/{internet_gateway_id}
Description
Delete Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.27.2 - 1.2
delete /v1/internet-gateways/{internet_gateway_id}
Description
Delete Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.27.3 - 1.1
delete /v1/internet-gateways/{internet_gateway_id}
Description
Delete Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.27.4 - 1.0
delete /v1/internet-gateways/{internet_gateway_id}
Description
Delete Internet Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.28 - Delete NAT Gateway
9.1.28.1 - 1.3
delete /v1/nat-gateways/{nat_gateway_id}
Description
Delete NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.28.2 - 1.2
delete /v1/nat-gateways/{nat_gateway_id}
Description
Delete NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.28.3 - 1.1
delete /v1/nat-gateways/{nat_gateway_id}
Description
Delete NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.28.4 - 1.0
delete /v1/nat-gateways/{nat_gateway_id}
Description
Delete NAT Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.29 - Delete Port
9.1.29.1 - 1.3
delete /v1/ports/{port_id}
Description
Delete port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 204
9.1.29.2 - 1.2
delete /v1/ports/{port_id}
Description
Delete port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 204
9.1.29.3 - 1.1
delete /v1/ports/{port_id}
Description
Delete port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 204
9.1.29.4 - 1.0
delete /v1/ports/{port_id}
Description
Delete port.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 204
9.1.30 - Delete Private NAT
9.1.30.1 - 1.3
delete /v1/private-nats/{private_nat_id}
Description
Delete Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.30.2 - 1.2
delete /v1/private-nats/{private_nat_id}
Description
Delete Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.30.3 - 1.1
delete /v1/private-nats/{private_nat_id}
Description
Delete Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.30.4 - 1.0
delete /v1/private-nats/{private_nat_id}
Description
Delete Private NAT.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.31 - Delete Private NAT IP
9.1.31.1 - 1.3
delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}
Description
Delete Private NAT IP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 204
9.1.31.2 - 1.2
delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}
Description
Delete Private NAT IP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 204
9.1.31.3 - 1.1
delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}
Description
Delete Private NAT IP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 204
9.1.31.4 - 1.0
delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}
Description
Delete Private NAT IP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 204
9.1.32 - Delete PrivateLink Endpoint
9.1.32.1 - 1.3
delete /v1/privatelink-endpoints/{privatelink_endpoint_id}
Description
Delete PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.32.2 - 1.2
delete /v1/privatelink-endpoints/{privatelink_endpoint_id}
Description
Delete PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.32.3 - 1.1
delete /v1/privatelink-endpoints/{privatelink_endpoint_id}
Description
Delete PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.33 - Delete PrivateLink Service
9.1.33.1 - 1.3
delete /v1/privatelink-services/{privatelink_service_id}
Description
Delete PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.33.2 - 1.2
delete /v1/privatelink-services/{privatelink_service_id}
Description
Delete PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.33.3 - 1.1
delete /v1/privatelink-services/{privatelink_service_id}
Description
Delete PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.34 - Delete PublicIP
9.1.34.1 - 1.3
delete /v1/publicips/{publicip_id}
Description
Delete PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 204
9.1.34.2 - 1.2
delete /v1/publicips/{publicip_id}
Description
Delete PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 204
9.1.34.3 - 1.1
delete /v1/publicips/{publicip_id}
Description
Delete PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 204
9.1.34.4 - 1.0
delete /v1/publicips/{publicip_id}
Description
Delete PublicIP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 204
9.1.35 - Delete Subnet
9.1.35.1 - 1.3
delete /v1/subnets/{subnet_id}
Description
Delete subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.35.2 - 1.2
delete /v1/subnets/{subnet_id}
Description
Delete subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.35.3 - 1.1
delete /v1/subnets/{subnet_id}
Description
Delete subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.35.4 - 1.0
delete /v1/subnets/{subnet_id}
Description
Delete subnet.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.36 - Delete Subnet Vip
9.1.36.1 - 1.3
delete /v1/subnets/{subnet_id}/vips/{vip_id}
Description
Delete Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | 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/subnets/{subnet_id}/vips/{vip_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 204
9.1.36.2 - 1.2
delete /v1/subnets/{subnet_id}/vips/{vip_id}
Description
Delete Subnet Vip
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | 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/subnets/{subnet_id}/vips/{vip_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 204
9.1.37 - Delete Subnet Vip Connected Port
9.1.37.1 - 1.3
delete /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_id}
Description
Delete Subnet Vip Connected Port
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
| path | connected_port_id required | Subnet Vip Connected Port Id Example : 13e2a5a1acbe4713a9a2c70ce226e822 | 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/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 204
9.1.37.2 - 1.2
delete /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_id}
Description
Delete Subnet Vip Connected Port
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
| path | connected_port_id required | Subnet Vip Connected Port Id Example : 13e2a5a1acbe4713a9a2c70ce226e822 | 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/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 204
9.1.38 - Delete Subnet VIP NAT IP
9.1.38.1 - 1.3
delete /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_id}
Description
Delete Subnet Vip Nat Ip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
| path | static_nat_id required | Static NAT ID Example : 0009e49548154745948e9722adefbf40 | 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/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.38.2 - 1.2
delete /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_id}
Description
Delete Subnet Vip Nat Ip
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
| path | static_nat_id required | Static NAT ID Example : 0009e49548154745948e9722adefbf40 | 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/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.39 - Delete Transit Gateway
9.1.39.1 - 1.3
delete /v1/transit-gateways/{transit_gateway_id}
Description
Delete Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.39.2 - 1.2
delete /v1/transit-gateways/{transit_gateway_id}
Description
Delete Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.39.3 - 1.1
delete /v1/transit-gateways/{transit_gateway_id}
Description
Delete Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.39.4 - 1.0
delete /v1/transit-gateways/{transit_gateway_id}
Description
Delete Transit Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.40 - Delete Transit Gateway Firewall
9.1.40.1 - 1.3
delete /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id}
Description
Delete Transit Gateway Firewall.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | firewall_id required | Firewall ID Example : bbb93aca123f4bb2b2c0f206f4a86b2b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayFirewallDeleteResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
{
"state": "ACTIVE",
"uplink_active_zone": "kr-west1-a",
"uplink_standby_zone": "kr-west1-b",
"uplink_zone_state": "ACTIVE"
}
9.1.40.2 - 1.2
delete /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id}
Description
Delete Transit Gateway Firewall.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | firewall_id required | Firewall ID Example : bbb93aca123f4bb2b2c0f206f4a86b2b | 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/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 204
9.1.41 - Delete Transit Gateway Firewall Connection
9.1.41.1 - 1.3
delete /v1/transit-gateways/{transit_gateway_id}/firewall-connections
Description
Delete Transit Gateway Firewall Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayFirewallConnectionCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/firewall-connections
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
{
"firewall_connection_state": "INACTIVE"
}
9.1.41.2 - 1.2
delete /v1/transit-gateways/{transit_gateway_id}/firewall-connections
Description
Delete Transit Gateway Firewall Connection.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TransitGatewayShowResponseV1Dot2 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/transit-gateways/{transit_gateway_id}/firewall-connections
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_connection_state": "INACTIVE",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.42 - Delete Transit Gateway Rule
9.1.42.1 - 1.3
delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}
Description
Delete Transit Gateway Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : 43772aff4539403d9ba74bf1fdaa00c8 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.42.2 - 1.2
delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}
Description
Delete Transit Gateway Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : 43772aff4539403d9ba74bf1fdaa00c8 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.42.3 - 1.1
delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}
Description
Delete Transit Gateway Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : 43772aff4539403d9ba74bf1fdaa00c8 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.42.4 - 1.0
delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}
Description
Delete Transit Gateway Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : 43772aff4539403d9ba74bf1fdaa00c8 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.43 - Delete Transit Gateway Uplink Rule
9.1.43.1 - 1.3
delete /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id}
Description
Delete Transit Gateway Uplink Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : 43772aff4539403d9ba74bf1fdaa00c8 | 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}/uplink-routing-rules/{routing_rule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.43.2 - 1.2
delete /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id}
Description
Delete Transit Gateway Uplink Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : 43772aff4539403d9ba74bf1fdaa00c8 | 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}/uplink-routing-rules/{routing_rule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.43.3 - 1.1
delete /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id}
Description
Delete Transit Gateway Uplink Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : 43772aff4539403d9ba74bf1fdaa00c8 | 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}/uplink-routing-rules/{routing_rule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.43.4 - 1.0
delete /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id}
Description
Delete Transit Gateway Uplink Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | routing_rule_id required | Routing Rule ID Example : 43772aff4539403d9ba74bf1fdaa00c8 | 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}/uplink-routing-rules/{routing_rule_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.44 - Delete Transit Gateway VPC Connection
9.1.44.1 - 1.3
delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}
Description
Delete Transit Gateway VPC Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | vpc_connection_id required | Transit Gateway VPC Connection ID Example : ffeced8e191c478eabd66b6e2cab8e34 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.44.2 - 1.2
delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}
Description
Delete Transit Gateway VPC Connection.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | vpc_connection_id required | Transit Gateway VPC Connection ID Example : ffeced8e191c478eabd66b6e2cab8e34 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.44.3 - 1.1
delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}
Description
Delete Transit Gateway VPC Connection.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | vpc_connection_id required | Transit Gateway VPC Connection ID Example : ffeced8e191c478eabd66b6e2cab8e34 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.44.4 - 1.0
delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}
Description
Delete Transit Gateway VPC Connection.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| path | vpc_connection_id required | Transit Gateway VPC Connection ID Example : ffeced8e191c478eabd66b6e2cab8e34 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.45 - Delete VPC
9.1.45.1 - 1.3
delete /v1/vpcs/{vpc_id}
Description
Delete VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 204
9.1.45.2 - 1.2
delete /v1/vpcs/{vpc_id}
Description
Delete VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 204
9.1.45.3 - 1.1
delete /v1/vpcs/{vpc_id}
Description
Delete VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 204
9.1.45.4 - 1.0
delete /v1/vpcs/{vpc_id}
Description
Delete VPC.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 204
9.1.46 - Delete VPC Endpoint
9.1.46.1 - 1.3
delete /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Delete VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.46.2 - 1.2
delete /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Delete VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.46.3 - 1.1
delete /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Delete VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.46.4 - 1.0
delete /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Delete VPC Endpoint.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.47 - Delete VPC Peering
9.1.47.1 - 1.3
delete /v1/vpc-peerings/{vpc_peering_id}
Description
Delete VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.47.2 - 1.2
delete /v1/vpc-peerings/{vpc_peering_id}
Description
Delete VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.47.3 - 1.1
delete /v1/vpc-peerings/{vpc_peering_id}
Description
Delete VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.47.4 - 1.0
delete /v1/vpc-peerings/{vpc_peering_id}
Description
Delete VPC Peering.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.48 - Delete VPC Peering Rule
9.1.48.1 - 1.3
delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}
Description
Delete a VPC Peering Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 202
9.1.48.2 - 1.2
delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}
Description
Delete a VPC Peering Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 202
9.1.48.3 - 1.1
delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}
Description
Delete a VPC Peering Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 202
9.1.48.4 - 1.0
delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}
Description
Delete a VPC Peering Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 202
9.1.49 - List Connected PrivateLink Endpoints
9.1.49.1 - 1.3
get /v1/privatelink-services/{privatelink_service_id}/connected-endpoints
Description
Get Connected PrivateLink Endpoint List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"connected_privatelink_endpoints": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"state": "ACTIVE"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.49.2 - 1.2
get /v1/privatelink-services/{privatelink_service_id}/connected-endpoints
Description
Get Connected PrivateLink Endpoint List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"connected_privatelink_endpoints": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"state": "ACTIVE"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.49.3 - 1.1
get /v1/privatelink-services/{privatelink_service_id}/connected-endpoints
Description
Get Connected PrivateLink Endpoint List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"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": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"state": "ACTIVE"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.50 - List Internet Gateways
9.1.50.1 - 1.3
get /v1/internet-gateways
Description
Get Internet Gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | name optional | Internet Gateway Name Example : IGW_VPCname | any of [string, null] | None |
| query | type optional | Internet Gateway Type Example : | enum (IGW, GGW, SIGW) | |
| query | state optional | State Example : | string | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InternetGatewayListResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"internet_gateways": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"multi_zone_enabled": true,
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.50.2 - 1.2
get /v1/internet-gateways
Description
Get Internet Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | name optional | Internet Gateway Name Example : IGW_VPCname | any of [string, null] | None |
| query | type optional | Internet Gateway Type Example : | enum (IGW, GGW, SIGW) | |
| query | state optional | State Example : | string | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InternetGatewayListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"internet_gateways": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.50.3 - 1.1
get /v1/internet-gateways
Description
Get Internet Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | name optional | Internet Gateway Name Example : IGW_VPCname | any of [string, null] | None |
| query | type optional | Internet Gateway Type Example : | enum (IGW, GGW, SIGW) | |
| query | state optional | State Example : | string | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | |
| query | vpc_name optional | VPC Name Example : vpcName | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"count": 20,
"internet_gateways": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
9.1.50.4 - 1.0
get /v1/internet-gateways
Description
Get Internet Gateway list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | name optional | Internet Gateway Name Example : IGW_VPCname | any of [string, null] | None |
| query | type optional | Internet Gateway Type Example : | enum (IGW, GGW, SIGW) | |
| query | state optional | State Example : | string | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | |
| query | vpc_name optional | VPC Name Example : vpcName | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 200
{
"count": 20,
"internet_gateways": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
9.1.51 - List NAT Gateways
9.1.51.1 - 1.3
get /v1/nat-gateways
Description
Get NAT Gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | NAT Gateway Name Example : NatGatewayName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | subnet_name optional | Subnet Name Example : subnetName | any of [string, null] | None |
| query | nat_gateway_ip_address optional | NAT Gateway IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | NAT Gateway State Example : ACTIVE | any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null] | None |
| query | multi_zone_enabled optional | Multi Zone Use Example : true | any of [boolean, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | NatGatewayListResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"nat_gateways": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"multi_zone_enabled": "true",
"name": "NatGatewayName",
"nat_gateway_ips": [
{
"ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18"
}
],
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.51.2 - 1.2
get /v1/nat-gateways
Description
Get NAT Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 | NAT Gateway Name Example : NatGatewayName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | subnet_name optional | Subnet Name Example : subnetName | any of [string, null] | None |
| query | nat_gateway_ip_address optional | NAT Gateway IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | NAT Gateway State Example : ACTIVE | any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | NatGatewayListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"nat_gateways": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.51.3 - 1.1
get /v1/nat-gateways
Description
Get NAT Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 Name Example : NatGatewayName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | subnet_name optional | Subnet Name Example : subnetName | any of [string, null] | None |
| query | nat_gateway_ip_address optional | NAT Gateway IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | NAT Gateway State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
9.1.51.4 - 1.0
get /v1/nat-gateways
Description
Get NAT Gateway list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 Name Example : NatGatewayName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | subnet_name optional | Subnet Name Example : subnetName | any of [string, null] | None |
| query | nat_gateway_ip_address optional | NAT Gateway IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | NAT Gateway State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
9.1.52 - List Ports
9.1.52.1 - 1.3
get /v1/ports
Description
Get port list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | Port Limit Example : | any of [integer, null] | None |
| query | marker optional | Port Marker Example : | any of [string, null] | None |
| query | sort optional | Port Sort Example : | any of [string, null] | None |
| query | name optional | Port Name Example : portName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | subnet_name optional | Subnet Name Example : subnetName | any of [string, null] | None |
| query | id optional | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | any of [string, null] | None |
| query | attached_resource_id optional | Connected resource ID Example : 9387e8f51de04a03994de8a9c3524935 | any of [string, null] | None |
| query | fixed_ip_address optional | Fixed IP Example : 192.168.1.100 | any of [string, null] | None |
| query | mac_address optional | MAC Address Example : fa:16:3e:00:00:01 | any of [string, null] | None |
| query | state optional | State Example : | any of [string, null] | None |
| query | security_groups optional | Security Group List Example : | any of [string, null] | None |
| query | attached_resource_types optional | Attached Resource Type Example : | any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]] | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"ports": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
]
}
9.1.52.2 - 1.2
get /v1/ports
Description
Get port list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | Port Limit Example : | any of [integer, null] | None |
| query | marker optional | Port Marker Example : | any of [string, null] | None |
| query | sort optional | Port Sort Example : | any of [string, null] | None |
| query | name optional | Port Name Example : portName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | subnet_name optional | Subnet Name Example : subnetName | any of [string, null] | None |
| query | id optional | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | any of [string, null] | None |
| query | attached_resource_id optional | Connected resource ID Example : 9387e8f51de04a03994de8a9c3524935 | any of [string, null] | None |
| query | fixed_ip_address optional | Fixed IP Example : 192.168.1.100 | any of [string, null] | None |
| query | mac_address optional | MAC Address Example : fa:16:3e:00:00:01 | any of [string, null] | None |
| query | state optional | State Example : | any of [string, null] | None |
| query | security_groups optional | Security Group List Example : | any of [string, null] | None |
| query | attached_resource_types optional | Attached Resource Type Example : | any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]] | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"ports": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
]
}
9.1.52.3 - 1.1
get /v1/ports
Description
Get port list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | Port Limit Example : | any of [integer, null] | None |
| query | marker optional | Port Marker Example : | any of [string, null] | None |
| query | sort optional | Port Sort Example : | any of [string, null] | None |
| query | name optional | Port Name Example : portName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | subnet_name optional | Subnet Name Example : subnetName | any of [string, null] | None |
| query | id optional | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | any of [string, null] | None |
| query | attached_resource_id optional | Connected resource ID Example : 9387e8f51de04a03994de8a9c3524935 | any of [string, null] | None |
| query | fixed_ip_address optional | Fixed IP Example : 192.168.1.100 | any of [string, null] | None |
| query | mac_address optional | MAC Address Example : fa:16:3e:00:00:01 | any of [string, null] | None |
| query | state optional | State Example : | any of [string, null] | None |
| query | security_groups optional | Security Group List Example : | any of [string, null] | None |
| query | attached_resource_types optional | Attached Resource Type Example : | any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]] | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
]
}
9.1.52.4 - 1.0
get /v1/ports
Description
Get port list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 Limit Example : | any of [integer, null] | None |
| query | marker optional | Port Marker Example : | any of [string, null] | None |
| query | sort optional | Port Sort Example : | any of [string, null] | None |
| query | name optional | Port Name Example : portName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | subnet_name optional | Subnet Name Example : subnetName | any of [string, null] | None |
| query | id optional | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | any of [string, null] | None |
| query | attached_resource_id optional | Connected resource ID Example : 9387e8f51de04a03994de8a9c3524935 | any of [string, null] | None |
| query | fixed_ip_address optional | Fixed IP Example : 192.168.1.100 | any of [string, null] | None |
| query | mac_address optional | MAC Address Example : fa:16:3e:00:00:01 | any of [string, null] | None |
| query | state optional | State Example : | any of [string, null] | None |
| query | security_groups optional | Security Group List Example : | any of [string, null] | None |
| query | attached_resource_types optional | Attached Resource Type Example : | any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]] | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
]
}
9.1.53 - List Private NAT
9.1.53.1 - 1.3
get /v1/private-nats
Description
Get Private NAT list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | Private NAT Name Example : PrivateNatName | any of [string, null] | None |
| query | cidr optional | Private NAT IP range Example : 192.167.0.0/24 | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | service_resource_id optional | Private NAT connected Service Resource ID Example : 3f342bf9a557405b997c2cf48c89cbc2 | any of [string, null] | None |
| query | service_type optional | Private NAT connected Service Type Example : DIRECT_CONNECT | enum (DIRECT_CONNECT, TRANSIT_GATEWAY) | None |
| query | service_resource_name optional | Private NAT connected Service Resource Name Example : Service Resource Name | any of [string, null] | None |
| query | state optional | Private NAT State Example : ACTIVE | any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateNatListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"private_nats": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
"service_resource_name": "PrivateNatName",
"service_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.53.2 - 1.2
get /v1/private-nats
Description
Get Private NAT list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 Name Example : PrivateNatName | any of [string, null] | None |
| query | cidr optional | Private NAT IP range Example : 192.167.0.0/24 | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | service_resource_id optional | Private NAT connected Service Resource ID Example : 3f342bf9a557405b997c2cf48c89cbc2 | any of [string, null] | None |
| query | service_type optional | Private NAT connected Service Type Example : DIRECT_CONNECT | enum (DIRECT_CONNECT, TRANSIT_GATEWAY) | None |
| query | service_resource_name optional | Private NAT connected Service Resource Name Example : Service Resource Name | any of [string, null] | None |
| query | state optional | Private NAT State Example : ACTIVE | any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateNatListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"private_nats": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
"service_resource_name": "PrivateNatName",
"service_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.53.3 - 1.1
get /v1/private-nats
Description
Get Private NAT list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 Name Example : PrivateNatName | any of [string, null] | None |
| query | cidr optional | Private NAT IP range Example : 192.167.0.0/24 | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | direct_connect_id optional | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | any of [string, null] | None |
| query | direct_connect_name optional | Direct Connect Name Example : DirectConnectName | any of [string, null] | None |
| query | state optional | Private NAT State Example : ACTIVE | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"private_nats": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
"direct_connect_name": "DirectConnectName",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.53.4 - 1.0
get /v1/private-nats
Description
Get Private NAT list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 Name Example : PrivateNatName | any of [string, null] | None |
| query | cidr optional | Private NAT IP range Example : 192.167.0.0/24 | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | direct_connect_id optional | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | any of [string, null] | None |
| query | direct_connect_name optional | Direct Connect Name Example : DirectConnectName | any of [string, null] | None |
| query | state optional | Private NAT State Example : ACTIVE | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"private_nats": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
"direct_connect_name": "DirectConnectName",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.54 - List Private NAT IP
9.1.54.1 - 1.3
get /v1/private-nats/{private_nat_id}/private-nat-ips
Description
Get Private NAT IP list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 Address Example : | any of [string, null] | None |
| query | state optional | Private NAT IP State Example : | any of [enum (RESERVED, ATTACHED, DELETED), null] | None |
| query | attached_resource_type optional | Private NAT IP Attached Resource Type Example : | any of [enum (VM, BM, ALB, GPU_SERVER), null] | None |
| query | attached_resource_id optional | Private NAT IP Attached Resource ID Example : | any of [string, null] | None |
| query | attached_resource_name optional | Private NAT IP Attached Resource Name 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 = en-US",
"Scp-Api-Version = vpc 1.3"
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"
]
}
9.1.54.2 - 1.2
get /v1/private-nats/{private_nat_id}/private-nat-ips
Description
Get Private NAT IP list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 Address Example : | any of [string, null] | None |
| query | state optional | Private NAT IP State Example : | any of [enum (RESERVED, ATTACHED, DELETED), null] | None |
| query | attached_resource_type optional | Private NAT IP Attached Resource Type Example : | any of [enum (VM, BM, ALB, GPU_SERVER), null] | None |
| query | attached_resource_id optional | Private NAT IP Attached Resource ID Example : | any of [string, null] | None |
| query | attached_resource_name optional | Private NAT IP Attached Resource Name 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 = en-US",
"Scp-Api-Version = vpc 1.2"
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"
]
}
9.1.54.3 - 1.1
get /v1/private-nats/{private_nat_id}/private-nat-ips
Description
Get Private NAT IP list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 Address Example : | any of [string, null] | None |
| query | state optional | Private NAT IP State Example : | any of [enum (RESERVED, ATTACHED, DELETED), null] | None |
| query | attached_resource_type optional | Private NAT IP Attached Resource Type Example : | any of [enum (VM, BM, ALB, GPU_SERVER), null] | None |
| query | attached_resource_id optional | Private NAT IP Attached Resource ID Example : | any of [string, null] | None |
| query | attached_resource_name optional | Private NAT IP Attached Resource Name 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 = en-US",
"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"
]
}
9.1.54.4 - 1.0
get /v1/private-nats/{private_nat_id}/private-nat-ips
Description
Get Private NAT IP list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 Address Example : | any of [string, null] | None |
| query | state optional | Private NAT IP State Example : | any of [enum (RESERVED, ATTACHED, DELETED), null] | None |
| query | attached_resource_type optional | Private NAT IP Attached Resource Type Example : | any of [enum (VM, BM, ALB, GPU_SERVER), null] | None |
| query | attached_resource_id optional | Private NAT IP Attached Resource ID Example : | any of [string, null] | None |
| query | attached_resource_name optional | Private NAT IP Attached Resource Name 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 = en-US",
"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"
]
}
9.1.55 - List PrivateLink Endpoint
9.1.55.1 - 1.3
get /v1/privatelink-endpoints
Description
Get PrivateLink Endpoint List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | any of [string, null] | None |
| query | name optional | PrivateLink Endpoint Name Example : EndpointName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | privatelink_service_id optional | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | any of [string, null] | None |
| query | endpoint_ip_address optional | Endpoint IP Address Example : 192.167.1.5 | any of [string, null] | None |
| query | state optional | PrivateLink Endpoint State Example : ACTIVE | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"privatelink_endpoints": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"endpoint_ip_address": "192.167.1.5",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.55.2 - 1.2
get /v1/privatelink-endpoints
Description
Get PrivateLink Endpoint List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 : bba6d4de3ad64e41b3a1b6c88983ec02 | any of [string, null] | None |
| query | name optional | PrivateLink Endpoint Name Example : EndpointName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | privatelink_service_id optional | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | any of [string, null] | None |
| query | endpoint_ip_address optional | Endpoint IP Address Example : 192.167.1.5 | any of [string, null] | None |
| query | state optional | PrivateLink Endpoint State Example : ACTIVE | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"privatelink_endpoints": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"endpoint_ip_address": "192.167.1.5",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.55.3 - 1.1
get /v1/privatelink-endpoints
Description
Get PrivateLink Endpoint List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 : bba6d4de3ad64e41b3a1b6c88983ec02 | any of [string, null] | None |
| query | name optional | PrivateLink Endpoint Name Example : EndpointName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | privatelink_service_id optional | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | any of [string, null] | None |
| query | endpoint_ip_address optional | Endpoint IP Address Example : 192.167.1.5 | any of [string, null] | None |
| query | state optional | PrivateLink Endpoint State Example : ACTIVE | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"privatelink_endpoints": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"endpoint_ip_address": "192.167.1.5",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.56 - List PrivateLink Service
9.1.56.1 - 1.3
get /v1/privatelink-services
Description
Get PrivateLink Service List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | any of [string, null] | None |
| query | name optional | PrivateLink Service Name Example : ServiceName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | service_ip_address optional | Service IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | connected_resource_id optional | Connected Resource ID Example : a3e3a662a4f34442a94166df5ff9f577 | any of [string, null] | None |
| query | connected_resource_type optional | Connected Resource Type Example : LB | any of [enum (LB, IP), null] | None |
| query | connected_resource_name optional | Connected Resource Name Example : lbResourceName | any of [string, null] | None |
| query | connected_resource_ip_address optional | Connected Resource IP Address Example : 192.167.0.10 | any of [string, null] | None |
| query | state optional | PrivateLink Service State Example : ACTIVE | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"privatelink_services": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"service_ip_address": "192.167.0.5",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.56.2 - 1.2
get /v1/privatelink-services
Description
Get PrivateLink Service List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 : e3df2e8e3b374fbb81d4e322b52ca50d | any of [string, null] | None |
| query | name optional | PrivateLink Service Name Example : ServiceName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | service_ip_address optional | Service IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | connected_resource_id optional | Connected Resource ID Example : a3e3a662a4f34442a94166df5ff9f577 | any of [string, null] | None |
| query | connected_resource_type optional | Connected Resource Type Example : LB | any of [enum (LB, IP), null] | None |
| query | connected_resource_name optional | Connected Resource Name Example : lbResourceName | any of [string, null] | None |
| query | connected_resource_ip_address optional | Connected Resource IP Address Example : 192.167.0.10 | any of [string, null] | None |
| query | state optional | PrivateLink Service State Example : ACTIVE | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"privatelink_services": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"service_ip_address": "192.167.0.5",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.56.3 - 1.1
get /v1/privatelink-services
Description
Get PrivateLink Service List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 : e3df2e8e3b374fbb81d4e322b52ca50d | any of [string, null] | None |
| query | name optional | PrivateLink Service Name Example : ServiceName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | service_ip_address optional | Service IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | connected_resource_id optional | Connected Resource ID Example : a3e3a662a4f34442a94166df5ff9f577 | any of [string, null] | None |
| query | connected_resource_type optional | Connected Resource Type Example : LB | any of [enum (LB, IP), null] | None |
| query | connected_resource_name optional | Connected Resource Name Example : lbResourceName | any of [string, null] | None |
| query | connected_resource_ip_address optional | Connected Resource IP Address Example : 192.167.0.10 | any of [string, null] | None |
| query | state optional | PrivateLink Service State Example : ACTIVE | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"privatelink_services": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"service_ip_address": "192.167.0.5",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.57 - List PublicIPs
9.1.57.1 - 1.3
get /v1/publicips
Description
Get PublicIP list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | ip_address optional | IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | PublicIP State Example : ATTACHED | any of [string, null] | None |
| query | attached_resource_type optional | PublicIP Attached Resource Type Example : NAT_GW | any of [string, null] | None |
| query | attached_resource_id optional | PublicIP Attached Resource ID Example : 37e6db41f5124184a43251a63124cdc9 | any of [string, null] | None |
| query | attached_resource_name optional | PublicIP Attached Resource Name Example : Attached NAT Gateway Name | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | type optional | PublicIP Type Example : IGW | any of [enum (IGW, GGW, SIGW), null] | None |
| query | zone optional | Zone Example : kr-west1-a | any of [array[string], string] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PublicipListResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"publicips": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW",
"zone": "kr-west1-a"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.57.2 - 1.2
get /v1/publicips
Description
Get PublicIP list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 | ip_address optional | IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | PublicIP State Example : ATTACHED | any of [string, null] | None |
| query | attached_resource_type optional | PublicIP Attached Resource Type Example : NAT_GW | any of [string, null] | None |
| query | attached_resource_id optional | PublicIP Attached Resource ID Example : 37e6db41f5124184a43251a63124cdc9 | any of [string, null] | None |
| query | attached_resource_name optional | PublicIP Attached Resource Name Example : Attached NAT Gateway Name | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | type optional | PublicIP Type Example : IGW | any of [enum (IGW, GGW, SIGW), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PublicipListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"publicips": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.57.3 - 1.1
get /v1/publicips
Description
Get PublicIP list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | PublicIP State Example : ATTACHED | any of [string, null] | None |
| query | attached_resource_type optional | PublicIP Attached Resource Type Example : NAT_GW | any of [string, null] | None |
| query | attached_resource_id optional | PublicIP Attached Resource ID Example : 37e6db41f5124184a43251a63124cdc9 | any of [string, null] | None |
| query | attached_resource_name optional | PublicIP Attached Resource Name Example : Attached NAT Gateway Name | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | type optional | PublicIP Type Example : IGW | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
]
}
9.1.57.4 - 1.0
get /v1/publicips
Description
Get PublicIP list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | PublicIP State Example : ATTACHED | any of [string, null] | None |
| query | attached_resource_type optional | PublicIP Attached Resource Type Example : NAT_GW | any of [string, null] | None |
| query | attached_resource_id optional | PublicIP Attached Resource ID Example : 37e6db41f5124184a43251a63124cdc9 | any of [string, null] | None |
| query | attached_resource_name optional | PublicIP Attached Resource Name Example : Attached NAT Gateway Name | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | type optional | PublicIP Type Example : IGW | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
]
}
9.1.58 - List SAP Secondary Subnets
9.1.58.1 - 1.3
get /v1/subnets/{subnet_id}/sap-secondary-subnets
Description
List SAP Secondary Subnets
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 = en-US",
"Scp-Api-Version = vpc 1.3"
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"
]
}
9.1.58.2 - 1.2
get /v1/subnets/{subnet_id}/sap-secondary-subnets
Description
List SAP Secondary Subnets
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 = en-US",
"Scp-Api-Version = vpc 1.2"
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"
]
}
9.1.58.3 - 1.1
get /v1/subnets/{subnet_id}/sap-secondary-subnets
Description
List SAP Secondary Subnets
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"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"
]
}
9.1.59 - List Subnet Vips
9.1.59.1 - 1.3
get /v1/subnets/{subnet_id}/vips
Description
Get list Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 |
| query | virtual_ip_address optional | Virtual IP Address Example : 192.168.20.6 | any of [string, null] | None |
| query | public_ip_address optional | Public IP Address Example : 100.112.9.84 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VipListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"subnet_vips": [
{
"connected_port_count": 2,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0466a9448d9a4411a86055939e451c8f",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"static_nat": {
"external_ip_address": "100.112.9.84",
"id": "0009e49548154745948e9722adefbf40",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE"
},
"virtual_ip_address": "192.168.20.6"
}
]
}
9.1.59.2 - 1.2
get /v1/subnets/{subnet_id}/vips
Description
Get list Subnet Vip
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 |
| query | virtual_ip_address optional | Virtual IP Address Example : 192.168.20.6 | any of [string, null] | None |
| query | public_ip_address optional | Public IP Address Example : 100.112.9.84 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VipListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"subnet_vips": [
{
"connected_port_count": 2,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0466a9448d9a4411a86055939e451c8f",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"static_nat": {
"external_ip_address": "100.112.9.84",
"id": "0009e49548154745948e9722adefbf40",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE"
},
"virtual_ip_address": "192.168.20.6"
}
]
}
9.1.60 - List Subnets
9.1.60.1 - 1.3
get /v1/subnets
Description
Get subnet list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | Subnet Id Example : 023c57b14f11483689338d085e061492 | string | |
| query | name optional | Subnet Name Example : subnetName | string | |
| query | type optional | Subnet Type Example : | any of [enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT), array[enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT)]] | |
| query | cidr optional | Subnet Cidr Example : 192.167.1.0/24 | any of [string, null] | None |
| query | state optional | State Example : | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR) | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| query | vpc_name optional | VPC Name Example : vpcName | string | |
| query | category optional | Subnet Category Example : PRIMARY | enum (PRIMARY, SECONDARY) | |
| query | zone optional | Subnet Zone Example : | string | |
| query | primary_subnet_id optional | Primary Subnet ID Example : 023c57b14f11483689338d085e061492 | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SubnetListResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"subnets": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"category": "PRIMARY",
"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",
"primary_subnet_id": "023c57b14f11483689338d085e061492",
"state": "CREATING",
"type": "PUBLIC",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName",
"zones": "[\"kr-west1-a\", \"kr-west1-b\", \"kr-west1-c\"]"
}
]
}
9.1.60.2 - 1.2
get /v1/subnets
Description
Get subnet list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 | Subnet Id Example : 023c57b14f11483689338d085e061492 | string | |
| query | name optional | Subnet Name Example : subnetName | string | |
| query | type optional | Subnet Type Example : | any of [enum (GENERAL, LOCAL, VPC_ENDPOINT), array[enum (GENERAL, LOCAL, VPC_ENDPOINT)]] | |
| query | cidr optional | Subnet Cidr Example : 192.167.1.0/24 | any of [string, null] | None |
| query | state optional | State Example : | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR) | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| query | vpc_name optional | VPC Name Example : vpcName | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SubnetListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"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"
}
]
}
9.1.60.3 - 1.1
get /v1/subnets
Description
Get subnet list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 Name Example : subnetName | string | |
| query | type optional | Subnet Type Example : | any of [enum (GENERAL, LOCAL, VPC_ENDPOINT), array[enum (GENERAL, LOCAL, VPC_ENDPOINT)]] | |
| query | state optional | State Example : | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR) | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| query | vpc_name optional | VPC Name 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 = en-US",
"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"
}
]
}
9.1.60.4 - 1.0
get /v1/subnets
Description
Get subnet list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 Name Example : subnetName | string | |
| query | type optional | Subnet Type Example : | any of [enum (GENERAL, LOCAL, VPC_ENDPOINT), array[enum (GENERAL, LOCAL, VPC_ENDPOINT)]] | |
| query | state optional | State Example : | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR) | |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| query | vpc_name optional | VPC Name 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 = en-US",
"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"
}
]
}
9.1.61 - List Transit Gateway Rules
9.1.61.1 - 1.3
get /v1/transit-gateways/{transit_gateway_id}/routing-rules
Description
Get Transit Gateway Rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 : 43772aff4539403d9ba74bf1fdaa00c8 | any of [string, null] | None |
| query | tgw_connection_vpc_id optional | VPC ID Connected to Transit Gateway. Example : ffeced8e191c478eabd66b6e2cab8e34 | any of [string, null] | None |
| query | tgw_connection_vpc_name optional | VPC Name Connected to Transit Gateway. Example : ConnectedVpcName | any of [string, null] | None |
| query | source_type optional | Source Type Example : TGW | enum (VPC, TGW, ON_PREMISE) | None |
| query | destination_type optional | Destination Type Example : VPC | enum (VPC, TGW, ON_PREMISE) | None |
| query | destination_cidr optional | Destination CIDR Example : 192.167.5.0/24 | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR) | None |
| query | rule_type optional | Rule Type Example : TGW_VPC | enum (TGW_VPC, TGW_UPLINK) | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TransitGatewayRuleListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"transit_gateway_rules": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
"destination_resource_name": "VpcName",
"destination_type": "VPC",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"rule_type": "TGW_VPC",
"source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
"source_resource_name": "TgwName",
"source_type": "TGW",
"state": "ACTIVE",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
"tgw_connection_vpc_name": "ConnectedVpcName"
}
]
}
9.1.61.2 - 1.2
get /v1/transit-gateways/{transit_gateway_id}/routing-rules
Description
Get Transit Gateway Rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 : 43772aff4539403d9ba74bf1fdaa00c8 | any of [string, null] | None |
| query | tgw_connection_vpc_id optional | VPC ID Connected to Transit Gateway. Example : ffeced8e191c478eabd66b6e2cab8e34 | any of [string, null] | None |
| query | tgw_connection_vpc_name optional | VPC Name Connected to Transit Gateway. Example : ConnectedVpcName | any of [string, null] | None |
| query | source_type optional | Source Type Example : TGW | enum (VPC, TGW, ON_PREMISE) | None |
| query | destination_type optional | Destination Type Example : VPC | enum (VPC, TGW, ON_PREMISE) | None |
| query | destination_cidr optional | Destination CIDR Example : 192.167.5.0/24 | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR) | None |
| query | rule_type optional | Rule Type Example : TGW_VPC | enum (TGW_VPC, TGW_UPLINK) | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TransitGatewayRuleListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"transit_gateway_rules": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
"destination_resource_name": "VpcName",
"destination_type": "VPC",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"rule_type": "TGW_VPC",
"source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
"source_resource_name": "TgwName",
"source_type": "TGW",
"state": "ACTIVE",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
"tgw_connection_vpc_name": "ConnectedVpcName"
}
]
}
9.1.61.3 - 1.1
get /v1/transit-gateways/{transit_gateway_id}/routing-rules
Description
Get Transit Gateway Rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 : 43772aff4539403d9ba74bf1fdaa00c8 | any of [string, null] | None |
| query | tgw_connection_vpc_id optional | VPC ID Connected to Transit Gateway. Example : ffeced8e191c478eabd66b6e2cab8e34 | any of [string, null] | None |
| query | tgw_connection_vpc_name optional | VPC Name Connected to Transit Gateway. Example : ConnectedVpcName | any of [string, null] | None |
| query | source_type optional | Source Type Example : TGW | enum (VPC, TGW, ON_PREMISE) | None |
| query | destination_type optional | Destination Type Example : VPC | enum (VPC, TGW, ON_PREMISE) | None |
| query | destination_cidr optional | Destination CIDR Example : 192.167.5.0/24 | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
"destination_resource_name": "VpcName",
"destination_type": "VPC",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
"source_resource_name": "TgwName",
"source_type": "TGW",
"state": "ACTIVE",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
"tgw_connection_vpc_name": "ConnectedVpcName"
}
]
}
9.1.61.4 - 1.0
get /v1/transit-gateways/{transit_gateway_id}/routing-rules
Description
Get Transit Gateway Rule list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 : 43772aff4539403d9ba74bf1fdaa00c8 | any of [string, null] | None |
| query | tgw_connection_vpc_id optional | VPC ID Connected to Transit Gateway. Example : ffeced8e191c478eabd66b6e2cab8e34 | any of [string, null] | None |
| query | tgw_connection_vpc_name optional | VPC Name Connected to Transit Gateway. Example : ConnectedVpcName | any of [string, null] | None |
| query | source_type optional | Source Type Example : TGW | enum (VPC, TGW, ON_PREMISE) | None |
| query | destination_type optional | Destination Type Example : VPC | enum (VPC, TGW, ON_PREMISE) | None |
| query | destination_cidr optional | Destination CIDR Example : 192.167.5.0/24 | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Routing Rule Description",
"destination_cidr": "192.167.5.0/24",
"destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
"destination_resource_name": "VpcName",
"destination_type": "VPC",
"id": "43772aff4539403d9ba74bf1fdaa00c8",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
"source_resource_name": "TgwName",
"source_type": "TGW",
"state": "ACTIVE",
"tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
"tgw_connection_vpc_name": "ConnectedVpcName"
}
]
}
9.1.62 - List Transit Gateway VPC Connections
9.1.62.1 - 1.3
get /v1/transit-gateways/{transit_gateway_id}/vpc-connections
Description
Get Transit Gateway VPC Connection list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 Connection ID Example : ffeced8e191c478eabd66b6e2cab8e34 | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"transit_gateway_vpc_connections": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "ffeced8e191c478eabd66b6e2cab8e34",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
9.1.62.2 - 1.2
get /v1/transit-gateways/{transit_gateway_id}/vpc-connections
Description
Get Transit Gateway VPC Connection list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 Connection ID Example : ffeced8e191c478eabd66b6e2cab8e34 | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"transit_gateway_vpc_connections": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "ffeced8e191c478eabd66b6e2cab8e34",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
9.1.62.3 - 1.1
get /v1/transit-gateways/{transit_gateway_id}/vpc-connections
Description
Get Transit Gateway VPC Connection list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 Connection ID Example : ffeced8e191c478eabd66b6e2cab8e34 | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "ffeced8e191c478eabd66b6e2cab8e34",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
9.1.62.4 - 1.0
get /v1/transit-gateways/{transit_gateway_id}/vpc-connections
Description
Get Transit Gateway VPC Connection list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 Connection ID Example : ffeced8e191c478eabd66b6e2cab8e34 | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "ffeced8e191c478eabd66b6e2cab8e34",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
9.1.63 - List Transit Gateways
9.1.63.1 - 1.3
get /v1/transit-gateways
Description
Get Transit Gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | any of [string, null] | None |
| query | name optional | Transit Gateway Name Example : TransitGatewayName | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null] | None |
| query | firewall_connection_state optional | Firewall Connection State Example : INACTIVE | any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null] | None |
| query | uplink_zone_state optional | Uplink Zone Connect state Example : ACTIVE | any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR, EDITING), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TransitGatewayListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"transit_gateways": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_connection_state": "INACTIVE",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
]
}
9.1.63.2 - 1.2
get /v1/transit-gateways
Description
Get Transit Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 : fe860e0af0c04dcd8182b84f907f31f4 | any of [string, null] | None |
| query | name optional | Transit Gateway Name Example : TransitGatewayName | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null] | None |
| query | firewall_connection_state optional | Firewall Connection State Example : INACTIVE | any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null] | None |
| query | uplink_zone_state optional | Uplink Zone Connect state Example : ACTIVE | any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR, EDITING), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TransitGatewayListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"transit_gateways": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_connection_state": "INACTIVE",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
]
}
9.1.63.3 - 1.1
get /v1/transit-gateways
Description
Get Transit Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 : fe860e0af0c04dcd8182b84f907f31f4 | any of [string, null] | None |
| query | name optional | Transit Gateway Name Example : TransitGatewayName | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
]
}
9.1.63.4 - 1.0
get /v1/transit-gateways
Description
Get Transit Gateway list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 : fe860e0af0c04dcd8182b84f907f31f4 | any of [string, null] | None |
| query | name optional | Transit Gateway Name Example : TransitGatewayName | any of [string, null] | None |
| query | state optional | State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
]
}
9.1.64 - List VPC Endpoint
9.1.64.1 - 1.3
get /v1/vpc-endpoints
Description
Get VPC Endpoint list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | any of [string, null] | None |
| query | name optional | VPC Endpoint Name Example : VpcEndpointName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | resource_key optional | VPC Endpoint Resource Key Example : 07c5364702384471b650147321b52173 | any of [string, null] | None |
| query | resource_type optional | VPC Endpoint Resource Type Example : FS | any of [enum (FS, OBS, SCR, DNS), null] | None |
| query | endpoint_ip_address optional | VPC Endpoint IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | VPC Endpoint State Example : ACTIVE | any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VpcEndpointListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"vpc_endpoints": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
9.1.64.2 - 1.2
get /v1/vpc-endpoints
Description
Get VPC Endpoint list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | any of [string, null] | None |
| query | name optional | VPC Endpoint Name Example : VpcEndpointName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | resource_key optional | VPC Endpoint Resource Key Example : 07c5364702384471b650147321b52173 | any of [string, null] | None |
| query | resource_type optional | VPC Endpoint Resource Type Example : FS | any of [enum (FS, OBS, SCR, DNS), null] | None |
| query | endpoint_ip_address optional | VPC Endpoint IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | VPC Endpoint State Example : ACTIVE | any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VpcEndpointListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"vpc_endpoints": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
9.1.64.3 - 1.1
get /v1/vpc-endpoints
Description
Get VPC Endpoint list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 : 12f56e27070248a6a240a497e43fbe18 | any of [string, null] | None |
| query | name optional | VPC Endpoint Name Example : VpcEndpointName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | resource_key optional | VPC Endpoint Resource Key Example : 07c5364702384471b650147321b52173 | any of [string, null] | None |
| query | resource_type optional | VPC Endpoint Resource Type Example : FS | any of [enum (FS, OBS, SCR, DNS), null] | None |
| query | endpoint_ip_address optional | VPC Endpoint IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | VPC Endpoint State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
9.1.64.4 - 1.0
get /v1/vpc-endpoints
Description
Get VPC Endpoint list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 : 12f56e27070248a6a240a497e43fbe18 | any of [string, null] | None |
| query | name optional | VPC Endpoint Name Example : VpcEndpointName | any of [string, null] | None |
| query | vpc_id optional | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | vpc_name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | resource_key optional | VPC Endpoint Resource Key Example : 07c5364702384471b650147321b52173 | any of [string, null] | None |
| query | resource_type optional | VPC Endpoint Resource Type Example : FS | any of [enum (FS, OBS, SCR, DNS), null] | None |
| query | endpoint_ip_address optional | VPC Endpoint IP Address Example : 192.167.0.5 | any of [string, null] | None |
| query | state optional | VPC Endpoint State Example : ACTIVE | 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
9.1.65 - List VPC Endpoint Connectable Resources
9.1.65.1 - 1.3
get /v1/vpc-endpoints/connectable-resources
Description
List VpcEndpoint connectable resources
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | resource_type required | VPC Endpoint Resource Type Example : FS | enum (FS, OBS, SCR, DNS) | None |
| query | vpc_id optional | VPC ID(required if resource_type is DNS) Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VpcEndpointConnectableResourceListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"vpc_endpoint_connectable_resources": [
{
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS"
}
]
}
9.1.65.2 - 1.2
get /v1/vpc-endpoints/connectable-resources
Description
List VpcEndpoint connectable resources
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | resource_type required | VPC Endpoint Resource Type Example : FS | enum (FS, OBS, SCR, DNS) | None |
| query | vpc_id optional | VPC ID(required if resource_type is DNS) Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VpcEndpointConnectableResourceListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"vpc_endpoint_connectable_resources": [
{
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS"
}
]
}
9.1.65.3 - 1.1
get /v1/vpc-endpoints/connectable-resources
Description
List VpcEndpoint connectable resources
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | resource_type required | VPC Endpoint Resource Type Example : FS | enum (FS, OBS, SCR, DNS) | None |
| query | vpc_id optional | VPC ID(required if resource_type is DNS) Example : 7df8abb4912e4709b1cb237daccca7a8 | 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 = en-US",
"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": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS"
}
]
}
9.1.65.4 - 1.0
get /v1/vpc-endpoints/connectable-resources
Description
List VpcEndpoint connectable resources
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | resource_type required | VPC Endpoint Resource Type Example : FS | enum (FS, OBS, SCR, DNS) | None |
| query | vpc_id optional | VPC ID(required if resource_type is DNS) Example : 7df8abb4912e4709b1cb237daccca7a8 | 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 = en-US",
"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": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS"
}
]
}
9.1.66 - List VPC Peering
9.1.66.1 - 1.3
get /v1/vpc-peerings
Description
Get VPC Peering list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | name optional | VPC Peering Name Example : vpcPeeringName | any of [string, null] | None |
| query | requester_vpc_id optional | Requester VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | requester_vpc_name optional | Requester VPC Name Example : vpcName | any of [string, null] | None |
| query | approver_vpc_id optional | Approver VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | approver_vpc_name optional | Approver VPC Name Example : vpcName | any of [string, null] | None |
| query | account_type optional | Account Type Example : | any of [enum (SAME, DIFFERENT), null] | None |
| query | state optional | State 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"vpc_peerings": [
{
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
]
}
9.1.66.2 - 1.2
get /v1/vpc-peerings
Description
Get VPC Peering list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | name optional | VPC Peering Name Example : vpcPeeringName | any of [string, null] | None |
| query | requester_vpc_id optional | Requester VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | requester_vpc_name optional | Requester VPC Name Example : vpcName | any of [string, null] | None |
| query | approver_vpc_id optional | Approver VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | approver_vpc_name optional | Approver VPC Name Example : vpcName | any of [string, null] | None |
| query | account_type optional | Account Type Example : | any of [enum (SAME, DIFFERENT), null] | None |
| query | state optional | State 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"vpc_peerings": [
{
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
]
}
9.1.66.3 - 1.1
get /v1/vpc-peerings
Description
Get VPC Peering list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | name optional | VPC Peering Name Example : vpcPeeringName | any of [string, null] | None |
| query | requester_vpc_id optional | Requester VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | requester_vpc_name optional | Requester VPC Name Example : vpcName | any of [string, null] | None |
| query | approver_vpc_id optional | Approver VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | approver_vpc_name optional | Approver VPC Name Example : vpcName | any of [string, null] | None |
| query | account_type optional | Account Type Example : | any of [enum (SAME, DIFFERENT), null] | None |
| query | state optional | State 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
]
}
9.1.66.4 - 1.0
get /v1/vpc-peerings
Description
Get VPC Peering list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 : 023c57b14f11483689338d085e061492 | any of [string, null] | None |
| query | name optional | VPC Peering Name Example : vpcPeeringName | any of [string, null] | None |
| query | requester_vpc_id optional | Requester VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | requester_vpc_name optional | Requester VPC Name Example : vpcName | any of [string, null] | None |
| query | approver_vpc_id optional | Approver VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | approver_vpc_name optional | Approver VPC Name Example : vpcName | any of [string, null] | None |
| query | account_type optional | Account Type Example : | any of [enum (SAME, DIFFERENT), null] | None |
| query | state optional | State 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 = en-US",
"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": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
]
}
9.1.67 - List VPC Peering Rules
9.1.67.1 - 1.3
get /v1/vpc-peerings/{vpc_peering_id}/routing-rules
Description
Get VPC Peering Rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering 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 |
| query | id optional | VPC Peering Rule ID Example : | any of [string, null] | None |
| query | source_vpc_id optional | Source VPC ID Example : | any of [string, null] | None |
| query | source_vpc_type optional | Source VPC Type Example : | enum (REQUESTER_VPC, APPROVER_VPC) | None |
| query | destination_vpc_id optional | Destination VPC ID Example : | any of [string, null] | None |
| query | destination_vpc_type optional | Destination VPC Type Example : | enum (REQUESTER_VPC, APPROVER_VPC) | None |
| query | destination_cidr optional | Destination CIDR Example : | any of [string, null] | None |
| query | state optional | State 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 = en-US",
"Scp-Api-Version = vpc 1.3"
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": ""
}
]
}
9.1.67.2 - 1.2
get /v1/vpc-peerings/{vpc_peering_id}/routing-rules
Description
Get VPC Peering Rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering 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 |
| query | id optional | VPC Peering Rule ID Example : | any of [string, null] | None |
| query | source_vpc_id optional | Source VPC ID Example : | any of [string, null] | None |
| query | source_vpc_type optional | Source VPC Type Example : | enum (REQUESTER_VPC, APPROVER_VPC) | None |
| query | destination_vpc_id optional | Destination VPC ID Example : | any of [string, null] | None |
| query | destination_vpc_type optional | Destination VPC Type Example : | enum (REQUESTER_VPC, APPROVER_VPC) | None |
| query | destination_cidr optional | Destination CIDR Example : | any of [string, null] | None |
| query | state optional | State 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 = en-US",
"Scp-Api-Version = vpc 1.2"
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": ""
}
]
}
9.1.67.3 - 1.1
get /v1/vpc-peerings/{vpc_peering_id}/routing-rules
Description
Get VPC Peering Rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering 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 |
| query | id optional | VPC Peering Rule ID Example : | any of [string, null] | None |
| query | source_vpc_id optional | Source VPC ID Example : | any of [string, null] | None |
| query | source_vpc_type optional | Source VPC Type Example : | enum (REQUESTER_VPC, APPROVER_VPC) | None |
| query | destination_vpc_id optional | Destination VPC ID Example : | any of [string, null] | None |
| query | destination_vpc_type optional | Destination VPC Type Example : | enum (REQUESTER_VPC, APPROVER_VPC) | None |
| query | destination_cidr optional | Destination CIDR Example : | any of [string, null] | None |
| query | state optional | State Example : | any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null] | None |
| query | name optional | VPC Peering Name Example : | any of [string, 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 = en-US",
"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": ""
}
]
}
9.1.67.4 - 1.0
get /v1/vpc-peerings/{vpc_peering_id}/routing-rules
Description
Get VPC Peering Rule list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering 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 |
| query | id optional | VPC Peering Rule ID Example : | any of [string, null] | None |
| query | source_vpc_id optional | Source VPC ID Example : | any of [string, null] | None |
| query | source_vpc_type optional | Source VPC Type Example : | enum (REQUESTER_VPC, APPROVER_VPC) | None |
| query | destination_vpc_id optional | Destination VPC ID Example : | any of [string, null] | None |
| query | destination_vpc_type optional | Destination VPC Type Example : | enum (REQUESTER_VPC, APPROVER_VPC) | None |
| query | destination_cidr optional | Destination CIDR Example : | any of [string, null] | None |
| query | state optional | State Example : | any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null] | None |
| query | name optional | VPC Peering Name Example : | any of [string, 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 = en-US",
"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": ""
}
]
}
9.1.68 - List VPCs
9.1.68.1 - 1.3
get /v1/vpcs
Description
Get VPC list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | state optional | State Example : | enum (CREATING, ACTIVE, DELETED, ERROR) | None |
| query | cidr optional | VPC Cidr Example : 192.167.0.0/18 | any of [string, null] | None |
| query | zone optional | Zone Example : kr-west1-a | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VpcListResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"vpcs": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr_count": 20,
"cidrs": [
{
"cidr": "192.167.0.0/18",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "7df8abb4912e4709b1cb237daccca7a8",
"id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"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",
"zone_type": "PUBLIC",
"zones": [
"zone-a",
"zone-b",
"zone-c"
]
}
]
}
9.1.68.2 - 1.2
get /v1/vpcs
Description
Get VPC list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | state optional | State 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 | VpcListResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"vpcs": [
{
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr_count": 20,
"cidrs": [
{
"cidr": "192.167.0.0/18",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "7df8abb4912e4709b1cb237daccca7a8",
"id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"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"
}
]
}
9.1.68.3 - 1.1
get /v1/vpcs
Description
Get VPC list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 Name Example : vpcName | any of [string, null] | None |
| query | state optional | State 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 = en-US",
"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"
}
]
}
9.1.68.4 - 1.0
get /v1/vpcs
Description
Get VPC list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker 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 Name Example : vpcName | any of [string, null] | None |
| query | state optional | State 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 = en-US",
"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"
}
]
}
9.1.69 - Request PrivateLink Endpoint
9.1.69.1 - 1.3
put /v1/privatelink-endpoints/{privatelink_endpoint_id}/request
Description
Request PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"type": "CANCEL"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.69.2 - 1.2
put /v1/privatelink-endpoints/{privatelink_endpoint_id}/request
Description
Request PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"type": "CANCEL"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.69.3 - 1.1
put /v1/privatelink-endpoints/{privatelink_endpoint_id}/request
Description
Request PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"type": "CANCEL"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.70 - Set Internet Gateway
9.1.70.1 - 1.3
put /v1/internet-gateways/{internet_gateway_id}
Description
Set Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | string | None |
| body | body required | InternetGatewaySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InternetGatewaySetResponse |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Internet Gateway Description",
"loggable": ""
}
Example HTTP response
Response 200
{
"description": "Internet Gateway Description",
"loggable": ""
}
9.1.70.2 - 1.2
put /v1/internet-gateways/{internet_gateway_id}
Description
Set Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Internet Gateway Description",
"loggable": ""
}
Example HTTP response
Response 200
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.70.3 - 1.1
put /v1/internet-gateways/{internet_gateway_id}
Description
Set Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "Internet Gateway Description",
"loggable": ""
}
Example HTTP response
Response 200
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.70.4 - 1.0
put /v1/internet-gateways/{internet_gateway_id}
Description
Set Internet Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "Internet Gateway Description",
"loggable": ""
}
Example HTTP response
Response 200
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.71 - Set NAT Gateway
9.1.71.1 - 1.3
put /v1/nat-gateways/{nat_gateway_id}
Description
Set NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | string | None |
| body | body required | NatGatewaySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | NatGatewaySetResponse |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "VpcEndpoint Description"
}
Example HTTP response
Response 200
{
"description": "VpcEndpoint Description"
}
9.1.71.2 - 1.2
put /v1/nat-gateways/{nat_gateway_id}
Description
Set NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "VpcEndpoint Description"
}
Example HTTP response
Response 200
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.71.3 - 1.1
put /v1/nat-gateways/{nat_gateway_id}
Description
Set NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "VpcEndpoint Description"
}
Example HTTP response
Response 200
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.71.4 - 1.0
put /v1/nat-gateways/{nat_gateway_id}
Description
Set NAT Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "VpcEndpoint Description"
}
Example HTTP response
Response 200
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.72 - Set Port
9.1.72.1 - 1.3
put /v1/ports/{port_id}
Description
Set port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | string | None |
| body | body required | PortSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PortShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Port Description",
"security_groups": [
""
]
}
Example HTTP response
Response 200
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"virtual_ip_addresses": [
""
],
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.72.2 - 1.2
put /v1/ports/{port_id}
Description
Set port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | string | None |
| body | body required | PortSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PortShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Port Description",
"security_groups": [
""
]
}
Example HTTP response
Response 200
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"virtual_ip_addresses": [
""
],
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.72.3 - 1.1
put /v1/ports/{port_id}
Description
Set port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "Port Description",
"security_groups": [
""
]
}
Example HTTP response
Response 200
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.72.4 - 1.0
put /v1/ports/{port_id}
Description
Set port.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "Port Description",
"security_groups": [
""
]
}
Example HTTP response
Response 200
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.73 - Set Private NAT
9.1.73.1 - 1.3
put /v1/private-nats/{private_nat_id}
Description
Set Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | string | None |
| body | body required | PrivateNatSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateNatShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "PrivateNat Description"
}
Example HTTP response
Response 200
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
"service_resource_name": "PrivateNatName",
"service_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
}
9.1.73.2 - 1.2
put /v1/private-nats/{private_nat_id}
Description
Set Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | string | None |
| body | body required | PrivateNatSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateNatShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "PrivateNat Description"
}
Example HTTP response
Response 200
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
"service_resource_name": "PrivateNatName",
"service_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
}
9.1.73.3 - 1.1
put /v1/private-nats/{private_nat_id}
Description
Set Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "PrivateNat Description"
}
Example HTTP response
Response 200
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
"direct_connect_name": "DirectConnectName",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.73.4 - 1.0
put /v1/private-nats/{private_nat_id}
Description
Set Private NAT.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "PrivateNat Description"
}
Example HTTP response
Response 200
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
"direct_connect_name": "DirectConnectName",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.74 - Set PrivateLink Endpoint
9.1.74.1 - 1.3
put /v1/privatelink-endpoints/{privatelink_endpoint_id}
Description
Set PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "PrivateLink Endpoint Description"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.74.2 - 1.2
put /v1/privatelink-endpoints/{privatelink_endpoint_id}
Description
Set PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "PrivateLink Endpoint Description"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.74.3 - 1.1
put /v1/privatelink-endpoints/{privatelink_endpoint_id}
Description
Set PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "PrivateLink Endpoint Description"
}
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.75 - Set PrivateLink Service
9.1.75.1 - 1.3
put /v1/privatelink-services/{privatelink_service_id}
Description
Set PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "PrivateLink Service Description"
}
Example HTTP response
Response 200
{
"privatelink_service": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.75.2 - 1.2
put /v1/privatelink-services/{privatelink_service_id}
Description
Set PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "PrivateLink Service Description"
}
Example HTTP response
Response 200
{
"privatelink_service": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.75.3 - 1.1
put /v1/privatelink-services/{privatelink_service_id}
Description
Set PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "PrivateLink Service Description"
}
Example HTTP response
Response 200
{
"privatelink_service": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.76 - Set PublicIP
9.1.76.1 - 1.3
put /v1/publicips/{publicip_id}
Description
Set PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | string | None |
| body | body required | PublicipSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PublicipSetResponse |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Public IP Description"
}
Example HTTP response
Response 200
{
"description": "Public IP Description"
}
9.1.76.2 - 1.2
put /v1/publicips/{publicip_id}
Description
Set PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Public IP Description"
}
Example HTTP response
Response 200
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
}
9.1.76.3 - 1.1
put /v1/publicips/{publicip_id}
Description
Set PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "Public IP Description"
}
Example HTTP response
Response 200
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
}
9.1.76.4 - 1.0
put /v1/publicips/{publicip_id}
Description
Set PublicIP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "Public IP Description"
}
Example HTTP response
Response 200
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
}
9.1.77 - Set Subnet
9.1.77.1 - 1.3
put /v1/subnets/{subnet_id}
Description
Set subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet Id Example : 023c57b14f11483689338d085e061492 | string | None |
| body | body required | SubnetSetRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SubnetSetResponse |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Subnet Description",
"dhcp_ip_address": "192.167.1.2"
}
Example HTTP response
Response 200
{
"description": "Subnet Description",
"dhcp_ip_address": "192.167.1.2"
}
9.1.77.2 - 1.2
put /v1/subnets/{subnet_id}
Description
Set subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet Id Example : 023c57b14f11483689338d085e061492 | string | None |
| body | body required | SubnetSetRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SubnetShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Subnet Description",
"dhcp_ip_address": "192.167.1.2"
}
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",
"dhcp_ip_address": "",
"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"
}
}
9.1.77.3 - 1.1
put /v1/subnets/{subnet_id}
Description
Set subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"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"
}
}
9.1.77.4 - 1.0
put /v1/subnets/{subnet_id}
Description
Set subnet.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
9.1.78 - Set Subnet Vip
9.1.78.1 - 1.3
put /v1/subnets/{subnet_id}/vips/{vip_id}
Description
Set Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
| body | body required | VipSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VipShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips/{vip_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "Subnet VIP Description"
}
Example HTTP response
Response 200
{
"subnet_vip": {
"connected_ports": [
{
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "Virtual Server",
"id": "13e2a5a1acbe4713a9a2c70ce226e822",
"port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
"port_ip_address": "192.168.20.5",
"port_name": "Port name"
}
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Subnet VIP Description",
"id": "0466a9448d9a4411a86055939e451c8f",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"static_nat": {
"external_ip_address": "100.112.9.84",
"id": "0009e49548154745948e9722adefbf40",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE"
},
"subnet_id": "023c57b14f11483689338d085e061492",
"vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
"virtual_ip_address": "192.168.20.6"
}
}
9.1.78.2 - 1.2
put /v1/subnets/{subnet_id}/vips/{vip_id}
Description
Set Subnet Vip
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
| body | body required | VipSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VipShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips/{vip_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "Subnet VIP Description"
}
Example HTTP response
Response 200
{
"subnet_vip": {
"connected_ports": [
{
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "Virtual Server",
"id": "13e2a5a1acbe4713a9a2c70ce226e822",
"port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
"port_ip_address": "192.168.20.5",
"port_name": "Port name"
}
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Subnet VIP Description",
"id": "0466a9448d9a4411a86055939e451c8f",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"static_nat": {
"external_ip_address": "100.112.9.84",
"id": "0009e49548154745948e9722adefbf40",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE"
},
"subnet_id": "023c57b14f11483689338d085e061492",
"vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
"virtual_ip_address": "192.168.20.6"
}
}
9.1.79 - Set Transit Gateway
9.1.79.1 - 1.3
put /v1/transit-gateways/{transit_gateway_id}
Description
Set Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| body | body required | TransitGatewaySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TransitGatewaySetResponse |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "TransitGateway Description"
}
Example HTTP response
Response 200
{
"description": "TransitGateway Description"
}
9.1.79.2 - 1.2
put /v1/transit-gateways/{transit_gateway_id}
Description
Set Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
| body | body required | TransitGatewaySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TransitGatewayShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "TransitGateway Description"
}
Example HTTP response
Response 200
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_connection_state": "INACTIVE",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.79.3 - 1.1
put /v1/transit-gateways/{transit_gateway_id}
Description
Set Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "TransitGateway Description"
}
Example HTTP response
Response 200
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.79.4 - 1.0
put /v1/transit-gateways/{transit_gateway_id}
Description
Set Transit Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "TransitGateway Description"
}
Example HTTP response
Response 200
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.80 - Set VPC
9.1.80.1 - 1.3
put /v1/vpcs/{vpc_id}
Description
Set VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
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 | VpcSetResponse |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "vpcDescription"
}
Example HTTP response
Response 200
{
"description": "vpcDescription"
}
9.1.80.2 - 1.2
put /v1/vpcs/{vpc_id}
Description
Set VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
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 | VpcShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "vpcDescription"
}
Example HTTP response
Response 200
{
"vpc": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr_count": 20,
"cidrs": [
{
"cidr": "192.167.0.0/18",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "7df8abb4912e4709b1cb237daccca7a8",
"id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"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"
}
}
9.1.80.3 - 1.1
put /v1/vpcs/{vpc_id}
Description
Set VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"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"
}
}
9.1.80.4 - 1.0
put /v1/vpcs/{vpc_id}
Description
Set VPC.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
9.1.81 - Set VPC Endpoint
9.1.81.1 - 1.3
put /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Set VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "VpcEndpoint Description"
}
Example HTTP response
Response 200
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.81.2 - 1.2
put /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Set VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "VpcEndpoint Description"
}
Example HTTP response
Response 200
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.81.3 - 1.1
put /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Set VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "VpcEndpoint Description"
}
Example HTTP response
Response 200
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.81.4 - 1.0
put /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Set VPC Endpoint.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "VpcEndpoint Description"
}
Example HTTP response
Response 200
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.82 - Set VPC Peering
9.1.82.1 - 1.3
put /v1/vpc-peerings/{vpc_peering_id}
Description
Set VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Request body
{
"description": "vpcPeering Description"
}
Example HTTP response
Response 200
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.82.2 - 1.2
put /v1/vpc-peerings/{vpc_peering_id}
Description
Set VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Request body
{
"description": "vpcPeering Description"
}
Example HTTP response
Response 200
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.82.3 - 1.1
put /v1/vpc-peerings/{vpc_peering_id}
Description
Set VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Request body
{
"description": "vpcPeering Description"
}
Example HTTP response
Response 200
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.82.4 - 1.0
put /v1/vpc-peerings/{vpc_peering_id}
Description
Set VPC Peering.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Request body
{
"description": "vpcPeering Description"
}
Example HTTP response
Response 200
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.83 - Show Internet Gateway
9.1.83.1 - 1.3
get /v1/internet-gateways/{internet_gateway_id}
Description
Show Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InternetGatewayShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"multi_zone_enabled": true,
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.83.2 - 1.2
get /v1/internet-gateways/{internet_gateway_id}
Description
Show Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.83.3 - 1.1
get /v1/internet-gateways/{internet_gateway_id}
Description
Show Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.83.4 - 1.0
get /v1/internet-gateways/{internet_gateway_id}
Description
Show Internet Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | internet_gateway_id required | Internet Gateway ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 200
{
"internet_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Internet Gateway Description",
"firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
"id": "023c57b14f11483689338d085e061492",
"loggable": false,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "IGW_VPCname",
"state": "CREATING",
"type": "IGW",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.84 - Show NAT Gateway
9.1.84.1 - 1.3
get /v1/nat-gateways/{nat_gateway_id}
Description
Show NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | NatGatewayShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"multi_zone_enabled": "true",
"name": "NatGatewayName",
"nat_gateway_ips": [
{
"ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18"
}
],
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.84.2 - 1.2
get /v1/nat-gateways/{nat_gateway_id}
Description
Show NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.84.3 - 1.1
get /v1/nat-gateways/{nat_gateway_id}
Description
Show NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.84.4 - 1.0
get /v1/nat-gateways/{nat_gateway_id}
Description
Show NAT Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | nat_gateway_id required | NAT Gateway ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 200
{
"nat_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "NatGatewayName",
"nat_gateway_ip_address": "192.167.0.5",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE",
"subnet_cidr": "192.167.1.0/24",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.85 - Show Port
9.1.85.1 - 1.3
get /v1/ports/{port_id}
Description
Show port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PortShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"virtual_ip_addresses": [
""
],
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.85.2 - 1.2
get /v1/ports/{port_id}
Description
Show port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PortShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"virtual_ip_addresses": [
""
],
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.85.3 - 1.1
get /v1/ports/{port_id}
Description
Show port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.85.4 - 1.0
get /v1/ports/{port_id}
Description
Show port.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | port_id required | Port ID Example : 023c57b1-4f11-4836-8933-8d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 200
{
"port": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "",
"created_at": "2024-01-15T10:30:00.000Z",
"description": "Port Description",
"fixed_ip_address": "192.168.1.100",
"id": "023c57b1-4f11-4836-8933-8d085e061492",
"mac_address": "fa:16:3e:00:00:01",
"modified_at": "2024-01-15T10:30:00.000Z",
"name": "portName",
"security_groups": [
{
"id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
"name": "sgName"
}
],
"state": "",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "071bc63b767444c9afaab1c972d302d5",
"vpc_name": "vpcName"
}
}
9.1.86 - Show Private NAT
9.1.86.1 - 1.3
get /v1/private-nats/{private_nat_id}
Description
Show Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateNatShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
"service_resource_name": "PrivateNatName",
"service_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
}
9.1.86.2 - 1.2
get /v1/private-nats/{private_nat_id}
Description
Show Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PrivateNatShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
"service_resource_name": "PrivateNatName",
"service_type": "DIRECT_CONNECT",
"state": "ACTIVE"
}
}
9.1.86.3 - 1.1
get /v1/private-nats/{private_nat_id}
Description
Show Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
"direct_connect_name": "DirectConnectName",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.86.4 - 1.0
get /v1/private-nats/{private_nat_id}
Description
Show Private NAT.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | private_nat_id required | Private NAT ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 200
{
"private_nat": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr": "192.167.0.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateNat Description",
"direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
"direct_connect_name": "DirectConnectName",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "PrivateNatName",
"state": "ACTIVE",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.87 - Show PrivateLink Endpoint
9.1.87.1 - 1.3
get /v1/privatelink-endpoints/{privatelink_endpoint_id}
Description
Show PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.87.2 - 1.2
get /v1/privatelink-endpoints/{privatelink_endpoint_id}
Description
Show PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.87.3 - 1.1
get /v1/privatelink-endpoints/{privatelink_endpoint_id}
Description
Show PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_endpoint_id required | PrivateLink Endpoint ID Example : bba6d4de3ad64e41b3a1b6c88983ec02 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"privatelink_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Endpoint Description",
"endpoint_ip_address": "192.167.1.5",
"endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
"id": "bba6d4de3ad64e41b3a1b6c88983ec02",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "EndpointName",
"privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.88 - Show PrivateLink Service
9.1.88.1 - 1.3
get /v1/privatelink-services/{privatelink_service_id}
Description
Show PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"privatelink_service": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.88.2 - 1.2
get /v1/privatelink-services/{privatelink_service_id}
Description
Show PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"privatelink_service": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.88.3 - 1.1
get /v1/privatelink-services/{privatelink_service_id}
Description
Show PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | privatelink_service_id required | PrivateLink Service ID Example : e3df2e8e3b374fbb81d4e322b52ca50d | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"privatelink_service": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approval_type": "AUTO",
"connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
"connected_resource_ip_address": "192.167.0.10",
"connected_resource_name": "lbResourceName",
"connected_resource_type": "LB",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "PrivateLink Service Description",
"high_speed_transfer": false,
"id": "e3df2e8e3b374fbb81d4e322b52ca50d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServiceName",
"security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
"service_ip_address": "192.167.0.5",
"service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
"state": "CREATING",
"subnet_id": "023c57b14f11483689338d085e061492",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}
}
9.1.89 - Show PublicIP
9.1.89.1 - 1.3
get /v1/publicips/{publicip_id}
Description
Show PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PublicipShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW",
"zone": "kr-west1-a"
}
}
9.1.89.2 - 1.2
get /v1/publicips/{publicip_id}
Description
Show PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
}
9.1.89.3 - 1.1
get /v1/publicips/{publicip_id}
Description
Show PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
}
9.1.89.4 - 1.0
get /v1/publicips/{publicip_id}
Description
Show PublicIP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 200
{
"publicip": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
"attached_resource_name": "Attached NAT Gateway Name",
"attached_resource_type": "NAT_GW",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Public IP Description",
"id": "12f56e27070248a6a240a497e43fbe18",
"ip_address": "192.167.0.5",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ATTACHED",
"type": "IGW"
}
}
9.1.90 - Show Subnet
9.1.90.1 - 1.3
get /v1/subnets/{subnet_id}
Description
Show subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet Id Example : 023c57b14f11483689338d085e061492 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SubnetShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"subnet": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"allocation_pools": [],
"category": "PRIMARY",
"cidr": "192.167.1.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Subnet Description",
"dhcp_ip_address": "",
"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",
"primary_subnet_id": "023c57b14f11483689338d085e061492",
"secondary_subnet_ids": "[\"522e102f680448a8804d18d4838baa78\", \"aec40baf53c243c1bb8401a703a2c888\"]",
"state": "CREATING",
"type": "PUBLIC",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName",
"zones": "[\"kr-west1-a\", \"kr-west1-b\", \"kr-west1-c\"]"
}
}
9.1.90.2 - 1.2
get /v1/subnets/{subnet_id}
Description
Show subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet Id Example : 023c57b14f11483689338d085e061492 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SubnetShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
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",
"dhcp_ip_address": "",
"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"
}
}
9.1.90.3 - 1.1
get /v1/subnets/{subnet_id}
Description
Show subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"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"
}
}
9.1.90.4 - 1.0
get /v1/subnets/{subnet_id}
Description
Show subnet.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
9.1.91 - Show Subnet Vip
9.1.91.1 - 1.3
get /v1/subnets/{subnet_id}/vips/{vip_id}
Description
Show Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VipShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips/{vip_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"subnet_vip": {
"connected_ports": [
{
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "Virtual Server",
"id": "13e2a5a1acbe4713a9a2c70ce226e822",
"port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
"port_ip_address": "192.168.20.5",
"port_name": "Port name"
}
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Subnet VIP Description",
"id": "0466a9448d9a4411a86055939e451c8f",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"static_nat": {
"external_ip_address": "100.112.9.84",
"id": "0009e49548154745948e9722adefbf40",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE"
},
"subnet_id": "023c57b14f11483689338d085e061492",
"vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
"virtual_ip_address": "192.168.20.6"
}
}
9.1.91.2 - 1.2
get /v1/subnets/{subnet_id}/vips/{vip_id}
Description
Show Subnet Vip
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string | None |
| path | vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VipShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/subnets/{subnet_id}/vips/{vip_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"subnet_vip": {
"connected_ports": [
{
"attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
"attached_resource_type": "Virtual Server",
"id": "13e2a5a1acbe4713a9a2c70ce226e822",
"port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
"port_ip_address": "192.168.20.5",
"port_name": "Port name"
}
],
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Subnet VIP Description",
"id": "0466a9448d9a4411a86055939e451c8f",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"state": "ACTIVE",
"static_nat": {
"external_ip_address": "100.112.9.84",
"id": "0009e49548154745948e9722adefbf40",
"publicip_id": "12f56e27070248a6a240a497e43fbe18",
"state": "ACTIVE"
},
"subnet_id": "023c57b14f11483689338d085e061492",
"vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
"virtual_ip_address": "192.168.20.6"
}
}
9.1.92 - Show Transit Gateway
9.1.92.1 - 1.3
get /v1/transit-gateways/{transit_gateway_id}
Description
Show Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TransitGatewayShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_connection_state": "INACTIVE",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_active_zone": "kr-west1-a",
"uplink_enabled": "False",
"uplink_standby_zone": "kr-west1-b",
"uplink_zone_state": "ACTIVE"
}
}
9.1.92.2 - 1.2
get /v1/transit-gateways/{transit_gateway_id}
Description
Show Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TransitGatewayShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_connection_state": "INACTIVE",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.92.3 - 1.1
get /v1/transit-gateways/{transit_gateway_id}
Description
Show Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.92.4 - 1.0
get /v1/transit-gateways/{transit_gateway_id}
Description
Show Transit Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | transit_gateway_id required | Transit Gateway ID Example : fe860e0af0c04dcd8182b84f907f31f4 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 200
{
"transit_gateway": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"bandwidth": 1,
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "TransitGateway Description",
"firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
"id": "fe860e0af0c04dcd8182b84f907f31f4",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "TransitGatewayName",
"state": "ACTIVE",
"uplink_enabled": "False"
}
}
9.1.93 - Show VPC
9.1.93.1 - 1.3
get /v1/vpcs/{vpc_id}
Description
Show VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_id required | VPC Id Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VpcShowResponseV1Dot3 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"vpc": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr_count": 20,
"cidrs": [
{
"cidr": "192.167.0.0/18",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "7df8abb4912e4709b1cb237daccca7a8",
"id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"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",
"zone_type": "PUBLIC",
"zones": [
"zone-a",
"zone-b",
"zone-c"
]
}
}
9.1.93.2 - 1.2
get /v1/vpcs/{vpc_id}
Description
Show VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_id required | VPC Id Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VpcShowResponseV1Dot2 |
| 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"vpc": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"cidr_count": 20,
"cidrs": [
{
"cidr": "192.167.0.0/18",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "7df8abb4912e4709b1cb237daccca7a8",
"id": "7df8abb4912e4709b1cb237daccca7a8"
}
],
"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"
}
}
9.1.93.3 - 1.1
get /v1/vpcs/{vpc_id}
Description
Show VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
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 = en-US",
"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"
}
}
9.1.93.4 - 1.0
get /v1/vpcs/{vpc_id}
Description
Show VPC.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
9.1.94 - Show VPC Endpoint
9.1.94.1 - 1.3
get /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Show VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.94.2 - 1.2
get /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Show VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.94.3 - 1.1
get /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Show VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.94.4 - 1.0
get /v1/vpc-endpoints/{vpc_endpoint_id}
Description
Show VPC Endpoint.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_endpoint_id required | VPC Endpoint ID Example : 12f56e27070248a6a240a497e43fbe18 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 200
{
"vpc_endpoint": {
"account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "VpcEndpoint Description",
"endpoint_ip_address": "192.167.0.5",
"id": "12f56e27070248a6a240a497e43fbe18",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "VpcEndpointName",
"resource_info": "x.samsungsdscloud.com(Registry)",
"resource_key": "07c5364702384471b650147321b52173",
"resource_type": "FS",
"state": "ACTIVE",
"subnet_id": "023c57b14f11483689338d085e061492",
"subnet_name": "subnetName",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
}
9.1.95 - Show VPC Peering
9.1.95.1 - 1.3
get /v1/vpc-peerings/{vpc_peering_id}
Description
Show VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.3"
Example HTTP response
Response 200
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.95.2 - 1.2
get /v1/vpc-peerings/{vpc_peering_id}
Description
Show VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20270131 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.2"
Example HTTP response
Response 200
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.95.3 - 1.1
get /v1/vpc-peerings/{vpc_peering_id}
Description
Show VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.1.95.4 - 1.0
get /v1/vpc-peerings/{vpc_peering_id}
Description
Show VPC Peering.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | vpc_peering_id required | VPC Peering ID Example : 023c57b14f11483689338d085e061492 | 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 = en-US",
"Scp-Api-Version = vpc 1.0"
Example HTTP response
Response 200
{
"vpc_peering": {
"account_type": "SAME",
"approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"approver_vpc_name": "vpcName",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"description": "vpcPeering Description",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vpcPeeringName",
"requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
"requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"requester_vpc_name": "vpcName",
"state": "CREATING"
}
}
9.2 - Models
9.2.1 - ConnectedEndpointListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.2 - ConnectedPortInfo
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.3 - ConnectedPrivateLinkEndpoint
| Name | Description | Schema | Default |
|---|---|---|---|
| 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) |
9.2.4 - InternetGateway
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.5 - InternetGatewayCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.6 - InternetGatewayListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.7 - InternetGatewayListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.8 - InternetGatewayListResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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.2.9 - InternetGatewaySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : Internet Gateway Description | any of [string, null] | |
| loggable optional | NAT Loggable Example : | boolean |
9.2.10 - InternetGatewaySetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : Internet Gateway Description | any of [string, null] | |
| loggable optional | NAT Loggable Example : | boolean |
9.2.11 - InternetGatewayShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| internet_gateway required | InternetGateway |
9.2.12 - InternetGatewayShowResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| internet_gateway required | InternetGatewayV1Dot3 |
9.2.13 - InternetGatewayV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.14 - NatGateway
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.15 - NatGatewayCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | NAT Gateway Description Example : VpcEndpoint DescriptionMaximum 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] |
9.2.16 - NatGatewayCreateRequestV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | NAT Gateway Description Example : VpcEndpoint DescriptionMaximum 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] |
9.2.17 - NatGatewayIp
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_address required | NAT Gateway IP Address Example : 192.167.0.5 | string | |
| publicip_id required | PublicIP ID Example : 12f56e27070248a6a240a497e43fbe18 | string |
9.2.18 - NatGatewayListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.19 - NatGatewayListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.20 - NatGatewayListResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.21 - NatGatewaySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | NAT Gateway Description Example : VpcEndpoint DescriptionMaximum length : 50 | string |
9.2.22 - NatGatewaySetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | NAT Gateway Description Example : VpcEndpoint Description | any of [string, null] |
9.2.23 - NatGatewayShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| nat_gateway required | NatGateway |
9.2.24 - NatGatewayShowResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| nat_gateway required | NatGatewayV1Dot3 |
9.2.25 - NatGatewayV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.26 - Port
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 DescriptionMaximum 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 |
9.2.27 - PortCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : portNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| security_groups optional | Security Group List | array[string] | |
| subnet_id required | Subnet Id Example : | string | |
| tags optional | Tag List | array[Tag] |
9.2.28 - PortList
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 DescriptionMaximum 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 |
9.2.29 - PortListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.30 - PortSecurityGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.31 - PortSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : Port Description | any of [string, null] | |
| security_groups optional | Security Group List Example : | any of [array[string], null] |
9.2.32 - PortShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| port required | any of [Port, null] |
9.2.33 - PortShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| port required | any of [PortV1Dot2, null] |
9.2.34 - PortV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 DescriptionMaximum 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 |
9.2.35 - PrivateLinkEndpoint
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.36 - PrivateLinkEndpointApprovalRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | PrivateLink Endpoint Action Type Example : APPROVE | enum (APPROVE, REJECT) |
9.2.37 - PrivateLinkEndpointConnectionRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | PrivateLink Endpoint Action Type Example : DISCONNECT | enum (DISCONNECT, RECONNECT) |
9.2.38 - PrivateLinkEndpointCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : PrivateLink Endpoint DescriptionMaximum length : 50 | string | |
| endpoint_ip_address required | Endpoint IP Address Example : 192.167.1.5 | string | |
| name required | PrivateLink Endpoint Name Example : EndpointNamePattern : ^[a-zA-Z0-9]([a-zA-Z0-9-])*$Minimum length : 3Maximum 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] |
9.2.39 - PrivateLinkEndpointDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.40 - PrivateLinkEndpointListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.41 - PrivateLinkEndpointRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | PrivateLink Endpoint Action Type Example : CANCEL | enum (CANCEL, RE_REQUEST) |
9.2.42 - PrivateLinkEndpointSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : PrivateLink Endpoint DescriptionMaximum length : 50 | string |
9.2.43 - PrivateLinkEndpointShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| privatelink_endpoint required | PrivateLinkEndpointDetail |
9.2.44 - PrivateLinkEndpointSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| 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) |
9.2.45 - PrivateLinkEndpointSummaryShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| privatelink_endpoint required | PrivateLinkEndpointSummary |
9.2.46 - PrivateLinkService
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.47 - PrivateLinkServiceCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 DescriptionMaximum length : 50 | string | |
| high_speed_transfer optional | High Speed Data Transfer Use Example : False | boolean | |
| name required | PrivateLink Service Name Example : ServiceNamePattern : ^[a-zA-Z0-9]([a-zA-Z0-9-])*$Minimum length : 3Maximum 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] |
9.2.48 - PrivateLinkServiceDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.49 - PrivateLinkServiceListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.50 - PrivateLinkServiceSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : PrivateLink Service DescriptionMaximum length : 50 | string |
9.2.51 - PrivateLinkServiceShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| privatelink_service required | PrivateLinkServiceDetail |
9.2.52 - PrivateNat
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.53 - PrivateNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cidr required | Private NAT IP range Example : 192.167.0.0/24 | string | |
| description optional | Description Example : PrivateNat DescriptionMaximum length : 50 | string | |
| direct_connect_id required | Direct Connect ID Example : fe860e0af0c04dcd8182b84f907f31f4 | string | |
| name required | Private NAT Name Example : PrivateNatNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| tags optional | Tag List Example : [{'key': 'key', 'value': 'value'}] | array[Tag] |
9.2.54 - PrivateNatCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| cidr required | Private NAT IP range Example : 192.167.0.0/24 | string | |
| description optional | Description Example : PrivateNat DescriptionMaximum length : 50 | string | |
| name required | Private NAT Name Example : PrivateNatNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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] |
9.2.55 - PrivateNatIp
| Name | Description | Schema | Default |
|---|---|---|---|
| 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) |
9.2.56 - PrivateNatIpCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_address required | Private NAT IP Address Example : Minimum length : 7Maximum length : 15 | string |
9.2.57 - PrivateNatIpListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.58 - PrivateNatIpShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| private_nat_ip required | PrivateNatIp |
9.2.59 - PrivateNatListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.60 - PrivateNatListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.61 - PrivateNatSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : PrivateNat DescriptionMaximum length : 50 | string |
9.2.62 - PrivateNatShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| private_nat required | PrivateNat |
9.2.63 - PrivateNatShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| private_nat required | PrivateNatV1Dot2 |
9.2.64 - PrivateNatV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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) |
9.2.65 - Publicip
| Name | Description | Schema | Default |
|---|---|---|---|
| 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) |
9.2.66 - PublicipCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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) |
9.2.67 - PublicipCreateRequestV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.68 - PublicipListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.69 - PublicipListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.70 - PublicipListResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.71 - PublicipSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | PublicIP Description Example : Public IP DescriptionMaximum length : 50 | string |
9.2.72 - PublicipSetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | PublicIP Description Example : Public IP Description | any of [string, null] |
9.2.73 - PublicipShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| publicip required | Publicip |
9.2.74 - PublicipShowResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| publicip required | PublicipV1Dot3 |
9.2.75 - PublicipV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.76 - SapSecondarySubnet
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.77 - SapSecondarySubnetListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.78 - StaticNatSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.79 - Subnet
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : subnetNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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 |
9.2.80 - SubnetCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : subnetNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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 |
9.2.81 - SubnetCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : subnetNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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 |
9.2.82 - SubnetCreateRequestV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : subnetNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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 |
9.2.83 - SubnetDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : subnetNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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 |
9.2.84 - SubnetDetailV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : subnetNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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 |
9.2.85 - SubnetDetailV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : subnetNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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] |
9.2.86 - SubnetListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.87 - SubnetListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.88 - SubnetListResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.89 - SubnetSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Description Example : Subnet DescriptionMaximum length : 50 | string |
9.2.90 - SubnetSetRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.91 - SubnetSetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.92 - SubnetShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| subnet required | SubnetDetail |
9.2.93 - SubnetShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| subnet required | SubnetDetailV1Dot2 |
9.2.94 - SubnetShowResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| subnet required | SubnetDetailV1Dot3 |
9.2.95 - SubnetV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : subnetNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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] |
9.2.96 - SubnetVipDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.97 - SubnetVipSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.98 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |
9.2.99 - TransitGateway
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : TransitGatewayNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING) | |
| uplink_enabled optional | Uplink Enabled Example : False | boolean |
9.2.100 - TransitGatewayCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : TransitGateway Description | any of [string, null] | |
| name required | Transit Gateway Name Example : TransitGatewayNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| tags optional | Tag List Example : [{'key': 'key', 'value': 'value'}] | array[Tag] |
9.2.101 - TransitGatewayFirewallConnectionCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| firewall_connection_state optional | Firewall Connection State Example : INACTIVE | any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null] |
9.2.102 - TransitGatewayFirewallCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| product_type required | Fw Product Type Example : TGW_DGW | enum (TGW_IGW, TGW_GGW, TGW_DGW, TGW_BM) |
9.2.103 - TransitGatewayFirewallCreateRequestV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.104 - TransitGatewayFirewallCreateResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.105 - TransitGatewayFirewallDeleteResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.106 - TransitGatewayListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.107 - TransitGatewayListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.108 - TransitGatewayRule
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.109 - TransitGatewayRuleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : Routing Rule DescriptionMaximum 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 |
9.2.110 - TransitGatewayRuleListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.111 - TransitGatewayRuleListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.112 - TransitGatewayRuleShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| transit_gateway_rule required | TransitGatewayVpcRule |
9.2.113 - TransitGatewayRuleV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.114 - TransitGatewaySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : TransitGateway DescriptionMaximum length : 50 | string |
9.2.115 - TransitGatewaySetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : TransitGateway Description | any of [string, null] |
9.2.116 - TransitGatewayShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| transit_gateway required | TransitGateway |
9.2.117 - TransitGatewayShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| transit_gateway required | TransitGatewayV1Dot2 |
9.2.118 - TransitGatewayShowResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| transit_gateway required | TransitGatewayV1Dot3 |
9.2.119 - TransitGatewayUplinkRule
| Name | Description | Schema | Default |
|---|---|---|---|
| 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) |
9.2.120 - TransitGatewayUplinkRuleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : Routing Rule DescriptionMaximum 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) |
9.2.121 - TransitGatewayUplinkRuleCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| transit_gateway_rule required | TransitGatewayUplinkRule |
9.2.122 - TransitGatewayV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : TransitGatewayNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING) | |
| uplink_enabled optional | Uplink Enabled Example : False | boolean |
9.2.123 - TransitGatewayV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : TransitGatewayNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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] |
9.2.124 - TransitGatewayVpcConnection
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.125 - TransitGatewayVpcConnectionCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| vpc_id required | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | string |
9.2.126 - TransitGatewayVpcConnectionListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.127 - TransitGatewayVpcConnectionShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| transit_gateway_vpc_connection required | TransitGatewayVpcConnection |
9.2.128 - TransitGatewayVpcRule
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.129 - VipCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.130 - VipCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| subnet_vip required | SubnetVipDetail |
9.2.131 - VipListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.132 - VipNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| nat_type required | NAT Type Example : PUBLIC | string | |
| publicip_id required | Publicip ID Example : 12f56e27070248a6a240a497e43fbe18 | string |
9.2.133 - VipNatCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Static Nat Id Example : 0009e49548154745948e9722adefbf40 | string | |
| publicip_id required | Publicip ID Example : 12f56e27070248a6a240a497e43fbe18 | string | |
| state required | Static Nat State Example : ACTIVE | string |
9.2.134 - VipPortRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| port_id required | Port ID Example : 35268a9f2eda4cde83b1d85c1f61f67d | string |
9.2.135 - VipPortResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Connected Port Id Example : 35268a9f2eda4cde83b1d85c1f61f67d | string | |
| subnet_vip_id required | Subnet Vip Id Example : 0466a9448d9a4411a86055939e451c8f | string |
9.2.136 - VipSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Description Example : Subnet VIP DescriptionMaximum length : 50 | string |
9.2.137 - VipShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| subnet_vip required | SubnetVipDetail |
9.2.138 - Vpc
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : vpcNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| state required | State Example : CREATING | enum (CREATING, ACTIVE, DELETED, ERROR) |
9.2.139 - VpcCidr
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.140 - VpcCidrCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cidr required | VPC Cidr Example : 192.167.0.0/18 | string |
9.2.141 - VpcCidrCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cidr optional | VPC Cidr Example : 192.167.0.0/18 | any of [string, null] |
9.2.142 - VpcCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : vpcNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| tags optional | Tag List | array[Tag] |
9.2.143 - VpcEndpoint
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.144 - VpcEndpointConnectableResourceDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| 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) |
9.2.145 - VpcEndpointConnectableResourceListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.146 - VpcEndpointConnectableResourceListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.147 - VpcEndpointCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : VpcEndpoint DescriptionMaximum length : 50 | string | |
| endpoint_ip_address required | VPC Endpoint IP Address Example : 192.167.0.5 | string | |
| name required | VPC Endpoint Name Example : VpcEndpointNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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 |
9.2.148 - VpcEndpointListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.149 - VpcEndpointListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.150 - VpcEndpointSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : VpcEndpoint DescriptionMaximum length : 50 | string |
9.2.151 - VpcEndpointShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| vpc_endpoint required | VpcEndpoint |
9.2.152 - VpcListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.153 - VpcListResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.154 - VpcListResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.155 - VpcPeering
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : vpcPeeringNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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) |
9.2.156 - VpcPeeringApprovalRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | Approval Type Example : CREATE_APPROVE | enum (CREATE_APPROVE, CREATE_CANCEL, CREATE_REJECT, CREATE_RE_REQUEST, DELETE_APPROVE, DELETE_CANCEL, DELETE_REJECT) |
9.2.157 - VpcPeeringCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : vpcPeeringNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| requester_vpc_id required | Requester VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| tags optional | Tag List | array[Tag] |
9.2.158 - VpcPeeringListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.159 - VpcPeeringRule
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
9.2.160 - VpcPeeringRuleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.161 - VpcPeeringRuleListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
9.2.162 - VpcPeeringRuleShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| vpc_peering_rule required | VpcPeeringRule |
9.2.163 - VpcPeeringSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : vpcPeering DescriptionMaximum length : 50 | string |
9.2.164 - VpcPeeringShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| vpc_peering required | VpcPeering |
9.2.165 - VpcSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : vpcDescription | any of [string, null] |
9.2.166 - VpcSetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : vpcDescription | any of [string, null] |
9.2.167 - VpcShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| vpc required | Vpc |
9.2.168 - VpcShowResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| vpc required | VpcV1Dot2 |
9.2.169 - VpcShowResponseV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| vpc required | VpcV1Dot3 |
9.2.170 - VpcV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : vpcNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum length : 20 | string | |
| state required | State Example : CREATING | enum (CREATING, ACTIVE, DELETED, ERROR) |
9.2.171 - VpcV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : vpcNamePattern : ^[a-zA-Z0-9-]*$Minimum length : 3Maximum 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] |
10 - VPN
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of VPN service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20251231 |
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 |
API Version History
1.1
VPN API has been released.
Changes
- [New]
GET /v1/vpn-gateways- API has been added. - [New]
POST /v1/vpn-gateways- API has been added. - [New]
GET /v1/vpn-gateways/{vpn_gateway_id}- API has been added. - [New]
PUT /v1/vpn-gateways/{vpn_gateway_id}- API has been added. - [New]
DELETE /v1/vpn-gateways/{vpn_gateway_id}- API has been added. - [New]
GET /v1/vpn-tunnels- API has been added. - [New]
POST /v1/vpn-tunnels- API has been added. - [New]
GET /v1/vpn-tunnels/{vpn_tunnel_id}- API has been added. - [New]
PUT /v1/vpn-tunnels/{vpn_tunnel_id}- API has been added. - [New]
DELETE /v1/vpn-tunnels/{vpn_tunnel_id}- API has been added.
10.1 - APIs
10.1.1 - Create VPN Gateway
10.1.1.1 - 1.1
post /v1/vpn-gateways
Description
Create VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.1.2 - 1.0
post /v1/vpn-gateways
Description
Create VPN gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.2 - Create VPN Tunnel
10.1.2.1 - 1.1
post /v1/vpn-tunnels
Description
Create VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.2.2 - 1.0
post /v1/vpn-tunnels
Description
Create VPN tunnel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.3 - Delete VPN Gateway
10.1.3.1 - 1.1
delete /v1/vpn-gateways/{vpn_gateway_id}
Description
Delete VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpn 1.1"
Example HTTP response
Response 202
10.1.3.2 - 1.0
delete /v1/vpn-gateways/{vpn_gateway_id}
Description
Delete VPN gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpn 1.0"
Example HTTP response
Response 202
10.1.4 - Delete VPN Tunnel
10.1.4.1 - 1.1
delete /v1/vpn-tunnels/{vpn_tunnel_id}
Description
Delete VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpn 1.1"
Example HTTP response
Response 202
10.1.4.2 - 1.0
delete /v1/vpn-tunnels/{vpn_tunnel_id}
Description
Delete VPN tunnel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"Scp-Api-Version = vpn 1.0"
Example HTTP response
Response 202
10.1.5 - List VPN Gateways
10.1.5.1 - 1.1
get /v1/vpn-gateways
Description
Get VPN gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 Address Example : 123.0.0.1 | string | None |
| query | vpc_id optional | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | string | None |
| query | vpc_name optional | VPC Name 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 = en-US",
"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"
}
]
}
10.1.5.2 - 1.0
get /v1/vpn-gateways
Description
Get VPN gateway list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 Address Example : 123.0.0.1 | string | None |
| query | vpc_id optional | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | string | None |
| query | vpc_name optional | VPC Name 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 = en-US",
"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"
}
]
}
10.1.6 - List VPN Tunnels
10.1.6.1 - 1.1
get /v1/vpn-tunnels
Description
Get VPN tunnel list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 Name 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 = en-US",
"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"
}
]
}
10.1.6.2 - 1.0
get /v1/vpn-tunnels
Description
Get VPN tunnel list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 Name 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 Address 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 = en-US",
"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"
}
]
}
10.1.7 - Set VPN Gateway
10.1.7.1 - 1.1
put /v1/vpn-gateways/{vpn_gateway_id}
Description
Set VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.7.2 - 1.0
put /v1/vpn-gateways/{vpn_gateway_id}
Description
Set VPN gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.8 - Set VPN Tunnel
10.1.8.1 - 1.1
put /v1/vpn-tunnels/{vpn_tunnel_id}
Description
Set VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.8.2 - 1.0
put /v1/vpn-tunnels/{vpn_tunnel_id}
Description
Set VPN tunnel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.9 - Show VPN Gateway
10.1.9.1 - 1.1
get /v1/vpn-gateways/{vpn_gateway_id}
Description
Show VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.9.2 - 1.0
get /v1/vpn-gateways/{vpn_gateway_id}
Description
Show VPN gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.10 - Show VPN Tunnel
10.1.10.1 - 1.1
get /v1/vpn-tunnels/{vpn_tunnel_id}
Description
Show VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.1.10.2 - 1.0
get /v1/vpn-tunnels/{vpn_tunnel_id}
Description
Show VPN tunnel.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 = en-US",
"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"
}
}
10.2 - Models
10.2.1 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |
10.2.2 - VpnGateway
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | 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 : Example Description for VPN Gateway | any of [string, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| ip_address required | VPN Gateway IP Address Example : 123.0.0.1 | string | |
| ip_id required | VPN Gateway IP ID Example : fcde872f75c145a0893d656cc698f13e | string | |
| ip_type required | VPN Gateway IP Type Example : PUBLIC | 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 | VPN Gateway Name Example : ExampleVpnGW1 | string | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
| vpc_id required | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | string | |
| vpc_name required | VPC Name Example : ExampleVPC1 | string |
10.2.3 - VpnGatewayCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : Example Description for VPN Gateway | any of [string, null] | |
| ip_address required | VPN Gateway IP Address Example : 123.0.0.1 | string | |
| ip_id required | VPN Gateway IP ID Example : fcde872f75c145a0893d656cc698f13e | string | |
| ip_type required | VPN Gateway IP Type Example : PUBLIC | string | |
| name required | VPN Gateway Name Example : ExampleVpnGW1 | string | |
| tags optional | Tag List | array[Tag] | |
| vpc_id required | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | string |
10.2.4 - VpnGatewayListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
10.2.5 - VpnGatewaySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : Example Description for VPN Gateway | string |
10.2.6 - VpnGatewayShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| vpn_gateway required | VpnGateway |
10.2.7 - VpnPhase1
| Name | Description | Schema | Default |
|---|---|---|---|
| dpd_retry_interval required | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) Example : 60 | integer | |
| ike_version required | VPN Tunnel IKE Version Example : 2 | integer | |
| life_time required | VPN Tunnel ISAKMP Lifetime (sec) Example : 86400 | integer | |
| peer_gateway_ip required | VPN Tunnel Peer Gateway IP Address Example : 123.0.0.2 | string |
10.2.8 - VpnPhase1CreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| dpd_retry_interval required | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) Example : 60 | integer | |
| ike_version required | VPN Tunnel IKE Version Example : 2 | integer | |
| peer_gateway_ip required | VPN Tunnel Peer Gateway IP Address Example : 123.0.0.2 | string | |
| phase1_diffie_hellman_groups required | VPN Tunnel ISAKMP Diffie-Hellman Group List Example : [30, 31, 32] | array[integer] | |
| phase1_encryptions required | VPN Tunnel ISAKMP Proposal List Example : ['des-md5', 'chacha20poly1305-prfsha256'] | array[string] | |
| phase1_life_time required | VPN Tunnel ISAKMP Lifetime (sec) Example : 86400 | integer | |
| pre_shared_key required | VPN Tunnel ISAKMP Authentication : Pre-shared Key Example : PreSharedKey1 | string |
10.2.9 - VpnPhase1CreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dpd_retry_interval required | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) Example : 60 | integer | |
| ike_version required | VPN Tunnel IKE Version Example : 2 | integer | |
| peer_gateway_ip required | VPN Tunnel Peer Gateway IP Address Example : 123.0.0.2 | string | |
| phase1_diffie_hellman_groups required | VPN Tunnel ISAKMP Diffie-Hellman Group List Example : [30, 31, 32] | array[integer] | |
| phase1_encryptions required | VPN Tunnel ISAKMP Proposal List Example : ['des-md5', 'chacha20poly1305-prfsha256'] | array[string] | |
| phase1_life_time required | VPN Tunnel ISAKMP Lifetime (sec) Example : 86400 | integer | |
| pre_shared_key required | VPN Tunnel ISAKMP Authentication : Pre-shared Key Example : PreSharedKey1 | string |
10.2.10 - VpnPhase1Detail
| Name | Description | Schema | Default |
|---|---|---|---|
| diffie_hellman_groups required | VPN Tunnel ISAKMP Diffie-Hellman Group List Example : [30, 31, 32] | array[integer] | |
| dpd_retry_interval required | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) Example : 60 | integer | |
| encryptions required | VPN Tunnel ISAKMP Proposal List Example : ['des-md5', 'chacha20poly1305-prfsha256'] | array[string] | |
| ike_version required | VPN Tunnel IKE Version Example : 2 | integer | |
| life_time required | VPN Tunnel ISAKMP Lifetime (sec) Example : 86400 | integer | |
| peer_gateway_ip required | VPN Tunnel Peer Gateway IP Address Example : 123.0.0.2 | string |
10.2.11 - VpnPhase1DetailV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| diffie_hellman_groups required | VPN Tunnel ISAKMP Diffie-Hellman Group List Example : [30, 31, 32] | array[integer] | |
| dpd_retry_interval required | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) Example : 60 | integer | |
| encryptions required | VPN Tunnel ISAKMP Proposal List Example : ['des-md5', 'chacha20poly1305-prfsha256'] | array[string] | |
| ike_version required | VPN Tunnel IKE Version Example : 2 | integer | |
| life_time required | VPN Tunnel ISAKMP Lifetime (sec) Example : 86400 | integer | |
| peer_gateway_ip required | VPN Tunnel Peer Gateway IP Address Example : 123.0.0.2 | string |
10.2.12 - VpnPhase1SetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| dpd_retry_interval optional | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) Example : 60 | any of [integer, null] | |
| ike_version optional | VPN Tunnel IKE Version Example : 2 | any of [integer, null] | |
| peer_gateway_ip optional | VPN Tunnel Peer Gateway IP Address Example : 123.0.0.2 | any of [string, null] | |
| phase1_diffie_hellman_groups optional | VPN Tunnel ISAKMP Diffie-Hellman Group List Example : [30, 31, 32] | any of [array[integer], null] | |
| phase1_encryptions optional | VPN Tunnel ISAKMP Proposal List Example : ['des-md5', 'chacha20poly1305-prfsha256'] | any of [array[string], null] | |
| phase1_life_time optional | VPN Tunnel ISAKMP Lifetime (sec) Example : 86400 | any of [integer, null] | |
| pre_shared_key optional | VPN Tunnel ISAKMP Authentication : Pre-shared Key Example : PreSharedKey1 | any of [string, null] |
10.2.13 - VpnPhase1SetRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dpd_retry_interval optional | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) Example : 60 | any of [integer, null] | |
| ike_version optional | VPN Tunnel IKE Version Example : 2 | any of [integer, null] | |
| peer_gateway_ip optional | VPN Tunnel Peer Gateway IP Address Example : 123.0.0.2 | any of [string, null] | |
| phase1_diffie_hellman_groups optional | VPN Tunnel ISAKMP Diffie-Hellman Group List Example : [30, 31, 32] | any of [array[integer], null] | |
| phase1_encryptions optional | VPN Tunnel ISAKMP Proposal List Example : ['des-md5', 'chacha20poly1305-prfsha256'] | any of [array[string], null] | |
| phase1_life_time optional | VPN Tunnel ISAKMP Lifetime (sec) Example : 86400 | any of [integer, null] | |
| pre_shared_key optional | VPN Tunnel ISAKMP Authentication : Pre-shared Key Example : PreSharedKey1 | any of [string, null] |
10.2.14 - VpnPhase1V1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dpd_retry_interval required | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) Example : 60 | integer | |
| ike_version required | VPN Tunnel IKE Version Example : 2 | integer | |
| life_time required | VPN Tunnel ISAKMP Lifetime (sec) Example : 86400 | integer | |
| peer_gateway_ip required | VPN Tunnel Peer Gateway IP Address Example : 123.0.0.2 | string |
10.2.15 - VpnPhase2
| Name | Description | Schema | Default |
|---|---|---|---|
| life_time required | VPN Tunnel IPSec Lifetime (sec) 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 |
10.2.16 - VpnPhase2CreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 List Example : [30, 31, 32] | array[integer] | |
| phase2_encryptions required | VPN Tunnel ISAKMP Proposal List Example : ['null-md5', 'aes128gcm', 'chacha20poly1305'] | array[string] | |
| phase2_life_time required | VPN Tunnel IPSec Lifetime (sec) Example : 43200 | integer | |
| remote_subnet required | VPN Tunnel IPSec Remote Subnet Example : 10.1.0.0/16 | string |
10.2.17 - VpnPhase2CreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 List Example : [30, 31, 32] | array[integer] | |
| phase2_encryptions required | VPN Tunnel ISAKMP Proposal List Example : ['null-md5', 'aes128gcm', 'chacha20poly1305'] | array[string] | |
| phase2_life_time required | VPN Tunnel IPSec Lifetime (sec) 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] |
10.2.18 - VpnPhase2Detail
| Name | Description | Schema | Default |
|---|---|---|---|
| diffie_hellman_groups optional | VPN Tunnel IPSec Diffie-Hellman Group List Example : [30, 31, 32] | any of [array[integer], null] | |
| encryptions required | VPN Tunnel IPSec Proposal List Example : ['null-md5', 'aes128gcm', 'chacha20poly1305'] | array[string] | |
| life_time required | VPN Tunnel IPSec Lifetime (sec) 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 |
10.2.19 - VpnPhase2DetailV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| diffie_hellman_groups optional | VPN Tunnel IPSec Diffie-Hellman Group List Example : [30, 31, 32] | any of [array[integer], null] | |
| encryptions required | VPN Tunnel IPSec Proposal List Example : ['null-md5', 'aes128gcm', 'chacha20poly1305'] | array[string] | |
| life_time required | VPN Tunnel IPSec Lifetime (sec) 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] |
10.2.20 - VpnPhase2SetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 List Example : [30, 31, 32] | any of [array[integer], null] | |
| phase2_encryptions optional | VPN Tunnel ISAKMP Proposal List Example : ['null-md5', 'aes128gcm', 'chacha20poly1305'] | any of [array[string], null] | |
| phase2_life_time optional | VPN Tunnel IPSec Lifetime (sec) Example : 43200 | any of [integer, null] | |
| remote_subnet optional | VPN Tunnel IPSec Remote Subnet Example : 10.1.0.0/16 | any of [string, null] |
10.2.21 - VpnPhase2SetRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 List Example : [30, 31, 32] | any of [array[integer], null] | |
| phase2_encryptions optional | VPN Tunnel ISAKMP Proposal List Example : ['null-md5', 'aes128gcm', 'chacha20poly1305'] | any of [array[string], null] | |
| phase2_life_time optional | VPN Tunnel IPSec Lifetime (sec) 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] |
10.2.22 - VpnPhase2V1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| life_time required | VPN Tunnel IPSec Lifetime (sec) 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] |
10.2.23 - VpnTunnel
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | 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 : Example Description for VPN Tunnel | any of [string, null] | |
| 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 | |
| name required | VPN Tunnel Name Example : ExampleVpnTunnel1 | string | |
| phase1 required | VPN Tunnel Phase1 | VpnPhase1 | |
| phase2 required | VPN Tunnel Phase2 | VpnPhase2 | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
| vpc_id required | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | string | |
| vpc_name required | VPC Name Example : ExampleVPC1 | string | |
| vpn_gateway_id required | VPN Gateway ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| vpn_gateway_ip_address required | VPN Gateway IP Address Example : 123.0.0.1 | string | |
| vpn_gateway_name required | VPN Gateway Name Example : ExampleVpnGW1 | string |
10.2.24 - VpnTunnelCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : Example Description for VPN Tunnel | any of [string, null] | |
| name required | VPN Tunnel Name Example : ExampleVpnTunnel1 | string | |
| phase1 required | VPN Tunnel Phase1 | VpnPhase1CreateRequest | |
| phase2 required | VPN Tunnel Phase2 | VpnPhase2CreateRequest | |
| tags optional | Tag List | array[Tag] | |
| vpn_gateway_id required | VPN Gateway ID Example : b156740b6335468d8354eb9ef8eddf5a | string |
10.2.25 - VpnTunnelCreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : Example Description for VPN Tunnel | any of [string, null] | |
| name required | VPN Tunnel Name Example : ExampleVpnTunnel1 | string | |
| phase1 required | VPN Tunnel Phase1 | VpnPhase1CreateRequestV1Dot1 | |
| phase2 required | VPN Tunnel Phase2 | VpnPhase2CreateRequestV1Dot1 | |
| tags optional | Tag List | array[Tag] | |
| vpn_gateway_id required | VPN Gateway ID Example : b156740b6335468d8354eb9ef8eddf5a | string |
10.2.26 - VpnTunnelDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | 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 : Example Description for VPN Tunnel | any of [string, null] | |
| 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 | |
| name required | VPN Tunnel Name Example : ExampleVpnTunnel1 | string | |
| phase1 required | VPN Tunnel Phase1 | VpnPhase1Detail | |
| phase2 required | VPN Tunnel Phase2 | VpnPhase2Detail | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
| vpc_id required | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | string | |
| vpc_name required | VPC Name Example : ExampleVPC1 | string | |
| vpn_gateway_id required | VPN Gateway ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| vpn_gateway_ip_address required | VPN Gateway IP Address Example : 123.0.0.1 | string | |
| vpn_gateway_name required | VPN Gateway Name Example : ExampleVpnGW1 | string |
10.2.27 - VpnTunnelDetailV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | 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 : Example Description for VPN Tunnel | any of [string, null] | |
| 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 | |
| name required | VPN Tunnel Name Example : ExampleVpnTunnel1 | string | |
| phase1 required | VPN Tunnel Phase1 | VpnPhase1DetailV1Dot1 | |
| phase2 required | VPN Tunnel Phase2 | VpnPhase2DetailV1Dot1 | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
| vpc_id required | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | string | |
| vpc_name required | VPC Name Example : ExampleVPC1 | string | |
| vpn_gateway_id required | VPN Gateway ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| vpn_gateway_ip_address required | VPN Gateway IP Address Example : 123.0.0.1 | string | |
| vpn_gateway_name required | VPN Gateway Name Example : ExampleVpnGW1 | string |
10.2.28 - VpnTunnelDetailWithStatus
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | 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 : Example Description for VPN Tunnel | any of [string, null] | |
| 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 | |
| name required | VPN Tunnel Name Example : ExampleVpnTunnel1 | string | |
| phase1 required | VPN Tunnel Phase1 | VpnPhase1Detail | |
| phase2 required | VPN Tunnel Phase2 | VpnPhase2Detail | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
| status required | VPN Tunnel Status Example : UP | enum (UP, DOWN) | |
| vpc_id required | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | string | |
| vpc_name required | VPC Name Example : ExampleVPC1 | string | |
| vpn_gateway_id required | VPN Gateway ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| vpn_gateway_ip_address required | VPN Gateway IP Address Example : 123.0.0.1 | string | |
| vpn_gateway_name required | VPN Gateway Name Example : ExampleVpnGW1 | string |
10.2.29 - VpnTunnelDetailWithStatusV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | 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 : Example Description for VPN Tunnel | any of [string, null] | |
| 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 | |
| name required | VPN Tunnel Name Example : ExampleVpnTunnel1 | string | |
| phase1 required | VPN Tunnel Phase1 | VpnPhase1DetailV1Dot1 | |
| phase2 required | VPN Tunnel Phase2 | VpnPhase2DetailV1Dot1 | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
| status required | VPN Tunnel Status Example : UP | enum (UP, DOWN) | |
| vpc_id required | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | string | |
| vpc_name required | VPC Name Example : ExampleVPC1 | string | |
| vpn_gateway_id required | VPN Gateway ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| vpn_gateway_ip_address required | VPN Gateway IP Address Example : 123.0.0.1 | string | |
| vpn_gateway_name required | VPN Gateway Name Example : ExampleVpnGW1 | string |
10.2.30 - VpnTunnelListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
10.2.31 - VpnTunnelListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
10.2.32 - VpnTunnelSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description 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] |
10.2.33 - VpnTunnelSetRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description 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] |
10.2.34 - VpnTunnelShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| vpn_tunnel required | VpnTunnelDetail |
10.2.35 - VpnTunnelShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| vpn_tunnel required | VpnTunnelDetailV1Dot1 |
10.2.36 - VpnTunnelShowWithStatusResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| vpn_tunnel required | VpnTunnelDetailWithStatus |
10.2.37 - VpnTunnelShowWithStatusResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| vpn_tunnel required | VpnTunnelDetailWithStatusV1Dot1 |
10.2.38 - VpnTunnelV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 0e3dffc50eb247a1adf4f2e5c82c4f99 | 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 : Example Description for VPN Tunnel | any of [string, null] | |
| 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 | |
| name required | VPN Tunnel Name Example : ExampleVpnTunnel1 | string | |
| phase1 required | VPN Tunnel Phase1 | VpnPhase1V1Dot1 | |
| phase2 required | VPN Tunnel Phase2 | VpnPhase2V1Dot1 | |
| state required | State Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
| vpc_id required | VPC Id Example : ceb44ea5ecb34a49b16495f9a63b0718 | string | |
| vpc_name required | VPC Name Example : ExampleVPC1 | string | |
| vpn_gateway_id required | VPN Gateway ID Example : b156740b6335468d8354eb9ef8eddf5a | string | |
| vpn_gateway_ip_address required | VPN Gateway IP Address Example : 123.0.0.1 | string | |
| vpn_gateway_name required | VPN Gateway Name Example : ExampleVpnGW1 | string |