This is the multi-page printable view of this section. Click here to print.
Networking
- 1: Direct Connect
- 1.1: CLIs
- 1.1.1: Create Direct Connect
- 1.1.2: Create Routing Rule
- 1.1.3: Delete Direct Connect
- 1.1.4: Delete Routing Rule
- 1.1.5: List Direct Connects
- 1.1.6: List Routing Rules
- 1.1.7: Set Direct Connect
- 1.1.8: Show Direct Connect
- 2: DNS
- 2.1: CLIs
- 2.1.1: Activate Private DNS
- 2.1.1.1: 1.3
- 2.1.2: Create Hosted Zone
- 2.1.2.1: 1.3
- 2.1.3: Create Hosted Zone Record
- 2.1.3.1: 1.3
- 2.1.4: Create Private DNS
- 2.1.4.1: 1.3
- 2.1.5: Create Public Domain Name
- 2.1.5.1: 1.3
- 2.1.6: Delete Hosted Zone
- 2.1.6.1: 1.3
- 2.1.7: Delete Hosted Zone Record
- 2.1.7.1: 1.3
- 2.1.8: Delete Private DNS
- 2.1.8.1: 1.3
- 2.1.9: List Hosted Zone Records
- 2.1.9.1: 1.3
- 2.1.10: List Hosted Zones
- 2.1.10.1: 1.3
- 2.1.11: List Private DNS
- 2.1.11.1: 1.3
- 2.1.12: List Public Domain Names
- 2.1.12.1: 1.3
- 2.1.13: Set Hosted Zone
- 2.1.13.1: 1.3
- 2.1.14: Set Hosted Zone Record
- 2.1.14.1: 1.3
- 2.1.15: Set Private DNS
- 2.1.15.1: 1.3
- 2.1.16: Set Public Domain Name
- 2.1.16.1: 1.3
- 2.1.17: Set Public Domain Name Whois Info
- 2.1.17.1: 1.3
- 2.1.18: Show Hosted Zone
- 2.1.18.1: 1.3
- 2.1.19: Show Hosted Zone Record
- 2.1.19.1: 1.3
- 2.1.20: Show Private DNS
- 2.1.20.1: 1.3
- 2.1.21: Show Public Domain Name
- 2.1.21.1: 1.3
- 2.1.22: Transfer Public Domain Name
- 2.1.22.1: 1.3
- 3: Firewall
- 3.1: CLIs
- 3.1.1: Create Firewall Rule
- 3.1.1.1: 1.0
- 3.1.2: Delete Firewall Rule
- 3.1.2.1: 1.0
- 3.1.3: List Firewall Rules
- 3.1.3.1: 1.0
- 3.1.4: List Firewalls
- 3.1.4.1: 1.0
- 3.1.5: Set Firewall
- 3.1.5.1: 1.0
- 3.1.6: Set Firewall Rule
- 3.1.6.1: 1.0
- 3.1.7: Show Firewall
- 3.1.7.1: 1.0
- 3.1.8: Show Firewall Rule
- 3.1.8.1: 1.0
- 4: Global CDN
- 4.1: CLIs
- 4.1.1: Create Cdn Service
- 4.1.1.1: 1.0
- 4.1.2: Delete Cdn Service
- 4.1.2.1: 1.0
- 4.1.3: Detail Cdn Service
- 4.1.3.1: 1.0
- 4.1.4: List Cdn Service
- 4.1.4.1: 1.0
- 4.1.5: Purge Cdn Service
- 4.1.5.1: 1.0
- 4.1.6: Start Cdn Service
- 4.1.6.1: 1.0
- 4.1.7: Stop Cdn Service
- 4.1.7.1: 1.0
- 4.1.8: Update Cdn Service
- 4.1.8.1: 1.0
- 4.1.9: Update Description of Cdn Service
- 4.1.9.1: 1.0
- 5: GSLB
- 5.1: CLIs
- 5.1.1: CreateGslb
- 5.1.2: DeleteGslb
- 5.1.3: ListGslbResources
- 5.1.4: ListGslbs
- 5.1.5: ListGslbsRegionalRoutingControl
- 5.1.5.1: 1.1
- 5.1.6: SetGslb
- 5.1.7: SetGslbHealthCheck
- 5.1.8: SetGslbRegionalRoutingControl
- 5.1.8.1: 1.1
- 5.1.9: SetGslbResources
- 5.1.10: ShowGslb
- 6: Load Balancer
- 6.1: CLIs
- 6.1.1: AddLbServerGroupMembers
- 6.1.2: CreateLBHealthCheck
- 6.1.3: CreateLbListener
- 6.1.4: CreateLBServerGroup
- 6.1.5: CreateLoadbalancer
- 6.1.6: CreateLoadbalancerPrivateNatIp
- 6.1.6.1: 1.3
- 6.1.7: CreateLoadbalancerPublicNatIp
- 6.1.8: DeleteLBHealthCheck
- 6.1.9: DeleteLbListener
- 6.1.10: DeleteLBServerGroup
- 6.1.11: DeleteLoadbalancer
- 6.1.12: DeleteLoadbalancerPrivateNatIp
- 6.1.12.1: 1.3
- 6.1.13: DeleteLoadbalancerPublicNatIp
- 6.1.14: ListLBHealthChecks
- 6.1.15: ListLbListeners
- 6.1.16: ListLbServerGroupMembers
- 6.1.17: ListLBServerGroups
- 6.1.18: ListLoadbalancerCertificates
- 6.1.19: ListLoadbalancers
- 6.1.20: RemoveLbServerGroupMember
- 6.1.21: RemoveLbServerGroupMembers
- 6.1.22: SetLBHealthCheck
- 6.1.23: SetLbListener
- 6.1.24: SetLBServerGroup
- 6.1.25: SetLbServerGroupMember
- 6.1.26: SetLoadbalancer
- 6.1.27: ShowLBHealthCheck
- 6.1.28: ShowLbListener
- 6.1.29: ShowLBServerGroup
- 6.1.30: ShowLbServerGroupMember
- 6.1.31: ShowLoadbalancer
- 6.1.32: ShowLoadbalancerCertificate
- 6.1.33: ShowLoadbalancerPrivateNatIp
- 6.1.33.1: 1.3
- 6.1.34: ShowLoadbalancerPublicNatIp
- 7: Security Group
- 7.1: CLIs
- 7.1.1: Create Security Group
- 7.1.1.1: 1.0
- 7.1.2: Create Security Group Rule
- 7.1.2.1: 1.0
- 7.1.3: Delete Security Group
- 7.1.3.1: 1.0
- 7.1.4: Delete Security Group Rule
- 7.1.4.1: 1.0
- 7.1.5: List Security Group Rules
- 7.1.5.1: 1.0
- 7.1.6: List Security Groups
- 7.1.6.1: 1.0
- 7.1.7: Set Security Group
- 7.1.7.1: 1.0
- 7.1.8: Show Security Group
- 7.1.8.1: 1.0
- 7.1.9: Show Security Group Rule
- 7.1.9.1: 1.0
- 8: VPC
- 8.1: CLIs
- 8.1.1: Add VPC CIDR
- 8.1.1.1: 1.2
- 8.1.2: Approval VPC Peering
- 8.1.3: Approve PrivateLink Endpoint
- 8.1.4: Connect PrivateLink Endpoint
- 8.1.5: Connect Subnet VIP Port
- 8.1.5.1: 1.2
- 8.1.6: Create Internet Gateway
- 8.1.7: Create NAT Gateway
- 8.1.8: Create Port
- 8.1.9: Create Private NAT
- 8.1.10: Create Private NAT IP
- 8.1.11: Create PrivateLink Endpoint
- 8.1.12: Create PrivateLink Service
- 8.1.13: Create PublicIP
- 8.1.14: Create Subnet
- 8.1.15: Create Subnet VIP
- 8.1.15.1: 1.2
- 8.1.16: Create Subnet VIP NAT IP
- 8.1.16.1: 1.2
- 8.1.17: Create Transit Gateway
- 8.1.18: Create Transit Gateway Firewall
- 8.1.18.1: 1.2
- 8.1.19: Create Transit Gateway Firewall Connection
- 8.1.19.1: 1.2
- 8.1.20: Create Transit Gateway Rule
- 8.1.21: Create Transit Gateway Uplink Rule
- 8.1.22: Create Transit Gateway VPC Connection
- 8.1.23: Create VPC
- 8.1.24: Create VPC Endpoint
- 8.1.25: Create VPC Peering
- 8.1.26: Create Vpc Peering Rule
- 8.1.27: Delete Internet Gateway
- 8.1.28: Delete NAT Gateway
- 8.1.29: Delete Port
- 8.1.30: Delete Private NAT
- 8.1.31: Delete Private NAT IP
- 8.1.32: Delete PrivateLink Endpoint
- 8.1.33: Delete PrivateLink Service
- 8.1.34: Delete PublicIP
- 8.1.35: Delete Subnet
- 8.1.36: Delete Subnet Vip
- 8.1.36.1: 1.2
- 8.1.37: Delete Subnet Vip Connected Port
- 8.1.37.1: 1.2
- 8.1.38: Delete Subnet VIP NAT IP
- 8.1.38.1: 1.2
- 8.1.39: Delete Transit Gateway
- 8.1.40: Delete Transit Gateway Firewall
- 8.1.40.1: 1.2
- 8.1.41: Delete Transit Gateway Firewall Connection
- 8.1.41.1: 1.2
- 8.1.42: Delete Transit Gateway Rule
- 8.1.43: Delete Transit Gateway Uplink Rule
- 8.1.44: Delete Transit Gateway VPC Connection
- 8.1.45: Delete VPC
- 8.1.46: Delete VPC Endpoint
- 8.1.47: Delete VPC Peering
- 8.1.48: Delete VPC Peering Rule
- 8.1.49: List Connected PrivateLink Endpoints
- 8.1.50: List Internet Gateways
- 8.1.51: List NAT Gateways
- 8.1.52: List Ports
- 8.1.53: List Private NAT
- 8.1.54: List Private NAT IP
- 8.1.55: List PrivateLink Endpoint
- 8.1.56: List PrivateLink Service
- 8.1.57: List PublicIPs
- 8.1.58: List Subnet Vips
- 8.1.58.1: 1.2
- 8.1.59: List Subnets
- 8.1.60: List Transit Gateway Rules
- 8.1.61: List Transit Gateway VPC Connections
- 8.1.62: List Transit Gateways
- 8.1.63: List VPC Endpoint
- 8.1.64: List VPC Endpoint Connectable Resources
- 8.1.65: List VPC Peering
- 8.1.66: List VPC Peering Rules
- 8.1.67: List VPCs
- 8.1.68: Request PrivateLink Endpoint
- 8.1.69: Set Internet Gateway
- 8.1.70: Set NAT Gateway
- 8.1.71: Set Port
- 8.1.72: Set Private NAT
- 8.1.73: Set PrivateLink Endpoint
- 8.1.74: Set PrivateLink Service
- 8.1.75: Set PublicIP
- 8.1.76: Set Subnet
- 8.1.77: Set Subnet Vip
- 8.1.77.1: 1.2
- 8.1.78: Set Transit Gateway
- 8.1.79: Set VPC
- 8.1.80: Set VPC Endpoint
- 8.1.81: Set VPC Peering
- 8.1.82: Show Internet Gateway
- 8.1.83: Show NAT Gateway
- 8.1.84: Show Port
- 8.1.85: Show Private NAT
- 8.1.86: Show PrivateLink Endpoint
- 8.1.87: Show PrivateLink Service
- 8.1.88: Show PublicIP
- 8.1.89: Show Subnet
- 8.1.90: Show Subnet Vip
- 8.1.90.1: 1.2
- 8.1.91: Show Transit Gateway
- 8.1.92: Show VPC
- 8.1.93: Show VPC Endpoint
- 8.1.94: Show VPC Peering
- 9: VPN
- 9.1: CLIs
- 9.1.1: Create VPN Gateway
- 9.1.2: Create VPN Tunnel
- 9.1.3: Delete VPN Gateway
- 9.1.4: Delete VPN Tunnel
- 9.1.5: List VPN Gateways
- 9.1.6: List VPN Tunnels
- 9.1.7: Set VPN Gateway
- 9.1.8: Set VPN Tunnel
- 9.1.9: Show VPN Gateway
- 9.1.10: Show VPN Tunnel
1 - Direct Connect
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Direct Connect service and how to call CLI.
Version
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 | 20261130 |
1.1 - CLIs
1.1.1 - Create Direct Connect
1.1.1.1 - 1.1
scp-cli direct-connect direct-connect create
--vpc_id <value>
--name <value>
--bandwidth <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Create direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| name required | string | Direct Connect Name | DirectConnectName |
| bandwidth required | integer | Port Bandwidth | 1 |
| description optional | string | Direct Connect Description | TransitGateway Description |
| firewall_enabled optional | boolean | Firewall Use | True |
| firewall_loggable optional | boolean | Firewall Loggable | True |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
1.1.1.2 - 1.0
scp-cli direct-connect direct-connect create
--vpc_id <value>
--name <value>
--bandwidth <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Create direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| name required | string | Direct Connect Name | DirectConnectName |
| bandwidth required | integer | Port Bandwidth | 1 |
| description optional | string | Direct Connect Description | TransitGateway Description |
| firewall_enabled optional | boolean | Firewall Use | True |
| firewall_loggable optional | boolean | Firewall Loggable | True |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
1.1.2 - Create Routing Rule
1.1.2.1 - 1.1
scp-cli direct-connect routing-rule create
--direct_connect_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
[--destination_resource_id <value>]
Description
Create a routing rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| destination_type required | string | Destination Type | ON_PREMISE |
| destination_cidr required | string | Destination CIDR | 11.11.11.0/24 |
| description optional | string | Description | TransitGateway Description |
| destination_resource_id optional | string | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | TransitGateway Description |
| destination_cidr | Destination CIDR | 11.11.11.0/24 |
| destination_resource_id | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
| destination_resource_name | Destination Resource Name | ResourceName |
| destination_type | Destination Type | ON_PREMISE |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| owner_id | Routing Rule Owner ID | cd1610830b9046418e4bc67831c533e6 |
| owner_type | Routing Rule Owner Type | DIRECT_CONNECT |
| state | State | ACTIVE |
1.1.2.2 - 1.0
scp-cli direct-connect routing-rule create
--direct_connect_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
[--destination_resource_id <value>]
Description
Create a routing rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| destination_type required | string | Destination Type | ON_PREMISE |
| destination_cidr required | string | Destination CIDR | 11.11.11.0/24 |
| description optional | string | Description | TransitGateway Description |
| destination_resource_id optional | string | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | TransitGateway Description |
| destination_cidr | Destination CIDR | 11.11.11.0/24 |
| destination_resource_id | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
| destination_resource_name | Destination Resource Name | ResourceName |
| destination_type | Destination Type | ON_PREMISE |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| owner_id | Routing Rule Owner ID | cd1610830b9046418e4bc67831c533e6 |
| owner_type | Routing Rule Owner Type | DIRECT_CONNECT |
| state | State | ACTIVE |
1.1.3 - Delete Direct Connect
1.1.3.1 - 1.1
scp-cli direct-connect direct-connect delete
--direct_connect_id <value>
Description
Delete direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
1.1.3.2 - 1.0
scp-cli direct-connect direct-connect delete
--direct_connect_id <value>
Description
Delete direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
1.1.4 - Delete Routing Rule
1.1.4.1 - 1.1
scp-cli direct-connect routing-rule delete
--routing_rule_id <value>
--direct_connect_id <value>
Description
Delete a routing rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
1.1.4.2 - 1.0
scp-cli direct-connect routing-rule delete
--routing_rule_id <value>
--direct_connect_id <value>
Description
Delete a routing rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
1.1.5 - List Direct Connects
1.1.5.1 - 1.1
scp-cli direct-connect direct-connect list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get direct connect list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| name optional | string | Direct Connect Name | DirectConnectName |
| state optional | **** | State | ACTIVE |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
1.1.5.2 - 1.0
scp-cli direct-connect direct-connect list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get direct connect list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| name optional | string | Direct Connect Name | DirectConnectName |
| state optional | **** | State | ACTIVE |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
1.1.6 - List Routing Rules
1.1.6.1 - 1.1
scp-cli direct-connect routing-rule list
--direct_connect_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
Get routing rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| destination_type optional | **** | Destination Type | ON_PREMISE |
| destination_cidr optional | string | Destination CIDR | 11.11.11.0/24 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | TransitGateway Description |
| destination_cidr | Destination CIDR | 11.11.11.0/24 |
| destination_resource_id | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
| destination_resource_name | Destination Resource Name | ResourceName |
| destination_type | Destination Type | ON_PREMISE |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| owner_id | Routing Rule Owner ID | cd1610830b9046418e4bc67831c533e6 |
| owner_type | Routing Rule Owner Type | DIRECT_CONNECT |
| state | State | ACTIVE |
1.1.6.2 - 1.0
scp-cli direct-connect routing-rule list
--direct_connect_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
Get routing rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| destination_type optional | **** | Destination Type | ON_PREMISE |
| destination_cidr optional | string | Destination CIDR | 11.11.11.0/24 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | TransitGateway Description |
| destination_cidr | Destination CIDR | 11.11.11.0/24 |
| destination_resource_id | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
| destination_resource_name | Destination Resource Name | ResourceName |
| destination_type | Destination Type | ON_PREMISE |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| owner_id | Routing Rule Owner ID | cd1610830b9046418e4bc67831c533e6 |
| owner_type | Routing Rule Owner Type | DIRECT_CONNECT |
| state | State | ACTIVE |
1.1.7 - Set Direct Connect
1.1.7.1 - 1.1
scp-cli direct-connect direct-connect set
--direct_connect_id <value>
--description <value>
Description
Set direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| description required | string | Direct Connect Description | TransitGateway Description |
1.1.7.2 - 1.0
scp-cli direct-connect direct-connect set
--direct_connect_id <value>
--description <value>
Description
Set direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| description required | string | Direct Connect Description | TransitGateway Description |
1.1.8 - Show Direct Connect
1.1.8.1 - 1.1
scp-cli direct-connect direct-connect show
--direct_connect_id <value>
Description
Show direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
1.1.8.2 - 1.0
scp-cli direct-connect direct-connect show
--direct_connect_id <value>
Description
Show direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
2 - DNS
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of DNS service and how to call CLI. The output is formatted as a JSON string
Version
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 | - |
2.1 - CLIs
2.1.1 - Activate Private DNS
2.1.1.1 - 1.3
scp-cli dns private-dns activate
--name <value>
Description
Activate Private DNS
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Private DNS Name | private-dns01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private DNS ID | 10fjkewefprivatedns3193rud543 |
| auth_dns_name | Auth DNS Name | |
| connected_vpc_ids | Connected VPC ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | This is description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private DNS Name | private-dns01 |
| pool_id | Designate Pool ID | 10fjksdpooliddfsi12389esfdslkdsr32 |
| pool_name | Pool Name | |
| registered_region | Registered Region | KR-WEST1 |
| resolver_ip | Private DNS Resolver IP | 198.19.0.101 |
| resolver_name | Private DNS Resolver Name | |
| state | State |
2.1.2 - Create Hosted Zone
2.1.2.1 - 1.3
scp-cli dns hosted-zone create
--type <value>
--name <value>
[--description <value>]
[--private_dns_id <value>]
[--tags <value>]
Description
Create a new hosted zone.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type required | string | Type of zone | private |
| name required | string | name | my-zone.com |
| description optional | string | description | This is description |
| private_dns_id optional | string | Private DNS ID | 10fjkewefprivatedns3193rud543 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Hosted Zone ID | 3432012nfdksdf03ktrld9234lgfg |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | This is description |
| hosted_zone_type | Hosted Zone type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Hosted Zone Name | my-zone.com |
| pool_id | Designate Pool ID | 10fjksdpooliddfsi12389esfdslkdsr32 |
| private_dns_id | Private DNS ID | 10fjkewefprivatedns3193rud543 |
| private_dns_name | Private DNS Name | private-dns01 |
| status | State | |
| ttl | TTL for the zone. | 3600 |
2.1.3 - Create Hosted Zone Record
2.1.3.1 - 1.3
scp-cli dns hosted-zone-record create
--hosted_zone_id <value>
--type <value>
--records <value>
--name <value>
[--description <value>]
[--ttl <value>]
Description
Create a new recordset in the hosted zone
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | 3432012nfdksdf03ktrld9234lgfg |
| type required | string | Type of the record | A |
| records required | array | A list of data for this record | 12345.ns.private.kr-west1.dev2.samsungsdscloud.com |
| name required | string | name | test.app |
| description optional | string | description | This is description |
| ttl optional | integer | TTL for the zone. | 3600 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Record ID | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
| action | current action in progress | CREATE |
| created_at | Created Date | 2025-09-08T03:43:57Z |
| description | description | This is description |
| links | Links to resource | |
| name | name | test.app |
| project_id | ProjectID | 003dffc50eb123a1cbf4f2e5c71d4f15 |
| records | A list of data for this record | [‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’] |
| status | The status | ACTIVE |
| ttl | TTL for the zone. | 3600 |
| type | Type of the record | A |
| updated_at | Updated Date | 2026-02-09T08:00:40Z |
| version | Version | 1 |
| zone_id | ID for the zone that contains this record | 3432012nfdksdf03ktrld9234lgfg |
| zone_name | The name of the zone that contains this record | my-zone.com |
2.1.4 - Create Private DNS
2.1.4.1 - 1.3
scp-cli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]
Description
Create Private DNS
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Private DNS Name | private-dns01 |
| connected_vpc_ids optional | array | Connected VPC ID | - |
| description optional | string | description | This is description |
| tags optional | array | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private DNS ID | 10fjkewefprivatedns3193rud543 |
| auth_dns_name | Auth DNS Name | |
| connected_vpc_ids | Connected VPC ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | This is description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private DNS Name | private-dns01 |
| pool_id | Designate Pool ID | 10fjksdpooliddfsi12389esfdslkdsr32 |
| pool_name | Pool Name | |
| registered_region | Registered Region | KR-WEST1 |
| resolver_ip | Private DNS Resolver IP | 198.19.0.101 |
| resolver_name | Private DNS Resolver Name | |
| state | State |
2.1.5 - Create Public Domain Name
2.1.5.1 - 1.3
scp-cli dns public-domain-name create
--register_telno <value>
--register_name_ko <value>
--register_name_en <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--name <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>
[--auto_extension <value>]
[--description <value>]
[--tags <value>]
Description
Create a new Public Domain Name
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| register_telno required | string | Register telephone number | 010-1234-5678 |
| register_name_ko required | string | Register Name Domestic | 홍길동 |
| register_name_en required | string | Register Name Overseas | Hong Gildong |
| register_email required | string | Register email | admin@example.com |
| postal_code required | string | Postal code | 12345 |
| overseas_third_address required | string | Overseas address - State & Country | NY 10001 |
| overseas_second_address required | string | Overseas address - City | New York |
| overseas_first_address required | string | Overseas address - Address | 123 Main St |
| name required | string | Public Domain Name | example.com |
| domestic_second_address_ko required | string | Domestic second address (KO) | 서관 1층 |
| domestic_second_address_en required | string | Domestic second address (EN) | West Campus 1F |
| domestic_first_address_ko required | string | Domestic first address (KO) | 서울특별시 송파구 올림픽로35길 125 (신천동) |
| domestic_first_address_en required | string | Domestic first address (EN) | 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
| address_type required | string | Address type | DOMESTIC |
| auto_extension optional | boolean | Auto extension flag | - |
| description optional | string | description | This is description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 10fjkeweffpublicdomain3193rud543 |
| address_type | Address type | DOMESTIC |
| auto_extension | Auto extension flag | True |
| created_at | Created Date | 2025-09-08T03:43:57Z |
| created_by | Created By_ | 504f24f8111e42e0578f367acd2a149f |
| description | description | This is description |
| domestic_address_en | Domestic Address (EN) | West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
| domestic_address_ko | Domestic Address (KO) | 서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층 |
| domestic_first_address_en | Domestic first address (EN) | 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
| domestic_first_address_ko | Domestic first address (KO) | 서울특별시 송파구 올림픽로35길 125 (신천동) |
| domestic_second_address_en | Domestic second address (EN) | West Campus 1F |
| domestic_second_address_ko | Domestic second address (KO) | 서관 1층 |
| expired_date | Expired date | 2026-09-09T00:00:00Z |
| modified_at | Modified Date | 2026-02-09T08:00:40Z |
| modified_by | Modified By_ | 504f24f8111e42e0578f367acd2a149f |
| name | Public Domain Name | example.com |
| overseas_address | Overseas Address | 123 Main St, New York, NY 10001 |
| overseas_first_address | Overseas address - Address | 123 Main St |
| overseas_second_address | Overseas address - City | New York |
| overseas_third_address | Overseas address - State & Country | NY 10001 |
| postal_code | Postal code | 12345 |
| register_email | Register email | admin@example.com |
| register_name_en | Register Name Overseas | Hong Gildong |
| register_name_ko | Register Name Domestic | 홍길동 |
| register_telno | Register telephone number | 010-1234-5678 |
| start_date | Start date | 2025-09-09T00:00:00Z |
| status | The status | REGISTERED |
2.1.6 - Delete Hosted Zone
2.1.6.1 - 1.3
scp-cli dns hosted-zone delete
--hosted_zone_id <value>
Description
Delete a hosted zone
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | 3432012nfdksdf03ktrld9234lgfg |
2.1.7 - Delete Hosted Zone Record
2.1.7.1 - 1.3
scp-cli dns hosted-zone-record delete
--record_id <value>
--hosted_zone_id <value>
Description
Delete hosted zone record
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
| hosted_zone_id required | string | Hosted Zone ID | 3432012nfdksdf03ktrld9234lgfg |
2.1.8 - Delete Private DNS
2.1.8.1 - 1.3
scp-cli dns private-dns delete
--private_dns_id <value>
Description
Delete Private DNS
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_dns_id required | string | Private DNS ID | 10fjkewefprivatedns3193rud543 |
2.1.9 - List Hosted Zone Records
2.1.9.1 - 1.3
scp-cli dns hosted-zone-record list
--hosted_zone_id <value>
[--limit <value>]
[--marker <value>]
[--sort_dir <value>]
[--sort_key <value>]
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--data <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]
Description
Get record list in a hosted zone
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | 3432012nfdksdf03ktrld9234lgfg |
| limit optional | integer | limit | - |
| marker optional | string | marker | - |
| sort_dir optional | string | sort direction | - |
| sort_key optional | string | sort key | - |
| name optional | string | name | test.app |
| exact_name optional | string | name | test.app |
| type optional | string | Type of the record | A |
| data optional | string | Record data | 12345.ns.private.kr-west1.dev2.samsungsdscloud.com |
| status optional | string | The status | ACTIVE |
| description optional | string | description | This is description |
| ttl optional | integer | TTL for the zone. | 3600 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Record ID | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
| action | current action in progress | CREATE |
| created_at | Created Date | 2025-09-08T03:43:57Z |
| description | description | This is description |
| links | Links to resource | |
| name | name | test.app |
| project_id | ProjectID | 003dffc50eb123a1cbf4f2e5c71d4f15 |
| records | A list of data for this record | [‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’] |
| status | The status | ACTIVE |
| ttl | TTL for the zone. | 3600 |
| type | Type of the record | A |
| updated_at | Updated Date | 2026-02-09T08:00:40Z |
| version | Version | 1 |
| zone_id | ID for the zone that contains this record | 3432012nfdksdf03ktrld9234lgfg |
| zone_name | The name of the zone that contains this record | my-zone.com |
2.1.10 - List Hosted Zones
2.1.10.1 - 1.3
scp-cli dns hosted-zone list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--type <value>]
[--status <value>]
Description
Return list of hosted zones
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | name | my-zone.com |
| type optional | **** | Type of zone | - |
| status optional | **** | The status | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Hosted Zone ID | 3432012nfdksdf03ktrld9234lgfg |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | This is description |
| hosted_zone_type | Hosted Zone type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Hosted Zone Name | my-zone.com |
| pool_id | Designate Pool ID | 10fjksdpooliddfsi12389esfdslkdsr32 |
| private_dns_id | Private DNS ID | 10fjkewefprivatedns3193rud543 |
| private_dns_name | Private DNS Name | private-dns01 |
| status | State | |
| ttl | TTL for the zone. | 3600 |
2.1.11 - List Private DNS
2.1.11.1 - 1.3
scp-cli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]
Description
List all Private DNS
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Private DNS ID | 10fjkewefprivatedns3193rud543 |
| name optional | string | Private DNS Name | - |
| vpc_id optional | string | Connected VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private DNS ID | 10fjkewefprivatedns3193rud543 |
| auth_dns_name | Auth DNS Name | |
| connected_vpc_ids | Connected VPC ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | This is description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private DNS Name | private-dns01 |
| pool_id | Designate Pool ID | 10fjksdpooliddfsi12389esfdslkdsr32 |
| pool_name | Pool Name | |
| registered_region | Registered Region | KR-WEST1 |
| resolver_ip | Private DNS Resolver IP | 198.19.0.101 |
| resolver_name | Private DNS Resolver Name | |
| state | State |
2.1.12 - List Public Domain Names
2.1.12.1 - 1.3
scp-cli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]
Description
Return list of Public Domain Names
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Public Domain Name | example.com |
| created_by optional | string | Created By_ | 504f24f8111e42e0578f367acd2a149f |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 10fjkeweffpublicdomain3193rud543 |
| created_at | Created Date | 2025-09-08T03:43:57Z |
| created_by | Start date | 504f24f8111e42e0578f367acd2a149f |
| expired_date | Expired date | 2026-09-09T00:00:00Z |
| modified_at | Modified Date | 2026-02-09T08:00:40Z |
| modified_by | Modified By_ | 504f24f8111e42e0578f367acd2a149f |
| name | Public Domain Name | example.com |
| register_email | Register email | admin@example.com |
| start_date | Start date | 2025-09-09T00:00:00Z |
| status | The status | REGISTERED |
2.1.13 - Set Hosted Zone
2.1.13.1 - 1.3
scp-cli dns hosted-zone set
--hosted_zone_id <value>
[--description <value>]
Description
Update Hosted Zone
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | 3432012nfdksdf03ktrld9234lgfg |
| description optional | string | description | This is description |
2.1.14 - Set Hosted Zone Record
2.1.14.1 - 1.3
scp-cli dns hosted-zone-record set
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]
Description
Update Hosted Zone record
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
| hosted_zone_id required | string | Hosted Zone ID | 3432012nfdksdf03ktrld9234lgfg |
| records optional | array | A list of data for this record | 12345.ns.private.kr-west1.dev2.samsungsdscloud.com |
| ttl optional | integer | TTL for the zone. | 3600 |
2.1.15 - Set Private DNS
2.1.15.1 - 1.3
scp-cli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]
Description
Update Private DNS
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_dns_id required | string | Private DNS ID | 10fjkewefprivatedns3193rud543 |
| connected_vpc_ids optional | array | Connected VPC ID | - |
| description optional | string | description | This is description |
2.1.16 - Set Public Domain Name
2.1.16.1 - 1.3
scp-cli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]
Description
Update Public Domain Name
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | ID | 10fjkeweffpublicdomain3193rud543 |
| auto_extension optional | boolean | Auto extension flag | True |
| description optional | string | description | This is description |
2.1.17 - Set Public Domain Name Whois Info
2.1.17.1 - 1.3
scp-cli dns public-domain-name-info update
--public_domain_id <value>
--register_telno <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>
Description
Update Public Domain Name Whois Info
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | ID | 10fjkeweffpublicdomain3193rud543 |
| register_telno required | string | Register telephone number | 010-1234-5678 |
| register_email required | string | Register email | admin@example.com |
| postal_code required | string | Postal code | 12345 |
| overseas_third_address required | string | Overseas address - State & Country | NY 10001 |
| overseas_second_address required | string | Overseas address - City | New York |
| overseas_first_address required | string | Overseas address - Address | 123 Main St |
| domestic_second_address_ko required | string | Domestic second address (KO) | 서관 1층 |
| domestic_second_address_en required | string | Domestic second address (EN) | West Campus 1F |
| domestic_first_address_ko required | string | Domestic first address (KO) | 서울특별시 송파구 올림픽로35길 125 (신천동) |
| domestic_first_address_en required | string | Domestic first address (EN) | 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
| address_type required | string | Address type | DOMESTIC |
2.1.18 - Show Hosted Zone
2.1.18.1 - 1.3
scp-cli dns hosted-zone show
--hosted_zone_id <value>
Description
Return details of a hosted zone.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | 3432012nfdksdf03ktrld9234lgfg |
Responses
| Name | Description | Example |
|---|---|---|
| id | Hosted Zone ID | 3432012nfdksdf03ktrld9234lgfg |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | This is description |
| hosted_zone_type | Hosted Zone type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Hosted Zone Name | my-zone.com |
| pool_id | Designate Pool ID | 10fjksdpooliddfsi12389esfdslkdsr32 |
| private_dns_id | Private DNS ID | 10fjkewefprivatedns3193rud543 |
| private_dns_name | Private DNS Name | private-dns01 |
| status | State | |
| ttl | TTL for the zone. | 3600 |
2.1.19 - Show Hosted Zone Record
2.1.19.1 - 1.3
scp-cli dns hosted-zone-record show
--record_id <value>
--hosted_zone_id <value>
Description
Get details of a hosted zone record
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
| hosted_zone_id required | string | Hosted Zone ID | 3432012nfdksdf03ktrld9234lgfg |
Responses
| Name | Description | Example |
|---|---|---|
| id | Record ID | 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7 |
| action | current action in progress | CREATE |
| created_at | Created Date | 2025-09-08T03:43:57Z |
| description | description | This is description |
| links | Links to resource | |
| name | name | test.app |
| project_id | ProjectID | 003dffc50eb123a1cbf4f2e5c71d4f15 |
| records | A list of data for this record | [‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’] |
| status | The status | ACTIVE |
| ttl | TTL for the zone. | 3600 |
| type | Type of the record | A |
| updated_at | Updated Date | 2026-02-09T08:00:40Z |
| version | Version | 1 |
| zone_id | ID for the zone that contains this record | 3432012nfdksdf03ktrld9234lgfg |
| zone_name | The name of the zone that contains this record | my-zone.com |
2.1.20 - Show Private DNS
2.1.20.1 - 1.3
scp-cli dns private-dns show
--private_dns_id <value>
Description
Show Private DNS
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_dns_id required | string | Private DNS ID | 10fjkewefprivatedns3193rud543 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private DNS ID | 10fjkewefprivatedns3193rud543 |
| auth_dns_name | Auth DNS Name | |
| connected_vpc_ids | Connected VPC ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | This is description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private DNS Name | private-dns01 |
| pool_id | Designate Pool ID | 10fjksdpooliddfsi12389esfdslkdsr32 |
| pool_name | Pool Name | |
| registered_region | Registered Region | KR-WEST1 |
| resolver_ip | Private DNS Resolver IP | 198.19.0.101 |
| resolver_name | Private DNS Resolver Name | |
| state | State |
2.1.21 - Show Public Domain Name
2.1.21.1 - 1.3
scp-cli dns public-domain-name show
--public_domain_id <value>
Description
Return details of a public domain name
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | ID | 10fjkeweffpublicdomain3193rud543 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 10fjkeweffpublicdomain3193rud543 |
| address_type | Address type | DOMESTIC |
| auto_extension | Auto extension flag | True |
| created_at | Created Date | 2025-09-08T03:43:57Z |
| created_by | Created By_ | 504f24f8111e42e0578f367acd2a149f |
| description | description | This is description |
| domestic_address_en | Domestic Address (EN) | West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
| domestic_address_ko | Domestic Address (KO) | 서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층 |
| domestic_first_address_en | Domestic first address (EN) | 125 Olympic-ro 35-gil, Songpa-gu, Seoul |
| domestic_first_address_ko | Domestic first address (KO) | 서울특별시 송파구 올림픽로35길 125 (신천동) |
| domestic_second_address_en | Domestic second address (EN) | West Campus 1F |
| domestic_second_address_ko | Domestic second address (KO) | 서관 1층 |
| expired_date | Expired date | 2026-09-09T00:00:00Z |
| modified_at | Modified Date | 2026-02-09T08:00:40Z |
| modified_by | Modified By_ | 504f24f8111e42e0578f367acd2a149f |
| name | Public Domain Name | example.com |
| overseas_address | Overseas Address | 123 Main St, New York, NY 10001 |
| overseas_first_address | Overseas address - Address | 123 Main St |
| overseas_second_address | Overseas address - City | New York |
| overseas_third_address | Overseas address - State & Country | NY 10001 |
| postal_code | Postal code | 12345 |
| register_email | Register email | admin@example.com |
| register_name_en | Register Name Overseas | Hong Gildong |
| register_name_ko | Register Name Domestic | 홍길동 |
| register_telno | Register telephone number | 010-1234-5678 |
| start_date | Start date | 2025-09-09T00:00:00Z |
| status | The status | REGISTERED |
2.1.22 - Transfer Public Domain Name
2.1.22.1 - 1.3
scp-cli dns public-domain-name-transfer update
--public_domain_id <value>
--type <value>
[--target_account_id <value>]
Description
Transfer Public Domain Name
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | ID | 10fjkeweffpublicdomain3193rud543 |
| type required | string | Transfer operation type | REQUEST |
| target_account_id optional | string | Target account id (required when type=REQUEST) | 003dffc50eb123a1cbf4f2e5c71d4f15 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 10fjkeweffpublicdomain3193rud543 |
| auto_extension | Auto extension flag | True |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | This is description |
| expired_date | Expired date | 2026-09-09T00:00:00Z |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Public Domain Name | example.com |
| start_date | Start date | 2025-09-09T00:00:00Z |
| state | State | TRANSFER_REQUESTED |
3 - Firewall
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Firewall service and how to call CLI. The output is formatted as a JSON string
Version
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 | - |
3.1 - CLIs
3.1.1 - Create Firewall Rule
3.1.1.1 - 1.0
scp-cli firewall firewall-rule create
--status <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
--firewall_id <value>
[--description <value>]
[--order_direction <value>]
[--order_rule_id <value>]
Description
Create firewall rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| status required | string | Firewall Rule Status | - |
| source_address required | array | Source Address | 192.168.1.1 |
| service required | array | Service Port | '{"service_type": "TCP", "service_value": "443"}' |
| direction required | string | Firewall Rule Direction | - |
| destination_address required | array | Destination Address | 10.0.0.1 |
| action required | string | Firewall Rule Action | - |
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| description optional | string | Firewall Rule Description | Firewall rule description example |
| order_direction optional | string | Order Direction | - |
| order_rule_id optional | string | Order Rule ID | 043aa63459da466faad71fe4fe587031 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
| action | Firewall Rule Action | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall Rule Description | Firewall rule description example |
| destination_address | Destination Address | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | Destination Interface Name | IFW1-v1001dn |
| direction | Firewall Rule Direction | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall Rule Name | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall Rule Sequence | 100 |
| service | Service Port | |
| source_address | Source Address | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | Source Interface Name | IFW1-v2501up |
| state | Firewall Rule State | |
| status | Firewall Rule Status | |
| vendor_rule_id | Vendor Rule ID | 72 |
3.1.2 - Delete Firewall Rule
3.1.2.1 - 1.0
scp-cli firewall firewall-rule delete
--firewall_rule_id <value>
Description
Delete firewall rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_rule_id required | string | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
3.1.3 - List Firewall Rules
3.1.3.1 - 1.0
scp-cli firewall firewall-rule list
--firewall_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--src_ip <value>]
[--dst_ip <value>]
[--description <value>]
[--state <value>]
[--status <value>]
[--fetch_all <value>]
Description
Get firewall rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| src_ip optional | string | Source IP | 192.168.1.1 |
| dst_ip optional | string | Destination IP | 192.168.1.1 |
| description optional | string | Firewall Rule Description | Firewall rule description example |
| state optional | array | Firewall Rule State | - |
| status optional | **** | Firewall Rule Status | - |
| fetch_all optional | boolean | Firewall Rule Fetch ALL | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
| action | Firewall Rule Action | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall Rule Description | Firewall rule description example |
| destination_address | Destination Address | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | Destination Interface Name | IFW1-v1001dn |
| direction | Firewall Rule Direction | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall Rule Name | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall Rule Sequence | 100 |
| service | Service Port | |
| source_address | Source Address | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | Source Interface Name | IFW1-v2501up |
| state | Firewall Rule State | |
| status | Firewall Rule Status | |
| vendor_rule_id | Vendor Rule ID | 72 |
3.1.4 - List Firewalls
3.1.4.1 - 1.0
scp-cli firewall firewall list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_name <value>]
[--product_type <value>]
[--state <value>]
Description
Get firewall list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Firewall Name | FW_IGW_secuVPC |
| vpc_name optional | string | VPC Name | secuVPC |
| product_type optional | array | Firewall Product Type | - |
| state optional | array | Firewall State | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| flavor_name | Firewall Size Name | SMALL |
| flavor_rule_quota | Firewall Rule Quota | 100 |
| fw_resource_id | Fw Resource ID | 005fd1d30dea11f08a2c56773bef875b |
| loggable | Logging Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall Name | FW_IGW_secuVPC |
| pre_product_id | Pre Product ID | 76479b7ffee1431198d9beb4502cda08 |
| product_type | Firewall Product Type | |
| state | Firewall State | |
| status | Firewall Status | |
| total_rule_count | Total Rule Count | 8 |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | secuVPC |
3.1.5 - Set Firewall
3.1.5.1 - 1.0
scp-cli firewall firewall set
--firewall_id <value>
[--flavor_name <value>]
[--loggable <value>]
Description
Set firewall.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| flavor_name optional | string | Firewall Size Name | - |
| loggable optional | boolean | Logging Use | False |
3.1.6 - Set Firewall Rule
3.1.6.1 - 1.0
scp-cli firewall firewall-rule set
--firewall_rule_id <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
[--description <value>]
Description
Set firewall rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_rule_id required | string | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
| source_address required | array | Source Address | 192.168.1.1 |
| service required | array | Service Port | '{"service_type": "TCP", "service_value": "443"}' |
| direction required | string | Firewall Rule Direction | - |
| destination_address required | array | Destination Address | 10.0.0.1 |
| action required | string | Firewall Rule Action | - |
| description optional | string | Firewall Rule Description | Firewall rule description example |
3.1.7 - Show Firewall
3.1.7.1 - 1.0
scp-cli firewall firewall show
--firewall_id <value>
Description
Show firewall.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| flavor_name | Firewall Size Name | SMALL |
| flavor_rule_quota | Firewall Rule Quota | 100 |
| fw_resource_id | Fw Resource ID | 005fd1d30dea11f08a2c56773bef875b |
| loggable | Logging Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall Name | FW_IGW_secuVPC |
| pre_product_id | Pre Product ID | 76479b7ffee1431198d9beb4502cda08 |
| product_type | Firewall Product Type | |
| state | Firewall State | |
| status | Firewall Status | |
| total_rule_count | Total Rule Count | 8 |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | secuVPC |
3.1.8 - Show Firewall Rule
3.1.8.1 - 1.0
scp-cli firewall firewall-rule show
--firewall_rule_id <value>
Description
Show firewall rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_rule_id required | string | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall Rule ID | b156740b6335468d8354eb9ef8eddf5a |
| action | Firewall Rule Action | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall Rule Description | Firewall rule description example |
| destination_address | Destination Address | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | Destination Interface Name | IFW1-v1001dn |
| direction | Firewall Rule Direction | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall Rule Name | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall Rule Sequence | 100 |
| service | Service Port | |
| source_address | Source Address | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | Source Interface Name | IFW1-v2501up |
| state | Firewall Rule State | |
| status | Firewall Rule Status | |
| vendor_rule_id | Vendor Rule ID | 72 |
4 - Global CDN
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Global CDN service and how to call CLI. The output is formatted as a JSON string
Version
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 | - |
4.1 - CLIs
4.1.1 - Create Cdn Service
4.1.1.1 - 1.0
scp-cli cdn cdn service create
--range_request_allowed <value>
--query_string_ignored <value>
--origin_hostname_type <value>
--name <value>
--forward_host_header <value>
--content_policy <value>
--cdn_service_domain_prefix <value>
--cdn_origin_protocol <value>
--cdn_origin_port <value>
--cdn_origin_hostname <value>
--caching_option <value>
--cache_key_hostname <value>
--cache_expiry_time <value>
[--cdn_service_origin_path <value>]
[--custom_forward_host_header <value>]
[--description <value>]
[--request_custom_headers <value>]
[--response_custom_headers <value>]
[--tags <value>]
Description
create cdn service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| range_request_allowed required | boolean | range request allowed | - |
| query_string_ignored required | boolean | query string ignored | - |
| origin_hostname_type required | string | origin hostname type | - |
| name required | string | cdn service name | test1 |
| forward_host_header required | string | forward host header | - |
| content_policy required | string | content policy | - |
| cdn_service_domain_prefix required | string | cdn service domain prefix | global1 |
| cdn_origin_protocol required | string | cdn service origin protocol | - |
| cdn_origin_port required | integer | cdn service origin port | - |
| cdn_origin_hostname required | string | cdn service origin host name | test.example.com |
| caching_option required | string | caching option | - |
| cache_key_hostname required | string | cache key hostname | - |
| cache_expiry_time required | integer | cache expiry time | - |
| cdn_service_origin_path optional | string | cdn service origin path | /test/global/ |
| custom_forward_host_header optional | string | custom forward host header | - |
| description optional | string | Description | - |
| request_custom_headers optional | object | request custom headers | - |
| response_custom_headers optional | object | response custom header | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | |
| resource_id | resource id | |
| workflow_id | workflow id |
4.1.2 - Delete Cdn Service
4.1.2.1 - 1.0
scp-cli cdn cdn service delete
--id <value>
Description
delete cdn service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | cdn service id | - |
4.1.3 - Detail Cdn Service
4.1.3.1 - 1.0
scp-cli cdn cdn service detail
--id <value>
Description
detail cdn service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | cdn service id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | cdn service id | |
| account_id | Account ID | |
| cache_expiry_time | cache expiry time | |
| cache_key_hostname | cache key hostname | |
| caching_option | caching option | |
| cdn_origin_hostname | cdn service origin host name | |
| cdn_origin_port | cdn service origin port | |
| cdn_origin_protocol | cdn service origin protocol | |
| cdn_service_activation_state | cdn service activation state | |
| cdn_service_config_version | cdn service config version | |
| cdn_service_domain | cdn service domain | |
| cdn_service_origin_path | cdn service origin path | |
| cdn_service_state | cdn service state | |
| content_policy | content policy | |
| created_at | create at | |
| created_by | create by | |
| custom_forward_host_header | custom forward host header | |
| description | Description | |
| forward_host_header | forward host header | |
| modified_at | modified at | |
| modified_by | modified by | |
| name | cdn service name | |
| origin_hostname_type | origin hostname type | |
| query_string_ignored | query string ignored | |
| range_request_allowed | range request allowed | |
| region | region | |
| request_custom_headers | request custom headers | |
| response_custom_headers | response custom header |
4.1.4 - List Cdn Service
4.1.4.1 - 1.0
scp-cli cdn cdn service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--name <value>]
[--cdn_service_domain <value>]
[--cdn_origin_hostname <value>]
Description
list cdn service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| created_by optional | string | create by | - |
| name optional | string | cdn service name | - |
| cdn_service_domain optional | string | cdn service domain | - |
| cdn_origin_hostname optional | string | cdn service origin host name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | cdn service id | |
| account_id | Account ID | |
| cdn_origin_hostname | cdn service origin host name | |
| cdn_service_domain | cdn service domain | |
| cdn_service_state | cdn service state | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | cdn service name | |
| region | region |
4.1.5 - Purge Cdn Service
4.1.5.1 - 1.0
scp-cli cdn cdn service purge
--id <value>
--target_url <value>
--target_content <value>
[--custom_url <value>]
Description
purge cdn service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | cdn service id | - |
| target_url required | string | target url | - |
| target_content required | string | target content | - |
| custom_url optional | string | custom url | /test/ |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | |
| resource_id | resource id | |
| workflow_id | workflow id |
4.1.6 - Start Cdn Service
4.1.6.1 - 1.0
scp-cli cdn cdn service start
--id <value>
Description
start cdn service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | cdn service id | - |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | |
| resource_id | resource id | |
| workflow_id | workflow id |
4.1.7 - Stop Cdn Service
4.1.7.1 - 1.0
scp-cli cdn cdn service stop
--id <value>
Description
stop cdn service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | cdn service id | - |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | |
| resource_id | resource id | |
| workflow_id | workflow id |
4.1.8 - Update Cdn Service
4.1.8.1 - 1.0
scp-cli cdn cdn service update
--id <value>
--range_request_allowed <value>
--query_string_ignored <value>
--origin_hostname_type <value>
--forward_host_header <value>
--content_policy <value>
--cdn_origin_protocol <value>
--cdn_origin_port <value>
--cdn_origin_hostname <value>
--caching_option <value>
--cache_key_hostname <value>
--cache_expiry_time <value>
[--cdn_service_origin_path <value>]
[--custom_forward_host_header <value>]
[--request_custom_headers <value>]
[--response_custom_headers <value>]
Description
update cdn service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | cdn service id | - |
| range_request_allowed required | boolean | range request allowed | - |
| query_string_ignored required | boolean | query string ignored | - |
| origin_hostname_type required | string | origin hostname type | - |
| forward_host_header required | string | forward host header | - |
| content_policy required | string | content policy | - |
| cdn_origin_protocol required | string | cdn service origin protocol | - |
| cdn_origin_port required | integer | cdn service origin port | - |
| cdn_origin_hostname required | string | cdn service origin host name | test.example.com |
| caching_option required | string | caching option | - |
| cache_key_hostname required | string | cache key hostname | - |
| cache_expiry_time required | integer | cache expiry time | - |
| cdn_service_origin_path optional | string | cdn service origin path | /test/global/ |
| custom_forward_host_header optional | string | custom forward host header | - |
| request_custom_headers optional | object | request custom headers | - |
| response_custom_headers optional | object | response custom header | - |
4.1.9 - Update Description of Cdn Service
4.1.9.1 - 1.0
scp-cli cdn description update
--id <value>
--description <value>
Description
Update description of cdn service
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | cdn service id | - |
| description required | string | Description | - |
5 - GSLB
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of GSLB service and how to call CLI. The output is formatted as a JSON string
Version
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 |
5.1 - CLIs
5.1.1 - CreateGslb
5.1.1.1 - 1.1
scp-cli gslb gslb create
--protocol <value>
--resources <value>
--name <value>
--env_usage <value>
--algorithm <value>
[--description <value>]
[--tags <value>]
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]
Description
The GSLB Create.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| protocol required | string | The GSLB Health Check Protocol. | - |
| resources required | array | The GSLB Resource List. | '{"description": "", "destination": "", "region": "", "weight": 0}' |
| name required | string | The Name of the gslb. | example.gslb.e.samsungsdscloud.com |
| env_usage required | string | The GSLB Environment Usage. | PUBLIC |
| algorithm required | string | The GSLB Algorithm. | ROUND_ROBIN |
| description optional | string | Description | Example Description for GSLB |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| health_check_interval optional | integer | The GSLB Health Check Interval. | - |
| health_check_probe_timeout optional | integer | The GSLB Health Check Probe Timeout. | - |
| health_check_user_id optional | string | The GSLB Health Check User Name. | - |
| health_check_user_password optional | string | The GSLB Health Check Password. | - |
| receive_string optional | string | The GSLB Health Check Receive String. | - |
| send_string optional | string | The GSLB Health Check Send String. | - |
| service_port optional | integer | The GSLB Health Check Service Port. | - |
| timeout optional | integer | The GSLB Health Check Timeout. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | ROUND_ROBIN |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for GSLB |
| env_usage | The GSLB Environment Usage. | PUBLIC |
| health_check | The GSLB Health Check. | |
| linked_resource_count | The GSLB Linked Resource Count. | 2 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | example.gslb.e.samsungsdscloud.com |
| state | The GSLB State. | ACTIVE |
5.1.1.2 - 1.0
scp-cli gslb gslb create
--protocol <value>
--resources <value>
--name <value>
--env_usage <value>
--algorithm <value>
[--description <value>]
[--tags <value>]
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]
Description
The GSLB Create.
State ACTIVE (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
| Name | Type | Description | Example |
|---|---|---|---|
| protocol required | string | The GSLB Health Check Protocol. | - |
| resources required | array | '{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}' | |
| name required | string | The Name of the gslb. | - |
| env_usage required | string | The GSLB Environment Usage. | - |
| algorithm required | string | The GSLB Algorithm. | - |
| description optional | string | Description | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| health_check_interval optional | integer | The GSLB Health Check Interval. | - |
| health_check_probe_timeout optional | integer | The GSLB Health Check Probe Timeout. | - |
| health_check_user_id optional | string | The GSLB Health Check User Name. | - |
| health_check_user_password optional | string | The GSLB Health Check Password. | - |
| receive_string optional | string | The GSLB Health Check Receive String. | - |
| send_string optional | string | The GSLB Health Check Send String. | - |
| service_port optional | integer | The GSLB Health Check Service Port. | - |
| timeout optional | integer | The GSLB Health Check Timeout. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| health_check | ||
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |
5.1.2 - DeleteGslb
5.1.2.1 - 1.1
scp-cli gslb gslb delete
--gslb_id <value>
Description
The GSLB Delete.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
5.1.2.2 - 1.0
scp-cli gslb gslb delete
--gslb_id <value>
Description
The GSLB Delete.
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
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
5.1.3 - ListGslbResources
5.1.3.1 - 1.1
scp-cli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
The GSLB Resource List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| destination | The GSLB Resource Destination. | |
| health_check_status | The GSLB Resource Health Check Status. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region | The GSLB Resource Region. | |
| status | The GSLB Resource Status. | |
| weight | The GSLB Resource Weight. |
5.1.3.2 - 1.0
scp-cli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
The GSLB Resource 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 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| destination | The GSLB Resource Destination. | |
| disabled | The GSLB Resource disabled. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region | The GSLB Resource Region. | |
| weight | The GSLB Resource Weight. |
5.1.4 - ListGslbs
5.1.4.1 - 1.1
scp-cli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]
Description
The GSLB List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| state optional | string | The GSLB State. | - |
| name optional | string | The Name of the gslb. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |
5.1.4.2 - 1.0
scp-cli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]
Description
The GSLB 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 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| state optional | string | The GSLB State. | - |
| name optional | string | The Name of the gslb. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |
5.1.5 - ListGslbsRegionalRoutingControl
5.1.5.1 - 1.1
scp-cli gslb gslb regional routing list
[--size <value>]
[--page <value>]
[--sort <value>]
[--region <value>]
[--status <value>]
[--name <value>]
Description
The GSLB Regional Resource List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| region optional | string | The GSLB Resource Region. | - |
| status optional | **** | The GSLB Resource Status. | - |
| name optional | string | The Name of the gslb. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| linked_regional_resource_count | The GSLB Linked Resource Count Per Region. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| region | The GSLB Resource Region. | |
| status | The GSLB Resource Status. |
5.1.6 - SetGslb
5.1.6.1 - 1.1
scp-cli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]
Description
The GSLB Set.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| algorithm optional | string | The GSLB Algorithm. | - |
| description optional | string | Description | - |
5.1.6.2 - 1.0
scp-cli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]
Description
The GSLB Set.
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
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| algorithm optional | string | The GSLB Algorithm. | - |
| description optional | string | Description | - |
5.1.7 - SetGslbHealthCheck
5.1.7.1 - 1.1
scp-cli gslb gslb-health-check update
--gslb_id <value>
--protocol <value>
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]
Description
Set GSLB Health Checks.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| protocol required | string | The GSLB Health Check Protocol. | - |
| health_check_interval optional | integer | The GSLB Health Check Interval. | - |
| health_check_probe_timeout optional | integer | The GSLB Health Check Probe Timeout. | - |
| health_check_user_id optional | string | The GSLB Health Check User Name. | - |
| health_check_user_password optional | string | The GSLB Health Check Password. | - |
| receive_string optional | string | The GSLB Health Check Receive String. | - |
| send_string optional | string | The GSLB Health Check Send String. | - |
| service_port optional | integer | The GSLB Health Check Service Port. | - |
| timeout optional | integer | The GSLB Health Check Timeout. | - |
5.1.7.2 - 1.0
scp-cli gslb gslb-health-check update
--gslb_id <value>
--protocol <value>
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]
Description
Set GSLB Health Checks.
State ACTIVE (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
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| protocol required | string | The GSLB Health Check Protocol. | - |
| health_check_interval optional | integer | The GSLB Health Check Interval. | - |
| health_check_probe_timeout optional | integer | The GSLB Health Check Probe Timeout. | - |
| health_check_user_id optional | string | The GSLB Health Check User Name. | - |
| health_check_user_password optional | string | The GSLB Health Check Password. | - |
| receive_string optional | string | The GSLB Health Check Receive String. | - |
| send_string optional | string | The GSLB Health Check Send String. | - |
| service_port optional | integer | The GSLB Health Check Service Port. | - |
| timeout optional | integer | The GSLB Health Check Timeout. | - |
5.1.8 - SetGslbRegionalRoutingControl
5.1.8.1 - 1.1
scp-cli gslb gslb-regional-routing-set
--gslb_id <value>
--status <value>
--region <value>
Description
Set GSLB Regional Routing.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| status required | string | The GSLB Resource Status. | - |
| region required | string | The GSLB Resource Region. | - |
5.1.9 - SetGslbResources
5.1.9.1 - 1.1
scp-cli gslb gslb-resource update
--gslb_id <value>
--resources <value>
Description
Set GSLB Resources.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| resources required | array | '{"description": "", "destination": "", "region": "", "weight": 0}' |
5.1.9.2 - 1.0
scp-cli gslb gslb-resource update
--gslb_id <value>
--resources <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| resources required | array | '{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}' |
5.1.10 - ShowGslb
5.1.10.1 - 1.1
scp-cli gslb gslb show
--gslb_id <value>
Description
The GSLB Show.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| health_check | ||
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |
5.1.10.2 - 1.0
scp-cli gslb gslb show
--gslb_id <value>
Description
The GSLB Show.
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
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| health_check | ||
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |
6 - Load Balancer
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of LOADBALANCER service and how to call CLI. The output is formatted as a JSON string
Version
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 | DEPRECATED | 20260319 |
| 1.1 | DEPRECATED | 20260319 |
| 1.0 | DEPRECATED | 20251023 |
6.1 - CLIs
6.1.1 - AddLbServerGroupMembers
6.1.1.1 - 1.3
scp-cli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>
Description
Add Lb Server Group Member bulk
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | ID of Lb Server Group | - |
| members required | array | '{"member_ip": "192.168.0.1", "member_port": 80, "member_state": "ENABLE", "member_weight": 100, "name": "virtualserver-1", "object_id": "1", "object_type": "VM"}' |
Responses
| Name | Description | Example |
|---|---|---|
| count | total count | 20 |
| links | links | [{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}] |
| members | [] |
6.1.1.2 - 1.2
scp-cli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>
Description
Add Lb Server Group Member bulk
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | ID of Lb Server Group | - |
| members required | array | '{"member_ip": "192.168.0.1", "member_port": 80, "member_state": "ENABLE", "member_weight": 100, "name": "virtualserver-1", "object_id": "1", "object_type": "VM"}' |
Responses
| Name | Description | Example |
|---|---|---|
| count | total count | 20 |
| links | links | [{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}] |
| members | [] |
6.1.1.3 - 1.1
scp-cli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>
Description
Add Lb Server Group Member bulk
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | ID of Lb Server Group | - |
| members required | array | '{"member_ip": "192.168.0.1", "member_port": 80, "member_state": "ENABLE", "member_weight": 100, "name": "virtualserver-1", "object_id": "1", "object_type": "VM"}' |
Responses
| Name | Description | Example |
|---|---|---|
| count | total count | 20 |
| links | links | [{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}] |
| members | [] |
6.1.2 - CreateLBHealthCheck
6.1.2.1 - 1.3
scp-cli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]
Description
Create LB Health Check
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | LB Health Check Protocol | TCP |
| name required | string | LB Health Check name | ServerGroup01 |
| description optional | string | Description | this is an lb server group |
| health_check_count optional | integer | LB Health Check count | 3 |
| health_check_interval optional | integer | LB Health Check interval | 5 |
| health_check_port optional | integer | LB Health Check port | 80 |
| health_check_timeout optional | integer | LB Health Check timeout | 5 |
| health_check_url optional | string | LB Health Check URL | /test |
| http_method optional | **** | LB Health Check HTTP Method | GET |
| request_data optional | string | LB Health Check Request data | username=admin&password=1234 |
| response_code optional | string | LB Health Check Response code | 200 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| health_check_count | LB Health Check count | 3 |
| health_check_interval | LB Health Check interval | 5 |
| health_check_port | LB Health Check port | 80 |
| health_check_timeout | LB Health Check timeout | 5 |
| health_check_type | LB Health Check type | DEFAULT |
| health_check_url | LB Health Check URL | /test |
| http_method | LB Health Check HTTP Method | GET |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| request_data | LB Health Check Request data | username=admin&password=1234 |
| response_code | LB Health Check Response code | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.2.2 - 1.2
scp-cli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]
Description
Create LB Health Check
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | LB Health Check Protocol | TCP |
| name required | string | LB Health Check name | ServerGroup01 |
| description optional | string | Description | this is an lb server group |
| health_check_count optional | integer | LB Health Check count | 3 |
| health_check_interval optional | integer | LB Health Check interval | 5 |
| health_check_port optional | integer | LB Health Check port | 80 |
| health_check_timeout optional | integer | LB Health Check timeout | 5 |
| health_check_url optional | string | LB Health Check URL | /test |
| http_method optional | **** | LB Health Check HTTP Method | GET |
| request_data optional | string | LB Health Check Request data | username=admin&password=1234 |
| response_code optional | string | LB Health Check Response code | 200 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| health_check_count | LB Health Check count | 3 |
| health_check_interval | LB Health Check interval | 5 |
| health_check_port | LB Health Check port | 80 |
| health_check_timeout | LB Health Check timeout | 5 |
| health_check_type | LB Health Check type | DEFAULT |
| health_check_url | LB Health Check URL | /test |
| http_method | LB Health Check HTTP Method | GET |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| request_data | LB Health Check Request data | username=admin&password=1234 |
| response_code | LB Health Check Response code | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.2.3 - 1.1
scp-cli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]
Description
Create LB Health Check
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | LB Health Check Protocol | TCP |
| name required | string | LB Health Check name | ServerGroup01 |
| description optional | string | Description | this is an lb server group |
| health_check_count optional | integer | LB Health Check count | 3 |
| health_check_interval optional | integer | LB Health Check interval | 5 |
| health_check_port optional | integer | LB Health Check port | 80 |
| health_check_timeout optional | integer | LB Health Check timeout | 5 |
| health_check_url optional | string | LB Health Check URL | /test |
| http_method optional | **** | LB Health Check HTTP Method | GET |
| request_data optional | string | LB Health Check Request data | username=admin&password=1234 |
| response_code optional | string | LB Health Check Response code | 200 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| health_check_count | LB Health Check count | 3 |
| health_check_interval | LB Health Check interval | 5 |
| health_check_port | LB Health Check port | 80 |
| health_check_timeout | LB Health Check timeout | 5 |
| health_check_type | LB Health Check type | DEFAULT |
| health_check_url | LB Health Check URL | /test |
| http_method | LB Health Check HTTP Method | GET |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| request_data | LB Health Check Request data | username=admin&password=1234 |
| response_code | LB Health Check Response code | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.3 - CreateLbListener
6.1.3.1 - 1.3
scp-cli loadbalancer lb-listener create
--listener_protocol <value>
--service_port <value>
--routing_action <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--hsts_max_age <value>]
[--idle_timeout <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--tags <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
[--listener_https_redirection_protocol <value>]
Description
create LB listener
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_protocol required | string | protocol | - |
| service_port required | integer | The port of the listener. | - |
| routing_action required | string | The routing action of the listener. | - |
| name required | string | The name of the listener. | - |
| loadbalancer_id required | string | The ID of the load balancer. | - |
| condition_type optional | **** | The condition type of the listener. | - |
| description optional | string | description | - |
| hsts_max_age optional | integer | The hsts_max_age of the listener. | - |
| idle_timeout optional | integer | The idle timeout(L7) of the listener. | - |
| insert_client_ip optional | boolean | Whether the client IP should be inserted. | - |
| persistence optional | string | The persistence of the listener. | - |
| response_timeout optional | integer | The response timeout of the listener. | - |
| server_group_id optional | string | The ID of the server group. | - |
| session_duration_time optional | integer | The session duration time. | - |
| sni_certificate optional | array | The sni certificate of the listener. | '{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}' |
| support_http2 optional | boolean | Whether the HTTP 2.0 is supported | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| url_handler optional | array | The URL handler of the listener. | - |
| url_redirection optional | string | The URL redirect of the listener. | - |
| x_forwarded_for optional | boolean | Whether the X-Forwarded-For should be inserted. | - |
| x_forwarded_port optional | boolean | Whether the X-Forwarded-Port should be inserted. | - |
| x_forwarded_proto optional | boolean | Whether the X-Forwarded-Protocol should be inserted. | - |
| port optional | string | port | - |
| response_code optional | string | response_code | - |
| client_cert_id optional | string | Certificate id for client ssl | - |
| client_cert_level optional | string | Certificate level for client ssl | - |
| server_cert_level optional | string | Certificate level for server ssl | - |
| listener_https_redirection_protocol optional | string | protocol | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| condition_type | The condition type of the listener. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| hsts_max_age | The hsts_max_age of the listener. | |
| https_redirection | The https redirection of the listener. | |
| idle_timeout | The idle timeout(L7) of the listener. | |
| insert_client_ip | Whether the client IP should be inserted. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the listener. | |
| persistence | The persistence of the listener. | |
| protocol | The protocol of the listener. | |
| response_timeout | The response timeout of the listener. | |
| routing_action | The routing action of the listener. | |
| server_group_id | The ID of the server group. | |
| server_group_name | The Name of the server group. | |
| service_port | The port of the listener. | |
| session_duration_time | The session duration time. | |
| sni_certificate | The sni certificate of the listener. | |
| ssl_certificate | The ssl certificate of the listener. | |
| state | The State of the listener. | |
| support_http2 | Whether the HTTP 2.0 is supported | |
| url_handler | The URL handler of the listener. | |
| url_redirection | The URL redirect of the listener. | |
| x_forwarded_for | Whether the X-Forwarded-For should be inserted. | |
| x_forwarded_port | Whether the X-Forwarded-Port should be inserted. | |
| x_forwarded_proto | Whether the X-Forwarded-Protocol should be inserted. |
6.1.3.2 - 1.2
scp-cli loadbalancer lb-listener create
--listener_protocol <value>
--service_port <value>
--routing_action <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--tags <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
[--listener_https_redirection_protocol <value>]
Description
create LB listener
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_protocol required | string | protocol | - |
| service_port required | integer | The port of the listener. | - |
| routing_action required | string | The routing action of the listener. | - |
| name required | string | The name of the listener. | - |
| loadbalancer_id required | string | The ID of the load balancer. | - |
| condition_type optional | **** | The condition type of the listener. | - |
| description optional | string | description | - |
| insert_client_ip optional | boolean | Whether the client IP should be inserted. | - |
| persistence optional | string | The persistence of the listener. | - |
| response_timeout optional | integer | The response timeout of the listener. | - |
| server_group_id optional | string | The ID of the server group. | - |
| session_duration_time optional | integer | The session duration time. | - |
| sni_certificate optional | array | The sni certificate of the listener. | '{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}' |
| support_http2 optional | boolean | Whether the HTTP 2.0 is supported | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| url_handler optional | array | The URL handler of the listener. | - |
| url_redirection optional | string | The URL redirect of the listener. | - |
| x_forwarded_for optional | boolean | Whether the X-Forwarded-For should be inserted. | - |
| x_forwarded_port optional | boolean | Whether the X-Forwarded-Port should be inserted. | - |
| x_forwarded_proto optional | boolean | Whether the X-Forwarded-Protocol should be inserted. | - |
| port optional | string | port | - |
| response_code optional | string | response_code | - |
| client_cert_id optional | string | Certificate id for client ssl | - |
| client_cert_level optional | string | Certificate level for client ssl | - |
| server_cert_level optional | string | Certificate level for server ssl | - |
| listener_https_redirection_protocol optional | string | protocol | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| condition_type | The condition type of the listener. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| https_redirection | The https redirection of the listener. | |
| insert_client_ip | Whether the client IP should be inserted. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the listener. | |
| persistence | The persistence of the listener. | |
| protocol | The protocol of the listener. | |
| response_timeout | The response timeout of the listener. | |
| routing_action | The routing action of the listener. | |
| server_group_id | The ID of the server group. | |
| server_group_name | The Name of the server group. | |
| service_port | The port of the listener. | |
| session_duration_time | The session duration time. | |
| sni_certificate | The sni certificate of the listener. | |
| ssl_certificate | The ssl certificate of the listener. | |
| state | The State of the listener. | |
| support_http2 | Whether the HTTP 2.0 is supported | |
| url_handler | The URL handler of the listener. | |
| url_redirection | The URL redirect of the listener. | |
| x_forwarded_for | Whether the X-Forwarded-For should be inserted. | |
| x_forwarded_port | Whether the X-Forwarded-Port should be inserted. | |
| x_forwarded_proto | Whether the X-Forwarded-Protocol should be inserted. |
6.1.3.3 - 1.1
scp-cli loadbalancer lb-listener create
--listener_protocol <value>
--service_port <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--routing_action <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--tags <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
[--listener_https_redirection_protocol <value>]
Description
create LB listener
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_protocol required | string | protocol | - |
| service_port required | integer | The port of the listener. | - |
| name required | string | The name of the listener. | - |
| loadbalancer_id required | string | The ID of the load balancer. | - |
| condition_type optional | **** | The condition type of the listener. | - |
| description optional | string | description | - |
| insert_client_ip optional | boolean | Whether the client IP should be inserted. | - |
| persistence optional | string | The persistence of the listener. | - |
| response_timeout optional | integer | The response timeout of the listener. | - |
| routing_action optional | **** | The routing action of the listener. | - |
| server_group_id optional | string | The ID of the server group. | - |
| session_duration_time optional | integer | The session duration time. | - |
| sni_certificate optional | array | The sni certificate of the listener. | '{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}' |
| support_http2 optional | boolean | Whether the HTTP 2.0 is supported | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| url_handler optional | array | The URL handler of the listener. | - |
| url_redirection optional | string | The URL redirect of the listener. | - |
| x_forwarded_for optional | boolean | Whether the X-Forwarded-For should be inserted. | - |
| x_forwarded_port optional | boolean | Whether the X-Forwarded-Port should be inserted. | - |
| x_forwarded_proto optional | boolean | Whether the X-Forwarded-Protocol should be inserted. | - |
| port optional | string | port | - |
| response_code optional | string | response_code | - |
| client_cert_id optional | string | Certificate id for client ssl | - |
| client_cert_level optional | string | Certificate level for client ssl | - |
| server_cert_level optional | string | Certificate level for server ssl | - |
| listener_https_redirection_protocol optional | string | protocol | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| condition_type | The condition type of the listener. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| https_redirection | The https redirection of the listener. | |
| insert_client_ip | Whether the client IP should be inserted. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the listener. | |
| persistence | The persistence of the listener. | |
| protocol | The protocol of the listener. | |
| response_timeout | The response timeout of the listener. | |
| routing_action | The routing action of the listener. | |
| server_group_id | The ID of the server group. | |
| server_group_name | The Name of the server group. | |
| service_port | The port of the listener. | |
| session_duration_time | The session duration time. | |
| sni_certificate | The sni certificate of the listener. | |
| ssl_certificate | The ssl certificate of the listener. | |
| state | The State of the listener. | |
| support_http2 | Whether the HTTP 2.0 is supported | |
| url_handler | The URL handler of the listener. | |
| url_redirection | The URL redirect of the listener. | |
| x_forwarded_for | Whether the X-Forwarded-For should be inserted. | |
| x_forwarded_port | Whether the X-Forwarded-Port should be inserted. | |
| x_forwarded_proto | Whether the X-Forwarded-Protocol should be inserted. |
6.1.4 - CreateLBServerGroup
6.1.4.1 - 1.3
scp-cli loadbalancer lb-server-group create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
--lb_method <value>
[--description <value>]
[--lb_health_check_id <value>]
[--tags <value>]
Description
Create LB Server Group
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | Protocol | TCP |
| name required | string | LB Health Check name | ServerGroup01 |
| lb_method required | string | LB Method | ROUND_ROBIN |
| description optional | string | Description | this is an lb server group |
| lb_health_check_id optional | string | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| lb_health_check_id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method | LB Method | ROUND_ROBIN |
| lb_name | Load Balancer name | Test-LB-01 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | ServerGroup01 |
| protocol | Protocol | TCP |
| state | LB Server Group state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.4.2 - 1.2
scp-cli loadbalancer lb-server-group create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
--lb_method <value>
[--description <value>]
[--lb_health_check_id <value>]
[--tags <value>]
Description
Create LB Server Group
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | Protocol | TCP |
| name required | string | LB Health Check name | ServerGroup01 |
| lb_method required | string | LB Method | ROUND_ROBIN |
| description optional | string | Description | this is an lb server group |
| lb_health_check_id optional | string | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| lb_health_check_id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method | LB Method | ROUND_ROBIN |
| lb_name | Load Balancer name | Test-LB-01 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | ServerGroup01 |
| protocol | Protocol | TCP |
| state | LB Server Group state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.4.3 - 1.1
scp-cli loadbalancer lb-server-group create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
--lb_method <value>
[--description <value>]
[--lb_health_check_id <value>]
[--tags <value>]
Description
Create LB Server Group
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | Protocol | TCP |
| name required | string | LB Health Check name | ServerGroup01 |
| lb_method required | string | LB Method | ROUND_ROBIN |
| description optional | string | Description | this is an lb server group |
| lb_health_check_id optional | string | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| lb_health_check_id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method | LB Method | ROUND_ROBIN |
| lb_name | Load Balancer name | Test-LB-01 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | ServerGroup01 |
| protocol | Protocol | TCP |
| state | LB Server Group state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.5 - CreateLoadbalancer
6.1.5.1 - 1.3
scp-cli loadbalancer loadbalancer create
--vpc_id <value>
--subnet_id <value>
--name <value>
--layer_type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_logging_enabled <value>]
[--health_check_ip_1 <value>]
[--health_check_ip_2 <value>]
[--publicip_id <value>]
[--service_ip <value>]
[--source_nat_ip <value>]
[--tags <value>]
Description
create Load Balancer
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | name | - |
| layer_type required | string | Layer type | - |
| description optional | string | description | - |
| firewall_enabled optional | boolean | Firewall enabled | - |
| firewall_logging_enabled optional | boolean | Firewall logging enabled | - |
| health_check_ip_1 optional | string | Health check IP | - |
| health_check_ip_2 optional | string | Health check IP | - |
| publicip_id optional | string | Public IP ID | - |
| service_ip optional | string | The service IP of the load balancer. | - |
| source_nat_ip optional | string | Source NAT IP | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | The account ID of the load balancer. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| layer_type | Layer type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | name | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
6.1.5.2 - 1.2
scp-cli loadbalancer loadbalancer create
--vpc_id <value>
--subnet_id <value>
--name <value>
--layer_type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_logging_enabled <value>]
[--health_check_ip_1 <value>]
[--health_check_ip_2 <value>]
[--publicip_id <value>]
[--service_ip <value>]
[--source_nat_ip <value>]
[--tags <value>]
Description
create Load Balancer
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | name | - |
| layer_type required | string | Layer type | - |
| description optional | string | description | - |
| firewall_enabled optional | boolean | Firewall enabled | - |
| firewall_logging_enabled optional | boolean | Firewall logging enabled | - |
| health_check_ip_1 optional | string | Health check IP | - |
| health_check_ip_2 optional | string | Health check IP | - |
| publicip_id optional | string | Public IP ID | - |
| service_ip optional | string | The service IP of the load balancer. | - |
| source_nat_ip optional | string | Source NAT IP | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | The account ID of the load balancer. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| layer_type | Layer type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | name | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
6.1.5.3 - 1.1
scp-cli loadbalancer loadbalancer create
--vpc_id <value>
--subnet_id <value>
--name <value>
--layer_type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_logging_enabled <value>]
[--health_check_ip_1 <value>]
[--health_check_ip_2 <value>]
[--publicip_id <value>]
[--service_ip <value>]
[--source_nat_ip <value>]
[--tags <value>]
Description
create Load Balancer
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | name | - |
| layer_type required | string | Layer type | - |
| description optional | string | description | - |
| firewall_enabled optional | boolean | Firewall enabled | - |
| firewall_logging_enabled optional | boolean | Firewall logging enabled | - |
| health_check_ip_1 optional | string | Health check IP | - |
| health_check_ip_2 optional | string | Health check IP | - |
| publicip_id optional | string | Public IP ID | - |
| service_ip optional | string | The service IP of the load balancer. | - |
| source_nat_ip optional | string | Source NAT IP | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | The account ID of the load balancer. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| layer_type | Layer type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | name | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
6.1.6 - CreateLoadbalancerPrivateNatIp
6.1.6.1 - 1.3
scp-cli loadbalancer loadbalancer-private-nat-ip create
--loadbalancer_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>
Description
create Load Balancer Private NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
| private_nat_ip_id required | string | private_nat_ip_id | - |
| private_nat_id required | string | private_nat_id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| external_ip_address | external_ip_address | |
| internal_ip_address | internal_ip_address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_ip_id | private_nat_ip_id | |
| state | state | |
| subnet_id | subnet_id |
6.1.7 - CreateLoadbalancerPublicNatIp
6.1.7.1 - 1.3
scp-cli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>
Description
create Load Balancer Public NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
| publicip_id required | string | publicip_id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | account_id | |
| action_type | action_type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| external_ip_address | external_ip_address | |
| internal_ip_address | internal_ip_address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | name | |
| owner_id | owner_id | |
| owner_name | owner_name | |
| owner_type | owner_type | |
| publicip_id | publicip_id | |
| service_ip_port_id | service_ip_port_id | |
| state | state | |
| subnet_id | subnet_id | |
| type | type | |
| vpc_id | vpc_id |
6.1.7.2 - 1.2
scp-cli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>
Description
create Load Balancer Public 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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
| publicip_id required | string | publicip_id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | account_id | |
| action_type | action_type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| external_ip_address | external_ip_address | |
| internal_ip_address | internal_ip_address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | name | |
| owner_id | owner_id | |
| owner_name | owner_name | |
| owner_type | owner_type | |
| publicip_id | publicip_id | |
| service_ip_port_id | service_ip_port_id | |
| state | state | |
| subnet_id | subnet_id | |
| type | type | |
| vpc_id | vpc_id |
6.1.7.3 - 1.1
scp-cli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>
Description
create Load Balancer Public 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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
| publicip_id required | string | publicip_id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | account_id | |
| action_type | action_type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| external_ip_address | external_ip_address | |
| internal_ip_address | internal_ip_address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | name | |
| owner_id | owner_id | |
| owner_name | owner_name | |
| owner_type | owner_type | |
| publicip_id | publicip_id | |
| service_ip_port_id | service_ip_port_id | |
| state | state | |
| subnet_id | subnet_id | |
| type | type | |
| vpc_id | vpc_id |
6.1.8 - DeleteLBHealthCheck
6.1.8.1 - 1.3
scp-cli loadbalancer lb-health-check delete
--lb_health_check_id <value>
Description
Delete LB Health Check
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB Health Check ID | e3cd678b11784734bc366148aa37580e |
6.1.8.2 - 1.2
scp-cli loadbalancer lb-health-check delete
--lb_health_check_id <value>
Description
Delete LB Health Check
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB Health Check ID | e3cd678b11784734bc366148aa37580e |
6.1.8.3 - 1.1
scp-cli loadbalancer lb-health-check delete
--lb_health_check_id <value>
Description
Delete LB Health Check
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB Health Check ID | e3cd678b11784734bc366148aa37580e |
6.1.9 - DeleteLbListener
6.1.9.1 - 1.3
scp-cli loadbalancer lb-listener delete
--listener_id <value>
Description
delete LB listener
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | The ID of the listener. | - |
6.1.9.2 - 1.2
scp-cli loadbalancer lb-listener delete
--listener_id <value>
Description
delete LB listener
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | The ID of the listener. | - |
6.1.9.3 - 1.1
scp-cli loadbalancer lb-listener delete
--listener_id <value>
Description
delete LB listener
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | The ID of the listener. | - |
6.1.10 - DeleteLBServerGroup
6.1.10.1 - 1.3
scp-cli loadbalancer lb-server-group delete
--lb_server_group_id <value>
Description
Delete LB Server Group
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
6.1.10.2 - 1.2
scp-cli loadbalancer lb-server-group delete
--lb_server_group_id <value>
Description
Delete LB Server Group
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
6.1.10.3 - 1.1
scp-cli loadbalancer lb-server-group delete
--lb_server_group_id <value>
Description
Delete LB Server Group
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
6.1.11 - DeleteLoadbalancer
6.1.11.1 - 1.3
scp-cli loadbalancer loadbalancer delete
--loadbalancer_id <value>
Description
delete Load Balancer
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
6.1.11.2 - 1.2
scp-cli loadbalancer loadbalancer delete
--loadbalancer_id <value>
Description
delete 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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
6.1.11.3 - 1.1
scp-cli loadbalancer loadbalancer delete
--loadbalancer_id <value>
Description
delete 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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
6.1.12 - DeleteLoadbalancerPrivateNatIp
6.1.12.1 - 1.3
scp-cli loadbalancer loadbalancer-private-nat-ip delete
--loadbalancer_id <value>
Description
delete Load Balancer Private NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
6.1.13 - DeleteLoadbalancerPublicNatIp
6.1.13.1 - 1.3
scp-cli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>
Description
delete Load Balancer Public NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
6.1.13.2 - 1.2
scp-cli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>
Description
delete Load Balancer Public 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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
6.1.13.3 - 1.1
scp-cli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>
Description
delete Load Balancer Public 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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
6.1.14 - ListLBHealthChecks
6.1.14.1 - 1.3
scp-cli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
Description
List LB Health Checks
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | LB Health Check name | Test-LbMonitor-01 |
| protocol optional | array | LB Health Check Protocol | 'TCP' |
| subnet_id optional | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| health_check_type | LB Health Check type | DEFAULT |
| lb_server_group_count | LB Server Group count | 2 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
6.1.14.2 - 1.2
scp-cli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
Description
List LB Health Checks
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | LB Health Check name | Test-LbMonitor-01 |
| protocol optional | array | LB Health Check Protocol | 'TCP' |
| subnet_id optional | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| health_check_type | LB Health Check type | DEFAULT |
| lb_server_group_count | LB Server Group count | 2 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
6.1.14.3 - 1.1
scp-cli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
Description
List LB Health Checks
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | LB Health Check name | Test-LbMonitor-01 |
| protocol optional | array | LB Health Check Protocol | 'TCP' |
| subnet_id optional | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| health_check_type | LB Health Check type | DEFAULT |
| lb_server_group_count | LB Server Group count | 2 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
6.1.15 - ListLbListeners
6.1.15.1 - 1.3
scp-cli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]
[--not_protocol <value>]
Description
get LB listener list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| loadbalancer_id optional | string | The ID of the load balancer. | - |
| state optional | string | The State of the listener. | - |
| name optional | string | The name of the listener. | - |
| service_port optional | integer | The port of the listener. | - |
| protocol optional | array | Protocol | 'TCP' |
| not_protocol optional | **** | The protocol of the listener to exclude. | TCP |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the listener. | |
| protocol | The protocol of the listener. | |
| service_port | The port of the listener. | |
| state | The State of the listener. |
6.1.15.2 - 1.2
scp-cli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]
[--not_protocol <value>]
Description
get LB listener 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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| loadbalancer_id optional | string | The ID of the load balancer. | - |
| state optional | string | The State of the listener. | - |
| name optional | string | The name of the listener. | - |
| service_port optional | integer | The port of the listener. | - |
| protocol optional | array | Protocol | 'TCP' |
| not_protocol optional | **** | The protocol of the listener to exclude. | TCP |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the listener. | |
| protocol | The protocol of the listener. | |
| service_port | The port of the listener. | |
| state | The State of the listener. |
6.1.15.3 - 1.1
scp-cli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]
[--not_protocol <value>]
Description
get LB listener 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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| loadbalancer_id optional | string | The ID of the load balancer. | - |
| state optional | string | The State of the listener. | - |
| name optional | string | The name of the listener. | - |
| service_port optional | integer | The port of the listener. | - |
| protocol optional | array | Protocol | 'TCP' |
| not_protocol optional | **** | The protocol of the listener to exclude. | TCP |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the listener. | |
| protocol | The protocol of the listener. | |
| service_port | The port of the listener. | |
| state | The State of the listener. |
6.1.16 - ListLbServerGroupMembers
6.1.16.1 - 1.3
scp-cli loadbalancer lb-server-group-member list
--lb_server_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--member_ip <value>]
[--member_port <value>]
Description
Get Lb Server Group Member List
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | ID of Lb Server Group | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Name of Member | - |
| member_ip optional | string | IP of Member | - |
| member_port optional | integer | Protocol port of Member | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| health_state | Health State of Member | |
| lb_server_group_id | ID of Lb Server Group | |
| member_ip | IP of Member | |
| member_port | Protocol port of Member | |
| member_state | Member State of Member | |
| member_weight | Weight of Member | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of Member | |
| object_id | Object ID of Member | |
| object_type | Object Type of Member | |
| state | State of Member |
6.1.16.2 - 1.2
scp-cli loadbalancer lb-server-group-member list
--lb_server_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--member_ip <value>]
[--member_port <value>]
Description
Get Lb Server Group Member List
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | ID of Lb Server Group | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Name of Member | - |
| member_ip optional | string | IP of Member | - |
| member_port optional | integer | Protocol port of Member | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| health_state | Health State of Member | |
| lb_server_group_id | ID of Lb Server Group | |
| member_ip | IP of Member | |
| member_port | Protocol port of Member | |
| member_state | Member State of Member | |
| member_weight | Weight of Member | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of Member | |
| object_id | Object ID of Member | |
| object_type | Object Type of Member | |
| state | State of Member |
6.1.16.3 - 1.1
scp-cli loadbalancer lb-server-group-member list
--lb_server_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--member_ip <value>]
[--member_port <value>]
Description
Get Lb Server Group Member List
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | ID of Lb Server Group | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Name of Member | - |
| member_ip optional | string | IP of Member | - |
| member_port optional | integer | Protocol port of Member | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| health_state | Health State of Member | |
| lb_server_group_id | ID of Lb Server Group | |
| member_ip | IP of Member | |
| member_port | Protocol port of Member | |
| member_state | Member State of Member | |
| member_weight | Weight of Member | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of Member | |
| object_id | Object ID of Member | |
| object_type | Object Type of Member | |
| state | State of Member |
6.1.17 - ListLBServerGroups
6.1.17.1 - 1.3
scp-cli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]
Description
Get LB Server Group list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | LB Server Group name | ServerGroup01 |
| protocol optional | array | Protocol | 'TCP' |
| subnet_id optional | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id optional | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| lb_health_check_id optional | string | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method optional | array | LB Method | 'R' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| lb_health_check_id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_name | Load Balancer name | Test-LB-01 |
| lb_server_group_member_count | LB Server Group Member count | 2 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | ServerGroup01 |
| protocol | Protocol | TCP |
| state | LB Server Group state | ACTIVE |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.17.2 - 1.2
scp-cli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]
Description
Get LB Server Group list
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | LB Server Group name | ServerGroup01 |
| protocol optional | array | Protocol | 'TCP' |
| subnet_id optional | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id optional | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| lb_health_check_id optional | string | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method optional | array | LB Method | 'R' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| lb_health_check_id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_name | Load Balancer name | Test-LB-01 |
| lb_server_group_member_count | LB Server Group Member count | 2 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | ServerGroup01 |
| protocol | Protocol | TCP |
| state | LB Server Group state | ACTIVE |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.17.3 - 1.1
scp-cli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]
Description
Get LB Server Group list
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | LB Server Group name | ServerGroup01 |
| protocol optional | array | Protocol | 'TCP' |
| subnet_id optional | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id optional | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| lb_health_check_id optional | string | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method optional | array | LB Method | 'R' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| lb_health_check_id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_name | Load Balancer name | Test-LB-01 |
| lb_server_group_member_count | LB Server Group Member count | 2 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | ServerGroup01 |
| protocol | Protocol | TCP |
| state | LB Server Group state | ACTIVE |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.18 - ListLoadbalancerCertificates
6.1.18.1 - 1.3
scp-cli loadbalancer loadbalancer-certificate list
Description
get Load Balancer certificate list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID of the certificate | |
| cert_kind | Kind of certificate | |
| cn | Common Name of certificate | |
| created_at | Created At | |
| created_by | Created By | |
| modified_at | Modified At | |
| modified_by | Modified By | |
| name | Name of the certificate | |
| not_after_dt | Expiration date and time of the certificate | |
| not_before_dt | Start date and time when the certificate becomes valid | |
| state | State of the certificate |
6.1.18.2 - 1.2
scp-cli loadbalancer loadbalancer-certificate list
Description
get Load Balancer certificate 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.2 | 20260319 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID of the certificate | |
| cert_kind | Kind of certificate | |
| cn | Common Name of certificate | |
| created_at | Created At | |
| created_by | Created By | |
| modified_at | Modified At | |
| modified_by | Modified By | |
| name | Name of the certificate | |
| not_after_dt | Expiration date and time of the certificate | |
| not_before_dt | Start date and time when the certificate becomes valid | |
| state | State of the certificate |
6.1.18.3 - 1.1
scp-cli loadbalancer loadbalancer-certificate list
Description
get Load Balancer certificate 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.1 | 20260319 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID of the certificate | |
| cert_kind | Kind of certificate | |
| cn | Common Name of certificate | |
| created_at | Created At | |
| created_by | Created By | |
| modified_at | Modified At | |
| modified_by | Modified By | |
| name | Name of the certificate | |
| not_after_dt | Expiration date and time of the certificate | |
| not_before_dt | Start date and time when the certificate becomes valid | |
| state | State of the certificate |
6.1.19 - ListLoadbalancers
6.1.19.1 - 1.3
scp-cli loadbalancer loadbalancer list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--service_ip <value>]
[--subnet_id <value>]
[--layer_type <value>]
[--vpc_id <value>]
Description
get Load Balancer list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | The name of the load balancer. | - |
| state optional | **** | The state of the load balancer. | - |
| service_ip optional | string | The service IP of the load balancer. | - |
| subnet_id optional | string | Subnet ID | - |
| layer_type optional | **** | Layer type | - |
| vpc_id optional | string | VPC ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| firewall_id | Firewall ID | |
| layer_type | Layer type | |
| listener_count | The number of listeners. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the load balancer. | |
| public_nat_enabled | Public NAT Enabled Status | |
| service_ip | The service IP of the load balancer. | |
| source_nat_ip | Source NAT IP | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
6.1.19.2 - 1.2
scp-cli loadbalancer loadbalancer list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--service_ip <value>]
[--subnet_id <value>]
[--layer_type <value>]
[--vpc_id <value>]
Description
get Load Balancer list
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | The name of the load balancer. | - |
| state optional | **** | The state of the load balancer. | - |
| service_ip optional | string | The service IP of the load balancer. | - |
| subnet_id optional | string | Subnet ID | - |
| layer_type optional | **** | Layer type | - |
| vpc_id optional | string | VPC ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| firewall_id | Firewall ID | |
| layer_type | Layer type | |
| listener_count | The number of listeners. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the load balancer. | |
| public_nat_enabled | Public NAT Enabled Status | |
| service_ip | The service IP of the load balancer. | |
| source_nat_ip | Source NAT IP | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
6.1.19.3 - 1.1
scp-cli loadbalancer loadbalancer list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--service_ip <value>]
[--subnet_id <value>]
[--layer_type <value>]
[--vpc_id <value>]
Description
get Load Balancer list
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | The name of the load balancer. | - |
| state optional | **** | The state of the load balancer. | - |
| service_ip optional | string | The service IP of the load balancer. | - |
| subnet_id optional | string | Subnet ID | - |
| layer_type optional | **** | Layer type | - |
| vpc_id optional | string | VPC ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| firewall_id | Firewall ID | |
| layer_type | Layer type | |
| listener_count | The number of listeners. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the load balancer. | |
| public_nat_enabled | Public NAT Enabled Status | |
| service_ip | The service IP of the load balancer. | |
| source_nat_ip | Source NAT IP | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
6.1.20 - RemoveLbServerGroupMember
6.1.20.1 - 1.3
scp-cli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>
Description
Remove Lb Server Group Member
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | ID of Lb Server Group | - |
6.1.20.2 - 1.2
scp-cli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>
Description
Remove Lb Server Group Member
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | ID of Lb Server Group | - |
6.1.20.3 - 1.1
scp-cli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>
Description
Remove Lb Server Group Member
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | ID of Lb Server Group | - |
6.1.21 - RemoveLbServerGroupMembers
6.1.21.1 - 1.3
scp-cli loadbalancer lb-server-group-members remove
--lb_server_group_id <value>
--member_id_list <value>
Description
Remove Lb Server Group Members
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | ID of Lb Server Group | - |
| member_id_list required | array | ID list of Member | - |
6.1.21.2 - 1.2
scp-cli loadbalancer lb-server-group-members remove
--lb_server_group_id <value>
--member_id_list <value>
Description
Remove Lb Server Group Members
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | ID of Lb Server Group | - |
| member_id_list required | array | ID list of Member | - |
6.1.22 - SetLBHealthCheck
6.1.22.1 - 1.3
scp-cli loadbalancer lb-health-check update
--lb_health_check_id <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--protocol <value>]
[--request_data <value>]
[--response_code <value>]
Description
Set LB Health Check
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB Health Check ID | e3cd678b11784734bc366148aa37580e |
| description optional | string | Description | this is an lb server group |
| health_check_count optional | integer | LB Health Check count | 3 |
| health_check_interval optional | integer | LB Health Check interval | 5 |
| health_check_port optional | integer | LB Health Check port | 80 |
| health_check_timeout optional | integer | LB Health Check timeout | 5 |
| health_check_url optional | string | LB Health Check URL | /test |
| http_method optional | **** | LB Health Check HTTP Method | GET |
| protocol optional | **** | LB Health Check Protocol | TCP |
| request_data optional | string | LB Health Check Request data | username=admin&password=1234 |
| response_code optional | string | LB Health Check Response code | 200 |
6.1.22.2 - 1.2
scp-cli loadbalancer lb-health-check update
--lb_health_check_id <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--protocol <value>]
[--request_data <value>]
[--response_code <value>]
Description
Set LB Health Check
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB Health Check ID | e3cd678b11784734bc366148aa37580e |
| description optional | string | Description | this is an lb server group |
| health_check_count optional | integer | LB Health Check count | 3 |
| health_check_interval optional | integer | LB Health Check interval | 5 |
| health_check_port optional | integer | LB Health Check port | 80 |
| health_check_timeout optional | integer | LB Health Check timeout | 5 |
| health_check_url optional | string | LB Health Check URL | /test |
| http_method optional | **** | LB Health Check HTTP Method | GET |
| protocol optional | **** | LB Health Check Protocol | TCP |
| request_data optional | string | LB Health Check Request data | username=admin&password=1234 |
| response_code optional | string | LB Health Check Response code | 200 |
6.1.22.3 - 1.1
scp-cli loadbalancer lb-health-check update
--lb_health_check_id <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--protocol <value>]
[--request_data <value>]
[--response_code <value>]
Description
Set LB Health Check
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB Health Check ID | e3cd678b11784734bc366148aa37580e |
| description optional | string | Description | this is an lb server group |
| health_check_count optional | integer | LB Health Check count | 3 |
| health_check_interval optional | integer | LB Health Check interval | 5 |
| health_check_port optional | integer | LB Health Check port | 80 |
| health_check_timeout optional | integer | LB Health Check timeout | 5 |
| health_check_url optional | string | LB Health Check URL | /test |
| http_method optional | **** | LB Health Check HTTP Method | GET |
| protocol optional | **** | LB Health Check Protocol | TCP |
| request_data optional | string | LB Health Check Request data | username=admin&password=1234 |
| response_code optional | string | LB Health Check Response code | 200 |
6.1.23 - SetLbListener
6.1.23.1 - 1.3
scp-cli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <value>]
[--hsts_max_age <value>]
[--idle_timeout <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--protocol <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
Description
set loadbalancer listener
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | The ID of the listener. | - |
| condition_type optional | **** | The condition type of the listener. | - |
| description optional | string | description | - |
| hsts_max_age optional | integer | The hsts_max_age of the listener. | - |
| idle_timeout optional | integer | The idle timeout(L7) of the listener. | - |
| insert_client_ip optional | boolean | Whether the client IP should be inserted. | - |
| persistence optional | string | The persistence of the listener. | - |
| response_timeout optional | integer | The response timeout of the listener. | - |
| server_group_id optional | string | The ID of the server group. | - |
| session_duration_time optional | integer | The session duration time. | - |
| sni_certificate optional | array | The sni certificate of the listener. | '{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}' |
| support_http2 optional | boolean | Whether the HTTP 2.0 is supported | - |
| url_handler optional | array | The URL handler of the listener. | - |
| url_redirection optional | string | The URL redirect of the listener. | - |
| x_forwarded_for optional | boolean | Whether the X-Forwarded-For should be inserted. | - |
| x_forwarded_port optional | boolean | Whether the X-Forwarded-Port should be inserted. | - |
| x_forwarded_proto optional | boolean | Whether the X-Forwarded-Protocol should be inserted. | - |
| port optional | string | port | - |
| protocol optional | string | protocol | - |
| response_code optional | string | response_code | - |
| client_cert_id optional | string | Certificate id for client ssl | - |
| client_cert_level optional | string | Certificate level for client ssl | - |
| server_cert_level optional | string | Certificate level for server ssl | - |
6.1.23.2 - 1.2
scp-cli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--protocol <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
Description
set loadbalancer listener
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | The ID of the listener. | - |
| condition_type optional | **** | The condition type of the listener. | - |
| description optional | string | description | - |
| insert_client_ip optional | boolean | Whether the client IP should be inserted. | - |
| persistence optional | string | The persistence of the listener. | - |
| response_timeout optional | integer | The response timeout of the listener. | - |
| server_group_id optional | string | The ID of the server group. | - |
| session_duration_time optional | integer | The session duration time. | - |
| sni_certificate optional | array | The sni certificate of the listener. | '{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}' |
| support_http2 optional | boolean | Whether the HTTP 2.0 is supported | - |
| url_handler optional | array | The URL handler of the listener. | - |
| url_redirection optional | string | The URL redirect of the listener. | - |
| x_forwarded_for optional | boolean | Whether the X-Forwarded-For should be inserted. | - |
| x_forwarded_port optional | boolean | Whether the X-Forwarded-Port should be inserted. | - |
| x_forwarded_proto optional | boolean | Whether the X-Forwarded-Protocol should be inserted. | - |
| port optional | string | port | - |
| protocol optional | string | protocol | - |
| response_code optional | string | response_code | - |
| client_cert_id optional | string | Certificate id for client ssl | - |
| client_cert_level optional | string | Certificate level for client ssl | - |
| server_cert_level optional | string | Certificate level for server ssl | - |
6.1.23.3 - 1.1
scp-cli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--routing_action <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--protocol <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
Description
set loadbalancer listener
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | The ID of the listener. | - |
| condition_type optional | **** | The condition type of the listener. | - |
| description optional | string | description | - |
| insert_client_ip optional | boolean | Whether the client IP should be inserted. | - |
| persistence optional | string | The persistence of the listener. | - |
| response_timeout optional | integer | The response timeout of the listener. | - |
| routing_action optional | **** | The routing action of the listener. | - |
| server_group_id optional | string | The ID of the server group. | - |
| session_duration_time optional | integer | The session duration time. | - |
| sni_certificate optional | array | The sni certificate of the listener. | '{"domain_name": "", "not_after_dt": "", "sni_cert_id": ""}' |
| support_http2 optional | boolean | Whether the HTTP 2.0 is supported | - |
| url_handler optional | array | The URL handler of the listener. | - |
| url_redirection optional | string | The URL redirect of the listener. | - |
| x_forwarded_for optional | boolean | Whether the X-Forwarded-For should be inserted. | - |
| x_forwarded_port optional | boolean | Whether the X-Forwarded-Port should be inserted. | - |
| x_forwarded_proto optional | boolean | Whether the X-Forwarded-Protocol should be inserted. | - |
| port optional | string | port | - |
| protocol optional | string | protocol | - |
| response_code optional | string | response_code | - |
| client_cert_id optional | string | Certificate id for client ssl | - |
| client_cert_level optional | string | Certificate level for client ssl | - |
| server_cert_level optional | string | Certificate level for server ssl | - |
6.1.24 - SetLBServerGroup
6.1.24.1 - 1.3
scp-cli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]
Description
Set LB Server Group
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| description optional | string | Description | this is an lb server group |
| lb_health_check_id optional | string | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method optional | **** | LB Method | ROUND_ROBIN |
6.1.24.2 - 1.2
scp-cli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]
Description
Set LB Server Group
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| description optional | string | Description | this is an lb server group |
| lb_health_check_id optional | string | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method optional | **** | LB Method | ROUND_ROBIN |
6.1.24.3 - 1.1
scp-cli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]
Description
Set LB Server Group
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| description optional | string | Description | this is an lb server group |
| lb_health_check_id optional | string | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method optional | **** | LB Method | ROUND_ROBIN |
6.1.25 - SetLbServerGroupMember
6.1.25.1 - 1.3
scp-cli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]
Description
Set Lb Server Group Member
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | ID of Lb Server Group | - |
| member_port optional | integer | Protocol port of Member | 80 |
| member_state optional | **** | Member State of Member | - |
| member_weight optional | integer | Weight of Member | 100 |
6.1.25.2 - 1.2
scp-cli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]
Description
Set Lb Server Group Member
State ACTIVE (DEPRECATED)
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | ID of Lb Server Group | - |
| member_port optional | integer | Protocol port of Member | 80 |
| member_state optional | **** | Member State of Member | - |
| member_weight optional | integer | Weight of Member | 100 |
6.1.25.3 - 1.1
scp-cli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]
Description
Set Lb Server Group Member
State ACTIVE (DEPRECATED)
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | ID of Lb Server Group | - |
| member_port optional | integer | Protocol port of Member | 80 |
| member_state optional | **** | Member State of Member | - |
| member_weight optional | integer | Weight of Member | 100 |
6.1.26 - SetLoadbalancer
6.1.26.1 - 1.3
scp-cli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>
Description
Set Load Balancer
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
| description required | string | description | - |
6.1.26.2 - 1.2
scp-cli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>
Description
Set 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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
| description required | string | description | - |
6.1.26.3 - 1.1
scp-cli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>
Description
Set 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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
| description required | string | description | - |
6.1.27 - ShowLBHealthCheck
6.1.27.1 - 1.3
scp-cli loadbalancer lb-health-check read
--lb_health_check_id <value>
Description
Get LB Health Check
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB Health Check ID | e3cd678b11784734bc366148aa37580e |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| health_check_count | LB Health Check count | 3 |
| health_check_interval | LB Health Check interval | 5 |
| health_check_port | LB Health Check port | 80 |
| health_check_timeout | LB Health Check timeout | 5 |
| health_check_type | LB Health Check type | DEFAULT |
| health_check_url | LB Health Check URL | /test |
| http_method | LB Health Check HTTP Method | GET |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| request_data | LB Health Check Request data | username=admin&password=1234 |
| response_code | LB Health Check Response code | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.27.2 - 1.2
scp-cli loadbalancer lb-health-check read
--lb_health_check_id <value>
Description
Get LB Health Check
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB Health Check ID | e3cd678b11784734bc366148aa37580e |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| health_check_count | LB Health Check count | 3 |
| health_check_interval | LB Health Check interval | 5 |
| health_check_port | LB Health Check port | 80 |
| health_check_timeout | LB Health Check timeout | 5 |
| health_check_type | LB Health Check type | DEFAULT |
| health_check_url | LB Health Check URL | /test |
| http_method | LB Health Check HTTP Method | GET |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| request_data | LB Health Check Request data | username=admin&password=1234 |
| response_code | LB Health Check Response code | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.27.3 - 1.1
scp-cli loadbalancer lb-health-check read
--lb_health_check_id <value>
Description
Get LB Health Check
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB Health Check ID | e3cd678b11784734bc366148aa37580e |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| health_check_count | LB Health Check count | 3 |
| health_check_interval | LB Health Check interval | 5 |
| health_check_port | LB Health Check port | 80 |
| health_check_timeout | LB Health Check timeout | 5 |
| health_check_type | LB Health Check type | DEFAULT |
| health_check_url | LB Health Check URL | /test |
| http_method | LB Health Check HTTP Method | GET |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Health Check name | Test-LbMonitor-01 |
| protocol | LB Health Check Protocol | TCP |
| request_data | LB Health Check Request data | username=admin&password=1234 |
| response_code | LB Health Check Response code | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.28 - ShowLbListener
6.1.28.1 - 1.3
scp-cli loadbalancer lb-listener show
--listener_id <value>
Description
show LB listener
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | The ID of the listener. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| condition_type | The condition type of the listener. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| hsts_max_age | The hsts_max_age of the listener. | |
| https_redirection | The https redirection of the listener. | |
| idle_timeout | The idle timeout(L7) of the listener. | |
| insert_client_ip | Whether the client IP should be inserted. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the listener. | |
| persistence | The persistence of the listener. | |
| protocol | The protocol of the listener. | |
| response_timeout | The response timeout of the listener. | |
| routing_action | The routing action of the listener. | |
| server_group_id | The ID of the server group. | |
| server_group_name | The Name of the server group. | |
| service_port | The port of the listener. | |
| session_duration_time | The session duration time. | |
| sni_certificate | The sni certificate of the listener. | |
| ssl_certificate | The ssl certificate of the listener. | |
| state | The State of the listener. | |
| support_http2 | Whether the HTTP 2.0 is supported | |
| url_handler | The URL handler of the listener. | |
| url_redirection | The URL redirect of the listener. | |
| x_forwarded_for | Whether the X-Forwarded-For should be inserted. | |
| x_forwarded_port | Whether the X-Forwarded-Port should be inserted. | |
| x_forwarded_proto | Whether the X-Forwarded-Protocol should be inserted. |
6.1.28.2 - 1.2
scp-cli loadbalancer lb-listener show
--listener_id <value>
Description
show LB listener
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | The ID of the listener. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| condition_type | The condition type of the listener. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| https_redirection | The https redirection of the listener. | |
| insert_client_ip | Whether the client IP should be inserted. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the listener. | |
| persistence | The persistence of the listener. | |
| protocol | The protocol of the listener. | |
| response_timeout | The response timeout of the listener. | |
| routing_action | The routing action of the listener. | |
| server_group_id | The ID of the server group. | |
| server_group_name | The Name of the server group. | |
| service_port | The port of the listener. | |
| session_duration_time | The session duration time. | |
| sni_certificate | The sni certificate of the listener. | |
| ssl_certificate | The ssl certificate of the listener. | |
| state | The State of the listener. | |
| support_http2 | Whether the HTTP 2.0 is supported | |
| url_handler | The URL handler of the listener. | |
| url_redirection | The URL redirect of the listener. | |
| x_forwarded_for | Whether the X-Forwarded-For should be inserted. | |
| x_forwarded_port | Whether the X-Forwarded-Port should be inserted. | |
| x_forwarded_proto | Whether the X-Forwarded-Protocol should be inserted. |
6.1.28.3 - 1.1
scp-cli loadbalancer lb-listener show
--listener_id <value>
Description
show LB listener
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | The ID of the listener. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| condition_type | The condition type of the listener. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| https_redirection | The https redirection of the listener. | |
| insert_client_ip | Whether the client IP should be inserted. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the listener. | |
| persistence | The persistence of the listener. | |
| protocol | The protocol of the listener. | |
| response_timeout | The response timeout of the listener. | |
| routing_action | The routing action of the listener. | |
| server_group_id | The ID of the server group. | |
| server_group_name | The Name of the server group. | |
| service_port | The port of the listener. | |
| session_duration_time | The session duration time. | |
| sni_certificate | The sni certificate of the listener. | |
| ssl_certificate | The ssl certificate of the listener. | |
| state | The State of the listener. | |
| support_http2 | Whether the HTTP 2.0 is supported | |
| url_handler | The URL handler of the listener. | |
| url_redirection | The URL redirect of the listener. | |
| x_forwarded_for | Whether the X-Forwarded-For should be inserted. | |
| x_forwarded_port | Whether the X-Forwarded-Port should be inserted. | |
| x_forwarded_proto | Whether the X-Forwarded-Protocol should be inserted. |
6.1.29 - ShowLBServerGroup
6.1.29.1 - 1.3
scp-cli loadbalancer lb-server-group read
--lb_server_group_id <value>
Description
Show LB Server Group
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| lb_health_check_id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method | LB Method | ROUND_ROBIN |
| lb_name | Load Balancer name | Test-LB-01 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | ServerGroup01 |
| protocol | Protocol | TCP |
| state | LB Server Group state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.29.2 - 1.2
scp-cli loadbalancer lb-server-group read
--lb_server_group_id <value>
Description
Show LB Server Group
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| lb_health_check_id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method | LB Method | ROUND_ROBIN |
| lb_name | Load Balancer name | Test-LB-01 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | ServerGroup01 |
| protocol | Protocol | TCP |
| state | LB Server Group state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.29.3 - 1.1
scp-cli loadbalancer lb-server-group read
--lb_server_group_id <value>
Description
Show LB Server Group
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB Server Group ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | this is an lb server group |
| lb_health_check_id | LB Health Check ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method | LB Method | ROUND_ROBIN |
| lb_name | Load Balancer name | Test-LB-01 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB Server Group name | ServerGroup01 |
| protocol | Protocol | TCP |
| state | LB Server Group state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
6.1.30 - ShowLbServerGroupMember
6.1.30.1 - 1.3
scp-cli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>
Description
Show Lb Server Group Member
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | ID of Lb Server Group | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| lb_server_group_id | ID of Lb Server Group | |
| member_ip | IP of Member | |
| member_port | Protocol port of Member | |
| member_state | Member State of Member | |
| member_weight | Weight of Member | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of Member | |
| object_id | Object ID of Member | |
| object_type | Object Type of Member | |
| state | State of Member | |
| subnet_id | ID of Subnet | |
| uuid | UUID of Member |
6.1.30.2 - 1.2
scp-cli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>
Description
Show Lb Server Group Member
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | ID of Lb Server Group | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| lb_server_group_id | ID of Lb Server Group | |
| member_ip | IP of Member | |
| member_port | Protocol port of Member | |
| member_state | Member State of Member | |
| member_weight | Weight of Member | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of Member | |
| object_id | Object ID of Member | |
| object_type | Object Type of Member | |
| state | State of Member | |
| subnet_id | ID of Subnet | |
| uuid | UUID of Member |
6.1.30.3 - 1.1
scp-cli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>
Description
Show Lb Server Group Member
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | ID of Lb Server Group | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| lb_server_group_id | ID of Lb Server Group | |
| member_ip | IP of Member | |
| member_port | Protocol port of Member | |
| member_state | Member State of Member | |
| member_weight | Weight of Member | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of Member | |
| object_id | Object ID of Member | |
| object_type | Object Type of Member | |
| state | State of Member | |
| subnet_id | ID of Subnet | |
| uuid | UUID of Member |
6.1.31 - ShowLoadbalancer
6.1.31.1 - 1.3
scp-cli loadbalancer loadbalancer show
--loadbalancer_id <value>
Description
show Load Balancer
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | The account ID of the load balancer. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| firewall_id | Firewall ID | |
| health_check_ip | Health check IP | |
| layer_type | Layer type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | name | |
| public_nat_enabled | Public NAT Enabled Status | |
| service_ip | The service IP of the load balancer. | |
| source_nat_ip | Source NAT IP | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
6.1.31.2 - 1.2
scp-cli loadbalancer loadbalancer show
--loadbalancer_id <value>
Description
show 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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | The account ID of the load balancer. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| firewall_id | Firewall ID | |
| health_check_ip | Health check IP | |
| layer_type | Layer type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | name | |
| public_nat_enabled | Public NAT Enabled Status | |
| service_ip | The service IP of the load balancer. | |
| source_nat_ip | Source NAT IP | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
6.1.31.3 - 1.1
scp-cli loadbalancer loadbalancer show
--loadbalancer_id <value>
Description
show 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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | The account ID of the load balancer. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| firewall_id | Firewall ID | |
| health_check_ip | Health check IP | |
| layer_type | Layer type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | name | |
| public_nat_enabled | Public NAT Enabled Status | |
| service_ip | The service IP of the load balancer. | |
| source_nat_ip | Source NAT IP | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
6.1.32 - ShowLoadbalancerCertificate
6.1.32.1 - 1.3
scp-cli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>
Description
show Load Balancer certificate
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_certificate_id required | string | The ID of the certificate | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | The project ID of the certificate | |
| cert_body | The body of the certificate | |
| cert_chain | The chain of the certificate | |
| cert_kind | ||
| cn | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | ||
| not_after_dt | ||
| not_before_dt | ||
| organization | The organization of the certificate | |
| private_key | The private key of the certificate | |
| state |
6.1.32.2 - 1.2
scp-cli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>
Description
show Load Balancer certificate
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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_certificate_id required | string | The ID of the certificate | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | The project ID of the certificate | |
| cert_body | The body of the certificate | |
| cert_chain | The chain of the certificate | |
| cert_kind | ||
| cn | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | ||
| not_after_dt | ||
| not_before_dt | ||
| organization | The organization of the certificate | |
| private_key | The private key of the certificate | |
| state |
6.1.32.3 - 1.1
scp-cli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>
Description
show Load Balancer certificate
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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_certificate_id required | string | The ID of the certificate | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | The project ID of the certificate | |
| cert_body | The body of the certificate | |
| cert_chain | The chain of the certificate | |
| cert_kind | ||
| cn | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | ||
| not_after_dt | ||
| not_before_dt | ||
| organization | The organization of the certificate | |
| private_key | The private key of the certificate | |
| state |
6.1.33 - ShowLoadbalancerPrivateNatIp
6.1.33.1 - 1.3
scp-cli loadbalancer loadbalancer-private-nat-ip show
--loadbalancer_id <value>
Description
Show Load Balancer Private NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| external_ip_address | external_ip_address | |
| internal_ip_address | internal_ip_address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_ip_id | private_nat_ip_id | |
| state | state |
6.1.34 - ShowLoadbalancerPublicNatIp
6.1.34.1 - 1.3
scp-cli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>
Description
Show Load Balancer Public NAT IP
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| external_ip_address | Static Nat External Ip Address | |
| publicip_id | Publicip ID | |
| state | Static Nat State |
6.1.34.2 - 1.2
scp-cli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>
Description
Show Load Balancer Public 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.2 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| external_ip_address | Static Nat External Ip Address | |
| publicip_id | Publicip ID | |
| state | Static Nat State |
6.1.34.3 - 1.1
scp-cli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>
Description
Show Load Balancer Public 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.1 | 20260319 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| external_ip_address | Static Nat External Ip Address | |
| publicip_id | Publicip ID | |
| state | Static Nat State |
7 - Security Group
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Security Group service and how to call CLI. The output is formatted as a JSON string
Version
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 | - |
7.1 - CLIs
7.1.1 - Create Security Group
7.1.1.1 - 1.0
scp-cli security-group security-group create
--name <value>
[--description <value>]
[--loggable <value>]
[--tags <value>]
Description
Create Security Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Security Group Name | - |
| description optional | string | Security Group Description | - |
| loggable optional | boolean | Security Group Loggable | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group ID | |
| account_id | Security Group Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Description | |
| loggable | Security Group Loggable | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Security Group Name | |
| rule_count | Security Group Rule Count | |
| state | Security Group State |
7.1.2 - Create Security Group Rule
7.1.2.1 - 1.0
scp-cli security-group security-group-rule create
--security_group_id <value>
--direction <value>
[--description <value>]
[--ethertype <value>]
[--port_range_max <value>]
[--port_range_min <value>]
[--protocol <value>]
[--remote_group_id <value>]
[--remote_ip_prefix <value>]
Description
Create Security Group rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_id required | string | Security Group ID | - |
| direction required | string | Security Group Rule Direction (Ingress, Egress) | - |
| description optional | string | Security Group Rule Description | - |
| ethertype optional | string | Security Group Rule Ethertype (IPV4, IPV6) | - |
| port_range_max optional | integer | Security Group Rule Port Range Max | - |
| port_range_min optional | integer | Security Group Rule Port Range Min | - |
| protocol optional | string | Security Group Rule Protocol | - |
| remote_group_id optional | string | Security Group Rule Remote Group ID | - |
| remote_ip_prefix optional | string | Security Group Rule Remote IP Address | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Rule Description | |
| direction | Security Group Rule Direction (Ingress, Egress) | |
| ethertype | Security Group Rule Ethertype (IPV4, IPV6) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| port_range_max | Security Group Rule Port Range Max | |
| port_range_min | Security Group Rule Port Range Min | |
| protocol | Security Group Rule Protocol | |
| remote_group_id | Security Group Rule Remote Group ID | |
| remote_group_name | Security Group Rule Remote Group Name | |
| remote_ip_prefix | Security Group Rule Remote IP Address | |
| security_group_id | Security Group ID |
7.1.3 - Delete Security Group
7.1.3.1 - 1.0
scp-cli security-group security-group delete
--security_group_id <value>
Description
Delete Security Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_id required | string | Security Group ID | - |
7.1.4 - Delete Security Group Rule
7.1.4.1 - 1.0
scp-cli security-group security-group-rule delete
--security_group_rule_id <value>
Description
Delete Security Group rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_rule_id required | string | Security Group Rule ID | - |
7.1.5 - List Security Group Rules
7.1.5.1 - 1.0
scp-cli security-group security-group-rule list
--security_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--remote_ip_prefix <value>]
[--remote_group_id <value>]
[--description <value>]
[--direction <value>]
[--service <value>]
Description
Get Security Group rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_id required | string | Security Group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Security Group Rule ID | - |
| remote_ip_prefix optional | string | Security Group Rule Remote IP Address | - |
| remote_group_id optional | string | Security Group Rule Remote Group ID | - |
| description optional | string | Security Group Rule Description | - |
| direction optional | string | Security Group Rule Direction (Ingress, Egress) | - |
| service optional | string | Security Group Rule Service | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Rule Description | |
| direction | Security Group Rule Direction (Ingress, Egress) | |
| ethertype | Security Group Rule Ethertype (IPV4, IPV6) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| port_range_max | Security Group Rule Port Range Max | |
| port_range_min | Security Group Rule Port Range Min | |
| protocol | Security Group Rule Protocol | |
| remote_group_id | Security Group Rule Remote Group ID | |
| remote_group_name | Security Group Rule Remote Group Name | |
| remote_ip_prefix | Security Group Rule Remote IP Address | |
| security_group_id | Security Group ID |
7.1.6 - List Security Groups
7.1.6.1 - 1.0
scp-cli security-group security-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
Description
Get Security Group list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Security Group ID | - |
| name optional | string | Security Group Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group ID | |
| account_id | Security Group Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Description | |
| loggable | Security Group Loggable | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Security Group Name | |
| rule_count | Security Group Rule Count | |
| state | Security Group State |
7.1.7 - Set Security Group
7.1.7.1 - 1.0
scp-cli security-group security-group set
--security_group_id <value>
[--description <value>]
[--loggable <value>]
Description
Set Security Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_id required | string | Security Group ID | - |
| description optional | string | Security Group Description | - |
| loggable optional | boolean | Security Group Loggable | - |
7.1.8 - Show Security Group
7.1.8.1 - 1.0
scp-cli security-group security-group show
--security_group_id <value>
Description
Show Security Group.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_id required | string | Security Group ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group ID | |
| account_id | Security Group Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Description | |
| loggable | Security Group Loggable | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Security Group Name | |
| rule_count | Security Group Rule Count | |
| state | Security Group State |
7.1.9 - Show Security Group Rule
7.1.9.1 - 1.0
scp-cli security-group security-group-rule show
--security_group_rule_id <value>
[--fields <value>]
Description
Show Security Group rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_rule_id required | string | Security Group Rule ID | - |
| fields optional | array | Field Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Rule Description | |
| direction | Security Group Rule Direction (Ingress, Egress) | |
| ethertype | Security Group Rule Ethertype (IPV4, IPV6) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| port_range_max | Security Group Rule Port Range Max | |
| port_range_min | Security Group Rule Port Range Min | |
| protocol | Security Group Rule Protocol | |
| remote_group_id | Security Group Rule Remote Group ID | |
| remote_group_name | Security Group Rule Remote Group Name | |
| remote_ip_prefix | Security Group Rule Remote IP Address | |
| security_group_id | Security Group ID |
8 - VPC
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of VPC service and how to call CLI. The output is formatted as a JSON string
Version
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 | 20261130 |
| 1.0 | DEPRECATED | 20251231 |
8.1 - CLIs
8.1.1 - Add VPC CIDR
8.1.1.1 - 1.2
scp-cli vpc vpc cidr create
--vpc_id <value>
--cidr <value>
Description
Add VPC CIDR.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
| cidr required | string | VPC Cidr | 192.167.0.0/18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr_count | Cidr Count | 20 |
| cidrs | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
8.1.2 - Approval VPC Peering
8.1.2.1 - 1.2
scp-cli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>
Description
Approval VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| type required | string | Approval Type | - |
8.1.2.2 - 1.1
scp-cli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>
Description
Approval VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| type required | string | Approval Type | - |
8.1.3 - Approve PrivateLink Endpoint
8.1.3.1 - 1.2
scp-cli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>
Description
Approve PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | APPROVE |
8.1.3.2 - 1.1
scp-cli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>
Description
Approve PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | APPROVE |
8.1.4 - Connect PrivateLink Endpoint
8.1.4.1 - 1.2
scp-cli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>
Description
Connect PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | DISCONNECT |
8.1.4.2 - 1.1
scp-cli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>
Description
Connect PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | DISCONNECT |
8.1.5 - Connect Subnet VIP Port
8.1.5.1 - 1.2
scp-cli vpc subnet vip port create
--vip_id <value>
--subnet_id <value>
--port_id <value>
Description
Connect Subnet Vip Port
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| port_id required | string | Port ID | 35268a9f2eda4cde83b1d85c1f61f67d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Connected Port Id | 35268a9f2eda4cde83b1d85c1f61f67d |
| subnet_vip_id | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
8.1.6 - Create Internet Gateway
8.1.6.1 - 1.2
scp-cli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Create Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Internet Gateway Type | - |
| description optional | string | Description | Internet Gateway Description |
| firewall_enabled optional | boolean | Firewall Enable | - |
| firewall_loggable optional | boolean | Firewall Loggable | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.6.2 - 1.1
scp-cli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Create Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Internet Gateway Type | - |
| description optional | string | Description | Internet Gateway Description |
| firewall_enabled optional | boolean | Firewall Enable | - |
| firewall_loggable optional | boolean | Firewall Loggable | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.6.3 - 1.0
scp-cli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Create Internet Gateway.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Internet Gateway Type | - |
| description optional | string | Description | Internet Gateway Description |
| firewall_enabled optional | boolean | Firewall Enable | - |
| firewall_loggable optional | boolean | Firewall Loggable | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.7 - Create NAT Gateway
8.1.7.1 - 1.2
scp-cli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]
Description
Create NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet CIDR | 023c57b14f11483689338d085e061492 |
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.7.2 - 1.1
scp-cli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]
Description
Create NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet CIDR | 023c57b14f11483689338d085e061492 |
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.7.3 - 1.0
scp-cli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet CIDR | 023c57b14f11483689338d085e061492 |
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.8 - Create Port
8.1.8.1 - 1.2
scp-cli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]
Description
Create port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | - |
| name required | string | Port Name | portName |
| description optional | string | Description | Port Description |
| fixed_ip_address optional | string | Fixed IP | - |
| security_groups optional | array | Security Group List | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| security_groups | Security Group List | |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| virtual_ip_addresses | Virtual IP Address | |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
8.1.8.2 - 1.1
scp-cli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]
Description
Create port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | - |
| name required | string | Port Name | portName |
| description optional | string | Description | Port Description |
| fixed_ip_address optional | string | Fixed IP | - |
| security_groups optional | array | Security Group List | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| security_groups | Security Group List | |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
8.1.8.3 - 1.0
scp-cli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]
Description
Create port.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | - |
| name required | string | Port Name | portName |
| description optional | string | Description | Port Description |
| fixed_ip_address optional | string | Fixed IP | - |
| security_groups optional | array | Security Group List | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| security_groups | Security Group List | |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
8.1.9 - Create Private NAT
8.1.9.1 - 1.2
scp-cli vpc private-nat create
--service_type <value>
--service_resource_id <value>
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Create Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_type required | string | Private NAT connected Service Type | DIRECT_CONNECT |
| service_resource_id required | string | Private NAT connected Service Resource ID | 3f342bf9a557405b997c2cf48c89cbc2 |
| name required | string | Private NAT Name | PrivateNatName |
| cidr required | string | Private NAT IP range | 192.167.0.0/24 |
| description optional | string | Description | PrivateNat Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| service_resource_id | Private NAT connected Service Resource ID | 3f342bf9a557405b997c2cf48c89cbc2 |
| service_resource_name | Private NAT connected Service Resource Name | PrivateNatName |
| service_type | Private NAT connected Service Type | DIRECT_CONNECT |
| state | Private NAT State | ACTIVE |
8.1.9.2 - 1.1
scp-cli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Create Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Private NAT Name | PrivateNatName |
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| cidr required | string | Private NAT IP range | 192.167.0.0/24 |
| description optional | string | Description | PrivateNat Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.9.3 - 1.0
scp-cli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Private NAT Name | PrivateNatName |
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| cidr required | string | Private NAT IP range | 192.167.0.0/24 |
| description optional | string | Description | PrivateNat Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.10 - Create Private NAT IP
8.1.10.1 - 1.2
scp-cli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>
Description
Create Private NAT IP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| ip_address required | string | Private NAT IP Address | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
8.1.10.2 - 1.1
scp-cli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>
Description
Create Private NAT IP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| ip_address required | string | Private NAT IP Address | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
8.1.10.3 - 1.0
scp-cli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| ip_address required | string | Private NAT IP Address | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
8.1.11 - Create PrivateLink Endpoint
8.1.11.1 - 1.2
scp-cli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name required | string | PrivateLink Endpoint Name | EndpointName |
| endpoint_ip_address required | string | Endpoint IP Address | 192.167.1.5 |
| description optional | string | Description | PrivateLink Endpoint Description |
| privatelink_service_id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids optional | array | Security Group List | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Endpoint Description |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| endpoint_ip_port_id | Endpoint IP Port ID | b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids | Security Group List | [‘17776b52-0a64-440d-9e93-b4fc37be935b’] |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.11.2 - 1.1
scp-cli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name required | string | PrivateLink Endpoint Name | EndpointName |
| endpoint_ip_address required | string | Endpoint IP Address | 192.167.1.5 |
| description optional | string | Description | PrivateLink Endpoint Description |
| privatelink_service_id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids optional | array | Security Group List | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Endpoint Description |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| endpoint_ip_port_id | Endpoint IP Port ID | b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids | Security Group List | [‘17776b52-0a64-440d-9e93-b4fc37be935b’] |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.12 - Create PrivateLink Service
8.1.12.1 - 1.2
scp-cli vpc privatelink-service create
--subnet_id <value>
--service_ip_address <value>
--name <value>
--connected_resource_type <value>
--approval_type <value>
[--connected_resource_id <value>]
[--connected_resource_ip_address <value>]
[--description <value>]
[--high_speed_transfer <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| service_ip_address required | string | Service IP Address | 192.167.0.5 |
| name required | string | PrivateLink Service Name | ServiceName |
| connected_resource_type required | string | Connected Resource Type | LB |
| approval_type required | string | PrivateLink Service Approval Type | AUTO |
| connected_resource_id optional | string | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address optional | string | Connected Resource IP Address | 192.167.0.10 |
| description optional | string | Description | PrivateLink Service Description |
| high_speed_transfer optional | boolean | High Speed Data Transfer Use | False |
| security_group_ids optional | array | Security Group List | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Service Description |
| high_speed_transfer | High Speed Data Transfer Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| security_group_ids | Security Group List | [‘00b6af37-73b5-4de2-b080-c295a1a0382e’] |
| service_ip_address | Service IP Address | 192.167.0.5 |
| service_ip_port_id | Service IP Port ID | d21a4b81-f52a-43a8-b985-341e763458bb |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.12.2 - 1.1
scp-cli vpc privatelink-service create
--subnet_id <value>
--service_ip_address <value>
--name <value>
--connected_resource_type <value>
--approval_type <value>
[--connected_resource_id <value>]
[--connected_resource_ip_address <value>]
[--description <value>]
[--high_speed_transfer <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| service_ip_address required | string | Service IP Address | 192.167.0.5 |
| name required | string | PrivateLink Service Name | ServiceName |
| connected_resource_type required | string | Connected Resource Type | LB |
| approval_type required | string | PrivateLink Service Approval Type | AUTO |
| connected_resource_id optional | string | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address optional | string | Connected Resource IP Address | 192.167.0.10 |
| description optional | string | Description | PrivateLink Service Description |
| high_speed_transfer optional | boolean | High Speed Data Transfer Use | False |
| security_group_ids optional | array | Security Group List | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Service Description |
| high_speed_transfer | High Speed Data Transfer Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| security_group_ids | Security Group List | [‘00b6af37-73b5-4de2-b080-c295a1a0382e’] |
| service_ip_address | Service IP Address | 192.167.0.5 |
| service_ip_port_id | Service IP Port ID | d21a4b81-f52a-43a8-b985-341e763458bb |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.13 - Create PublicIP
8.1.13.1 - 1.2
scp-cli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]
Description
Create PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type required | string | PublicIP Type | IGW |
| description optional | string | PublicIP Description | Public IP Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
8.1.13.2 - 1.1
scp-cli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]
Description
Create PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type required | string | PublicIP Type | IGW |
| description optional | string | PublicIP Description | Public IP Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
8.1.13.3 - 1.0
scp-cli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| type required | string | PublicIP Type | IGW |
| description optional | string | PublicIP Description | Public IP Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
8.1.14 - Create Subnet
8.1.14.1 - 1.2
scp-cli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--gateway_ip_address <value>]
[--host_routes <value>]
[--tags <value>]
Description
Create subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Subnet Type | - |
| name required | string | Subnet Name | subnetName |
| cidr required | string | Subnet Cidr | 192.167.1.0/24 |
| allocation_pools optional | array | Allocation Pools | [ |
| description optional | string | Description | Subnet Description |
| dns_nameservers optional | array | DNS Name Servers | [ |
| gateway_ip_address optional | string | Gateway IP Address | 192.167.1.1 |
| host_routes optional | array | Host Routes | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dhcp_ip_address | DHCP IP Address | |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.14.2 - 1.1
scp-cli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--host_routes <value>]
[--tags <value>]
Description
Create subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Subnet Type | - |
| name required | string | Subnet Name | subnetName |
| cidr required | string | Subnet Cidr | 192.167.1.0/24 |
| allocation_pools optional | array | Allocation Pools | [ |
| description optional | string | Description | Subnet Description |
| dns_nameservers optional | array | DNS Name Servers | [ |
| host_routes optional | array | Host Routes | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.14.3 - 1.0
scp-cli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--host_routes <value>]
[--tags <value>]
Description
Create subnet.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Subnet Type | - |
| name required | string | Subnet Name | subnetName |
| cidr required | string | Subnet Cidr | 192.167.1.0/24 |
| allocation_pools optional | array | Allocation Pools | [ |
| description optional | string | Description | Subnet Description |
| dns_nameservers optional | array | DNS Name Servers | [ |
| host_routes optional | array | Host Routes | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.15 - Create Subnet VIP
8.1.15.1 - 1.2
scp-cli vpc subnet vip create
--subnet_id <value>
[--description <value>]
[--virtual_ip_address <value>]
Description
Create Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | Subnet VIP Description |
| virtual_ip_address optional | string | Virtual IP Address | 192.168.20.6 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| connected_ports | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet VIP Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| static_nat | Static NAT Info | |
| subnet_id | Subnet ID | 023c57b14f11483689338d085e061492 |
| vip_port_id | Vip Port Id | 35268a9f2eda4cde83b1d85c1f61f67d |
| virtual_ip_address | Virtual IP Address | 192.168.20.6 |
8.1.16 - Create Subnet VIP NAT IP
8.1.16.1 - 1.2
scp-cli vpc subnet vip nat create
--vip_id <value>
--subnet_id <value>
--publicip_id <value>
--nat_type <value>
Description
Create Subnet Vip Nat Ip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| publicip_id required | string | Publicip ID | 12f56e27070248a6a240a497e43fbe18 |
| nat_type required | string | NAT Type | PUBLIC |
Responses
| Name | Description | Example |
|---|---|---|
| id | Static Nat Id | 0009e49548154745948e9722adefbf40 |
| publicip_id | Publicip ID | 12f56e27070248a6a240a497e43fbe18 |
| state | Static Nat State | ACTIVE |
8.1.17 - Create Transit Gateway
8.1.17.1 - 1.2
scp-cli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]
Description
Create Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Transit Gateway Name | TransitGatewayName |
| description optional | string | Description | TransitGateway Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_connection_state | Firewall Connection State | INACTIVE |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.17.2 - 1.1
scp-cli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]
Description
Create Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Transit Gateway Name | TransitGatewayName |
| description optional | string | Description | TransitGateway Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.17.3 - 1.0
scp-cli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Transit Gateway Name | TransitGatewayName |
| description optional | string | Description | TransitGateway Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.18 - Create Transit Gateway Firewall
8.1.18.1 - 1.2
scp-cli vpc transit-gateway-firewall create
--transit_gateway_id <value>
--product_type <value>
Description
Create Transit Gateway Firewall.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| product_type required | string | Fw Product Type | TGW_DGW |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_connection_state | Firewall Connection State | INACTIVE |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.19 - Create Transit Gateway Firewall Connection
8.1.19.1 - 1.2
scp-cli vpc transit-gateway-firewall-connection create
--transit_gateway_id <value>
Description
Create Transit Gateway Firewall Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_connection_state | Firewall Connection State | INACTIVE |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.20 - Create Transit Gateway Rule
8.1.20.1 - 1.2
scp-cli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| tgw_connection_vpc_id required | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| destination_type required | string | Destination Type | VPC |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
8.1.20.2 - 1.1
scp-cli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| tgw_connection_vpc_id required | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| destination_type required | string | Destination Type | VPC |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
8.1.20.3 - 1.0
scp-cli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Rule.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| tgw_connection_vpc_id required | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| destination_type required | string | Destination Type | VPC |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
8.1.21 - Create Transit Gateway Uplink Rule
8.1.21.1 - 1.2
scp-cli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Uplink Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| destination_type required | string | Destination Type | ON_PREMISE |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_type | Destination Type | ON_PREMISE |
| state | State | ACTIVE |
8.1.21.2 - 1.1
scp-cli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Uplink Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| destination_type required | string | Destination Type | ON_PREMISE |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_type | Destination Type | ON_PREMISE |
| state | State | ACTIVE |
8.1.21.3 - 1.0
scp-cli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| destination_type required | string | Destination Type | ON_PREMISE |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_type | Destination Type | ON_PREMISE |
| state | State | ACTIVE |
8.1.22 - Create Transit Gateway VPC Connection
8.1.22.1 - 1.2
scp-cli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>
Description
Create Transit Gateway VPC Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.22.2 - 1.1
scp-cli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>
Description
Create Transit Gateway VPC Connection.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.22.3 - 1.0
scp-cli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.23 - Create VPC
8.1.23.1 - 1.2
scp-cli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Create VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | VPC Name | vpcName |
| cidr required | string | VPC Cidr | 192.167.0.0/18 |
| description optional | string | Description | VPC Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr_count | Cidr Count | 20 |
| cidrs | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
8.1.23.2 - 1.1
scp-cli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Create VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | VPC Name | vpcName |
| cidr required | string | VPC Cidr | 192.167.0.0/18 |
| description optional | string | Description | VPC Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
8.1.23.3 - 1.0
scp-cli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | VPC Name | vpcName |
| cidr required | string | VPC Cidr | 192.167.0.0/18 |
| description optional | string | Description | VPC Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
8.1.24 - Create VPC Endpoint
8.1.24.1 - 1.2
scp-cli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_type required | string | VPC Endpoint Resource Type | FS |
| resource_key required | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_info required | string | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| name required | string | VPC Endpoint Name | VpcEndpointName |
| endpoint_ip_address required | string | VPC Endpoint IP Address | 192.167.0.5 |
| description optional | string | Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.24.2 - 1.1
scp-cli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_type required | string | VPC Endpoint Resource Type | FS |
| resource_key required | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_info required | string | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| name required | string | VPC Endpoint Name | VpcEndpointName |
| endpoint_ip_address required | string | VPC Endpoint IP Address | 192.167.0.5 |
| description optional | string | Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.24.3 - 1.0
scp-cli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Endpoint.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_type required | string | VPC Endpoint Resource Type | FS |
| resource_key required | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_info required | string | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| name required | string | VPC Endpoint Name | VpcEndpointName |
| endpoint_ip_address required | string | VPC Endpoint IP Address | 192.167.0.5 |
| description optional | string | Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.25 - Create VPC Peering
8.1.25.1 - 1.2
scp-cli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| requester_vpc_id required | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| name required | string | VPC Peering Name | vpcPeeringName |
| approver_vpc_id required | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_account_id required | string | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description optional | string | Description | vpcPeering Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
8.1.25.2 - 1.1
scp-cli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| requester_vpc_id required | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| name required | string | VPC Peering Name | vpcPeeringName |
| approver_vpc_id required | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_account_id required | string | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description optional | string | Description | vpcPeering Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
8.1.25.3 - 1.0
scp-cli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Peering.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| requester_vpc_id required | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| name required | string | VPC Peering Name | vpcPeeringName |
| approver_vpc_id required | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_account_id required | string | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description optional | string | Description | vpcPeering Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
8.1.26 - Create Vpc Peering Rule
8.1.26.1 - 1.2
scp-cli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]
Description
Create a VPC Peering Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| destination_vpc_type required | string | Destination VPC Type | - |
| destination_cidr required | string | Destination CIDR | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
8.1.26.2 - 1.1
scp-cli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]
Description
Create a VPC Peering Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| destination_vpc_type required | string | Destination VPC Type | - |
| destination_cidr required | string | Destination CIDR | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
8.1.26.3 - 1.0
scp-cli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]
Description
Create a VPC Peering Rule.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| destination_vpc_type required | string | Destination VPC Type | - |
| destination_cidr required | string | Destination CIDR | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
8.1.27 - Delete Internet Gateway
8.1.27.1 - 1.2
scp-cli vpc internet-gateway delete
--internet_gateway_id <value>
Description
Delete Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
8.1.27.2 - 1.1
scp-cli vpc internet-gateway delete
--internet_gateway_id <value>
Description
Delete Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
8.1.27.3 - 1.0
scp-cli vpc internet-gateway delete
--internet_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
8.1.28 - Delete NAT Gateway
8.1.28.1 - 1.2
scp-cli vpc nat-gateway delete
--nat_gateway_id <value>
Description
Delete NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.28.2 - 1.1
scp-cli vpc nat-gateway delete
--nat_gateway_id <value>
Description
Delete NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.28.3 - 1.0
scp-cli vpc nat-gateway delete
--nat_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.29 - Delete Port
8.1.29.1 - 1.2
scp-cli vpc port delete
--port_id <value>
Description
Delete port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
8.1.29.2 - 1.1
scp-cli vpc port delete
--port_id <value>
Description
Delete port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
8.1.29.3 - 1.0
scp-cli vpc port delete
--port_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
8.1.30 - Delete Private NAT
8.1.30.1 - 1.2
scp-cli vpc private-nat delete
--private_nat_id <value>
Description
Delete Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.30.2 - 1.1
scp-cli vpc private-nat delete
--private_nat_id <value>
Description
Delete Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.30.3 - 1.0
scp-cli vpc private-nat delete
--private_nat_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.31 - Delete Private NAT IP
8.1.31.1 - 1.2
scp-cli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Delete Private NAT IP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_ip_id required | string | Private NAT IP ID | - |
| private_nat_id required | string | Private NAT ID | - |
8.1.31.2 - 1.1
scp-cli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Delete Private NAT IP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_ip_id required | string | Private NAT IP ID | - |
| private_nat_id required | string | Private NAT ID | - |
8.1.31.3 - 1.0
scp-cli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_ip_id required | string | Private NAT IP ID | - |
| private_nat_id required | string | Private NAT ID | - |
8.1.32 - Delete PrivateLink Endpoint
8.1.32.1 - 1.2
scp-cli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>
Description
Delete PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
8.1.32.2 - 1.1
scp-cli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>
Description
Delete PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
8.1.33 - Delete PrivateLink Service
8.1.33.1 - 1.2
scp-cli vpc privatelink-service delete
--privatelink_service_id <value>
Description
Delete PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
8.1.33.2 - 1.1
scp-cli vpc privatelink-service delete
--privatelink_service_id <value>
Description
Delete PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
8.1.34 - Delete PublicIP
8.1.34.1 - 1.2
scp-cli vpc public-ip delete
--publicip_id <value>
Description
Delete PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.34.2 - 1.1
scp-cli vpc public-ip delete
--publicip_id <value>
Description
Delete PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.34.3 - 1.0
scp-cli vpc public-ip delete
--publicip_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.35 - Delete Subnet
8.1.35.1 - 1.2
scp-cli vpc subnet delete
--subnet_id <value>
Description
Delete subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
8.1.35.2 - 1.1
scp-cli vpc subnet delete
--subnet_id <value>
Description
Delete subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
8.1.35.3 - 1.0
scp-cli vpc subnet delete
--subnet_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
8.1.36 - Delete Subnet Vip
8.1.36.1 - 1.2
scp-cli vpc subnet vip delete
--vip_id <value>
--subnet_id <value>
Description
Delete Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
8.1.37 - Delete Subnet Vip Connected Port
8.1.37.1 - 1.2
scp-cli vpc subnet vip port delete
--connected_port_id <value>
--vip_id <value>
--subnet_id <value>
Description
Delete Subnet Vip Connected Port
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| connected_port_id required | string | Subnet Vip Connected Port Id | 13e2a5a1acbe4713a9a2c70ce226e822 |
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
8.1.38 - Delete Subnet VIP NAT IP
8.1.38.1 - 1.2
scp-cli vpc subnet vip nat delete
--static_nat_id <value>
--vip_id <value>
--subnet_id <value>
Description
Delete Subnet Vip Nat Ip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| static_nat_id required | string | Static NAT ID | 0009e49548154745948e9722adefbf40 |
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
8.1.39 - Delete Transit Gateway
8.1.39.1 - 1.2
scp-cli vpc transit-gateway delete
--transit_gateway_id <value>
Description
Delete Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.39.2 - 1.1
scp-cli vpc transit-gateway delete
--transit_gateway_id <value>
Description
Delete Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.39.3 - 1.0
scp-cli vpc transit-gateway delete
--transit_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.40 - Delete Transit Gateway Firewall
8.1.40.1 - 1.2
scp-cli vpc transit-gateway-firewall-delete
--firewall_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Firewall.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_id required | string | Firewall ID | bbb93aca123f4bb2b2c0f206f4a86b2b |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.41 - Delete Transit Gateway Firewall Connection
8.1.41.1 - 1.2
scp-cli vpc transit-gateway-firewall-connection delete
--transit_gateway_id <value>
Description
Delete Transit Gateway Firewall Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.42 - Delete Transit Gateway Rule
8.1.42.1 - 1.2
scp-cli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.42.2 - 1.1
scp-cli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.42.3 - 1.0
scp-cli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.43 - Delete Transit Gateway Uplink Rule
8.1.43.1 - 1.2
scp-cli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Uplink Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.43.2 - 1.1
scp-cli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Uplink Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.43.3 - 1.0
scp-cli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.44 - Delete Transit Gateway VPC Connection
8.1.44.1 - 1.2
scp-cli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway VPC Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_connection_id required | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.44.2 - 1.1
scp-cli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway VPC Connection.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_connection_id required | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.44.3 - 1.0
scp-cli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_connection_id required | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
8.1.45 - Delete VPC
8.1.45.1 - 1.2
scp-cli vpc vpc delete
--vpc_id <value>
Description
Delete VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
8.1.45.2 - 1.1
scp-cli vpc vpc delete
--vpc_id <value>
Description
Delete VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
8.1.45.3 - 1.0
scp-cli vpc vpc delete
--vpc_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
8.1.46 - Delete VPC Endpoint
8.1.46.1 - 1.2
scp-cli vpc vpc-endpoint delete
--vpc_endpoint_id <value>
Description
Delete VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.46.2 - 1.1
scp-cli vpc vpc-endpoint delete
--vpc_endpoint_id <value>
Description
Delete VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.46.3 - 1.0
scp-cli vpc vpc-endpoint delete
--vpc_endpoint_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
8.1.47 - Delete VPC Peering
8.1.47.1 - 1.2
scp-cli vpc vpc-peering delete
--vpc_peering_id <value>
Description
Delete VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
8.1.47.2 - 1.1
scp-cli vpc vpc-peering delete
--vpc_peering_id <value>
Description
Delete VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
8.1.47.3 - 1.0
scp-cli vpc vpc-peering delete
--vpc_peering_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
8.1.48 - Delete VPC Peering Rule
8.1.48.1 - 1.2
scp-cli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>
Description
Delete a VPC Peering Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
8.1.48.2 - 1.1
scp-cli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>
Description
Delete a VPC Peering Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
8.1.48.3 - 1.0
scp-cli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
8.1.49 - List Connected PrivateLink Endpoints
8.1.49.1 - 1.2
scp-cli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
Get Connected PrivateLink Endpoint List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| state | PrivateLink Endpoint State | ACTIVE |
8.1.49.2 - 1.1
scp-cli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
Get Connected PrivateLink Endpoint List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| state | PrivateLink Endpoint State | ACTIVE |
8.1.50 - List Internet Gateways
8.1.50.1 - 1.2
scp-cli vpc internet-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get Internet Gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| name optional | string | Internet Gateway Name | IGW_VPCname |
| type optional | **** | Internet Gateway Type | - |
| state optional | string | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.50.2 - 1.1
scp-cli vpc internet-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get Internet Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| name optional | string | Internet Gateway Name | IGW_VPCname |
| type optional | **** | Internet Gateway Type | - |
| state optional | string | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.50.3 - 1.0
scp-cli vpc internet-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get Internet Gateway list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| name optional | string | Internet Gateway Name | IGW_VPCname |
| type optional | **** | Internet Gateway Type | - |
| state optional | string | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.51 - List NAT Gateways
8.1.51.1 - 1.2
scp-cli vpc nat-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]
Description
Get NAT Gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | NAT Gateway Name | NatGatewayName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| nat_gateway_ip_address optional | string | NAT Gateway IP Address | 192.167.0.5 |
| state optional | **** | NAT Gateway State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.51.2 - 1.1
scp-cli vpc nat-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]
Description
Get NAT Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| name optional | string | NAT Gateway Name | NatGatewayName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| nat_gateway_ip_address optional | string | NAT Gateway IP Address | 192.167.0.5 |
| state optional | **** | NAT Gateway State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.51.3 - 1.0
scp-cli vpc nat-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]
Description
Get NAT Gateway list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| name optional | string | NAT Gateway Name | NatGatewayName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| nat_gateway_ip_address optional | string | NAT Gateway IP Address | 192.167.0.5 |
| state optional | **** | NAT Gateway State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.52 - List Ports
8.1.52.1 - 1.2
scp-cli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]
Description
Get port list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | Port Limit | - |
| marker optional | string | Port Marker | - |
| sort optional | string | Port Sort | - |
| name optional | string | Port Name | portName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| id optional | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| attached_resource_id optional | string | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| fixed_ip_address optional | string | Fixed IP | 192.168.1.100 |
| mac_address optional | string | MAC Address | fa:16:3e:00:00:01 |
| state optional | string | State | - |
| security_groups optional | string | Security Group List | - |
| attached_resource_types optional | **** | Attached Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
8.1.52.2 - 1.1
scp-cli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]
Description
Get port list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | Port Limit | - |
| marker optional | string | Port Marker | - |
| sort optional | string | Port Sort | - |
| name optional | string | Port Name | portName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| id optional | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| attached_resource_id optional | string | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| fixed_ip_address optional | string | Fixed IP | 192.168.1.100 |
| mac_address optional | string | MAC Address | fa:16:3e:00:00:01 |
| state optional | string | State | - |
| security_groups optional | string | Security Group List | - |
| attached_resource_types optional | **** | Attached Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
8.1.52.3 - 1.0
scp-cli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | Port Limit | - |
| marker optional | string | Port Marker | - |
| sort optional | string | Port Sort | - |
| name optional | string | Port Name | portName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| id optional | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| attached_resource_id optional | string | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| fixed_ip_address optional | string | Fixed IP | 192.168.1.100 |
| mac_address optional | string | MAC Address | fa:16:3e:00:00:01 |
| state optional | string | State | - |
| security_groups optional | string | Security Group List | - |
| attached_resource_types optional | **** | Attached Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
8.1.53 - List Private NAT
8.1.53.1 - 1.2
scp-cli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--service_resource_id <value>]
[--service_type <value>]
[--service_resource_name <value>]
[--state <value>]
Description
Get Private NAT list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Private NAT Name | PrivateNatName |
| cidr optional | string | Private NAT IP range | 192.167.0.0/24 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| service_resource_id optional | string | Private NAT connected Service Resource ID | 3f342bf9a557405b997c2cf48c89cbc2 |
| service_type optional | **** | Private NAT connected Service Type | DIRECT_CONNECT |
| service_resource_name optional | string | Private NAT connected Service Resource Name | Service Resource Name |
| state optional | **** | Private NAT State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| service_resource_id | Private NAT connected Service Resource ID | 3f342bf9a557405b997c2cf48c89cbc2 |
| service_resource_name | Private NAT connected Service Resource Name | PrivateNatName |
| service_type | Private NAT connected Service Type | DIRECT_CONNECT |
| state | Private NAT State | ACTIVE |
8.1.53.2 - 1.1
scp-cli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--direct_connect_id <value>]
[--direct_connect_name <value>]
[--state <value>]
Description
Get Private NAT list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Private NAT Name | PrivateNatName |
| cidr optional | string | Private NAT IP range | 192.167.0.0/24 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| direct_connect_id optional | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name optional | string | Direct Connect Name | DirectConnectName |
| state optional | **** | Private NAT State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.53.3 - 1.0
scp-cli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--direct_connect_id <value>]
[--direct_connect_name <value>]
[--state <value>]
Description
Get Private NAT list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Private NAT Name | PrivateNatName |
| cidr optional | string | Private NAT IP range | 192.167.0.0/24 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| direct_connect_id optional | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name optional | string | Direct Connect Name | DirectConnectName |
| state optional | **** | Private NAT State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.54 - List Private NAT IP
8.1.54.1 - 1.2
scp-cli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
Description
Get Private NAT IP list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | Private NAT IP Address | - |
| state optional | **** | Private NAT IP State | - |
| attached_resource_type optional | **** | Private NAT IP Attached Resource Type | - |
| attached_resource_id optional | string | Private NAT IP Attached Resource ID | - |
| attached_resource_name optional | string | Private NAT IP Attached Resource Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
8.1.54.2 - 1.1
scp-cli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
Description
Get Private NAT IP list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | Private NAT IP Address | - |
| state optional | **** | Private NAT IP State | - |
| attached_resource_type optional | **** | Private NAT IP Attached Resource Type | - |
| attached_resource_id optional | string | Private NAT IP Attached Resource ID | - |
| attached_resource_name optional | string | Private NAT IP Attached Resource Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
8.1.54.3 - 1.0
scp-cli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
Description
Get Private NAT IP list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | Private NAT IP Address | - |
| state optional | **** | Private NAT IP State | - |
| attached_resource_type optional | **** | Private NAT IP Attached Resource Type | - |
| attached_resource_id optional | string | Private NAT IP Attached Resource ID | - |
| attached_resource_name optional | string | Private NAT IP Attached Resource Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
8.1.55 - List PrivateLink Endpoint
8.1.55.1 - 1.2
scp-cli vpc privatelink-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--privatelink_service_id <value>]
[--endpoint_ip_address <value>]
[--state <value>]
Description
Get PrivateLink Endpoint List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| name optional | string | PrivateLink Endpoint Name | EndpointName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| privatelink_service_id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| endpoint_ip_address optional | string | Endpoint IP Address | 192.167.1.5 |
| state optional | **** | PrivateLink Endpoint State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.55.2 - 1.1
scp-cli vpc privatelink-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--privatelink_service_id <value>]
[--endpoint_ip_address <value>]
[--state <value>]
Description
Get PrivateLink Endpoint List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| name optional | string | PrivateLink Endpoint Name | EndpointName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| privatelink_service_id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| endpoint_ip_address optional | string | Endpoint IP Address | 192.167.1.5 |
| state optional | **** | PrivateLink Endpoint State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.56 - List PrivateLink Service
8.1.56.1 - 1.2
scp-cli vpc privatelink-service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--service_ip_address <value>]
[--connected_resource_id <value>]
[--connected_resource_type <value>]
[--connected_resource_name <value>]
[--connected_resource_ip_address <value>]
[--state <value>]
Description
Get PrivateLink Service List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| name optional | string | PrivateLink Service Name | ServiceName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| service_ip_address optional | string | Service IP Address | 192.167.0.5 |
| connected_resource_id optional | string | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_type optional | **** | Connected Resource Type | LB |
| connected_resource_name optional | string | Connected Resource Name | lbResourceName |
| connected_resource_ip_address optional | string | Connected Resource IP Address | 192.167.0.10 |
| state optional | **** | PrivateLink Service State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| service_ip_address | Service IP Address | 192.167.0.5 |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.56.2 - 1.1
scp-cli vpc privatelink-service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--service_ip_address <value>]
[--connected_resource_id <value>]
[--connected_resource_type <value>]
[--connected_resource_name <value>]
[--connected_resource_ip_address <value>]
[--state <value>]
Description
Get PrivateLink Service List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| name optional | string | PrivateLink Service Name | ServiceName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| service_ip_address optional | string | Service IP Address | 192.167.0.5 |
| connected_resource_id optional | string | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_type optional | **** | Connected Resource Type | LB |
| connected_resource_name optional | string | Connected Resource Name | lbResourceName |
| connected_resource_ip_address optional | string | Connected Resource IP Address | 192.167.0.10 |
| state optional | **** | PrivateLink Service State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| service_ip_address | Service IP Address | 192.167.0.5 |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.57 - List PublicIPs
8.1.57.1 - 1.2
scp-cli vpc public-ip list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]
Description
Get PublicIP list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | IP Address | 192.167.0.5 |
| state optional | string | PublicIP State | ATTACHED |
| attached_resource_type optional | string | PublicIP Attached Resource Type | NAT_GW |
| attached_resource_id optional | string | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name optional | string | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type optional | **** | PublicIP Type | IGW |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
8.1.57.2 - 1.1
scp-cli vpc public-ip list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]
Description
Get PublicIP list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | IP Address | 192.167.0.5 |
| state optional | string | PublicIP State | ATTACHED |
| attached_resource_type optional | string | PublicIP Attached Resource Type | NAT_GW |
| attached_resource_id optional | string | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name optional | string | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type optional | **** | PublicIP Type | IGW |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
8.1.57.3 - 1.0
scp-cli vpc public-ip list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]
Description
Get PublicIP list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | IP Address | 192.167.0.5 |
| state optional | string | PublicIP State | ATTACHED |
| attached_resource_type optional | string | PublicIP Attached Resource Type | NAT_GW |
| attached_resource_id optional | string | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name optional | string | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type optional | **** | PublicIP Type | IGW |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
8.1.58 - List Subnet Vips
8.1.58.1 - 1.2
scp-cli vpc subnet vip list
--subnet_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--virtual_ip_address <value>]
[--public_ip_address <value>]
Description
Get list Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| virtual_ip_address optional | string | Virtual IP Address | 192.168.20.6 |
| public_ip_address optional | string | Public IP Address | 100.112.9.84 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| connected_port_count | Connected Port Count | 2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| static_nat | Static NAT Info | |
| virtual_ip_address | Virtual IP Address | 192.168.20.6 |
8.1.59 - List Subnets
8.1.59.1 - 1.2
scp-cli vpc subnet list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--cidr <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get subnet list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name optional | string | Subnet Name | subnetName |
| type optional | **** | Subnet Type | - |
| cidr optional | string | Subnet Cidr | 192.167.1.0/24 |
| state optional | **** | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.59.2 - 1.1
scp-cli vpc subnet list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get subnet list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name optional | string | Subnet Name | subnetName |
| type optional | **** | Subnet Type | - |
| state optional | **** | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.59.3 - 1.0
scp-cli vpc subnet list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get subnet list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name optional | string | Subnet Name | subnetName |
| type optional | **** | Subnet Type | - |
| state optional | **** | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.60 - List Transit Gateway Rules
8.1.60.1 - 1.2
scp-cli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--rule_type <value>]
Description
Get Transit Gateway Rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| tgw_connection_vpc_id optional | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name optional | string | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
| source_type optional | **** | Source Type | TGW |
| destination_type optional | **** | Destination Type | VPC |
| destination_cidr optional | string | Destination CIDR | 192.167.5.0/24 |
| state optional | **** | State | ACTIVE |
| rule_type optional | **** | Rule Type | TGW_VPC |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| rule_type | Rule Type | TGW_VPC |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
8.1.60.2 - 1.1
scp-cli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
Get Transit Gateway Rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| tgw_connection_vpc_id optional | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name optional | string | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
| source_type optional | **** | Source Type | TGW |
| destination_type optional | **** | Destination Type | VPC |
| destination_cidr optional | string | Destination CIDR | 192.167.5.0/24 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
8.1.60.3 - 1.0
scp-cli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
Get Transit Gateway Rule list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| tgw_connection_vpc_id optional | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name optional | string | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
| source_type optional | **** | Source Type | TGW |
| destination_type optional | **** | Destination Type | VPC |
| destination_cidr optional | string | Destination CIDR | 192.167.5.0/24 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
8.1.61 - List Transit Gateway VPC Connections
8.1.61.1 - 1.2
scp-cli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]
Description
Get Transit Gateway VPC Connection list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.61.2 - 1.1
scp-cli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]
Description
Get Transit Gateway VPC Connection list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.61.3 - 1.0
scp-cli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]
Description
Get Transit Gateway VPC Connection list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.62 - List Transit Gateways
8.1.62.1 - 1.2
scp-cli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--firewall_connection_state <value>]
Description
Get Transit Gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| name optional | string | Transit Gateway Name | TransitGatewayName |
| state optional | **** | State | ACTIVE |
| firewall_connection_state optional | **** | Firewall Connection State | INACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_connection_state | Firewall Connection State | INACTIVE |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.62.2 - 1.1
scp-cli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
Description
Get Transit Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| name optional | string | Transit Gateway Name | TransitGatewayName |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.62.3 - 1.0
scp-cli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| name optional | string | Transit Gateway Name | TransitGatewayName |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.63 - List VPC Endpoint
8.1.63.1 - 1.2
scp-cli vpc vpc-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]
Description
Get VPC Endpoint list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| name optional | string | VPC Endpoint Name | VpcEndpointName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_key optional | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type optional | **** | VPC Endpoint Resource Type | FS |
| endpoint_ip_address optional | string | VPC Endpoint IP Address | 192.167.0.5 |
| state optional | **** | VPC Endpoint State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.63.2 - 1.1
scp-cli vpc vpc-endpoint list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]
Description
Get VPC Endpoint list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| name optional | string | VPC Endpoint Name | VpcEndpointName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_key optional | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type optional | **** | VPC Endpoint Resource Type | FS |
| endpoint_ip_address optional | string | VPC Endpoint IP Address | 192.167.0.5 |
| state optional | **** | VPC Endpoint State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.63.3 - 1.0
scp-cli vpc vpc-endpoint list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]
Description
Get VPC Endpoint list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| name optional | string | VPC Endpoint Name | VpcEndpointName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_key optional | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type optional | **** | VPC Endpoint Resource Type | FS |
| endpoint_ip_address optional | string | VPC Endpoint IP Address | 192.167.0.5 |
| state optional | **** | VPC Endpoint State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.64 - List VPC Endpoint Connectable Resources
8.1.64.1 - 1.2
scp-cli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]
Description
List VpcEndpoint connectable resources
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | VPC Endpoint Resource Type | FS |
| vpc_id optional | string | VPC ID(required if resource_type is DNS) | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
8.1.64.2 - 1.1
scp-cli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]
Description
List VpcEndpoint connectable resources
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | VPC Endpoint Resource Type | FS |
| vpc_id optional | string | VPC ID(required if resource_type is DNS) | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
8.1.64.3 - 1.0
scp-cli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | VPC Endpoint Resource Type | FS |
| vpc_id optional | string | VPC ID(required if resource_type is DNS) | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
8.1.65 - List VPC Peering
8.1.65.1 - 1.2
scp-cli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]
Description
Get VPC Peering list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| name optional | string | VPC Peering Name | vpcPeeringName |
| requester_vpc_id optional | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name optional | string | Requester VPC Name | vpcName |
| approver_vpc_id optional | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name optional | string | Approver VPC Name | vpcName |
| account_type optional | **** | Account Type | - |
| state optional | **** | State | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
8.1.65.2 - 1.1
scp-cli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]
Description
Get VPC Peering list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| name optional | string | VPC Peering Name | vpcPeeringName |
| requester_vpc_id optional | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name optional | string | Requester VPC Name | vpcName |
| approver_vpc_id optional | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name optional | string | Approver VPC Name | vpcName |
| account_type optional | **** | Account Type | - |
| state optional | **** | State | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
8.1.65.3 - 1.0
scp-cli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]
Description
Get VPC Peering list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| name optional | string | VPC Peering Name | vpcPeeringName |
| requester_vpc_id optional | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name optional | string | Requester VPC Name | vpcName |
| approver_vpc_id optional | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name optional | string | Approver VPC Name | vpcName |
| account_type optional | **** | Account Type | - |
| state optional | **** | State | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
8.1.66 - List VPC Peering Rules
8.1.66.1 - 1.2
scp-cli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
Get VPC Peering Rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering Rule ID | - |
| source_vpc_id optional | string | Source VPC ID | - |
| source_vpc_type optional | **** | Source VPC Type | - |
| destination_vpc_id optional | string | Destination VPC ID | - |
| destination_vpc_type optional | **** | Destination VPC Type | - |
| destination_cidr optional | string | Destination CIDR | - |
| state optional | **** | State | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
8.1.66.2 - 1.1
scp-cli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--name <value>]
Description
Get VPC Peering Rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering Rule ID | - |
| source_vpc_id optional | string | Source VPC ID | - |
| source_vpc_type optional | **** | Source VPC Type | - |
| destination_vpc_id optional | string | Destination VPC ID | - |
| destination_vpc_type optional | **** | Destination VPC Type | - |
| destination_cidr optional | string | Destination CIDR | - |
| state optional | **** | State | - |
| name optional | string | VPC Peering Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
8.1.66.3 - 1.0
scp-cli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--name <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering Rule ID | - |
| source_vpc_id optional | string | Source VPC ID | - |
| source_vpc_type optional | **** | Source VPC Type | - |
| destination_vpc_id optional | string | Destination VPC ID | - |
| destination_vpc_type optional | **** | Destination VPC Type | - |
| destination_cidr optional | string | Destination CIDR | - |
| state optional | **** | State | - |
| name optional | string | VPC Peering Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
8.1.67 - List VPCs
8.1.67.1 - 1.2
scp-cli vpc vpc list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]
Description
Get VPC list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| name optional | string | VPC Name | vpcName |
| state optional | **** | State | - |
| cidr optional | string | VPC Cidr | 192.167.0.0/18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr_count | Cidr Count | 20 |
| cidrs | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
8.1.67.2 - 1.1
scp-cli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]
Description
Get VPC list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| name optional | string | VPC Name | vpcName |
| state optional | **** | State | - |
| cidr optional | string | VPC Cidr | 192.167.0.0/18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
8.1.67.3 - 1.0
scp-cli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]
Description
Get VPC list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| name optional | string | VPC Name | vpcName |
| state optional | **** | State | - |
| cidr optional | string | VPC Cidr | 192.167.0.0/18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
8.1.68 - Request PrivateLink Endpoint
8.1.68.1 - 1.2
scp-cli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>
Description
Request PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | CANCEL |
8.1.68.2 - 1.1
scp-cli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>
Description
Request PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | CANCEL |
8.1.69 - Set Internet Gateway
8.1.69.1 - 1.2
scp-cli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]
Description
Set Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | Internet Gateway Description |
| loggable optional | boolean | NAT Loggable | - |
8.1.69.2 - 1.1
scp-cli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]
Description
Set Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | Internet Gateway Description |
| loggable optional | boolean | NAT Loggable | - |
8.1.69.3 - 1.0
scp-cli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | Internet Gateway Description |
| loggable optional | boolean | NAT Loggable | - |
8.1.70 - Set NAT Gateway
8.1.70.1 - 1.2
scp-cli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]
Description
Set NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
8.1.70.2 - 1.1
scp-cli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]
Description
Set NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
8.1.70.3 - 1.0
scp-cli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
8.1.71 - Set Port
8.1.71.1 - 1.2
scp-cli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]
Description
Set port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| description optional | string | Description | Port Description |
| security_groups optional | array | Security Group List | - |
8.1.71.2 - 1.1
scp-cli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]
Description
Set port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| description optional | string | Description | Port Description |
| security_groups optional | array | Security Group List | - |
8.1.71.3 - 1.0
scp-cli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| description optional | string | Description | Port Description |
| security_groups optional | array | Security Group List | - |
8.1.72 - Set Private NAT
8.1.72.1 - 1.2
scp-cli vpc private-nat set
--private_nat_id <value>
[--description <value>]
Description
Set Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | PrivateNat Description |
8.1.72.2 - 1.1
scp-cli vpc private-nat set
--private_nat_id <value>
[--description <value>]
Description
Set Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | PrivateNat Description |
8.1.72.3 - 1.0
scp-cli vpc private-nat set
--private_nat_id <value>
[--description <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | PrivateNat Description |
8.1.73 - Set PrivateLink Endpoint
8.1.73.1 - 1.2
scp-cli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]
Description
Set PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| description optional | string | Description | PrivateLink Endpoint Description |
8.1.73.2 - 1.1
scp-cli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]
Description
Set PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| description optional | string | Description | PrivateLink Endpoint Description |
8.1.74 - Set PrivateLink Service
8.1.74.1 - 1.2
scp-cli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]
Description
Set PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| description optional | string | Description | PrivateLink Service Description |
8.1.74.2 - 1.1
scp-cli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]
Description
Set PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| description optional | string | Description | PrivateLink Service Description |
8.1.75 - Set PublicIP
8.1.75.1 - 1.2
scp-cli vpc public-ip set
--publicip_id <value>
--description <value>
Description
Set PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description required | string | PublicIP Description | Public IP Description |
8.1.75.2 - 1.1
scp-cli vpc public-ip set
--publicip_id <value>
--description <value>
Description
Set PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description required | string | PublicIP Description | Public IP Description |
8.1.75.3 - 1.0
scp-cli vpc public-ip set
--publicip_id <value>
--description <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description required | string | PublicIP Description | Public IP Description |
8.1.76 - Set Subnet
8.1.76.1 - 1.2
scp-cli vpc subnet set
--subnet_id <value>
[--description <value>]
[--dhcp_ip_address <value>]
Description
Set subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | Subnet Description |
| dhcp_ip_address optional | string | DHCP IP Address | - |
8.1.76.2 - 1.1
scp-cli vpc subnet set
--subnet_id <value>
--description <value>
Description
Set subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| description required | string | Description | Subnet Description |
8.1.76.3 - 1.0
scp-cli vpc subnet set
--subnet_id <value>
--description <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| description required | string | Description | Subnet Description |
8.1.77 - Set Subnet Vip
8.1.77.1 - 1.2
scp-cli vpc subnet vip set
--vip_id <value>
--subnet_id <value>
--description <value>
Description
Set Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| description required | string | Description | Subnet VIP Description |
8.1.78 - Set Transit Gateway
8.1.78.1 - 1.2
scp-cli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]
Description
Set Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| description optional | string | Description | TransitGateway Description |
8.1.78.2 - 1.1
scp-cli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]
Description
Set Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| description optional | string | Description | TransitGateway Description |
8.1.78.3 - 1.0
scp-cli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| description optional | string | Description | TransitGateway Description |
8.1.79 - Set VPC
8.1.79.1 - 1.2
scp-cli vpc vpc set
--vpc_id <value>
[--description <value>]
Description
Set VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
| description optional | string | Description | vpcDescription |
8.1.79.2 - 1.1
scp-cli vpc vpc set
--vpc_id <value>
[--description <value>]
Description
Set VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
| description optional | string | Description | vpcDescription |
8.1.79.3 - 1.0
scp-cli vpc vpc set
--vpc_id <value>
[--description <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
| description optional | string | Description | vpcDescription |
8.1.80 - Set VPC Endpoint
8.1.80.1 - 1.2
scp-cli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]
Description
Set VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | VpcEndpoint Description |
8.1.80.2 - 1.1
scp-cli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]
Description
Set VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | VpcEndpoint Description |
8.1.80.3 - 1.0
scp-cli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | VpcEndpoint Description |
8.1.81 - Set VPC Peering
8.1.81.1 - 1.2
scp-cli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]
Description
Set VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | vpcPeering Description |
8.1.81.2 - 1.1
scp-cli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]
Description
Set VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | vpcPeering Description |
8.1.81.3 - 1.0
scp-cli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | vpcPeering Description |
8.1.82 - Show Internet Gateway
8.1.82.1 - 1.2
scp-cli vpc internet-gateway show
--internet_gateway_id <value>
Description
Show Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.82.2 - 1.1
scp-cli vpc internet-gateway show
--internet_gateway_id <value>
Description
Show Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.82.3 - 1.0
scp-cli vpc internet-gateway show
--internet_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.83 - Show NAT Gateway
8.1.83.1 - 1.2
scp-cli vpc nat-gateway show
--nat_gateway_id <value>
Description
Show NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.83.2 - 1.1
scp-cli vpc nat-gateway show
--nat_gateway_id <value>
Description
Show NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.83.3 - 1.0
scp-cli vpc nat-gateway show
--nat_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.84 - Show Port
8.1.84.1 - 1.2
scp-cli vpc port show
--port_id <value>
Description
Show port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| security_groups | Security Group List | |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| virtual_ip_addresses | Virtual IP Address | |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
8.1.84.2 - 1.1
scp-cli vpc port show
--port_id <value>
Description
Show port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| security_groups | Security Group List | |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
8.1.84.3 - 1.0
scp-cli vpc port show
--port_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| security_groups | Security Group List | |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
8.1.85 - Show Private NAT
8.1.85.1 - 1.2
scp-cli vpc private-nat show
--private_nat_id <value>
Description
Show Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| service_resource_id | Private NAT connected Service Resource ID | 3f342bf9a557405b997c2cf48c89cbc2 |
| service_resource_name | Private NAT connected Service Resource Name | PrivateNatName |
| service_type | Private NAT connected Service Type | DIRECT_CONNECT |
| state | Private NAT State | ACTIVE |
8.1.85.2 - 1.1
scp-cli vpc private-nat show
--private_nat_id <value>
Description
Show Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.85.3 - 1.0
scp-cli vpc private-nat show
--private_nat_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.86 - Show PrivateLink Endpoint
8.1.86.1 - 1.2
scp-cli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>
Description
Show PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Endpoint Description |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| endpoint_ip_port_id | Endpoint IP Port ID | b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids | Security Group List | [‘17776b52-0a64-440d-9e93-b4fc37be935b’] |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.86.2 - 1.1
scp-cli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>
Description
Show PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Endpoint Description |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| endpoint_ip_port_id | Endpoint IP Port ID | b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids | Security Group List | [‘17776b52-0a64-440d-9e93-b4fc37be935b’] |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.87 - Show PrivateLink Service
8.1.87.1 - 1.2
scp-cli vpc privatelink-service show
--privatelink_service_id <value>
Description
Show PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Service Description |
| high_speed_transfer | High Speed Data Transfer Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| security_group_ids | Security Group List | [‘00b6af37-73b5-4de2-b080-c295a1a0382e’] |
| service_ip_address | Service IP Address | 192.167.0.5 |
| service_ip_port_id | Service IP Port ID | d21a4b81-f52a-43a8-b985-341e763458bb |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.87.2 - 1.1
scp-cli vpc privatelink-service show
--privatelink_service_id <value>
Description
Show PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Service Description |
| high_speed_transfer | High Speed Data Transfer Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| security_group_ids | Security Group List | [‘00b6af37-73b5-4de2-b080-c295a1a0382e’] |
| service_ip_address | Service IP Address | 192.167.0.5 |
| service_ip_port_id | Service IP Port ID | d21a4b81-f52a-43a8-b985-341e763458bb |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
8.1.88 - Show PublicIP
8.1.88.1 - 1.2
scp-cli vpc public-ip show
--publicip_id <value>
Description
Show PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
8.1.88.2 - 1.1
scp-cli vpc public-ip show
--publicip_id <value>
Description
Show PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
8.1.88.3 - 1.0
scp-cli vpc public-ip show
--publicip_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
8.1.89 - Show Subnet
8.1.89.1 - 1.2
scp-cli vpc subnet show
--subnet_id <value>
Description
Show subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dhcp_ip_address | DHCP IP Address | |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.89.2 - 1.1
scp-cli vpc subnet show
--subnet_id <value>
Description
Show subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.89.3 - 1.0
scp-cli vpc subnet show
--subnet_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.90 - Show Subnet Vip
8.1.90.1 - 1.2
scp-cli vpc subnet vip show
--vip_id <value>
--subnet_id <value>
Description
Show Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| connected_ports | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet VIP Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| static_nat | Static NAT Info | |
| subnet_id | Subnet ID | 023c57b14f11483689338d085e061492 |
| vip_port_id | Vip Port Id | 35268a9f2eda4cde83b1d85c1f61f67d |
| virtual_ip_address | Virtual IP Address | 192.168.20.6 |
8.1.91 - Show Transit Gateway
8.1.91.1 - 1.2
scp-cli vpc transit-gateway show
--transit_gateway_id <value>
Description
Show Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_connection_state | Firewall Connection State | INACTIVE |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.91.2 - 1.1
scp-cli vpc transit-gateway show
--transit_gateway_id <value>
Description
Show Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.91.3 - 1.0
scp-cli vpc transit-gateway show
--transit_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
8.1.92 - Show VPC
8.1.92.1 - 1.2
scp-cli vpc vpc show
--vpc_id <value>
Description
Show VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr_count | Cidr Count | 20 |
| cidrs | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
8.1.92.2 - 1.1
scp-cli vpc vpc show
--vpc_id <value>
Description
Show VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
8.1.92.3 - 1.0
scp-cli vpc vpc show
--vpc_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
8.1.93 - Show VPC Endpoint
8.1.93.1 - 1.2
scp-cli vpc vpc-endpoint show
--vpc_endpoint_id <value>
Description
Show VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.93.2 - 1.1
scp-cli vpc vpc-endpoint show
--vpc_endpoint_id <value>
Description
Show VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.93.3 - 1.0
scp-cli vpc vpc-endpoint show
--vpc_endpoint_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.1.94 - Show VPC Peering
8.1.94.1 - 1.2
scp-cli vpc vpc-peering show
--vpc_peering_id <value>
Description
Show VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
8.1.94.2 - 1.1
scp-cli vpc vpc-peering show
--vpc_peering_id <value>
Description
Show VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
8.1.94.3 - 1.0
scp-cli vpc vpc-peering show
--vpc_peering_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
9 - VPN
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of VPN service and how to call CLI. The output is formatted as a JSON string
Version
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 |
9.1 - CLIs
9.1.1 - Create VPN Gateway
9.1.1.1 - 1.1
scp-cli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]
Description
Create VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| name required | string | VPN Gateway Name | ExampleVpnGW1 |
| ip_type required | string | VPN Gateway IP Type | PUBLIC |
| ip_id required | string | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_address required | string | VPN Gateway IP Address | 123.0.0.1 |
| description optional | string | Description | Example Description for VPN Gateway |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
9.1.1.2 - 1.0
scp-cli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]
Description
Create VPN gateway.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| name required | string | VPN Gateway Name | ExampleVpnGW1 |
| ip_type required | string | VPN Gateway IP Type | PUBLIC |
| ip_id required | string | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_address required | string | VPN Gateway IP Address | 123.0.0.1 |
| description optional | string | Description | Example Description for VPN Gateway |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
9.1.2 - Create VPN Tunnel
9.1.2.1 - 1.1
scp-cli vpn vpn-tunnel create
--remote_subnets <value>
--phase2_life_time <value>
--phase2_encryptions <value>
--phase2_diffie_hellman_groups <value>
--perfect_forward_secrecy <value>
--pre_shared_key <value>
--phase1_life_time <value>
--phase1_encryptions <value>
--phase1_diffie_hellman_groups <value>
--peer_gateway_ip <value>
--ike_version <value>
--dpd_retry_interval <value>
--vpn_gateway_id <value>
--name <value>
[--description <value>]
[--tags <value>]
Description
Create VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| remote_subnets required | array | VPN Tunnel IPSec Remote Subnet | 10.1.1.0/24 |
| phase2_life_time required | integer | VPN Tunnel IPSec Lifetime (sec) | 43200 |
| phase2_encryptions required | array | VPN Tunnel ISAKMP Proposal List | null-md5 |
| phase2_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| perfect_forward_secrecy required | string | VPN Tunnel IPSec Perfect Forward Secrecy(PFS) | ENABLE |
| pre_shared_key required | string | VPN Tunnel ISAKMP Authentication : Pre-shared Key | PreSharedKey1 |
| phase1_life_time required | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| phase1_encryptions required | array | VPN Tunnel ISAKMP Proposal List | des-md5 |
| phase1_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| peer_gateway_ip required | string | VPN Tunnel Peer Gateway IP Address | 123.0.0.2 |
| ike_version required | integer | VPN Tunnel IKE Version | 2 |
| dpd_retry_interval required | integer | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) | 60 |
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| name required | string | VPN Tunnel Name | ExampleVpnTunnel1 |
| description optional | string | Description | Example Description for VPN Tunnel |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
9.1.2.2 - 1.0
scp-cli vpn vpn-tunnel create
--remote_subnet <value>
--phase2_life_time <value>
--phase2_encryptions <value>
--phase2_diffie_hellman_groups <value>
--perfect_forward_secrecy <value>
--pre_shared_key <value>
--phase1_life_time <value>
--phase1_encryptions <value>
--phase1_diffie_hellman_groups <value>
--peer_gateway_ip <value>
--ike_version <value>
--dpd_retry_interval <value>
--vpn_gateway_id <value>
--name <value>
[--description <value>]
[--tags <value>]
Description
Create VPN tunnel.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| remote_subnet required | string | VPN Tunnel IPSec Remote Subnet | 10.1.0.0/16 |
| phase2_life_time required | integer | VPN Tunnel IPSec Lifetime (sec) | 43200 |
| phase2_encryptions required | array | VPN Tunnel ISAKMP Proposal List | null-md5 |
| phase2_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| perfect_forward_secrecy required | string | VPN Tunnel IPSec Perfect Forward Secrecy(PFS) | ENABLE |
| pre_shared_key required | string | VPN Tunnel ISAKMP Authentication : Pre-shared Key | PreSharedKey1 |
| phase1_life_time required | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| phase1_encryptions required | array | VPN Tunnel ISAKMP Proposal List | des-md5 |
| phase1_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| peer_gateway_ip required | string | VPN Tunnel Peer Gateway IP Address | 123.0.0.2 |
| ike_version required | integer | VPN Tunnel IKE Version | 2 |
| dpd_retry_interval required | integer | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) | 60 |
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| name required | string | VPN Tunnel Name | ExampleVpnTunnel1 |
| description optional | string | Description | Example Description for VPN Tunnel |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
9.1.3 - Delete VPN Gateway
9.1.3.1 - 1.1
scp-cli vpn vpn-gateway delete
--vpn_gateway_id <value>
Description
Delete VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
9.1.3.2 - 1.0
scp-cli vpn vpn-gateway delete
--vpn_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
9.1.4 - Delete VPN Tunnel
9.1.4.1 - 1.1
scp-cli vpn vpn-tunnel delete
--vpn_tunnel_id <value>
Description
Delete VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
9.1.4.2 - 1.0
scp-cli vpn vpn-tunnel delete
--vpn_tunnel_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
9.1.5 - List VPN Gateways
9.1.5.1 - 1.1
scp-cli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get VPN gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | VPN Gateway Name | ExampleVpnGW1 |
| ip_address optional | string | VPN Gateway IP Address | 123.0.0.1 |
| vpc_id optional | string | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name optional | string | VPC Name | ExampleVPC1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
9.1.5.2 - 1.0
scp-cli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get VPN gateway list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | VPN Gateway Name | ExampleVpnGW1 |
| ip_address optional | string | VPN Gateway IP Address | 123.0.0.1 |
| vpc_id optional | string | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name optional | string | VPC Name | ExampleVPC1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
9.1.6 - List VPN Tunnels
9.1.6.1 - 1.1
scp-cli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]
Description
Get VPN tunnel list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | VPN Tunnel Name | ExampleVpnTunnel1 |
| vpn_gateway_id optional | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_name optional | string | VPN Gateway Name | ExampleVpnGW1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
9.1.6.2 - 1.0
scp-cli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]
[--peer_gateway_ip <value>]
[--remote_subnet <value>]
Description
Get VPN tunnel list.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | VPN Tunnel Name | ExampleVpnTunnel1 |
| vpn_gateway_id optional | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_name optional | string | VPN Gateway Name | ExampleVpnGW1 |
| peer_gateway_ip optional | string | VPN Tunnel Peer Gateway IP Address | 123.0.0.2 |
| remote_subnet optional | string | VPN Tunnel IPSec Remote Subnet | 10.1.0.0/16 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
9.1.7 - Set VPN Gateway
9.1.7.1 - 1.1
scp-cli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]
Description
Set VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| description optional | string | Description | Example Description for VPN Gateway |
9.1.7.2 - 1.0
scp-cli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| description optional | string | Description | Example Description for VPN Gateway |
9.1.8 - Set VPN Tunnel
9.1.8.1 - 1.1
scp-cli vpn vpn-tunnel set
--vpn_tunnel_id <value>
[--description <value>]
[--dpd_retry_interval <value>]
[--ike_version <value>]
[--peer_gateway_ip <value>]
[--phase1_diffie_hellman_groups <value>]
[--phase1_encryptions <value>]
[--phase1_life_time <value>]
[--pre_shared_key <value>]
[--perfect_forward_secrecy <value>]
[--phase2_diffie_hellman_groups <value>]
[--phase2_encryptions <value>]
[--phase2_life_time <value>]
[--remote_subnets <value>]
Description
Set VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
| description optional | string | Description | Example Description for VPN Tunnel |
| dpd_retry_interval optional | integer | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) | 60 |
| ike_version optional | integer | VPN Tunnel IKE Version | 2 |
| peer_gateway_ip optional | string | VPN Tunnel Peer Gateway IP Address | 123.0.0.2 |
| phase1_diffie_hellman_groups optional | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| phase1_encryptions optional | array | VPN Tunnel ISAKMP Proposal List | des-md5 |
| phase1_life_time optional | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| pre_shared_key optional | string | VPN Tunnel ISAKMP Authentication : Pre-shared Key | PreSharedKey1 |
| perfect_forward_secrecy optional | **** | VPN Tunnel IPSec Perfect Forward Secrecy(PFS) | ENABLE |
| phase2_diffie_hellman_groups optional | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| phase2_encryptions optional | array | VPN Tunnel ISAKMP Proposal List | null-md5 |
| phase2_life_time optional | integer | VPN Tunnel IPSec Lifetime (sec) | 43200 |
| remote_subnets optional | array | VPN Tunnel IPSec Remote Subnet | 10.1.1.0/24 |
9.1.8.2 - 1.0
scp-cli vpn vpn-tunnel set
--vpn_tunnel_id <value>
[--description <value>]
[--dpd_retry_interval <value>]
[--ike_version <value>]
[--peer_gateway_ip <value>]
[--phase1_diffie_hellman_groups <value>]
[--phase1_encryptions <value>]
[--phase1_life_time <value>]
[--pre_shared_key <value>]
[--perfect_forward_secrecy <value>]
[--phase2_diffie_hellman_groups <value>]
[--phase2_encryptions <value>]
[--phase2_life_time <value>]
[--remote_subnet <value>]
Description
Set VPN tunnel.
State ACTIVE (DEPRECATED)
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
| description optional | string | Description | Example Description for VPN Tunnel |
| dpd_retry_interval optional | integer | VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec) | 60 |
| ike_version optional | integer | VPN Tunnel IKE Version | 2 |
| peer_gateway_ip optional | string | VPN Tunnel Peer Gateway IP Address | 123.0.0.2 |
| phase1_diffie_hellman_groups optional | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| phase1_encryptions optional | array | VPN Tunnel ISAKMP Proposal List | des-md5 |
| phase1_life_time optional | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| pre_shared_key optional | string | VPN Tunnel ISAKMP Authentication : Pre-shared Key | PreSharedKey1 |
| perfect_forward_secrecy optional | **** | VPN Tunnel IPSec Perfect Forward Secrecy(PFS) | ENABLE |
| phase2_diffie_hellman_groups optional | array | VPN Tunnel ISAKMP Diffie-Hellman Group List | 30 |
| phase2_encryptions optional | array | VPN Tunnel ISAKMP Proposal List | null-md5 |
| phase2_life_time optional | integer | VPN Tunnel IPSec Lifetime (sec) | 43200 |
| remote_subnet optional | string | VPN Tunnel IPSec Remote Subnet | 10.1.0.0/16 |
9.1.9 - Show VPN Gateway
9.1.9.1 - 1.1
scp-cli vpn vpn-gateway show
--vpn_gateway_id <value>
Description
Show VPN gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
9.1.9.2 - 1.0
scp-cli vpn vpn-gateway show
--vpn_gateway_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP Address | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP Type | PUBLIC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | State | ACTIVE |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
9.1.10 - Show VPN Tunnel
9.1.10.1 - 1.1
scp-cli vpn vpn-tunnel show
--vpn_tunnel_id <value>
Description
Show VPN tunnel.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| status | VPN Tunnel Status | UP |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
9.1.10.2 - 1.0
scp-cli vpn vpn-tunnel show
--vpn_tunnel_id <value>
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
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for VPN Tunnel |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel Name | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | State | ACTIVE |
| status | VPN Tunnel Status | UP |
| vpc_id | VPC Id | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC Name | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP Address | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |