이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
CLI Reference
- 1: Common
- 2: Compute
- 2.1: Bare Metal Server
- 2.1.1: CLIs
- 2.1.1.1: Assign Baremetal Private NAT IP
- 2.1.1.1.1: 1.1
- 2.1.1.2: Assign Baremetal Public NAT IP
- 2.1.1.3: Attach Baremetal Local Subnet
- 2.1.1.4: Create Baremetals
- 2.1.1.5: Delete Baremetal Private NAT IP
- 2.1.1.5.1: 1.1
- 2.1.1.6: Delete Baremetal Public NAT IP
- 2.1.1.7: Delete Baremetals
- 2.1.1.8: Detach Baremetal Local Subnet
- 2.1.1.9: List Baremetal Images
- 2.1.1.10: List Baremetal Products
- 2.1.1.11: List Baremetals
- 2.1.1.12: Lock Baremetal
- 2.1.1.13: Show Baremetal
- 2.1.1.14: Start Baremetals
- 2.1.1.15: Stop Baremetals
- 2.1.1.16: Unlock Baremetal
- 2.2: Cloud Functions
- 2.2.1: CLIs
- 2.2.1.1: Approve PrivateLink Endpoint
- 2.2.1.1.1: 1.2
- 2.2.1.2: Check Function Name Duplication
- 2.2.1.3: Connect PrivateLink Endpoint
- 2.2.1.3.1: 1.2
- 2.2.1.4: Create Cloud Function
- 2.2.1.5: Create Cloud Function Apigateway Trigger
- 2.2.1.6: Create Cloud Function Cronjob Trigger
- 2.2.1.7: Create PrivateLink Endpoint
- 2.2.1.7.1: 1.2
- 2.2.1.8: Delete Cloud Function
- 2.2.1.9: Delete Cloud Function Trigger
- 2.2.1.10: Delete PrivateLink Endpoint
- 2.2.1.10.1: 1.2
- 2.2.1.11: List Cloud Function Triggers
- 2.2.1.12: List Cloud Functions
- 2.2.1.13: List Runtimes
- 2.2.1.14: List Sample Codes
- 2.2.1.15: Request PrivateLink Endpoint
- 2.2.1.15.1: 1.2
- 2.2.1.16: Show Cloud Function
- 2.2.1.17: Show Cloud Function Code
- 2.2.1.18: Show Cloud Function Configuration
- 2.2.1.19: Show Cloud Function Logs
- 2.2.1.20: Show Cloud Function Metrics
- 2.2.1.21: Show Cloud Function Trigger
- 2.2.1.22: Update Cloud Function Code
- 2.2.1.23: Update Cloud Function Code File
- 2.2.1.24: Update Cloud Function Config
- 2.2.1.25: Update Cloud Function Cronjob Trigger
- 2.2.1.26: Update Cloud Function Url
- 2.2.1.27: Update Cloud Function Variables
- 2.2.1.28: Update PrivateLink Service
- 2.2.1.28.1: 1.2
- 2.3: Virtual Server
- 2.3.1: CLIs
- 2.3.1.1: Accept a volume transfer
- 2.3.1.2: Attach Virtual Server Security Group
- 2.3.1.2.1: 1.0
- 2.3.1.3: Attach Volume to Virtual Server
- 2.3.1.4: Create a snapshot
- 2.3.1.5: Create a volume transfer
- 2.3.1.6: Create Auto-Scaling Group
- 2.3.1.7: Create Auto-Scaling Group Notification
- 2.3.1.8: Create Auto-Scaling Group Policy
- 2.3.1.9: Create Auto-Scaling Group Schedule
- 2.3.1.10: Create Image
- 2.3.1.11: Create Image member
- 2.3.1.12: Create Keypair
- 2.3.1.13: Create Launch Configuration
- 2.3.1.14: Create Server Group
- 2.3.1.15: Create Server Interface
- 2.3.1.16: Create Server Interface Nat
- 2.3.1.17: Create Server Interface Private Nat
- 2.3.1.18: Create Server Volume
- 2.3.1.19: Create Sharing Image
- 2.3.1.20: Create Virtual Server
- 2.3.1.21: Create Virtual Server Custom Image
- 2.3.1.22: Create Virtual Server Dump
- 2.3.1.23: Create Volume
- 2.3.1.24: Delete a snapshot
- 2.3.1.25: Delete a volume transfer
- 2.3.1.26: Delete Auto-Scaling Group
- 2.3.1.27: Delete Auto-Scaling Group Notification
- 2.3.1.28: Delete Auto-Scaling Group Policy
- 2.3.1.29: Delete Auto-Scaling Group Schedule
- 2.3.1.30: Delete Image
- 2.3.1.31: Delete Image member
- 2.3.1.32: Delete Keypair
- 2.3.1.33: Delete Launch Configuration
- 2.3.1.34: Delete Server Group
- 2.3.1.35: Delete Server Interface
- 2.3.1.36: Delete Server Interface Nat
- 2.3.1.37: Delete Server Interface Private Nat
- 2.3.1.38: Delete Server Volume
- 2.3.1.39: Delete Virtual Server
- 2.3.1.40: Delete Volume
- 2.3.1.41: Detach Virtual Server Security Group
- 2.3.1.41.1: 1.0
- 2.3.1.42: Detach Volume from Virtual Server
- 2.3.1.43: Extend Volume
- 2.3.1.44: Get region's maximum partition size.
- 2.3.1.45: Import Image
- 2.3.1.46: List Auto-Scaling Group LB Server Groups
- 2.3.1.47: List Auto-Scaling Group Notifications
- 2.3.1.48: List Auto-Scaling Group Policies
- 2.3.1.49: List Auto-Scaling Group Schedules
- 2.3.1.50: List Auto-Scaling Group Virtual Servers
- 2.3.1.51: List Auto-Scaling Groups
- 2.3.1.52: List Default Configs
- 2.3.1.53: List Image members
- 2.3.1.54: List Images
- 2.3.1.55: List Keypairs
- 2.3.1.56: List Launch Configurations
- 2.3.1.57: List pending Images
- 2.3.1.58: List Server Groups
- 2.3.1.59: List Server Interfaces
- 2.3.1.60: List Server Ips
- 2.3.1.61: List Server Types
- 2.3.1.62: List Server Volumes
- 2.3.1.63: List snapshots and details
- 2.3.1.64: List Virtual Server Security Group
- 2.3.1.65: List Virtual Servers
- 2.3.1.66: List volume transfers
- 2.3.1.67: List volume types and details
- 2.3.1.68: List volumes and details
- 2.3.1.69: Lock Virtual Server
- 2.3.1.70: Reboot Virtual Server
- 2.3.1.71: Rebuild Virtual Server
- 2.3.1.72: Revert Volume to snapshot
- 2.3.1.73: Show a snapshot’s details
- 2.3.1.74: Show Auto-Scaling Group
- 2.3.1.75: Show Auto-Scaling Group Notification
- 2.3.1.76: Show Auto-Scaling Group Policy
- 2.3.1.77: Show Auto-Scaling Group Schedule
- 2.3.1.78: Show default Volume type’s details
- 2.3.1.79: Show Image
- 2.3.1.80: Show Image member
- 2.3.1.81: Show Keypair
- 2.3.1.82: Show Launch Configuration
- 2.3.1.83: Show Server Group
- 2.3.1.84: Show Server Interface
- 2.3.1.85: Show Server Ip
- 2.3.1.86: Show Server Quota Set
- 2.3.1.87: Show Server Type
- 2.3.1.88: Show Server Volume
- 2.3.1.89: Show Virtual Server
- 2.3.1.90: Show Virtual Server Console Log
- 2.3.1.91: Show Virtual Server Password
- 2.3.1.92: Show Volume Quota Set
- 2.3.1.93: Show volume transfer detail
- 2.3.1.94: Show Volume type’s details
- 2.3.1.95: Show Volume's details
- 2.3.1.96: Start Virtual Server
- 2.3.1.97: Stop Virtual Server
- 2.3.1.98: Unlock Virtual Server
- 2.3.1.99: Update a snapshot
- 2.3.1.100: Update Auto-Scaling Group
- 2.3.1.101: Update Auto-Scaling Group LB Server Groups
- 2.3.1.102: Update Auto-Scaling Group Notification
- 2.3.1.103: Update Auto-Scaling Group Policy
- 2.3.1.104: Update Auto-Scaling Group Schedule
- 2.3.1.105: Update Auto-Scaling Group server count
- 2.3.1.106: Update Image
- 2.3.1.107: Update Image member
- 2.3.1.108: Update Server Interface
- 2.3.1.109: Update Server Volume
- 2.3.1.110: Update Virtual Server
- 2.3.1.111: Update Virtual Server type
- 2.3.1.112: Update Volume
- 3: Storage
- 3.1: Archive Storage
- 3.1.1: CLIs
- 3.1.1.1: CancelArchiving
- 3.1.1.2: CancelRecovery
- 3.1.1.3: CreateArchivingPolicy
- 3.1.1.4: CreateBucket
- 3.1.1.5: DeleteBucket
- 3.1.1.6: DeleteBucketObjects
- 3.1.1.7: DeleteBucketObjectVersions
- 3.1.1.7.1: 1.1
- 3.1.1.8: ListArchivingHistories
- 3.1.1.9: ListArchivingPolicies
- 3.1.1.10: ListBucketObjects
- 3.1.1.11: ListBucketObjectVersions
- 3.1.1.11.1: 1.1
- 3.1.1.12: ListBuckets
- 3.1.1.13: ListRecoveryHistories
- 3.1.1.14: RecoverObjects
- 3.1.1.15: RecoverObjectVersions
- 3.1.1.15.1: 1.1
- 3.1.1.16: SetArchivingPolicy
- 3.1.1.17: SetArchivingPolicyState
- 3.1.1.17.1: 1.1
- 3.1.1.18: SetBucketEncryption
- 3.1.1.19: SetBucketVersioning
- 3.1.1.19.1: 1.1
- 3.1.1.20: ShowArchivingHistory
- 3.1.1.21: ShowArchivingPolicy
- 3.1.1.22: ShowBucket
- 3.1.1.23: ShowBucketEncryption
- 3.1.1.24: ShowBucketVersioning
- 3.1.1.24.1: 1.1
- 3.1.1.25: ShowRecoveryHistory
- 3.2: Backup
- 3.2.1: CLIs
- 3.2.1.1: Check Backup Master Connection State
- 3.2.1.2: Check Backup Name Duplicate
- 3.2.1.3: Check Backup Restore Server Name Duplicate
- 3.2.1.4: Check Filesystem Path Duplication
- 3.2.1.5: Create Backup
- 3.2.1.6: Create Backup Agent
- 3.2.1.7: Delete Backup
- 3.2.1.8: Delete Backup Agent
- 3.2.1.9: Delete Backup Restore Target
- 3.2.1.10: List Agent Backup Restore Target Servers
- 3.2.1.11: List Backup Agents
- 3.2.1.12: List Backup Histories
- 3.2.1.13: List Backup Region Relationship
- 3.2.1.14: List Backup Restore Histories
- 3.2.1.15: List Backup Restore Subnets
- 3.2.1.16: List Backup Restore Targets
- 3.2.1.17: List Backup Schedules
- 3.2.1.18: List Backup Targets
- 3.2.1.19: List Backups
- 3.2.1.20: List Targets of Backup Agent
- 3.2.1.21: Manual Backup
- 3.2.1.22: Restore Agent Backup
- 3.2.1.23: Restore Backup
- 3.2.1.24: Set Backup Schedule
- 3.2.1.25: Set Filesystem Path
- 3.2.1.26: Show Backup
- 3.2.1.27: Show Backup Agent
- 3.2.1.28: Show Backup Agent Install File Path
- 3.2.1.29: Update Replication Use
- 3.2.1.30: Update Retention Period
- 3.3: Block Storage(BM)
- 3.3.1: CLIs
- 3.3.1.1: Add Volume Group Member on Volume Group
- 3.3.1.2: Attach Volume
- 3.3.1.3: Create Volume
- 3.3.1.4: Create Volume Group
- 3.3.1.5: Create Volume Group Recovery
- 3.3.1.6: Create Volume Group Replication
- 3.3.1.7: Create Volume Group Snapshot
- 3.3.1.8: Create Volume Group Snapshot Schedule
- 3.3.1.9: Create Volume Recovery
- 3.3.1.10: Create Volume Replication
- 3.3.1.11: Create Volume Snapshot
- 3.3.1.12: Create Volume Snapshot Rate
- 3.3.1.13: Create Volume Snapshot Schedule
- 3.3.1.14: Delete Volume
- 3.3.1.15: Delete Volume Group Replication
- 3.3.1.16: Delete Volume Group Snapshot
- 3.3.1.17: Delete Volume Group Snapshot Schedule
- 3.3.1.18: Delete Volume Replication
- 3.3.1.19: Delete Volume Snapshot
- 3.3.1.20: Delete Volume Snapshot Rate
- 3.3.1.21: Delete Volume Snapshot Schedule
- 3.3.1.22: Detach Volume
- 3.3.1.23: List Volume Group Snapshots
- 3.3.1.24: List Volume Groups
- 3.3.1.25: List Volume Snapshots
- 3.3.1.26: List Volumes
- 3.3.1.27: Remove Volume Group Member on Volume Group
- 3.3.1.28: Restore Volume Group Snapshot
- 3.3.1.29: Restore Volume Snapshot
- 3.3.1.30: Set Volume Group Replication Cycle
- 3.3.1.31: Set Volume Group Replication Policy
- 3.3.1.32: Set Volume Group Snapshot Schedule
- 3.3.1.33: Set Volume QoS
- 3.3.1.33.1: 1.2
- 3.3.1.34: Set Volume Replication Cycle
- 3.3.1.35: Set Volume Replication Policy
- 3.3.1.36: Set Volume Snapshot Rate
- 3.3.1.37: Set Volume Snapshot Schedule
- 3.3.1.38: Show Volume
- 3.3.1.39: Show Volume Group
- 3.3.1.40: Show Volume Group Replication
- 3.3.1.41: Show Volume Replication
- 3.4: File Storage
- 3.4.1: CLIs
- 3.4.1.1: CreateSnapshot
- 3.4.1.2: CreateSnapshotSchedule
- 3.4.1.3: CreateVolume
- 3.4.1.4: CreateVolumeReplication
- 3.4.1.5: DeleteSnapshot
- 3.4.1.6: DeleteSnapshotSchedule
- 3.4.1.7: DeleteVolume
- 3.4.1.8: DeleteVolumeReplication
- 3.4.1.9: ListAccessRules
- 3.4.1.10: ListSnapshots
- 3.4.1.11: ListSnapshotSchedule
- 3.4.1.12: ListVolumeReplicationRegion
- 3.4.1.13: ListVolumeReplications
- 3.4.1.14: ListVolumes
- 3.4.1.15: RestoreSnapshot
- 3.4.1.16: SetAccessRule
- 3.4.1.17: SetSnapshotSchedule
- 3.4.1.18: SetVolume
- 3.4.1.19: SetVolumeReplication
- 3.4.1.20: ShowVolume
- 3.4.1.21: ShowVolumeReplication
- 3.5: Parallel File Storage
- 3.5.1: CLIs
- 3.5.1.1: CreateSnapshot
- 3.5.1.1.1: 1.0
- 3.5.1.2: CreateVolume
- 3.5.1.2.1: 1.0
- 3.5.1.3: DeleteSnapshot
- 3.5.1.3.1: 1.0
- 3.5.1.4: DeleteVolume
- 3.5.1.4.1: 1.0
- 3.5.1.5: ListAccessRule
- 3.5.1.5.1: 1.0
- 3.5.1.6: ListSnapshots
- 3.5.1.6.1: 1.0
- 3.5.1.7: ListVolumes
- 3.5.1.7.1: 1.0
- 3.5.1.8: SetAccessRule
- 3.5.1.8.1: 1.0
- 3.5.1.9: SetVolumeCapacity
- 3.5.1.9.1: 1.0
- 3.5.1.10: ShowVolume
- 3.5.1.10.1: 1.0
- 4: Container
- 4.1: Container Registry
- 4.1.1: CLIs
- 4.1.1.1: Check Registry Name Duplication
- 4.1.1.2: Check Repository Name Duplication
- 4.1.1.3: Check Tags Vulnerability
- 4.1.1.4: Create Registry
- 4.1.1.5: Create Repository
- 4.1.1.6: Delete Image
- 4.1.1.7: Delete Registry
- 4.1.1.8: Delete Repository
- 4.1.1.9: Delete Tags
- 4.1.1.10: Delete Tagses
- 4.1.1.11: Download Manifest
- 4.1.1.12: List Connectable Resources
- 4.1.1.13: List Images
- 4.1.1.14: List Registries
- 4.1.1.15: List Repositories
- 4.1.1.16: List Tagses
- 4.1.1.17: Run Image Lifecycle Policy Preview
- 4.1.1.18: Show Image
- 4.1.1.19: Show Image Lifecycle Policy Preview
- 4.1.1.20: Show Registry
- 4.1.1.21: Show Repository
- 4.1.1.22: Show Tags
- 4.1.1.23: Show Tags Packages
- 4.1.1.24: Show Tags Secrets
- 4.1.1.25: Show Tags Vulnerabilities
- 4.1.1.26: Update Image Description
- 4.1.1.27: Update Image Lifecycle Policy
- 4.1.1.28: Update Image Lock Policy
- 4.1.1.29: Update Image Pull Policy
- 4.1.1.30: Update Image Scan Policy
- 4.1.1.31: Update Private Acl
- 4.1.1.32: Update Public Acl
- 4.1.1.33: Update Public Endpoint Enabled
- 4.1.1.34: Update Repository Description
- 4.1.1.35: Update Repository Lifecycle Policy
- 4.1.1.36: Update Repository Lock Policy
- 4.1.1.37: Update Repository Pull Policy
- 4.1.1.38: Update Repository Scan Policy
- 4.1.1.39: Update Tags Lock Policy
- 4.2: Kubernetes
- 4.2.1: CLIs
- 4.2.1.1: Create Cluster
- 4.2.1.2: Create Cluster Kubeconfig
- 4.2.1.3: Create Nodepool
- 4.2.1.4: Delete Cluster
- 4.2.1.5: Delete Nodepool
- 4.2.1.6: List Clusters
- 4.2.1.7: List Nodepool Nodes
- 4.2.1.8: List Nodepools
- 4.2.1.9: Set Cluster Logging
- 4.2.1.10: Set Cluster Private Access Control
- 4.2.1.11: Set Cluster Public Access Control
- 4.2.1.12: Set Cluster Security Groups
- 4.2.1.13: Set Cluster Service Watch Logging
- 4.2.1.13.1: 1.1
- 4.2.1.14: Set Cluster Upgrade
- 4.2.1.15: Set Nodepool
- 4.2.1.16: Set Nodepool Labels
- 4.2.1.17: Set Nodepool Taints
- 4.2.1.18: Set Nodepool Upgrade
- 4.2.1.19: Show Cluster
- 4.2.1.20: Show Cluster User Kubeconfig
- 4.2.1.21: Show Nodepool
- 5: Networking
- 5.1: Direct Connect
- 5.1.1: CLIs
- 5.1.1.1: Create Direct Connect
- 5.1.1.1.1: 1.0
- 5.1.1.2: Create Routing Rule
- 5.1.1.2.1: 1.0
- 5.1.1.3: Delete Direct Connect
- 5.1.1.3.1: 1.0
- 5.1.1.4: Delete Routing Rule
- 5.1.1.4.1: 1.0
- 5.1.1.5: List Direct Connects
- 5.1.1.5.1: 1.0
- 5.1.1.6: List Routing Rules
- 5.1.1.6.1: 1.0
- 5.1.1.7: Set Direct Connect
- 5.1.1.7.1: 1.0
- 5.1.1.8: Show Direct Connect
- 5.1.1.8.1: 1.0
- 5.2: DNS
- 5.2.1: CLIs
- 5.2.1.1: Activate Private DNS
- 5.2.1.2: Create Hosted Zone
- 5.2.1.3: Create Hosted Zone Record
- 5.2.1.3.1: 1.3
- 5.2.1.4: Create Private DNS
- 5.2.1.5: Create Public Domain
- 5.2.1.6: Create Public Domain Name
- 5.2.1.6.1: 1.3
- 5.2.1.7: Create Record
- 5.2.1.8: Delete Hosted Zone
- 5.2.1.9: Delete Hosted Zone Record
- 5.2.1.9.1: 1.3
- 5.2.1.10: Delete Private DNS
- 5.2.1.11: Delete Record
- 5.2.1.12: Get Public Domain Detail
- 5.2.1.13: List Hosted Zone Records
- 5.2.1.13.1: 1.3
- 5.2.1.14: List Hosted Zones
- 5.2.1.15: List Private DNS
- 5.2.1.16: List Public Domain Names
- 5.2.1.16.1: 1.3
- 5.2.1.17: List Public Domains
- 5.2.1.18: List Records
- 5.2.1.19: Set Hosted Zone Record
- 5.2.1.19.1: 1.3
- 5.2.1.20: Set Private DNS
- 5.2.1.21: Set Public Domain Name
- 5.2.1.21.1: 1.3
- 5.2.1.22: Set Public Domain Name Whois Info
- 5.2.1.22.1: 1.3
- 5.2.1.23: Show Hosted Zone
- 5.2.1.24: Show Hosted Zone Record
- 5.2.1.24.1: 1.3
- 5.2.1.25: Show Private DNS
- 5.2.1.26: Show Public Domain Name
- 5.2.1.26.1: 1.3
- 5.2.1.27: Show Record
- 5.2.1.28: Transfer Public Domain Name
- 5.2.1.28.1: 1.3
- 5.2.1.29: Update auto_extension or description
- 5.2.1.30: Update Hosted Zone
- 5.2.1.31: Update Record
- 5.2.1.32: Update WHOIS info for Public Domain
- 5.3: Firewall
- 5.3.1: CLIs
- 5.3.1.1: Create Firewall Rule
- 5.3.1.1.1: 1.0
- 5.3.1.2: Delete Firewall Rule
- 5.3.1.2.1: 1.0
- 5.3.1.3: List Firewall Rules
- 5.3.1.3.1: 1.0
- 5.3.1.4: List Firewalls
- 5.3.1.4.1: 1.0
- 5.3.1.5: Set Firewall
- 5.3.1.5.1: 1.0
- 5.3.1.6: Set Firewall Rule
- 5.3.1.6.1: 1.0
- 5.3.1.7: Show Firewall
- 5.3.1.7.1: 1.0
- 5.3.1.8: Show Firewall Rule
- 5.3.1.8.1: 1.0
- 5.4: Global CDN
- 5.4.1: CLIs
- 5.4.1.1: Create Cdn Service
- 5.4.1.1.1: 1.0
- 5.4.1.2: Delete Cdn Service
- 5.4.1.2.1: 1.0
- 5.4.1.3: Detail Cdn Service
- 5.4.1.3.1: 1.0
- 5.4.1.4: List Cdn Service
- 5.4.1.4.1: 1.0
- 5.4.1.5: Purge Cdn Service
- 5.4.1.5.1: 1.0
- 5.4.1.6: Start Cdn Service
- 5.4.1.6.1: 1.0
- 5.4.1.7: Stop Cdn Service
- 5.4.1.7.1: 1.0
- 5.4.1.8: Update Cdn Service
- 5.4.1.8.1: 1.0
- 5.4.1.9: Update Description of Cdn Service
- 5.4.1.9.1: 1.0
- 5.5: GSLB
- 5.5.1: CLIs
- 5.5.1.1: CreateGslb
- 5.5.1.2: DeleteGslb
- 5.5.1.3: ListGslbResources
- 5.5.1.4: ListGslbs
- 5.5.1.5: ListGslbsRegionalRoutingControl
- 5.5.1.5.1: 1.1
- 5.5.1.6: SetGslb
- 5.5.1.7: SetGslbHealthCheck
- 5.5.1.8: SetGslbRegionalRoutingControl
- 5.5.1.8.1: 1.1
- 5.5.1.9: SetGslbResources
- 5.5.1.10: ShowGslb
- 5.6: Load Balancer
- 5.6.1: CLIs
- 5.6.1.1: AddLbServerGroupMembers
- 5.6.1.2: CreateLBHealthCheck
- 5.6.1.3: CreateLbListener
- 5.6.1.4: CreateLBServerGroup
- 5.6.1.5: CreateLoadbalancer
- 5.6.1.6: CreateLoadbalancerPublicNatIp
- 5.6.1.7: DeleteLBHealthCheck
- 5.6.1.8: DeleteLbListener
- 5.6.1.9: DeleteLBServerGroup
- 5.6.1.10: DeleteLoadbalancer
- 5.6.1.11: DeleteLoadbalancerPublicNatIp
- 5.6.1.12: ListLBHealthChecks
- 5.6.1.13: ListLbListeners
- 5.6.1.14: ListLbServerGroupMembers
- 5.6.1.15: ListLBServerGroups
- 5.6.1.16: ListLoadbalancerCertificates
- 5.6.1.17: ListLoadbalancers
- 5.6.1.18: RemoveLbServerGroupMember
- 5.6.1.19: RemoveLbServerGroupMembers
- 5.6.1.19.1: 1.2
- 5.6.1.20: SetLBHealthCheck
- 5.6.1.21: SetLbListener
- 5.6.1.22: SetLBServerGroup
- 5.6.1.23: SetLbServerGroupMember
- 5.6.1.24: SetLoadbalancer
- 5.6.1.24.1: 1.1
- 5.6.1.25: ShowLBHealthCheck
- 5.6.1.26: ShowLbListener
- 5.6.1.27: ShowLBServerGroup
- 5.6.1.28: ShowLbServerGroupMember
- 5.6.1.29: ShowLoadbalancer
- 5.6.1.30: ShowLoadbalancerCertificate
- 5.6.1.31: ShowLoadbalancerPublicNatIp
- 5.7: Security Group
- 5.7.1: CLIs
- 5.7.1.1: Create Security Group
- 5.7.1.1.1: 1.0
- 5.7.1.2: Create Security Group Rule
- 5.7.1.2.1: 1.0
- 5.7.1.3: Delete Security Group
- 5.7.1.3.1: 1.0
- 5.7.1.4: Delete Security Group Rule
- 5.7.1.4.1: 1.0
- 5.7.1.5: List Security Group Rules
- 5.7.1.5.1: 1.0
- 5.7.1.6: List Security Groups
- 5.7.1.6.1: 1.0
- 5.7.1.7: Set Security Group
- 5.7.1.7.1: 1.0
- 5.7.1.8: Show Security Group
- 5.7.1.8.1: 1.0
- 5.7.1.9: Show Security Group Rule
- 5.7.1.9.1: 1.0
- 5.8: VPC
- 5.8.1: CLIs
- 5.8.1.1: Approval VPC Peering
- 5.8.1.1.1: 1.1
- 5.8.1.2: Approve PrivateLink Endpoint
- 5.8.1.2.1: 1.1
- 5.8.1.3: Connect PrivateLink Endpoint
- 5.8.1.3.1: 1.1
- 5.8.1.4: Create Internet Gateway
- 5.8.1.5: Create NAT Gateway
- 5.8.1.6: Create Port
- 5.8.1.7: Create Private NAT
- 5.8.1.8: Create Private NAT IP
- 5.8.1.9: Create PrivateLink Endpoint
- 5.8.1.9.1: 1.1
- 5.8.1.10: Create PrivateLink Service
- 5.8.1.10.1: 1.1
- 5.8.1.11: Create PublicIP
- 5.8.1.12: Create Subnet
- 5.8.1.13: Create Transit Gateway
- 5.8.1.14: Create Transit Gateway Rule
- 5.8.1.15: Create Transit Gateway VPC Connection
- 5.8.1.16: Create VPC
- 5.8.1.17: Create VPC Endpoint
- 5.8.1.18: Create VPC Peering
- 5.8.1.19: Create Vpc Peering Rule
- 5.8.1.20: Delete Internet Gateway
- 5.8.1.21: Delete NAT Gateway
- 5.8.1.22: Delete Port
- 5.8.1.23: Delete Private NAT
- 5.8.1.24: Delete Private NAT IP
- 5.8.1.25: Delete PrivateLink Endpoint
- 5.8.1.25.1: 1.1
- 5.8.1.26: Delete PrivateLink Service
- 5.8.1.26.1: 1.1
- 5.8.1.27: Delete PublicIP
- 5.8.1.28: Delete Subnet
- 5.8.1.29: Delete Transit Gateway
- 5.8.1.30: Delete Transit Gateway Rule
- 5.8.1.31: Delete Transit Gateway VPC Connection
- 5.8.1.32: Delete VPC
- 5.8.1.33: Delete VPC Endpoint
- 5.8.1.34: Delete VPC Peering
- 5.8.1.35: Delete VPC Peering Rule
- 5.8.1.36: List Connected PrivateLink Endpoints
- 5.8.1.36.1: 1.1
- 5.8.1.37: List Internet Gateways
- 5.8.1.38: List NAT Gateways
- 5.8.1.39: List Ports
- 5.8.1.40: List Private NAT
- 5.8.1.41: List Private NAT IP
- 5.8.1.42: List PrivateLink Endpoint
- 5.8.1.42.1: 1.1
- 5.8.1.43: List PrivateLink Service
- 5.8.1.43.1: 1.1
- 5.8.1.44: List PublicIPs
- 5.8.1.45: List Subnets
- 5.8.1.46: List Transit Gateway Rules
- 5.8.1.47: List Transit Gateway VPC Connections
- 5.8.1.48: List Transit Gateways
- 5.8.1.49: List VPC Endpoint
- 5.8.1.50: List VPC Endpoint Connectable Resources
- 5.8.1.51: List VPC Peering
- 5.8.1.52: List VPC Peering Rules
- 5.8.1.53: List VPCs
- 5.8.1.54: Request PrivateLink Endpoint
- 5.8.1.54.1: 1.1
- 5.8.1.55: Set Internet Gateway
- 5.8.1.56: Set NAT Gateway
- 5.8.1.57: Set Port
- 5.8.1.58: Set Private NAT
- 5.8.1.59: Set PrivateLink Endpoint
- 5.8.1.59.1: 1.1
- 5.8.1.60: Set PrivateLink Service
- 5.8.1.60.1: 1.1
- 5.8.1.61: Set PublicIP
- 5.8.1.62: Set Subnet
- 5.8.1.63: Set Transit Gateway
- 5.8.1.64: Set VPC
- 5.8.1.65: Set VPC Endpoint
- 5.8.1.66: Set VPC Peering
- 5.8.1.67: Show Internet Gateway
- 5.8.1.68: Show NAT Gateway
- 5.8.1.69: Show Port
- 5.8.1.70: Show Private NAT
- 5.8.1.71: Show PrivateLink Endpoint
- 5.8.1.71.1: 1.1
- 5.8.1.72: Show PrivateLink Service
- 5.8.1.72.1: 1.1
- 5.8.1.73: Show PublicIP
- 5.8.1.74: Show Subnet
- 5.8.1.75: Show Transit Gateway
- 5.8.1.76: Show VPC
- 5.8.1.77: Show VPC Endpoint
- 5.8.1.78: Show VPC Peering
- 5.9: VPN
- 5.9.1: CLIs
- 5.9.1.1: Create VPN Gateway
- 5.9.1.2: Create VPN Tunnel
- 5.9.1.3: Delete VPN Gateway
- 5.9.1.4: Delete VPN Tunnel
- 5.9.1.5: List VPN Gateways
- 5.9.1.6: List VPN Tunnels
- 5.9.1.7: Set VPN Gateway
- 5.9.1.8: Set VPN Tunnel
- 5.9.1.9: Show VPN Gateway
- 5.9.1.10: Show VPN Tunnel
- 6: Database
- 6.1: CacheStore(DBaaS)
- 6.1.1: CLIs
- 6.1.1.1: Create Cluster
- 6.1.1.1.1: 1.0
- 6.1.1.2: Create Restore Cluster
- 6.1.1.2.1: 1.0
- 6.1.1.3: List Backup Histories
- 6.1.1.3.1: 1.0
- 6.1.1.4: List Clusters
- 6.1.1.4.1: 1.0
- 6.1.1.5: List Commands
- 6.1.1.5.1: 1.0
- 6.1.1.6: List Engine Version Properties
- 6.1.1.6.1: 1.0
- 6.1.1.7: List Engine Versions
- 6.1.1.7.1: 1.0
- 6.1.1.8: List Parameter Groups
- 6.1.1.8.1: 1.0
- 6.1.1.9: List Parameter Values
- 6.1.1.9.1: 1.0
- 6.1.1.10: List Parameters
- 6.1.1.10.1: 1.0
- 6.1.1.11: List Server Types
- 6.1.1.11.1: 1.0
- 6.1.1.12: Remove Backup Histories
- 6.1.1.12.1: 1.0
- 6.1.1.13: Restart Cluster
- 6.1.1.13.1: 1.0
- 6.1.1.14: Set Backup
- 6.1.1.14.1: 1.0
- 6.1.1.15: Set Block Storage Size
- 6.1.1.15.1: 1.0
- 6.1.1.16: Set Maintenance
- 6.1.1.16.1: 1.0
- 6.1.1.17: Set Parameter Values
- 6.1.1.17.1: 1.0
- 6.1.1.18: Set Security Group Rules
- 6.1.1.18.1: 1.0
- 6.1.1.19: Set Server Type
- 6.1.1.19.1: 1.0
- 6.1.1.20: Show Cluster
- 6.1.1.20.1: 1.0
- 6.1.1.21: Show Request
- 6.1.1.21.1: 1.0
- 6.1.1.22: Start Cluster
- 6.1.1.22.1: 1.0
- 6.1.1.23: Stop Cluster
- 6.1.1.23.1: 1.0
- 6.1.1.24: Switchover Cluster
- 6.1.1.24.1: 1.0
- 6.1.1.25: Synchronize Cluster State
- 6.1.1.25.1: 1.0
- 6.1.1.26: Synchronize Commands
- 6.1.1.26.1: 1.0
- 6.1.1.27: Synchronize Parameter Values
- 6.1.1.27.1: 1.0
- 6.1.1.28: Terminate Cluster
- 6.1.1.28.1: 1.0
- 6.1.1.29: Unset Backup
- 6.1.1.29.1: 1.0
- 6.1.1.30: Unset Maintenance
- 6.1.1.30.1: 1.0
- 6.1.1.31: Update Commands
- 6.1.1.31.1: 1.0
- 6.2: EPAS(DBaaS)
- 6.2.1: CLIs
- 6.2.1.1: Add Block Storages
- 6.2.1.1.1: 1.0
- 6.2.1.2: Create Cluster
- 6.2.1.2.1: 1.0
- 6.2.1.3: Create Replica
- 6.2.1.3.1: 1.0
- 6.2.1.4: Create Restore Cluster
- 6.2.1.4.1: 1.0
- 6.2.1.5: Delete Archive Log
- 6.2.1.5.1: 1.0
- 6.2.1.6: Export Log
- 6.2.1.6.1: 1.0
- 6.2.1.7: List Backup Histories
- 6.2.1.7.1: 1.0
- 6.2.1.8: List Clusters
- 6.2.1.8.1: 1.0
- 6.2.1.9: List Engine Version Properties
- 6.2.1.9.1: 1.0
- 6.2.1.10: List Engine Versions
- 6.2.1.10.1: 1.0
- 6.2.1.11: List Log Export Configs
- 6.2.1.11.1: 1.0
- 6.2.1.12: List Parameter Groups
- 6.2.1.12.1: 1.0
- 6.2.1.13: List Parameter Values
- 6.2.1.13.1: 1.0
- 6.2.1.14: List Parameters
- 6.2.1.14.1: 1.0
- 6.2.1.15: List Replicas
- 6.2.1.15.1: 1.0
- 6.2.1.16: List Server Types
- 6.2.1.16.1: 1.0
- 6.2.1.17: Patch Minor Version
- 6.2.1.17.1: 1.0
- 6.2.1.18: Promote Replica Cluster
- 6.2.1.18.1: 1.0
- 6.2.1.19: Register Log Export Config
- 6.2.1.19.1: 1.0
- 6.2.1.20: Remove Backup Histories
- 6.2.1.20.1: 1.0
- 6.2.1.21: Reset Replica
- 6.2.1.21.1: 1.0
- 6.2.1.22: Restart Cluster
- 6.2.1.22.1: 1.0
- 6.2.1.23: Set Archive Config
- 6.2.1.23.1: 1.0
- 6.2.1.24: Set Audit Log
- 6.2.1.24.1: 1.0
- 6.2.1.25: Set Backup
- 6.2.1.25.1: 1.0
- 6.2.1.26: Set Block Storage Size
- 6.2.1.26.1: 1.0
- 6.2.1.27: Set Log Export Config
- 6.2.1.27.1: 1.0
- 6.2.1.28: Set Maintenance
- 6.2.1.28.1: 1.0
- 6.2.1.29: Set Parameter Values
- 6.2.1.29.1: 1.0
- 6.2.1.30: Set Security Group Rules
- 6.2.1.30.1: 1.0
- 6.2.1.31: Set Server Type
- 6.2.1.31.1: 1.0
- 6.2.1.32: Show Archive Config
- 6.2.1.32.1: 1.0
- 6.2.1.33: Show Cluster
- 6.2.1.33.1: 1.0
- 6.2.1.34: Show Request
- 6.2.1.34.1: 1.0
- 6.2.1.35: Start Cluster
- 6.2.1.35.1: 1.0
- 6.2.1.36: Stop Cluster
- 6.2.1.36.1: 1.0
- 6.2.1.37: Switchover Cluster
- 6.2.1.37.1: 1.0
- 6.2.1.38: Synchronize Archive Config
- 6.2.1.38.1: 1.0
- 6.2.1.39: Synchronize Cluster State
- 6.2.1.39.1: 1.0
- 6.2.1.40: Synchronize Parameter Values
- 6.2.1.40.1: 1.0
- 6.2.1.41: Synchronize Replica State
- 6.2.1.41.1: 1.0
- 6.2.1.42: Terminate Cluster
- 6.2.1.42.1: 1.0
- 6.2.1.43: Unregister Log Export Config
- 6.2.1.43.1: 1.0
- 6.2.1.44: Unset Backup
- 6.2.1.44.1: 1.0
- 6.2.1.45: Unset Maintenance
- 6.2.1.45.1: 1.0
- 6.3: MariaDB(DBaaS)
- 6.3.1: CLIs
- 6.3.1.1: Add Block Storages
- 6.3.1.1.1: 1.0
- 6.3.1.2: Create Cluster
- 6.3.1.2.1: 1.0
- 6.3.1.3: Create Replica
- 6.3.1.3.1: 1.0
- 6.3.1.4: Create Restore Cluster
- 6.3.1.4.1: 1.0
- 6.3.1.5: Export Log
- 6.3.1.5.1: 1.0
- 6.3.1.6: List Backup Histories
- 6.3.1.6.1: 1.0
- 6.3.1.7: List Clusters
- 6.3.1.7.1: 1.0
- 6.3.1.8: List Engine Version Properties
- 6.3.1.8.1: 1.0
- 6.3.1.9: List Engine Versions
- 6.3.1.9.1: 1.0
- 6.3.1.10: List Log Export Configs
- 6.3.1.10.1: 1.0
- 6.3.1.11: List Parameter Groups
- 6.3.1.11.1: 1.0
- 6.3.1.12: List Parameter Values
- 6.3.1.12.1: 1.0
- 6.3.1.13: List Parameters
- 6.3.1.13.1: 1.0
- 6.3.1.14: List Replicas
- 6.3.1.14.1: 1.0
- 6.3.1.15: List Server Types
- 6.3.1.15.1: 1.0
- 6.3.1.16: Patch Minor Version
- 6.3.1.16.1: 1.0
- 6.3.1.17: Promote Replica Cluster
- 6.3.1.17.1: 1.0
- 6.3.1.18: Register Log Export Config
- 6.3.1.18.1: 1.0
- 6.3.1.19: Remove Backup Histories
- 6.3.1.19.1: 1.0
- 6.3.1.20: Reset Replica
- 6.3.1.20.1: 1.0
- 6.3.1.21: Restart Cluster
- 6.3.1.21.1: 1.0
- 6.3.1.22: Set Archive Config
- 6.3.1.22.1: 1.0
- 6.3.1.23: Set Audit Log
- 6.3.1.23.1: 1.0
- 6.3.1.24: Set Backup
- 6.3.1.24.1: 1.0
- 6.3.1.25: Set Block Storage Size
- 6.3.1.25.1: 1.0
- 6.3.1.26: Set Log Export Config
- 6.3.1.26.1: 1.0
- 6.3.1.27: Set Maintenance
- 6.3.1.27.1: 1.0
- 6.3.1.28: Set Parameter Values
- 6.3.1.28.1: 1.0
- 6.3.1.29: Set Security Group Rules
- 6.3.1.29.1: 1.0
- 6.3.1.30: Set Server Type
- 6.3.1.30.1: 1.0
- 6.3.1.31: Show Archive Config
- 6.3.1.31.1: 1.0
- 6.3.1.32: Show Cluster
- 6.3.1.32.1: 1.0
- 6.3.1.33: Show Request
- 6.3.1.33.1: 1.0
- 6.3.1.34: Start Cluster
- 6.3.1.34.1: 1.0
- 6.3.1.35: Stop Cluster
- 6.3.1.35.1: 1.0
- 6.3.1.36: Switchover Cluster
- 6.3.1.36.1: 1.0
- 6.3.1.37: Synchronize Archive Config
- 6.3.1.37.1: 1.0
- 6.3.1.38: Synchronize Cluster State
- 6.3.1.38.1: 1.0
- 6.3.1.39: Synchronize Parameter Values
- 6.3.1.39.1: 1.0
- 6.3.1.40: Synchronize Replica State
- 6.3.1.40.1: 1.0
- 6.3.1.41: Terminate Cluster
- 6.3.1.41.1: 1.0
- 6.3.1.42: Unregister Log Export Config
- 6.3.1.42.1: 1.0
- 6.3.1.43: Unset Backup
- 6.3.1.43.1: 1.0
- 6.3.1.44: Unset Maintenance
- 6.3.1.44.1: 1.0
- 6.4: Microsoft SQL Server(DBaaS)
- 6.4.1: CLIs
- 6.4.1.1: Add Block Storages
- 6.4.1.1.1: 1.0
- 6.4.1.2: Add Secondary
- 6.4.1.2.1: 1.0
- 6.4.1.3: Add/Remove Databases
- 6.4.1.3.1: 1.0
- 6.4.1.4: Create Cluster
- 6.4.1.4.1: 1.0
- 6.4.1.5: Create Restore Cluster
- 6.4.1.5.1: 1.0
- 6.4.1.6: Export Log
- 6.4.1.6.1: 1.0
- 6.4.1.7: List Backup Histories
- 6.4.1.7.1: 1.0
- 6.4.1.8: List Clusters
- 6.4.1.8.1: 1.0
- 6.4.1.9: List Engine Version Properties
- 6.4.1.9.1: 1.0
- 6.4.1.10: List Engine Versions
- 6.4.1.10.1: 1.0
- 6.4.1.11: List Log Export Configs
- 6.4.1.11.1: 1.0
- 6.4.1.12: List Parameter Groups
- 6.4.1.12.1: 1.0
- 6.4.1.13: List Parameter Values
- 6.4.1.13.1: 1.0
- 6.4.1.14: List Parameters
- 6.4.1.14.1: 1.0
- 6.4.1.15: List Server Types
- 6.4.1.15.1: 1.0
- 6.4.1.16: Patch Minor Version
- 6.4.1.16.1: 1.0
- 6.4.1.17: Register Log Export Config
- 6.4.1.17.1: 1.0
- 6.4.1.18: Remove Backup Histories
- 6.4.1.18.1: 1.0
- 6.4.1.19: Restart Cluster
- 6.4.1.19.1: 1.0
- 6.4.1.20: Set Audit Log
- 6.4.1.20.1: 1.0
- 6.4.1.21: Set Backup
- 6.4.1.21.1: 1.0
- 6.4.1.22: Set Block Storage Size
- 6.4.1.22.1: 1.0
- 6.4.1.23: Set Log Export Config
- 6.4.1.23.1: 1.0
- 6.4.1.24: Set Maintenance
- 6.4.1.24.1: 1.0
- 6.4.1.25: Set Parameter Values
- 6.4.1.25.1: 1.0
- 6.4.1.26: Set Security Group Rules
- 6.4.1.26.1: 1.0
- 6.4.1.27: Set Server Type
- 6.4.1.27.1: 1.0
- 6.4.1.28: Show Cluster
- 6.4.1.28.1: 1.0
- 6.4.1.29: Show Request
- 6.4.1.29.1: 1.0
- 6.4.1.30: Start Cluster
- 6.4.1.30.1: 1.0
- 6.4.1.31: Stop Cluster
- 6.4.1.31.1: 1.0
- 6.4.1.32: Switchover Cluster
- 6.4.1.32.1: 1.0
- 6.4.1.33: Synchronize Cluster State
- 6.4.1.33.1: 1.0
- 6.4.1.34: Synchronize Parameter Values
- 6.4.1.34.1: 1.0
- 6.4.1.35: Terminate Cluster
- 6.4.1.35.1: 1.0
- 6.4.1.36: Unregister Log Export Config
- 6.4.1.36.1: 1.0
- 6.4.1.37: Unset Backup
- 6.4.1.37.1: 1.0
- 6.4.1.38: Unset Maintenance
- 6.4.1.38.1: 1.0
- 6.5: MySQL(DBaaS)
- 6.5.1: CLIs
- 6.5.1.1: Add Block Storages
- 6.5.1.1.1: 1.0
- 6.5.1.2: Create Cluster
- 6.5.1.2.1: 1.0
- 6.5.1.3: Create Replica
- 6.5.1.3.1: 1.0
- 6.5.1.4: Create Restore Cluster
- 6.5.1.4.1: 1.0
- 6.5.1.5: Export Log
- 6.5.1.5.1: 1.0
- 6.5.1.6: List Backup Histories
- 6.5.1.6.1: 1.0
- 6.5.1.7: List Clusters
- 6.5.1.7.1: 1.0
- 6.5.1.8: List Engine Version Properties
- 6.5.1.8.1: 1.0
- 6.5.1.9: List Engine Versions
- 6.5.1.9.1: 1.0
- 6.5.1.10: List Log Export Configs
- 6.5.1.10.1: 1.0
- 6.5.1.11: List Parameter Groups
- 6.5.1.11.1: 1.0
- 6.5.1.12: List Parameter Values
- 6.5.1.12.1: 1.0
- 6.5.1.13: List Parameters
- 6.5.1.13.1: 1.0
- 6.5.1.14: List Replicas
- 6.5.1.14.1: 1.0
- 6.5.1.15: List Server Types
- 6.5.1.15.1: 1.0
- 6.5.1.16: Patch Minor Version
- 6.5.1.16.1: 1.0
- 6.5.1.17: Promote Replica Cluster
- 6.5.1.17.1: 1.0
- 6.5.1.18: Register Log Export Config
- 6.5.1.18.1: 1.0
- 6.5.1.19: Remove Backup Histories
- 6.5.1.19.1: 1.0
- 6.5.1.20: Reset Replica
- 6.5.1.20.1: 1.0
- 6.5.1.21: Restart Cluster
- 6.5.1.21.1: 1.0
- 6.5.1.22: Set Archive Config
- 6.5.1.22.1: 1.0
- 6.5.1.23: Set Backup
- 6.5.1.23.1: 1.0
- 6.5.1.24: Set Block Storage Size
- 6.5.1.24.1: 1.0
- 6.5.1.25: Set Log Export Config
- 6.5.1.25.1: 1.0
- 6.5.1.26: Set Maintenance
- 6.5.1.26.1: 1.0
- 6.5.1.27: Set Parameter Values
- 6.5.1.27.1: 1.0
- 6.5.1.28: Set Security Group Rules
- 6.5.1.28.1: 1.0
- 6.5.1.29: Set Server Type
- 6.5.1.29.1: 1.0
- 6.5.1.30: Show Archive Config
- 6.5.1.30.1: 1.0
- 6.5.1.31: Show Cluster
- 6.5.1.31.1: 1.0
- 6.5.1.32: Show Request
- 6.5.1.32.1: 1.0
- 6.5.1.33: Start Cluster
- 6.5.1.33.1: 1.0
- 6.5.1.34: Stop Cluster
- 6.5.1.34.1: 1.0
- 6.5.1.35: Switchover Cluster
- 6.5.1.35.1: 1.0
- 6.5.1.36: Synchronize Archive Config
- 6.5.1.36.1: 1.0
- 6.5.1.37: Synchronize Cluster State
- 6.5.1.37.1: 1.0
- 6.5.1.38: Synchronize Parameter Values
- 6.5.1.38.1: 1.0
- 6.5.1.39: Synchronize Replica State
- 6.5.1.39.1: 1.0
- 6.5.1.40: Terminate Cluster
- 6.5.1.40.1: 1.0
- 6.5.1.41: Unregister Log Export Config
- 6.5.1.41.1: 1.0
- 6.5.1.42: Unset Backup
- 6.5.1.42.1: 1.0
- 6.5.1.43: Unset Maintenance
- 6.5.1.43.1: 1.0
- 6.6: PostgreSQL(DBaaS)
- 6.6.1: CLIs
- 6.6.1.1: Add Block Storages
- 6.6.1.1.1: 1.0
- 6.6.1.2: Create Cluster
- 6.6.1.2.1: 1.0
- 6.6.1.3: Create Other region Replica
- 6.6.1.3.1: 1.0
- 6.6.1.4: Create Replica
- 6.6.1.4.1: 1.0
- 6.6.1.5: Create Restore Cluster
- 6.6.1.5.1: 1.0
- 6.6.1.6: Delete Archive Log
- 6.6.1.6.1: 1.0
- 6.6.1.7: Export Log
- 6.6.1.7.1: 1.0
- 6.6.1.8: List Backup Histories
- 6.6.1.8.1: 1.0
- 6.6.1.9: List Clusters
- 6.6.1.9.1: 1.0
- 6.6.1.10: List Engine Version Properties
- 6.6.1.10.1: 1.0
- 6.6.1.11: List Engine Versions
- 6.6.1.11.1: 1.0
- 6.6.1.12: List Log Export Configs
- 6.6.1.12.1: 1.0
- 6.6.1.13: List Parameter Groups
- 6.6.1.13.1: 1.0
- 6.6.1.14: List Parameter Values
- 6.6.1.14.1: 1.0
- 6.6.1.15: List Parameters
- 6.6.1.15.1: 1.0
- 6.6.1.16: List Replicas
- 6.6.1.16.1: 1.0
- 6.6.1.17: List Server Types
- 6.6.1.17.1: 1.0
- 6.6.1.18: Patch Minor Version
- 6.6.1.18.1: 1.0
- 6.6.1.19: Promote Replica Cluster
- 6.6.1.19.1: 1.0
- 6.6.1.20: Register Log Export Config
- 6.6.1.20.1: 1.0
- 6.6.1.21: Remove Backup Histories
- 6.6.1.21.1: 1.0
- 6.6.1.22: Reset Replica
- 6.6.1.22.1: 1.0
- 6.6.1.23: Restart Cluster
- 6.6.1.23.1: 1.0
- 6.6.1.24: Set Archive Config
- 6.6.1.24.1: 1.0
- 6.6.1.25: Set Audit Log
- 6.6.1.25.1: 1.0
- 6.6.1.26: Set Backup
- 6.6.1.26.1: 1.0
- 6.6.1.27: Set Block Storage Size
- 6.6.1.27.1: 1.0
- 6.6.1.28: Set Log Export Config
- 6.6.1.28.1: 1.0
- 6.6.1.29: Set Maintenance
- 6.6.1.29.1: 1.0
- 6.6.1.30: Set Parameter Values
- 6.6.1.30.1: 1.0
- 6.6.1.31: Set Security Group Rules
- 6.6.1.31.1: 1.0
- 6.6.1.32: Set Server Type
- 6.6.1.32.1: 1.0
- 6.6.1.33: Show Archive Config
- 6.6.1.33.1: 1.0
- 6.6.1.34: Show Cluster
- 6.6.1.34.1: 1.0
- 6.6.1.35: Show Request
- 6.6.1.35.1: 1.0
- 6.6.1.36: Start Cluster
- 6.6.1.36.1: 1.0
- 6.6.1.37: Stop Cluster
- 6.6.1.37.1: 1.0
- 6.6.1.38: Switchover Cluster
- 6.6.1.38.1: 1.0
- 6.6.1.39: Synchronize Archive Config
- 6.6.1.39.1: 1.0
- 6.6.1.40: Synchronize Cluster State
- 6.6.1.40.1: 1.0
- 6.6.1.41: Synchronize Parameter Values
- 6.6.1.41.1: 1.0
- 6.6.1.42: Synchronize Replica State
- 6.6.1.42.1: 1.0
- 6.6.1.43: Terminate Cluster
- 6.6.1.43.1: 1.0
- 6.6.1.44: Unregister Log Export Config
- 6.6.1.44.1: 1.0
- 6.6.1.45: Unset Backup
- 6.6.1.45.1: 1.0
- 6.6.1.46: Unset Maintenance
- 6.6.1.46.1: 1.0
- 7: Data Analytics
- 7.1: Data Flow
- 7.1.1: CLIs
- 7.1.1.1: CheckClusterResourceSizeForDataFlowServiceCreate
- 7.1.1.2: CheckClusterResourceSizeForDataFlowServiceUpdate
- 7.1.1.3: CheckDataFlowNameDuplication
- 7.1.1.4: CheckDataFlowServiceNameDuplication
- 7.1.1.5: CreateDataFlow
- 7.1.1.6: CreateDataFlowService
- 7.1.1.7: DeleteDataFlow
- 7.1.1.8: DeleteDataFlowService
- 7.1.1.9: ListDataFlowImages
- 7.1.1.10: ListDataFlows
- 7.1.1.11: ListDataFlowService
- 7.1.1.12: ShowDataFlow
- 7.1.1.13: ShowDataFlowService
- 7.1.1.14: ShowDataFlowServiceSubVersions
- 7.1.1.15: UpdateDataFlow
- 7.1.1.16: UpdateDataFlowService
- 7.2: Data Ops
- 7.2.1: CLIs
- 7.2.1.1: CheckClusterResourceSizeForDataOpsServiceCreate
- 7.2.1.2: CheckClusterResourceSizeForDataOpsServiceUpdate
- 7.2.1.3: CheckDataOpsNameDuplication
- 7.2.1.4: CheckDataOpsServiceNameDuplication
- 7.2.1.5: CreateDataOps
- 7.2.1.6: CreateDataOpsService
- 7.2.1.7: DeleteDataOps
- 7.2.1.8: DeleteDataOpsService
- 7.2.1.9: ListDataOps
- 7.2.1.10: ListDataOpsImageVersions
- 7.2.1.11: ListDataOpsService
- 7.2.1.12: ShowDataOps
- 7.2.1.13: ShowDataOpsService
- 7.2.1.14: ShowDataOpsServiceSubVersion
- 7.2.1.15: UpdateDataOps
- 7.2.1.16: UpdateDataOpsService
- 7.3: Event Streams
- 7.3.1: CLIs
- 7.3.1.1: Add Instances
- 7.3.1.1.1: 1.0
- 7.3.1.2: Create Cluster
- 7.3.1.2.1: 1.0
- 7.3.1.3: List Clusters
- 7.3.1.3.1: 1.0
- 7.3.1.4: List Engine Version Properties
- 7.3.1.4.1: 1.0
- 7.3.1.5: List Engine Versions
- 7.3.1.5.1: 1.0
- 7.3.1.6: List Parameter Groups
- 7.3.1.6.1: 1.0
- 7.3.1.7: List Parameter Values
- 7.3.1.7.1: 1.0
- 7.3.1.8: List Parameters
- 7.3.1.8.1: 1.0
- 7.3.1.9: List Server Types
- 7.3.1.9.1: 1.0
- 7.3.1.10: Restart Cluster
- 7.3.1.10.1: 1.0
- 7.3.1.11: Set Block Storage Size
- 7.3.1.11.1: 1.0
- 7.3.1.12: Set Maintenance
- 7.3.1.12.1: 1.0
- 7.3.1.13: Set Parameter Values
- 7.3.1.13.1: 1.0
- 7.3.1.14: Set Security Group Rules
- 7.3.1.14.1: 1.0
- 7.3.1.15: Set Server Type
- 7.3.1.15.1: 1.0
- 7.3.1.16: Show Cluster
- 7.3.1.16.1: 1.0
- 7.3.1.17: Show Request
- 7.3.1.17.1: 1.0
- 7.3.1.18: Start Cluster
- 7.3.1.18.1: 1.0
- 7.3.1.19: Stop Cluster
- 7.3.1.19.1: 1.0
- 7.3.1.20: Synchronize Cluster State
- 7.3.1.20.1: 1.0
- 7.3.1.21: Synchronize Parameter Values
- 7.3.1.21.1: 1.0
- 7.3.1.22: Terminate Cluster
- 7.3.1.22.1: 1.0
- 7.3.1.23: Unset Maintenance
- 7.3.1.23.1: 1.0
- 7.4: Quick Query
- 7.4.1: CLIs
- 7.4.1.1: CheckClusterResourceSizeForQuickQuery
- 7.4.1.2: CheckDuplicationQuickQueryName
- 7.4.1.3: CreateQuickQuery
- 7.4.1.4: DeleteQuickQuery
- 7.4.1.5: ListQuickQuery
- 7.4.1.6: ListQuickQueryImages
- 7.4.1.7: ShowQuickQuery
- 7.4.1.8: UpdateQuickQueryDescription
- 7.4.1.9: UpdateQuickQueryDomain
- 7.4.1.10: UpdateQuickQueryDscDomain
- 7.4.1.11: UpdateQuickQueryEngine
- 7.4.1.12: UpdateQuickQueryHostAlias
- 7.5: Search Engine
- 7.5.1: CLIs
- 7.5.1.1: Add Block Storages
- 7.5.1.1.1: 1.0
- 7.5.1.2: Add Instances
- 7.5.1.2.1: 1.0
- 7.5.1.3: Create Cluster
- 7.5.1.3.1: 1.0
- 7.5.1.4: Create Restore Cluster
- 7.5.1.4.1: 1.0
- 7.5.1.5: List Backup Histories
- 7.5.1.5.1: 1.0
- 7.5.1.6: List Clusters
- 7.5.1.6.1: 1.0
- 7.5.1.7: List Engine Version Properties
- 7.5.1.7.1: 1.0
- 7.5.1.8: List Engine Versions
- 7.5.1.8.1: 1.0
- 7.5.1.9: List Server Types
- 7.5.1.9.1: 1.0
- 7.5.1.10: Remove Backup Histories
- 7.5.1.10.1: 1.0
- 7.5.1.11: Restart Cluster
- 7.5.1.11.1: 1.0
- 7.5.1.12: Set Backup
- 7.5.1.12.1: 1.0
- 7.5.1.13: Set Block Storage Size
- 7.5.1.13.1: 1.0
- 7.5.1.14: Set Maintenance
- 7.5.1.14.1: 1.0
- 7.5.1.15: Set Security Group Rules
- 7.5.1.15.1: 1.0
- 7.5.1.16: Set Server Type
- 7.5.1.16.1: 1.0
- 7.5.1.17: Show Cluster
- 7.5.1.17.1: 1.0
- 7.5.1.18: Show Request
- 7.5.1.18.1: 1.0
- 7.5.1.19: Start Cluster
- 7.5.1.19.1: 1.0
- 7.5.1.20: Stop Cluster
- 7.5.1.20.1: 1.0
- 7.5.1.21: Synchronize Cluster State
- 7.5.1.21.1: 1.0
- 7.5.1.22: Terminate Cluster
- 7.5.1.22.1: 1.0
- 7.5.1.23: Unset Backup
- 7.5.1.23.1: 1.0
- 7.5.1.24: Unset Maintenance
- 7.5.1.24.1: 1.0
- 7.6: Vertica(DBaaS)
- 7.6.1: CLIs
- 7.6.1.1: Add Block Storages
- 7.6.1.1.1: 1.0
- 7.6.1.2: Create Cluster
- 7.6.1.2.1: 1.0
- 7.6.1.3: Create Restore Cluster
- 7.6.1.3.1: 1.0
- 7.6.1.4: List Backup Histories
- 7.6.1.4.1: 1.0
- 7.6.1.5: List Clusters
- 7.6.1.5.1: 1.0
- 7.6.1.6: List Engine Version Properties
- 7.6.1.6.1: 1.0
- 7.6.1.7: List Engine Versions
- 7.6.1.7.1: 1.0
- 7.6.1.8: List Server Types
- 7.6.1.8.1: 1.0
- 7.6.1.9: Remove Backup Histories
- 7.6.1.9.1: 1.0
- 7.6.1.10: Restart Cluster
- 7.6.1.10.1: 1.0
- 7.6.1.11: Set Backup
- 7.6.1.11.1: 1.0
- 7.6.1.12: Set Block Storage Size
- 7.6.1.12.1: 1.0
- 7.6.1.13: Set Maintenance
- 7.6.1.13.1: 1.0
- 7.6.1.14: Set Security Group Rules
- 7.6.1.14.1: 1.0
- 7.6.1.15: Set Server Type
- 7.6.1.15.1: 1.0
- 7.6.1.16: Show Cluster
- 7.6.1.16.1: 1.0
- 7.6.1.17: Show Request
- 7.6.1.17.1: 1.0
- 7.6.1.18: Start Cluster
- 7.6.1.18.1: 1.0
- 7.6.1.19: Stop Cluster
- 7.6.1.19.1: 1.0
- 7.6.1.20: Synchronize Cluster State
- 7.6.1.20.1: 1.0
- 7.6.1.21: Terminate Cluster
- 7.6.1.21.1: 1.0
- 7.6.1.22: Unset Backup
- 7.6.1.22.1: 1.0
- 7.6.1.23: Unset Maintenance
- 7.6.1.23.1: 1.0
- 8: Application Service
- 8.1: API Gateway
- 8.1.1: CLIs
- 8.1.1.1: Approve PrivateLink Endpoint
- 8.1.1.1.1: 1.2
- 8.1.1.2: Connect PrivateLink Endpoint
- 8.1.1.2.1: 1.2
- 8.1.1.3: Create AccessControl
- 8.1.1.4: Create Api
- 8.1.1.5: Create Api Deployment
- 8.1.1.6: Create Api Key
- 8.1.1.7: Create Auth
- 8.1.1.8: Create Method
- 8.1.1.9: Create PrivateLink Endpoint
- 8.1.1.9.1: 1.2
- 8.1.1.10: Create Resource
- 8.1.1.11: Create Stage
- 8.1.1.12: Create Usage Plans
- 8.1.1.13: Delete Access Control
- 8.1.1.14: Delete an API Key
- 8.1.1.15: Delete Api
- 8.1.1.16: Delete Auth
- 8.1.1.17: Delete Method
- 8.1.1.18: Delete PrivateLink Endpoint
- 8.1.1.18.1: 1.2
- 8.1.1.19: Delete Resource
- 8.1.1.20: Delete Stage
- 8.1.1.21: Delete Usage Plan
- 8.1.1.22: List AccessControls
- 8.1.1.23: List Api Deployments
- 8.1.1.24: List Api Keys
- 8.1.1.25: List Apis
- 8.1.1.26: List Auths
- 8.1.1.27: List Connected PrivateLink Endpoints
- 8.1.1.27.1: 1.2
- 8.1.1.28: List Methods
- 8.1.1.29: List PrivateLink Endpoints
- 8.1.1.29.1: 1.2
- 8.1.1.30: List Reports
- 8.1.1.31: List Resources
- 8.1.1.32: List Stages
- 8.1.1.33: List Usage Plans
- 8.1.1.34: Request PrivateLink Endpoint
- 8.1.1.34.1: 1.2
- 8.1.1.35: Set Access Control
- 8.1.1.36: Set Api Description
- 8.1.1.37: Set API Key Description
- 8.1.1.38: Set Auth
- 8.1.1.39: Set Method
- 8.1.1.40: Set PrivateLink Endpoint
- 8.1.1.40.1: 1.2
- 8.1.1.41: Set Stage Active Deployment
- 8.1.1.42: Set Stage Configuration
- 8.1.1.43: Set Usage Plan Description
- 8.1.1.44: Set Usage Plan Quota
- 8.1.1.45: Show Access Control
- 8.1.1.46: Show Api
- 8.1.1.47: Show Auth
- 8.1.1.48: Show Method
- 8.1.1.49: Show PrivateLink Endpoint
- 8.1.1.49.1: 1.2
- 8.1.1.50: Show Resource
- 8.1.1.51: Show Stage
- 8.1.1.52: Show Usage Plan
- 8.2: Queue Service
- 8.2.1: CLIs
- 8.2.1.1: Check Queue Name Duplication
- 8.2.1.1.1: 1.0
- 8.2.1.2: Create Queue
- 8.2.1.2.1: 1.0
- 8.2.1.3: Delete Acl
- 8.2.1.3.1: 1.0
- 8.2.1.4: Delete Queue
- 8.2.1.4.1: 1.0
- 8.2.1.5: List Queue
- 8.2.1.5.1: 1.0
- 8.2.1.6: Set Acl
- 8.2.1.6.1: 1.0
- 8.2.1.7: Show Queue
- 8.2.1.7.1: 1.0
- 8.2.1.8: Update Queue Config
- 8.2.1.8.1: 1.0
- 8.2.1.9: Update Queue Description
- 8.2.1.9.1: 1.0
- 9: Security
- 9.1: Certificate Manager
- 9.1.1: CLIs
- 9.1.1.1: Check duplicate name
- 9.1.1.2: Create a certificate
- 9.1.1.3: Delete a certificate
- 9.1.1.4: Detail a certificate
- 9.1.1.5: List certificates
- 9.1.1.6: Self-sign a certificate
- 9.1.1.7: Validate a certificate
- 9.2: Config Inspection
- 9.2.1: CLIs
- 9.2.1.1: Create Config Inspection
- 9.2.1.2: Delete Config Inspection
- 9.2.1.3: Diagnosis Request
- 9.2.1.4: Get Diagnosis Object Detail
- 9.2.1.5: Get Diagnosis Result Detail
- 9.2.1.6: List Config Inspection
- 9.2.1.7: List Diagnosis Result
- 9.3: Key Management Service
- 9.3.1: CLIs
- 9.3.1.1: Change Rotate Info
- 9.3.1.2: Change State Of Key
- 9.3.1.3: Check Duplicate Name
- 9.3.1.4: Create Datakey
- 9.3.1.5: Create Key
- 9.3.1.6: Decrypt Data
- 9.3.1.7: Delete Key
- 9.3.1.8: Encrypt Data
- 9.3.1.9: List Keys
- 9.3.1.10: List Users
- 9.3.1.11: Make hmac
- 9.3.1.12: Rewrap Data
- 9.3.1.13: Rotate Key
- 9.3.1.14: Show Key
- 9.3.1.15: Sign Data
- 9.3.1.16: Update Description
- 9.3.1.17: Verify Data
- 9.3.1.18: Verify hmac with input
- 9.4: Secret Vault
- 9.4.1: CLIs
- 9.4.1.1: Create Secret Vault
- 9.4.1.1.1: 1.0
- 9.4.1.2: Delete Secret Vault
- 9.4.1.2.1: 1.0
- 9.4.1.3: List Secret Vaults
- 9.4.1.3.1: 1.0
- 9.4.1.4: Show Secret Vault
- 9.4.1.4.1: 1.0
- 9.5: Secrets Manager
- 9.5.1: CLIs
- 9.5.1.1: Create Secret
- 9.5.1.1.1: 1.0
- 9.5.1.2: Delete Secret
- 9.5.1.2.1: 1.0
- 9.5.1.3: Generate Random Password
- 9.5.1.3.1: 1.0
- 9.5.1.4: List Secrets
- 9.5.1.4.1: 1.0
- 9.5.1.5: List Versions of Secret
- 9.5.1.5.1: 1.0
- 9.5.1.6: Restore Secret
- 9.5.1.6.1: 1.0
- 9.5.1.7: Set CIDR of Secret
- 9.5.1.7.1: 1.0
- 9.5.1.8: Set Description of Secret
- 9.5.1.8.1: 1.0
- 9.5.1.9: Set KMS ID of Secret
- 9.5.1.9.1: 1.0
- 9.5.1.10: Set Label of Version
- 9.5.1.10.1: 1.0
- 9.5.1.11: Show Secret Detail
- 9.5.1.11.1: 1.0
- 9.5.1.12: Show Secret Value
- 9.5.1.12.1: 1.0
- 9.5.1.13: Update Secret Value
- 9.5.1.13.1: 1.0
- 10: Management
- 10.1: Cloud Control
- 10.1.1: CLIs
- 10.1.1.1: AddBaselineAssignment
- 10.1.1.1.1: 1.0
- 10.1.1.2: CreateAccountFactoryAccount
- 10.1.1.2.1: 1.0
- 10.1.1.3: CreateLandingZone
- 10.1.1.3.1: 1.0
- 10.1.1.4: DeleteLandingZone
- 10.1.1.4.1: 1.0
- 10.1.1.5: DisableGuardrailBindings
- 10.1.1.5.1: 1.0
- 10.1.1.6: EnableGuardrailBindings
- 10.1.1.6.1: 1.0
- 10.1.1.7: ListBaselineAssignments
- 10.1.1.7.1: 1.0
- 10.1.1.8: ListGuardrails
- 10.1.1.8.1: 1.0
- 10.1.1.9: ListGuardrailsForTarget
- 10.1.1.9.1: 1.0
- 10.1.1.10: ListTargetsForGuardrail
- 10.1.1.10.1: 1.0
- 10.1.1.11: ShowGuardrail
- 10.1.1.11.1: 1.0
- 10.1.1.12: ShowLandingZone
- 10.1.1.12.1: 1.0
- 10.1.1.13: UpdateBaselineAssignment
- 10.1.1.13.1: 1.0
- 10.2: Cloud Monitoring
- 10.2.1: CLIs
- 10.2.1.1: CreateEventPolicy
- 10.2.1.1.1: 1.0
- 10.2.1.2: DeleteEventPolicy
- 10.2.1.2.1: 1.0
- 10.2.1.3: ListAccountEvents
- 10.2.1.3.1: 1.0
- 10.2.1.4: ListAccountMember
- 10.2.1.4.1: 1.0
- 10.2.1.5: ListAccountResources
- 10.2.1.5.1: 1.0
- 10.2.1.6: ListAddressBookMembers
- 10.2.1.6.1: 1.0
- 10.2.1.7: ListAddressBooks
- 10.2.1.7.1: 1.0
- 10.2.1.8: ListEventPolicies
- 10.2.1.8.1: 1.0
- 10.2.1.9: ListEventPolicyHistories
- 10.2.1.9.1: 1.0
- 10.2.1.10: ListEventPolicyNotification
- 10.2.1.10.1: 1.0
- 10.2.1.11: ListMetricPefData
- 10.2.1.11.1: 1.0
- 10.2.1.12: ListMetrics
- 10.2.1.12.1: 1.0
- 10.2.1.13: ListResourceEvents
- 10.2.1.13.1: 1.0
- 10.2.1.14: ListService
- 10.2.1.14.1: 1.0
- 10.2.1.15: SetEventPolicy
- 10.2.1.15.1: 1.0
- 10.2.1.16: ShowEventNotificationStates
- 10.2.1.16.1: 1.0
- 10.2.1.17: ShowEventPolicy
- 10.2.1.17.1: 1.0
- 10.2.1.18: ShowResourceEvent
- 10.2.1.18.1: 1.0
- 10.3: IAM
- 10.3.1: CLIs
- 10.3.1.1: Add a permission into the resource based policy
- 10.3.1.2: Add a user to a group
- 10.3.1.3: Assign policies to the group
- 10.3.1.4: Assign policies to user
- 10.3.1.5: Attach policies to Role
- 10.3.1.6: Create a group
- 10.3.1.7: Create a policy
- 10.3.1.8: Create a saml provider
- 10.3.1.9: Create an access key
- 10.3.1.10: Create IAM user
- 10.3.1.11: Create role
- 10.3.1.12: Delete bulk role
- 10.3.1.13: Delete IAM user
- 10.3.1.14: Delete IAM users
- 10.3.1.15: Delete role
- 10.3.1.16: Delete the policy
- 10.3.1.17: Delete the resource based policy
- 10.3.1.18: Delete user policy
- 10.3.1.19: Detach policies to Role
- 10.3.1.20: Detach policy to Role
- 10.3.1.21: Get a Group
- 10.3.1.22: Get a specific policy binding list
- 10.3.1.23: Get an access key
- 10.3.1.24: Get endpoint list
- 10.3.1.25: Get IAM users
- 10.3.1.26: Get policy list
- 10.3.1.27: Get role
- 10.3.1.28: Get role list
- 10.3.1.29: Get Role Policy-Binding list
- 10.3.1.30: Get saml provider information
- 10.3.1.31: Get service account
- 10.3.1.32: Get user policy-binding list
- 10.3.1.33: Group Member list
- 10.3.1.34: List access keys
- 10.3.1.35: List Groups
- 10.3.1.36: List IAM users
- 10.3.1.37: List saml providers
- 10.3.1.38: List service accounts
- 10.3.1.39: Modify a Group
- 10.3.1.40: Query policy list
- 10.3.1.41: Remove a permission into the resource based policy
- 10.3.1.42: Remove a User from a Group
- 10.3.1.43: Remove policies
- 10.3.1.44: Remove policy assignment from group
- 10.3.1.45: Remove saml providers
- 10.3.1.46: Remove the access key
- 10.3.1.47: Remove the access keys
- 10.3.1.48: Remove the Group
- 10.3.1.49: Send Temporary Access Key OTP
- 10.3.1.50: Set a permission into the resource based policy
- 10.3.1.51: Set an access key
- 10.3.1.52: Set role
- 10.3.1.53: Set role trust policy
- 10.3.1.54: Set the policy
- 10.3.1.55: Set the resource based policy
- 10.3.1.56: Show group policy
- 10.3.1.57: Show the policy
- 10.3.1.58: Show the resource based policy
- 10.3.1.59: Update IAM user
- 10.3.1.60: Update IAM user password
- 10.3.1.61: Update saml provider information
- 10.4: ID Center
- 10.4.1: CLIs
- 10.4.1.1: CreateAccountAssignment
- 10.4.1.2: CreateBulkGroupUsers
- 10.4.1.3: CreateGroup
- 10.4.1.4: CreateInstance
- 10.4.1.5: CreatePermissionSet
- 10.4.1.6: CreateUser
- 10.4.1.7: DeleteAccountAssignment
- 10.4.1.8: DeleteBulkAccountAssignment
- 10.4.1.9: DeleteBulkGroups
- 10.4.1.10: DeleteBulkGroupUsers
- 10.4.1.11: DeleteBulkUsers
- 10.4.1.12: DeleteGroup
- 10.4.1.13: DeleteInstance
- 10.4.1.14: DeletePermissionSet
- 10.4.1.15: DeletePermissionSetPolicies
- 10.4.1.16: DeleteUser
- 10.4.1.17: ListAccountAssignments
- 10.4.1.18: ListGroups
- 10.4.1.19: ListGroupUsers
- 10.4.1.20: ListInstances
- 10.4.1.21: ListPermissionSetPolicies
- 10.4.1.22: ListPermissionSets
- 10.4.1.23: ListUsers
- 10.4.1.24: SetGroup
- 10.4.1.25: SetPermissionSet
- 10.4.1.26: SetPermissionSetPolicies
- 10.4.1.27: SetUser
- 10.4.1.28: ShowGroup
- 10.4.1.29: ShowInstance
- 10.4.1.30: ShowPermissionSet
- 10.4.1.31: ShowUser
- 10.5: Logging&Audit
- 10.5.1: CLIs
- 10.5.1.1: CreateTrail
- 10.5.1.2: DeleteTrail
- 10.5.1.3: DownloadLogs
- 10.5.1.4: ListLogs
- 10.5.1.5: ListTrails
- 10.5.1.6: SetTrail
- 10.5.1.7: ShowLog
- 10.5.1.8: ShowTrail
- 10.5.1.9: StartTrail
- 10.5.1.10: StopTrail
- 10.6: Network Logging
- 10.6.1: CLIs
- 10.6.1.1: Create Network Logging Storage
- 10.6.1.1.1: 1.0
- 10.6.1.2: Delete Network Logging Storage
- 10.6.1.2.1: 1.0
- 10.6.1.3: List Network Logging Configurations
- 10.6.1.3.1: 1.0
- 10.6.1.4: List Network Logging Storages
- 10.6.1.4.1: 1.0
- 10.7: Organization
- 10.7.1: CLIs
- 10.7.1.1: AcceptInvitation
- 10.7.1.2: AttachPolicyBindings
- 10.7.1.3: CancelInvitations
- 10.7.1.4: CreateAccount
- 10.7.1.5: CreateDelegationPolicy
- 10.7.1.6: CreateInvitation
- 10.7.1.7: CreateOrganization
- 10.7.1.8: CreateOrganizationUnit
- 10.7.1.9: CreateServiceControlPolicy
- 10.7.1.10: DeclineInvitation
- 10.7.1.11: DeleteDelegationPolicy
- 10.7.1.12: DeleteOrganization
- 10.7.1.13: DeleteOrganizationUnits
- 10.7.1.14: DeleteServiceControlPolicies
- 10.7.1.15: LeaveOrganization
- 10.7.1.16: ListAccountInvitations
- 10.7.1.17: ListAccounts
- 10.7.1.18: ListOrganizationInvitations
- 10.7.1.19: ListOrganizations
- 10.7.1.20: ListOrganizationUnits
- 10.7.1.21: ListParents
- 10.7.1.22: ListPoliciesForTarget
- 10.7.1.23: ListServiceControlPolicies
- 10.7.1.24: ListTargetsForPolicy
- 10.7.1.25: MoveAccount
- 10.7.1.26: RemoveAccounts
- 10.7.1.27: RemovePolicyBindings
- 10.7.1.28: SetDelegationPolicy
- 10.7.1.29: SetOrganization
- 10.7.1.30: SetOrganizationUnit
- 10.7.1.31: SetServiceControlPolicy
- 10.7.1.32: ShowAccount
- 10.7.1.33: ShowDelegationPolicy
- 10.7.1.34: ShowOrganization
- 10.7.1.35: ShowOrganizationUnit
- 10.7.1.36: ShowServiceControlPolicy
- 10.8: Quota Service
- 10.8.1: CLIs
- 10.8.1.1: ListAccountQuota
- 10.8.1.2: ListQuotaRequests
- 10.8.1.3: ShowAccountQuota
- 10.8.1.4: ShowQuotaRequest
- 10.9: Resource Manager
- 10.9.1: CLIs
- 10.9.1.1: CreateResourceGroup
- 10.9.1.1.1: 1.0
- 10.9.1.2: DeleteComponentsTag
- 10.9.1.2.1: 1.0
- 10.9.1.3: DeleteComponentsTags
- 10.9.1.3.1: 1.0
- 10.9.1.4: DeleteResourceGroup
- 10.9.1.4.1: 1.0
- 10.9.1.5: DeleteResourceGroups
- 10.9.1.5.1: 1.0
- 10.9.1.6: DeleteResourceTag
- 10.9.1.6.1: 1.0
- 10.9.1.7: DeleteResourceTags
- 10.9.1.7.1: 1.0
- 10.9.1.8: DeleteTags
- 10.9.1.8.1: 1.0
- 10.9.1.9: ListComponentsTags
- 10.9.1.9.1: 1.0
- 10.9.1.10: ListResourceGroupResources
- 10.9.1.10.1: 1.0
- 10.9.1.11: ListResourceGroups
- 10.9.1.11.1: 1.0
- 10.9.1.12: ListResources
- 10.9.1.12.1: 1.0
- 10.9.1.13: ListResourceTags
- 10.9.1.13.1: 1.0
- 10.9.1.14: ListTagKeys
- 10.9.1.14.1: 1.0
- 10.9.1.15: ListTags
- 10.9.1.15.1: 1.0
- 10.9.1.16: ListTagValues
- 10.9.1.16.1: 1.0
- 10.9.1.17: SetResourceGroup
- 10.9.1.17.1: 1.0
- 10.9.1.18: ShowComponentsTag
- 10.9.1.18.1: 1.0
- 10.9.1.19: ShowResource
- 10.9.1.19.1: 1.0
- 10.9.1.20: ShowResourceByComponents
- 10.9.1.20.1: 1.0
- 10.9.1.21: ShowResourceGroup
- 10.9.1.21.1: 1.0
- 10.9.1.22: ShowResourceTag
- 10.9.1.22.1: 1.0
- 10.9.1.23: UpdateComponentsTags
- 10.9.1.23.1: 1.0
- 10.9.1.24: UpdateComponentsTagValue
- 10.9.1.24.1: 1.0
- 10.9.1.25: UpdateResourceTags
- 10.9.1.25.1: 1.0
- 10.9.1.26: UpdateResourceTagValue
- 10.9.1.26.1: 1.0
- 10.9.1.27: UpdateTags
- 10.9.1.27.1: 1.0
- 10.10: ServiceWatch
- 10.10.1: CLIs
- 10.10.1.1: CreateCustomLogEvents
- 10.10.1.1.1: 1.1
- 10.10.1.2: CreateCustomLogStream
- 10.10.1.2.1: 1.1
- 10.10.1.3: CreateCustomMetricMetas
- 10.10.1.3.1: 1.1
- 10.10.1.4: CreateCustomMetrics
- 10.10.1.4.1: 1.1
- 10.10.1.5: CreateDashboard
- 10.10.1.6: DeleteBulkDashboards
- 10.10.1.7: DownloadMetricDataImage
- 10.10.1.8: ListDashboards
- 10.10.1.9: ListMetricData
- 10.10.1.10: ListMetricInfos
- 10.10.1.11: SetDashboard
- 10.10.1.12: ShowAgentDownloadLink
- 10.10.1.12.1: 1.1
- 10.10.1.13: ShowDashboard
- 10.11: Support
- 10.11.1: CLIs
- 10.11.1.1: Get Inquiry List
- 10.11.1.1.1: 1.0
- 10.11.1.2: Get Service Request List
- 10.11.1.2.1: 1.0
- 10.11.1.3: Show Inquiry
- 10.11.1.3.1: 1.0
- 10.11.1.4: Show Service Request
- 10.11.1.4.1: 1.0
- 11: Platform
- 11.1: Product
- 11.1.1: CLIs
- 11.1.1.1: List Product Categories
- 11.1.1.1.1: 1.0
- 11.1.1.2: List Products
- 11.1.1.2.1: 1.0
- 11.1.1.3: Show Product
- 11.1.1.3.1: 1.0
- 11.1.1.4: Show Product category
- 11.1.1.4.1: 1.0
- 11.2: STS
- 11.2.1: CLIs
- 11.2.1.1: Acquire temporary role credential
- 11.2.1.1.1: 1.0
- 11.2.1.2: Acquire temporary role credential from SAML Assertion
- 11.2.1.2.1: 1.0
- 11.2.1.3: Create new Signature based on Session Token
- 11.2.1.3.1: 1.0
- 12: Financial Management
- 12.1: BillingPlan
- 12.1.1: CLIs
- 12.1.1.1: Change Request Planned Compute
- 12.1.1.1.1: 1.0
- 12.1.1.2: Create Request Planned Computes
- 12.1.1.2.1: 1.0
- 12.1.1.3: Get Planned Compute
- 12.1.1.3.1: 1.0
- 12.1.1.4: GetCancellationFee
- 12.1.1.4.1: 1.0
- 12.1.1.5: List Contract Type
- 12.1.1.5.1: 1.0
- 12.1.1.6: List OS System
- 12.1.1.6.1: 1.0
- 12.1.1.7: List Planned Compute Covered Resource
- 12.1.1.7.1: 1.0
- 12.1.1.8: ListServerType
- 12.1.1.8.1: 1.0
- 12.1.1.9: ListServiceType
- 12.1.1.9.1: 1.0
- 12.2: Budget
- 12.2.1: CLIs
- 12.2.1.1: CreateAccountBudget
- 12.2.1.1.1: 1.0
- 12.2.1.2: DeleteAccountBudget
- 12.2.1.2.1: 1.0
- 12.2.1.3: ListAccountBudgets
- 12.2.1.3.1: 1.0
- 12.2.1.4: SetAccountBudget
- 12.2.1.4.1: 1.0
- 12.2.1.5: ShowAccountBudget
- 12.2.1.5.1: 1.0
- 12.3: CostExplorer
- 12.3.1: CLIs
- 12.3.1.1: GetPaymentMonthly
- 12.3.1.1.1: 1.0
- 12.3.1.2: ListBills
- 12.3.1.2.1: 1.0
- 12.3.1.3: ListUsages
- 12.3.1.3.1: 1.0
- 13: DevOps Tools
- 13.1: DevOps Service
- 13.1.1: CLIs
- 13.1.1.1: Check Deletable DevOps Service
- 13.1.1.1.1: 1.0
- 13.1.1.2: Check Duplication DevOps Service
- 13.1.1.2.1: 1.0
- 13.1.1.3: Create DevOps Service
- 13.1.1.3.1: 1.0
- 13.1.1.4: Delete DevOps Service
- 13.1.1.4.1: 1.0
- 13.1.1.5: List DevOps Services
- 13.1.1.5.1: 1.0
- 13.1.1.6: Show DevOps Service
- 13.1.1.6.1: 1.0
- 14: AI-ML
- 14.1: AI&MLOps Platform
- 14.1.1: CLIs
- 14.1.1.1: Check Cluster Version
- 14.1.1.1.1: 1.0
- 14.1.1.2: Check Duplication AI&MLOps Platform Name
- 14.1.1.2.1: 1.0
- 14.1.1.3: Create AI&MLOps Platform
- 14.1.1.3.1: 1.0
- 14.1.1.4: Delete AI&MLOps Platform
- 14.1.1.4.1: 1.0
- 14.1.1.5: Get AI&MLOps Platform details
- 14.1.1.5.1: 1.0
- 14.1.1.6: List AI&MLOps Platform
- 14.1.1.6.1: 1.0
- 14.1.1.7: List Images
- 14.1.1.7.1: 1.0
- 14.1.1.8: List Nodes
- 14.1.1.8.1: 1.0
- 14.1.1.9: List StorageClasses
- 14.1.1.9.1: 1.0
- 14.1.1.10: Update AI&MLOps Platform
- 14.1.1.10.1: 1.0
- 14.1.1.11: Validate Cluster Namespace
- 14.1.1.11.1: 1.0
- 14.1.1.12: Validate Cluster Resource Size
- 14.1.1.12.1: 1.0
- 14.2: Cloud ML
- 14.2.1: CLIs
- 14.2.1.1: CheckDuplicationNameAndDomainName
- 14.2.1.1.1: 1.0
- 14.2.1.2: CloudMLClusterCheckEstimate
- 14.2.1.2.1: 1.0
- 14.2.1.3: CloudMLImages
- 14.2.1.3.1: 1.0
- 14.2.1.4: ClusterCheckReleasable
- 14.2.1.4.1: 1.0
- 14.2.1.5: ClusterProduct
- 14.2.1.5.1: 1.0
- 14.2.1.6: CreateCloudML
- 14.2.1.6.1: 1.0
- 14.2.1.7: DeleteCloudML
- 14.2.1.7.1: 1.0
- 14.2.1.8: ShowCloudML
- 14.2.1.8.1: 1.0
- 14.2.1.9: UpdateCloudML
- 14.2.1.9.1: 1.0
- 15:
1 - Common
Overview
삼성 클라우드 플랫폼에서 제공하는 인프라/솔루션 상품을 이용할 수있도록 지원하는 명령줄 인터페이스(Command Line Interface, CLI)를 제공하고 있습니다.
본 가이드에서는 삼성 클라우드 플랫폼 Open API에 대한 간략한 설명 및 CLI 호출하는 방법을 제공합니다.
CLI에 따라 파라미터 값을 입력하고 등록, 수정, 삭제 , 조회 할 수 있습니다.
설치
CLI는 아래에서 다운로드 합니다.
windows
linux
다운 받은 파일에 실행권한을 부여 합니다.
chmod +x scp-cli
사전 필요 사항
인증키 발급
삼성 클라우드 플랫폼의 CLI 기능을 사용하시려면 인증키를 발급받아야 합니다.
인증키 발급은 삼성 클라우드 플랫폼 콘솔의 왼쪽 상단 [My 메뉴] > [My Info] > [인증키 관리] 에서 확인 할 수 있습니다.
인증키는 Access Key와 Access Secret Key의 한 쌍으로 구성되어 있습니다. 인증키는 API 인증 토큰을 발급할 때 사용됩니다.
- Samsung Cloud Platform Console에 로그인을 하세요.
- My 메뉴 > My Info > 인증키 관리 메뉴로 이동하여, 인증키 생성 버튼을 클릭하세요.
- 기간과 사용 용도를 작성하고, 확인 버튼을 클릭하여 인증키를 생성하세요.
- 인증키 목록에서 발급받은 Access Key와 Access Secret Key를 확인하세요.
- Access Secret Key는 인증키 상세 페이지에서 확인할 수 있습니다.
임시 보안 자격 증명 (Optional)
임시 보안 자격 증명은 사용자가 정해진 시간 동안만 유효한 인증 정보를 통해 시스템에 접근할 수 있도록 하는 기능입니다. 이 자격 증명은 일반적으로 다음과 같은 목적을 위해 사용됩니다:
- 보안 강화: 장기 자격 증명(예: API 키, 비밀번호) 유출 시의 피해를 줄이기 위해
- 권한 위임: 외부 사용자나 시스템에 제한된 권한을 임시로 부여 가능
- 자동 만료: 자격 증명이 일정 시간 후 자동으로 만료되므로 관리가 간편
구성 요소
임시 자격 증명은 일반적으로 다음 정보를 포함합니다:
- Access Key : 인증을 위한 식별자
- Secret Key : 암호화된 인증 서명 생성에 사용
- Session Token: 세션 식별 및 유효성 검사를 위한 토큰
임시 보안 자격 증명 생성하기
삼성 클라우드 플랫폼의 임시 보안 자격 증명 기능을 사용하시려면 역할을 생성하여야 합니다.
역할 생성은 삼성 클라우드 플랫폼 콘솔의 [My 메뉴] > [My Info] > [역할] 에서 확인 할 수 있습니다.
수행 주체
- 역할을 생성할시 해당 역할을 맡을 수 있는 수행 주체를 설정해 주어야 합니다.
- 수행 주체는 역할을 맡을 수 있는 계정, 사용자 SRN, 자격 증명 공급자 등으로 지정합니다
정책
- 역할을 맡은 사람이 어떤 행동을 할 수 있는지 정의하는 정책을 설정해주어야 합니다.
- 정책은 최소 권한 원칙(Principle of Least Privilege)을 준수하여 필요한 권한만 부여합니다
- Samsung Cloud Platform Console에 로그인을 하세요.
- My 메뉴 > My Info > 역할 메뉴로 이동하여, 역할 생성 버튼을 클릭하세요.
- 역할명을 작성하고 최대 세션 지속 시간을 선택하여 역할 수임의 유효시간을 설정하세요.
- 수행 주체 항목에서 구분 버튼을 눌러 수행 주체를 설정할 수 있으며, 추가 버튼을 눌러 여러 수행 주체 설정이 가능합니다
- 정책의 목록에서 원하는 정책을 확인한 후 왼쪽의 체크박스을 누르면 정책의 설정이 가능합니다
- 완료 버튼을 눌러 역할의 생성을 확인합니다
이후엔 역할자의 토큰을 생성해주어야 합니다. 이는 assume-role api를 수행하여야 하며, 결과 값으로는 Access key, Secret key, Session token을 받게 됩니다
assume-role 사용법 문서 : assume-role 사용법
실행 환경 설정 관리
CLI의 실행 환경 설정은 config 파일로 정의하여 수행합니다. 해당 파일은 PC 내, 해당위치에 파일 형태로 작성 되어야 합니다.
windows
C:\Users\{사용자명}\.scp\cli-config.json
linux
~/.scp/cli-config.json
설정 파일의 포멧은 JSON 포멧을 지원하며, 아래와 같이 설정합니다.
{
"auth_url": "https://iam.s.samsungsdscloud.com/v1/endpoints",
"access_key": "my-access-key",
"access_secret_key": "my-access-secret-key",
"default_scp_region": "kr-west1",
(Optional) "session_token": "session_token"
}
설정 항목 확인
| key | 설명 | 예시 |
|---|---|---|
| auth_url | 인증 url | https://iam.s.samsungsdscloud.com/v1/endpoints |
| access_key | 발급받은 access key | my-access-key |
| access_secret_key | 발급받은 access secret key | my-access-secret-key |
| default_scp_region | 기본 region 이름 | kr-west1 |
| (Optional) session_token | 임시 보안 자격 증명의 세션 토큰 | session_token |
auth_url 예시
| Environment | env value | Example Service URL |
|---|---|---|
| for Samsung | s | https://iam.s.samsungsdscloud.com/v1/endpoints |
| for Sovereign | g | https://iam.g.samsungsdscloud.com/v1/endpoints |
| for Enterprise | e | https://iam.e.samsungsdscloud.com/v1/endpoints |
CLI 명령어
명령어 도움말
CLI 명령어 형식은 아래와 같습니다.
scp-cli [서비스] [리소스] [actcion] [--option and parameters]
// e.g. ( 예제의 입출력 결과는 예시를 위한 것이며 실제와 다를 수 있습니다. )
> scp-cli iam user create --user-name TestUser
사용 가능한 명령어는 –help를 통해 확인할 수 있습니다.
scp-cli iam policy create --help
usage: scp-cli iam policy create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width]
[--print-empty] --Version [VERSION] --Statement [STATEMENT ...] --policy_name [POLICY_NAME]
[--default_version_id [DEFAULT_VERSION_ID]] [--description [DESCRIPTION]] [--policy_category [POLICY_CATEGORY]]
[--policy_type [POLICY_TYPE]] [--service_type [SERVICE_TYPE]] [--tags [TAGS ...]] [--policy_id [POLICY_ID]]
[--policy_version_id [POLICY_VERSION_ID]] [--policy_version_name [POLICY_VERSION_NAME]]
Create a policy
options:
-h, --help show this help message and exit
--Version [VERSION]
[Required] Policy Version.
--Statement [STATEMENT ...]
[Required] Statement.
--policy_name [POLICY_NAME]
[Required] Policy Name.
--default_version_id [DEFAULT_VERSION_ID]
[Optional] Default Version Id.
--description [DESCRIPTION]
[Optional] Description.
--policy_category [POLICY_CATEGORY]
[Optional] Policy Category.
--policy_type [POLICY_TYPE]
[Optional] Policy Type.
--service_type [SERVICE_TYPE]
[Optional] Service Type.
--tags [TAGS ...]
[Optional] Policy Tag.
--policy_id [POLICY_ID]
[Optional] Policy ID.
--policy_version_id [POLICY_VERSION_ID]
[Optional] Policy Version Id.
--policy_version_name [POLICY_VERSION_NAME]
[Optional] Policy Version Name.
옵션 설명에 “[Required]” 표시는 필수 옵션 항목이며, “[Optional]” 표시는 선택 옵션 항목입니다.
API 버저닝
CLI는 Micro version 형태의 API 버전을 지원하며 명령어를 통해 각 상품의 api 버전을 확인 할 수 있습니다.
기본적으로, 현재 상품이 지원하는 최신 버전이 호출 되며, CLI 버전에 따라 호출 가능한 기본버전이 따라 응답 출력이 다를 수 있습니다.
–{상품명}–api-version 인자를 통해, 고정된 버전의 CLI를 사용할 수 있습니다.
- 해당 인자는 global option 인자로 대화형 모드 사용 시, 진입시 설정이 필요합니다.
API 버전확인 CLI Command 호출예시
scp-cli versions show [--region-name <region_name>] [--service <service>] [--status <status>] [--timeout <timeout>]
API 버전 CLI 예시
+-------------+----------------------------+---------+-----------+---------------------------------------------------------+------------+
| Region Name | Service Name | Version | Status | Endpoint | Not Before |
+-------------+----------------------------+---------+-----------+---------------------------------------------------------+------------+
| kr-west1 | data-flow | 1.0 | CURRENT | https://data-flow.kr-west1.e.samsungsdscloud.com | None |
| kr-west1 | data-ops | 1.0 | CURRENT | https://data-ops.kr-west1.e.samsungsdscloud.com | None |
| kr-west2 | scp-aimlops-platform | 1.0 | CURRENT | https://aimlops-platform.kr-west2.e.samsungsdscloud.com | None |
| kr-west1 | scp-aimlops-platform | 1.0 | CURRENT | https://aimlops-platform.kr-west1.e.samsungsdscloud.com | None |
| kr-west1 | scp-apigateway | 1.1 | CURRENT | https://apigateway.kr-west1.e.samsungsdscloud.com | None |
API 버전 Status 목록
| STATUS | Description |
|---|---|
| CURRENT | 현재 사용 권장되는 최신버전 (최신 1개만 유지) |
| SUPPORTED | 신규 기능의 추가는 없고 bug fix만 되는 버전 |
| PLANNED | 미리 다음 버전 정보를 주기 위한 단계 API 호출 불가, 문서로만 제공 |
| DEPRECATED | API 버전의 남은 Not Before 기간이 90일 이하인 단계 |
대화형 모드
대화형 모드로 CLI를 실행하여, 사용 할 수 있습니다.
scp-cli <global 인자>
global 인자의 설정이 필요한 경우, 실행시 입력하여 설정 후 진입합니다.
global 인자 : CLI를 수행할 때 사용되는 명령어의 인자 외 제공 되는 인자. (ex. debug, microversion 등)
global 인자 사용 예시
scp-cli --iam-api-version 1.3 --vpc-api-version 1.3
실행 후 아래와 같은 프롬프트가 나타나며, 명령을 직접 입력하여 실행할 수 있습니다.
(scp-cli)
대화형 모드 사용 예시
(scp-cli) iam policy list
종료 하려면 Ctrl + D 를 통해 대화형 모드를 종료합니다.
2 - Compute
2.1 - Bare Metal Server
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Bare Metal Server 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
2.1.1 - CLIs
2.1.1.1 - Assign Baremetal Private NAT IP
2.1.1.1.1 - 1.1
scpcli baremetal private-nat-ip create
--baremetal_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Bare Metal Server Private NAT IP 연결 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
| private_nat_ip_id required | string | Private NAT IP ID | 03cd065d8acc4e47b11a11dc1411323e |
| private_nat_id required | string | Private NAT ID | a4fd0216cd32442a82733bbb8be0e82b |
Responses
| Name | Description | Example |
|---|---|---|
| nat_id | NAT ID | a4fd0216cd32442a82733bbb8be0e82b |
| nat_ip | NAT IP | 192.170.2.10 |
| nat_ip_id | NAT IP ID | 20c507a036c447cdb3b19468d8ea62ac |
| state | Static NAT 상태 | ACTIVE |
| static_nat_id | Static NAT ID | a1b97ae4695b40b0866e86a19cb191d3 |
2.1.1.2 - Assign Baremetal Public NAT IP
2.1.1.2.1 - 1.1
scpcli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>
Description
Bare Metal Server NAT IP 연결 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
| public_ip_address_id required | string | Public NAT ID | 20c507a036c447cdb3b19468d8ea62ac |
Responses
| Name | Description | Example |
|---|---|---|
| baremetal_id | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.2.2 - 1.0
scpcli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>
Description
Bare Metal Server NAT IP 연결 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
| public_ip_address_id required | string | Public NAT ID | 20c507a036c447cdb3b19468d8ea62ac |
Responses
| Name | Description | Example |
|---|---|---|
| baremetal_id | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.3 - Attach Baremetal Local Subnet
2.1.1.3.1 - 1.1
scpcli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]
Description
Bare Metal Server 로컬 서브넷 연결 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
| local_subnet_id required | string | 로컬 Subnet ID | ab313c43291e4b678f4bacffe10768ae |
| local_subnet_ip optional | string | 로컬 Subnet IP | 192.168.0.1 |
2.1.1.3.2 - 1.0
scpcli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]
Description
Bare Metal Server 로컬 서브넷 연결 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
| local_subnet_id required | string | 로컬 Subnet ID | ab313c43291e4b678f4bacffe10768ae |
| local_subnet_ip optional | string | 로컬 Subnet IP | 192.168.0.1 |
2.1.1.4 - Create Baremetals
2.1.1.4.1 - 1.1
scpcli baremetal baremetal create
--vpc_id <value>
--subnet_id <value>
--server_details <value>
--region_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
[--init_script <value>]
[--lock_enabled <value>]
[--placement_group_name <value>]
[--tags <value>]
[--use_placement_group <value>]
Description
Bare Metal Server 생성 요청 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | e58348b1bc9148e5af86500fd4ef99ca |
| subnet_id required | string | Subnet ID | ab313c43291e4b678f4bacffe10768ae |
| server_details required | array | 서버별 세부 설정 | '{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "ip_address": "192.168.0.1", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "server_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg", "use_hyper_threading": true}' |
| region_id required | string | 리전 ID | kr-west1 |
| os_user_password required | string | OS 유저 패스워드 | password |
| os_user_id required | string | OS 유저 ID | user001 |
| image_id required | string | 이미지 ID | IMAGE-7XFMaJpLsapKvskFMjCtmm |
| init_script optional | string | Init script | init script |
| lock_enabled optional | boolean | Lock 사용 여부 | True |
| placement_group_name optional | string | Placement Group 이름 | pgtest |
| tags optional | array | 태그 | '{"key": "key", "value": "value"}' |
| use_placement_group optional | boolean | placement group 사용 여부 | False |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | f5c8e56a4d9b49a8bd89e14758a32d53 |
| request_id | Request ID | req-002daa83-52d9-41e8-9b0f-d31d35610f65 |
| resource_id | 자원 ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.4.2 - 1.0
scpcli baremetal baremetal create
--vpc_id <value>
--subnet_id <value>
--server_details <value>
--region_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
[--init_script <value>]
[--lock_enabled <value>]
[--placement_group_name <value>]
[--tags <value>]
[--use_placement_group <value>]
Description
Bare Metal Server 생성 요청 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | e58348b1bc9148e5af86500fd4ef99ca |
| subnet_id required | string | Subnet ID | ab313c43291e4b678f4bacffe10768ae |
| server_details required | array | 서버별 세부 설정 | '{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "ip_address": "192.168.0.1", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "server_type_id": "PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg", "use_hyper_threading": true}' |
| region_id required | string | 리전 ID | kr-west1 |
| os_user_password required | string | OS 유저 패스워드 | password |
| os_user_id required | string | OS 유저 ID | user001 |
| image_id required | string | 이미지 ID | IMAGE-7XFMaJpLsapKvskFMjCtmm |
| init_script optional | string | Init script | init script |
| lock_enabled optional | boolean | Lock 사용 여부 | True |
| placement_group_name optional | string | Placement Group 이름 | pgtest |
| tags optional | array | 태그 | '{"key": "key", "value": "value"}' |
| use_placement_group optional | boolean | placement group 사용 여부 | False |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | f5c8e56a4d9b49a8bd89e14758a32d53 |
| request_id | Request ID | req-002daa83-52d9-41e8-9b0f-d31d35610f65 |
| resource_id | 자원 ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.5 - Delete Baremetal Private NAT IP
2.1.1.5.1 - 1.1
scpcli baremetal private-nat-ip delete
--baremetal_id <value>
Description
Bare Metal Server Private NAT IP 해지 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.6 - Delete Baremetal Public NAT IP
2.1.1.6.1 - 1.1
scpcli baremetal nat-ip delete
--baremetal_id <value>
Description
Bare Metal Server NAT IP 해지 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.6.2 - 1.0
scpcli baremetal nat-ip delete
--baremetal_id <value>
Description
Bare Metal Server NAT IP 해지 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.7 - Delete Baremetals
2.1.1.7.1 - 1.1
scpcli baremetal baremetal delete
--baremetal_id_list <value>
Description
Bare Metal Server 해지 요청 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id_list required | array | Bare Metal Server ID 리스트 | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.7.2 - 1.0
scpcli baremetal baremetal delete
--baremetal_id_list <value>
Description
Bare Metal Server 해지 요청 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id_list required | array | Bare Metal Server ID 리스트 | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.8 - Detach Baremetal Local Subnet
2.1.1.8.1 - 1.1
scpcli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>
Description
Bare Metal Server 로컬 서브넷 해지 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
| local_subnet_ip required | string | 로컬 Subnet IP | 192.168.0.1 |
| local_subnet_id required | string | 로컬 Subnet ID | ab313c43291e4b678f4bacffe10768ae |
2.1.1.8.2 - 1.0
scpcli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>
Description
Bare Metal Server 로컬 서브넷 해지 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
| local_subnet_ip required | string | 로컬 Subnet IP | 192.168.0.1 |
| local_subnet_id required | string | 로컬 Subnet ID | ab313c43291e4b678f4bacffe10768ae |
2.1.1.9 - List Baremetal Images
2.1.1.9.1 - 1.1
scpcli baremetal image list
--region_id <value>
Description
Bare Metal Server 이미지 조회 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| region_id required | string | 리전 ID | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | IMAGE-7XFMaJpLsapKvskFMjCtmm |
| created_at | 생성 시간 | 2024-07-11 08:56:59 |
| name | 이미지명 | RHEL 8.8 for BM |
| os_distro | OS type | RHEL |
| scp_image_type | 이미지 타입 | STANDARD |
| scp_os_version | OS 버전 | 8.7 |
2.1.1.9.2 - 1.0
scpcli baremetal image list
--region_id <value>
Description
Bare Metal Server 이미지 조회 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| region_id required | string | 리전 ID | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | IMAGE-7XFMaJpLsapKvskFMjCtmm |
| created_at | 생성 시간 | 2024-07-11 08:56:59 |
| name | 이미지명 | RHEL 8.8 for BM |
| os_distro | OS type | RHEL |
| scp_image_type | 이미지 타입 | STANDARD |
| scp_os_version | OS 버전 | 8.7 |
2.1.1.10 - List Baremetal Products
2.1.1.10.1 - 1.1
scpcli baremetal product list
[--image_id <value>]
Description
Bare Metal Server Scale type 조회 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id optional | string | 이미지 ID | IMAGE-7XFMaJpLsapKvskFMjCtmm |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg |
| compute_class_type_name | Compute class type 이름 | StandardMetal-2 |
| compute_class_type_value | Compute class type value | s2_metal |
| cpu_name | CPU 이름 | cpu 16 vCore |
| cpu_unit | CPU unit | vCPU |
| cpu_value | CPU value | 64 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| description | 설명 | vCPU 16 │ Memory 128G │ Disk 480G |
| disk_unit | Disk unit | GB |
| disk_value | Disk value | 480 |
| memory_name | Memroy 이름 | server memory 128GB |
| memory_unit | Memory unit | GB |
| memory_value | Memory value | 128 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| name | 이름 | s2v16m128_metal |
| name_with_generation | 세대 | s2v16m128_metal |
| os_disk_gb | OS Disk 값 | 480 |
| state | State | AVAILABLE |
| type | 유형 | SCALE |
2.1.1.10.2 - 1.0
scpcli baremetal product list
[--image_id <value>]
Description
Bare Metal Server Scale type 조회 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id optional | string | 이미지 ID | IMAGE-7XFMaJpLsapKvskFMjCtmm |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg |
| attri_name | Attribute 이름 | attri name |
| attri_value | Attribute value | attri value |
| compute_class_type_name | Compute class type 이름 | StandardMetal-2 |
| compute_class_type_unit | Compute class type unit | compute_class_type_unit |
| compute_class_type_value | Compute class type value | s2_metal |
| cpu_generation | CPU generation | cpu generation |
| cpu_name | CPU 이름 | cpu 16 vCore |
| cpu_unit | CPU unit | vCPU |
| cpu_value | CPU value | 64 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | vCPU 16 │ Memory 128G │ Disk 480G |
| disk_name | Disk명 | disk_name |
| disk_unit | Disk unit | GB |
| disk_value | Disk value | 480 |
| infiniband_name | InfiniBand 이름 | infiniband_name |
| infiniband_unit | InfiniBand unit | infiniband_unit |
| infiniband_value | Infiniband value | infiniband_value |
| memory_name | Memroy 이름 | server memory 128GB |
| memory_unit | Memory unit | GB |
| memory_value | Memory value | 128 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 이름 | s2v16m128_metal |
| name_with_generation | 세대 | s2v16m128_metal |
| socket_name | Socket 이름 | socket_name |
| socket_unit | Socket unit | socket_unit |
| socket_value | Socket value | socket_value |
| state | State | AVAILABLE |
| type | 유형 | SCALE |
2.1.1.11 - List Baremetals
2.1.1.11.1 - 1.1
scpcli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]
Description
Bare Metal Server 목록 조회 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| server_name optional | string | Bare Metal Server 이름 | bmserver-001 |
| state optional | string | Bare Metal Server 상태 | RUNNING |
| ip optional | string | Bare Metal Server IP 주소 | 192.168.0.1 |
| vpc_id optional | string | VPC ID | e58348b1bc9148e5af86500fd4ef99ca |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| image_id | 이미지 ID | IMAGE-7XFMaJpLsapKvskFMjCtmm |
| image_version | 이미지 버전 | RHEL 8.7 for BM |
| lock_enabled | Lock 사용 여부 | True |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| network_id | Subnet ID | ab313c43291e4b678f4bacffe10768ae |
| os_type | OS type | WINDOWS |
| placement_group_name | Placement Group 이름 | pgtest |
| policy_ip | 정책 IP | 192.168.0.1 |
| product_type_id | Bare Metal Server 스케일 ID | PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg |
| region_id | 리전 ID | kr-west1 |
| server_name | Bare Metal Server 이름 | bmserver-001 |
| server_type | Bare Metal Server 스케일 타입 | s1v8m32_metal |
| state | Bare Metal Server 상태 | RUNNING |
| vpc_id | VPC ID | e58348b1bc9148e5af86500fd4ef99ca |
2.1.1.11.2 - 1.0
scpcli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]
Description
Bare Metal Server 목록 조회 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
| server_name optional | string | Bare Metal Server 이름 | bmserver-001 |
| state optional | string | Bare Metal Server 상태 | RUNNING |
| ip optional | string | Bare Metal Server IP 주소 | 192.168.0.1 |
| vpc_id optional | string | VPC ID | e58348b1bc9148e5af86500fd4ef99ca |
Responses
| Name | Description | Example |
|---|---|---|
| id | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
| account_id | Account ID | f5c8e56a4d9b49a8bd89e14758a32d53 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef716e80-1fac-4faa-892d-0132fc7f5583 |
| hyper_threading_use | Hyper threading 사용 여부 | True |
| image_id | 이미지 ID | IMAGE-7XFMaJpLsapKvskFMjCtmm |
| image_version | 이미지 버전 | RHEL 8.7 for BM |
| init_script | Init script | init script |
| local_subnet_info | Local Subnet 정보 | |
| lock_enabled | Lock 사용 여부 | True |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef716e80-1fac-4faa-892d-0132fc7f5583 |
| network_id | Subnet ID | ab313c43291e4b678f4bacffe10768ae |
| os_type | OS type | WINDOWS |
| placement_group_name | Placement Group 이름 | pgtest |
| policy_ip | 정책 IP | 192.168.0.1 |
| policy_nat | Public NAT IP | 192.168.0.1 |
| policy_use_nat | Public NAT 사용 여부 | True |
| product_type_id | Bare Metal Server 스케일 ID | PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg |
| public_nat_status | Public NAT 상태 | ACTIVE |
| region_id | 리전 ID | kr-west1 |
| root_account | 루트 계정 | rootaccount |
| server_name | Bare Metal Server 이름 | bmserver-001 |
| server_type | Bare Metal Server 스케일 타입 | s1v8m32_metal |
| state | Bare Metal Server 상태 | RUNNING |
| time_zone | 타임존 | Asia/Seoul |
| use_local_subnet | 로컬 서브넷 사용 여부 | True |
| vpc_id | VPC ID | e58348b1bc9148e5af86500fd4ef99ca |
2.1.1.12 - Lock Baremetal
2.1.1.12.1 - 1.1
scpcli baremetal baremetal lock
--baremetal_id <value>
Description
Bare Metal Server Lock 활성화 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.12.2 - 1.0
scpcli baremetal baremetal lock
--baremetal_id <value>
Description
Bare Metal Server Lock 활성화 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.13 - Show Baremetal
2.1.1.13.1 - 1.1
scpcli baremetal baremetal show
--baremetal_id <value>
Description
Bare Metal Server 상세 조회 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
Responses
| Name | Description | Example |
|---|---|---|
| interface_name | Interface명 | ens8f1,bond_serv.2 |
| local_subnet_id | 로컬 Subnet ID | ab313c43291e4b678f4bacffe10768ae |
| policy_local_subnet_ip | 로컬 Subnet IP | 192.168.0.1 |
| state | Local subnet IP의 상태 | CREATING |
| vlan_id | Vlan ID | 500 |
| vni_role_name | VNI Role Name | mgmtJ4dzQBo |
2.1.1.13.2 - 1.0
scpcli baremetal baremetal show
--baremetal_id <value>
Description
Bare Metal Server 상세 조회 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
Responses
| Name | Description | Example |
|---|---|---|
| interface_name | Interface명 | ens8f1,bond_serv.2 |
| local_subnet_id | 로컬 Subnet ID | ab313c43291e4b678f4bacffe10768ae |
| policy_local_subnet_ip | 로컬 Subnet IP | 192.168.0.1 |
| state | Local subnet IP의 상태 | CREATING |
| vlan_id | Vlan ID | 500 |
| vni_role_name | VNI Role Name | mgmtJ4dzQBo |
2.1.1.14 - Start Baremetals
2.1.1.14.1 - 1.1
scpcli baremetal baremetal start
--bare_metal_server_ids <value>
Description
Bare Metal Server 시작(부팅) 요청 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bare_metal_server_ids required | array | Bare Metal Server ID 리스트 | 20c507a036c447cdb3b19468d8ea62ac |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | f5c8e56a4d9b49a8bd89e14758a32d53 |
| request_id | Request ID | req-002daa83-52d9-41e8-9b0f-d31d35610f65 |
| resource_id | 자원 ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.14.2 - 1.0
scpcli baremetal baremetal start
--bare_metal_server_ids <value>
Description
Bare Metal Server 시작(부팅) 요청 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bare_metal_server_ids required | array | Bare Metal Server ID 리스트 | 20c507a036c447cdb3b19468d8ea62ac |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | f5c8e56a4d9b49a8bd89e14758a32d53 |
| request_id | Request ID | req-002daa83-52d9-41e8-9b0f-d31d35610f65 |
| resource_id | 자원 ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.15 - Stop Baremetals
2.1.1.15.1 - 1.1
scpcli baremetal baremetal stop
--bare_metal_server_ids <value>
Description
Bare Metal Server 중지 요청 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bare_metal_server_ids required | array | Bare Metal Server ID 리스트 | 20c507a036c447cdb3b19468d8ea62ac |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | f5c8e56a4d9b49a8bd89e14758a32d53 |
| request_id | Request ID | req-002daa83-52d9-41e8-9b0f-d31d35610f65 |
| resource_id | 자원 ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.15.2 - 1.0
scpcli baremetal baremetal stop
--bare_metal_server_ids <value>
Description
Bare Metal Server 중지 요청 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bare_metal_server_ids required | array | Bare Metal Server ID 리스트 | 20c507a036c447cdb3b19468d8ea62ac |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | f5c8e56a4d9b49a8bd89e14758a32d53 |
| request_id | Request ID | req-002daa83-52d9-41e8-9b0f-d31d35610f65 |
| resource_id | 자원 ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.16 - Unlock Baremetal
2.1.1.16.1 - 1.1
scpcli baremetal baremetal unlock
--baremetal_id <value>
Description
Bare Metal Server Lock 해지 기능
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
2.1.1.16.2 - 1.0
scpcli baremetal baremetal unlock
--baremetal_id <value>
Description
Bare Metal Server Lock 해지 기능
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| baremetal_id required | string | Bare Metal Server ID | 20c507a036c447cdb3b19468d8ea62ac |
2.2 - Cloud Functions
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Cloud Function 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | DEPRECATED | 20260430 |
| 1.2 | CURRENT | - |
2.2.1 - CLIs
2.2.1.1 - Approve PrivateLink Endpoint
2.2.1.1.1 - 1.2
scpcli scf privatelink-endpoint approve
--endpoint_id <value>
--cloud_function_id <value>
--type <value>
Description
PrivateLink Endpoint 승인
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| endpoint_id required | string | Endpoint Id | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| type required | string | 타입 | APPROVE |
2.2.1.2 - Check Function Name Duplication
2.2.1.2.1 - 1.2
scpcli scf cloud-function duplication show
--name <value>
Description
Cloud Function 이름 중복 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 이름 | sample-function-name |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
2.2.1.2.2 - 1.1
scpcli scf cloud-function duplication show
--name <value>
Description
Cloud Function 이름 중복 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 이름 | sample-function-name |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
2.2.1.2.3 - 1.0
scpcli scf cloud-function duplication show
--name <value>
Description
Cloud Function 이름 중복 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 이름 | sample-function-name |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
2.2.1.3 - Connect PrivateLink Endpoint
2.2.1.3.1 - 1.2
scpcli scf privatelink-endpoint connect
--endpoint_id <value>
--cloud_function_id <value>
--type <value>
Description
PrivateLink Endpoint 연결
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| endpoint_id required | string | Endpoint Id | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| type required | string | 타입 | RECONNECT |
2.2.1.4 - Create Cloud Function
2.2.1.4.1 - 1.2
scpcli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]
Description
Cloud Function 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| runtime required | string | 런타임 | Node.js:20 |
| name required | string | 이름 | sample-function-name |
| content required | string | 코드 내용 | sample |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| message | 설명 | Description |
| state | 함수 상태 | READY |
2.2.1.4.2 - 1.1
scpcli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]
Description
Cloud Function 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| runtime required | string | 런타임 | Node.js:20 |
| name required | string | 이름 | sample-function-name |
| content required | string | 코드 내용 | sample |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| message | 설명 | Description |
| state | 함수 상태 | READY |
2.2.1.4.3 - 1.0
scpcli scf cloud-function create
--runtime <value>
--name <value>
--content <value>
[--tags <value>]
Description
Cloud Function 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| runtime required | string | 런타임 | Node.js:20 |
| name required | string | 이름 | sample-function-name |
| content required | string | 코드 내용 | sample |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| message | 설명 | Description |
| state | 함수 상태 | READY |
2.2.1.5 - Create Cloud Function Apigateway Trigger
2.2.1.5.1 - 1.2
scpcli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>
Description
Cloud Function 트리거 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| apigateway_stage_name required | string | Apigateway 스테이지 이름 | sample |
| apigateway_api_id required | string | Apigateway API ID | 31e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.5.2 - 1.1
scpcli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>
Description
Cloud Function 트리거 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| apigateway_stage_name required | string | Apigateway 스테이지 이름 | sample |
| apigateway_api_id required | string | Apigateway API ID | 31e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.5.3 - 1.0
scpcli scf cloud-function apigateway trigger create
--cloud_function_id <value>
--apigateway_stage_name <value>
--apigateway_api_id <value>
Description
Cloud Function 트리거 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| apigateway_stage_name required | string | Apigateway 스테이지 이름 | sample |
| apigateway_api_id required | string | Apigateway API ID | 31e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.6 - Create Cloud Function Cronjob Trigger
2.2.1.6.1 - 1.2
scpcli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>
Description
Cloud Function 트리거 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| timezone required | string | 타임존 | Asia/Tokyo |
| schedule required | string | 스케쥴 | * * * * 0 |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.6.2 - 1.1
scpcli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>
Description
Cloud Function 트리거 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| timezone required | string | 타임존 | Asia/Tokyo |
| schedule required | string | 스케쥴 | * * * * 0 |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.6.3 - 1.0
scpcli scf cloud-function cronjob trigger create
--timezone <value>
--schedule <value>
--cloud_function_id <value>
Description
Cloud Function 트리거 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| timezone required | string | 타임존 | Asia/Tokyo |
| schedule required | string | 스케쥴 | * * * * 0 |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.7 - Create PrivateLink Endpoint
2.2.1.7.1 - 1.2
scpcli scf privatelink-endpoint create
--cloud_function_id <value>
--service_id <value>
--alias <value>
Description
PrivateLink Endpoint 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| service_id required | string | Service Id | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| alias required | string | Alias | sample |
Responses
| Name | Description | Example |
|---|---|---|
| endpoint | Endpoint |
2.2.1.8 - Delete Cloud Function
2.2.1.8.1 - 1.2
scpcli scf cloud-function delete
--cloud_function_id <value>
Description
Cloud Function 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
2.2.1.8.2 - 1.1
scpcli scf cloud-function delete
--cloud_function_id <value>
Description
Cloud Function 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
2.2.1.8.3 - 1.0
scpcli scf cloud-function delete
--cloud_function_id <value>
Description
Cloud Function 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
2.2.1.9 - Delete Cloud Function Trigger
2.2.1.9.1 - 1.2
scpcli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>
Description
Cloud Function 트리거 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trigger_id required | integer | 트리거 ID | 1 |
| trigger_type required | string | 트리거 타입 | apigateway |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
2.2.1.9.2 - 1.1
scpcli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>
Description
Cloud Function 트리거 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trigger_id required | integer | 트리거 ID | 1 |
| trigger_type required | string | 트리거 타입 | apigateway |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
2.2.1.9.3 - 1.0
scpcli scf cloud-function trigger delete
--trigger_id <value>
--trigger_type <value>
--cloud_function_id <value>
Description
Cloud Function 트리거 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trigger_id required | integer | 트리거 ID | 1 |
| trigger_type required | string | 트리거 타입 | apigateway |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
2.2.1.10 - Delete PrivateLink Endpoint
2.2.1.10.1 - 1.2
scpcli scf privatelink-endpoint delete
--endpoint_id <value>
--cloud_function_id <value>
Description
PrivateLink Endpoint 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| endpoint_id required | string | Endpoint Id | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
2.2.1.11 - List Cloud Function Triggers
2.2.1.11.1 - 1.2
scpcli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]
Description
Cloud Function 트리거 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| trigger_name optional | string | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type optional | string | 트리거 타입 | apigateway |
Responses
| Name | Description | Example |
|---|---|---|
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.11.2 - 1.1
scpcli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]
Description
Cloud Function 트리거 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| trigger_name optional | string | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type optional | string | 트리거 타입 | apigateway |
Responses
| Name | Description | Example |
|---|---|---|
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.11.3 - 1.0
scpcli scf cloud-function trigger list
--cloud_function_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--trigger_name <value>]
[--trigger_type <value>]
Description
Cloud Function 트리거 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| trigger_name optional | string | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type optional | string | 트리거 타입 | apigateway |
Responses
| Name | Description | Example |
|---|---|---|
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.12 - List Cloud Functions
2.2.1.12.1 - 1.2
scpcli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]
Description
Cloud Function 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| name optional | string | 이름 | sample-function-name |
| state optional | array | 함수 상태 | R |
| runtime optional | array | 런타임 | N |
Responses
| Name | Description | Example |
|---|---|---|
| id | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| account_id | 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| created_at | 생성 시간 | 2025-05-22T06:21:17.580522 |
| function_url | 함수 URL | https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello |
| name | Cloud Functions 이름 | sample |
| runtime | 런타임 | Node.js:20 |
| state | 함수 상태 | READY |
| user_id | 사용자 ID | 617b3d0e90c24a5fa1f65a3824861354 |
2.2.1.12.2 - 1.1
scpcli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]
Description
Cloud Function 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| name optional | string | 이름 | sample-function-name |
| state optional | array | 함수 상태 | R |
| runtime optional | array | 런타임 | N |
Responses
| Name | Description | Example |
|---|---|---|
| id | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| account_id | 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| created_at | 생성 시간 | 2025-05-22T06:21:17.580522 |
| function_url | 함수 URL | https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello |
| name | Cloud Functions 이름 | sample |
| runtime | 런타임 | Node.js:20 |
| state | 함수 상태 | READY |
| user_id | 사용자 ID | 617b3d0e90c24a5fa1f65a3824861354 |
2.2.1.12.3 - 1.0
scpcli scf cloud-function list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
[--runtime <value>]
Description
Cloud Function 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| name optional | string | 이름 | sample-function-name |
| state optional | array | 함수 상태 | R |
| runtime optional | array | 런타임 | N |
Responses
| Name | Description | Example |
|---|---|---|
| id | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| account_id | 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| created_at | 생성 시간 | 2025-05-22T06:21:17.580522 |
| function_url | 함수 URL | https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello |
| name | Cloud Functions 이름 | sample |
| runtime | 런타임 | Node.js:20 |
| state | 함수 상태 | READY |
| user_id | 사용자 ID | 617b3d0e90c24a5fa1f65a3824861354 |
2.2.1.13 - List Runtimes
2.2.1.13.1 - 1.2
scpcli scf cloud-function runtime list
Description
Runtime 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Responses
| Name | Description | Example |
|---|---|---|
| base_image_seq | 기본 이미지 번호 | 3 |
| name | 이름 | sample |
| version | 버전 | 1.0.0 |
2.2.1.13.2 - 1.1
scpcli scf cloud-function runtime list
Description
Runtime 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Responses
| Name | Description | Example |
|---|---|---|
| base_image_seq | 기본 이미지 번호 | 3 |
| name | 이름 | sample |
| version | 버전 | 1.0.0 |
2.2.1.13.3 - 1.0
scpcli scf cloud-function runtime list
Description
Runtime 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|---|---|
| base_image_seq | 기본 이미지 번호 | 3 |
| name | 이름 | sample |
| version | 버전 | 1.0.0 |
2.2.1.14 - List Sample Codes
2.2.1.14.1 - 1.2
scpcli scf cloud-function sample-codes show
Description
Sample 코드 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Responses
| Name | Description | Example |
|---|---|---|
| content | 코드 내용 | sample |
| default | 기본값 | False |
| description | 설명 | sample |
| name | 이름 | sample |
| runtime | 런타임 | Node.js:20 |
| seq | 번호 | 3 |
| version | 버전 | sample |
2.2.1.14.2 - 1.1
scpcli scf cloud-function sample-codes show
Description
Sample 코드 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Responses
| Name | Description | Example |
|---|---|---|
| content | 코드 내용 | sample |
| default | 기본값 | False |
| description | 설명 | sample |
| name | 이름 | sample |
| runtime | 런타임 | Node.js:20 |
| seq | 번호 | 3 |
| version | 버전 | sample |
2.2.1.14.3 - 1.0
scpcli scf cloud-function sample-codes show
Description
Sample 코드 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|---|---|
| content | 코드 내용 | sample |
| default | 기본값 | False |
| description | 설명 | sample |
| name | 이름 | sample |
| runtime | 런타임 | Node.js:20 |
| seq | 번호 | 3 |
| version | 버전 | sample |
2.2.1.15 - Request PrivateLink Endpoint
2.2.1.15.1 - 1.2
scpcli scf privatelink-endpoint request
--endpoint_id <value>
--cloud_function_id <value>
--type <value>
Description
PrivateLink Endpoint 요청
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| endpoint_id required | string | Endpoint Id | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| type required | string | 타입 | CANCEL |
2.2.1.16 - Show Cloud Function
2.2.1.16.1 - 1.2
scpcli scf cloud-function show
--cloud_function_id <value>
Description
Cloud Function 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| account_id | 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| function_url | 함수 URL | https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello |
| name | Cloud Functions 이름 | sample |
| runtime | 런타임 | Node.js:20 |
| state | 함수 상태 | READY |
| user_id | 사용자 ID | 617b3d0e90c24a5fa1f65a3824861354 |
2.2.1.16.2 - 1.1
scpcli scf cloud-function show
--cloud_function_id <value>
Description
Cloud Function 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| account_id | 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| function_url | 함수 URL | https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello |
| name | Cloud Functions 이름 | sample |
| runtime | 런타임 | Node.js:20 |
| state | 함수 상태 | READY |
| user_id | 사용자 ID | 617b3d0e90c24a5fa1f65a3824861354 |
2.2.1.16.3 - 1.0
scpcli scf cloud-function show
--cloud_function_id <value>
Description
Cloud Function 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| account_id | 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| function_url | 함수 URL | https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello |
| name | Cloud Functions 이름 | sample |
| runtime | 런타임 | Node.js:20 |
| state | 함수 상태 | READY |
| user_id | 사용자 ID | 617b3d0e90c24a5fa1f65a3824861354 |
2.2.1.17 - Show Cloud Function Code
2.2.1.17.1 - 1.2
scpcli scf cloud-function code show
--cloud_function_id <value>
Description
Cloud Function 코드 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| class_name | 클래스명 | com.example.Handler |
| code_text | 코드 내용 | ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM== |
| code_type | 코드 유형 | text |
| file_name | 파일명 | sample |
| file_transfer_status | 파일 전송 상태 | sample |
| file_upload_at | 파일 업로드 시간 | 2025-05-17 00:23:17 |
| method_name | 메소드명 | handleRequest |
| runtime | 런타임 | Node.js:20 |
2.2.1.17.2 - 1.1
scpcli scf cloud-function code show
--cloud_function_id <value>
Description
Cloud Function 코드 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| class_name | 클래스명 | com.example.Handler |
| code_text | 코드 내용 | ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM== |
| code_type | 코드 유형 | text |
| file_name | 파일명 | sample |
| file_transfer_status | 파일 전송 상태 | sample |
| file_upload_at | 파일 업로드 시간 | 2025-05-17 00:23:17 |
| method_name | 메소드명 | handleRequest |
| runtime | 런타임 | Node.js:20 |
2.2.1.17.3 - 1.0
scpcli scf cloud-function code show
--cloud_function_id <value>
Description
Cloud Function 코드 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| class_name | 클래스명 | com.example.Handler |
| code_text | 코드 내용 | ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM== |
| code_type | 코드 유형 | text |
| file_name | 파일명 | sample |
| file_transfer_status | 파일 전송 상태 | sample |
| file_upload_at | 파일 업로드 시간 | 2025-05-17 00:23:17 |
| method_name | 메소드명 | handleRequest |
| runtime | 런타임 | Node.js:20 |
2.2.1.18 - Show Cloud Function Configuration
2.2.1.18.1 - 1.2
scpcli scf cloud-function configuration show
--cloud_function_id <value>
Description
Cloud Function 구성 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| endpoint_alias | Alias | sample |
| endpoint_id | Endpoint Id | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| service_id | Service Id | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| state | 상태 | Active |
2.2.1.18.2 - 1.1
scpcli scf cloud-function configuration show
--cloud_function_id <value>
Description
Cloud Function 구성 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| key | 키 | sample |
| value | 값 | sample |
2.2.1.18.3 - 1.0
scpcli scf cloud-function configuration show
--cloud_function_id <value>
Description
Cloud Function 구성 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| key | 키 | sample |
| value | 값 | sample |
2.2.1.19 - Show Cloud Function Logs
2.2.1.19.1 - 1.2
scpcli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]
Description
Cloud Function Log 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| time optional | integer | 시간 | 3 |
| start optional | string | 시작 일자 | 20250517 |
| end optional | string | 종료 일자 | 20250517 |
Responses
| Name | Description | Example |
|---|---|---|
| log | 로그 | [2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST |
| time | 시간 | 2025-05-17 00:23:17 |
2.2.1.19.2 - 1.1
scpcli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]
Description
Cloud Function Log 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| time optional | integer | 시간 | 3 |
| start optional | string | 시작 일자 | 20250517 |
| end optional | string | 종료 일자 | 20250517 |
Responses
| Name | Description | Example |
|---|---|---|
| log | 로그 | [2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST |
| time | 시간 | 2025-05-17 00:23:17 |
2.2.1.19.3 - 1.0
scpcli scf cloud-function logs show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]
Description
Cloud Function Log 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| time optional | integer | 시간 | 3 |
| start optional | string | 시작 일자 | 20250517 |
| end optional | string | 종료 일자 | 20250517 |
Responses
| Name | Description | Example |
|---|---|---|
| log | 로그 | [2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST |
| time | 시간 | 2025-05-17 00:23:17 |
2.2.1.20 - Show Cloud Function Metrics
2.2.1.20.1 - 1.2
scpcli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]
Description
Cloud Function Metric 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| time optional | integer | 시간 | 3 |
| start optional | string | 시작 일자 | 20250517 |
| end optional | string | 종료 일자 | 20250517 |
Responses
| Name | Description | Example |
|---|---|---|
| metric_data | Metric 데이터 | 1.0033444816053512 |
| time | 시간 | 16:37 |
2.2.1.20.2 - 1.1
scpcli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]
Description
Cloud Function Metric 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| time optional | integer | 시간 | 3 |
| start optional | string | 시작 일자 | 20250517 |
| end optional | string | 종료 일자 | 20250517 |
Responses
| Name | Description | Example |
|---|---|---|
| metric_data | Metric 데이터 | 1.0033444816053512 |
| time | 시간 | 16:37 |
2.2.1.20.3 - 1.0
scpcli scf cloud-function metrics show
--cloud_function_id <value>
[--time <value>]
[--start <value>]
[--end <value>]
Description
Cloud Function Metric 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| time optional | integer | 시간 | 3 |
| start optional | string | 시작 일자 | 20250517 |
| end optional | string | 종료 일자 | 20250517 |
Responses
| Name | Description | Example |
|---|---|---|
| metric_data | Metric 데이터 | 1.0033444816053512 |
| time | 시간 | 16:37 |
2.2.1.21 - Show Cloud Function Trigger
2.2.1.21.1 - 1.2
scpcli scf cloud-function trigger show
--trigger_id <value>
Description
Cloud Function 트리거 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trigger_id required | integer | 트리거 ID | 1 |
Responses
| Name | Description | Example |
|---|---|---|
| alias | Alias | $LATEST |
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_sid | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.21.2 - 1.1
scpcli scf cloud-function trigger show
--trigger_id <value>
Description
Cloud Function 트리거 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trigger_id required | integer | 트리거 ID | 1 |
Responses
| Name | Description | Example |
|---|---|---|
| alias | Alias | $LATEST |
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_sid | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.21.3 - 1.0
scpcli scf cloud-function trigger show
--trigger_id <value>
Description
Cloud Function 트리거 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trigger_id required | integer | 트리거 ID | 1 |
Responses
| Name | Description | Example |
|---|---|---|
| alias | Alias | $LATEST |
| schedule | 스케쥴 | * * * * 0 |
| timezone | 타임존 | Asia/Tokyo |
| trigger_id | 트리거 ID | 1 |
| trigger_name | 트리거 타입 | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_sid | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_account_id | 트리거 타겟 어카운트 ID | 617b3d0e90c24a5fa1f65a3824861354 |
| trigger_target_srn | 트리거 타겟 SRN | srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe |
| trigger_target_uuid | 트리거 타겟 UUID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| trigger_type | 트리거 타입 | apigateway |
2.2.1.22 - Update Cloud Function Code
2.2.1.22.1 - 1.2
scpcli scf cloud-function code set
--cloud_function_id <value>
--content <value>
Description
Cloud Function 코드 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| content required | string | 코드 내용 | print("Hello World") |
2.2.1.22.2 - 1.1
scpcli scf cloud-function code set
--cloud_function_id <value>
--content <value>
Description
Cloud Function 코드 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| content required | string | 코드 내용 | print("Hello World") |
2.2.1.22.3 - 1.0
scpcli scf cloud-function code set
--cloud_function_id <value>
--content <value>
Description
Cloud Function 코드 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| content required | string | 코드 내용 | print("Hello World") |
2.2.1.23 - Update Cloud Function Code File
2.2.1.23.1 - 1.2
scpcli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]
Description
Cloud Function 코드 파일 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| method_name required | string | 메소드명 | handleRequest |
| class_name required | string | 클래스명 | com.example.Handler |
| obs_url optional | string | Object Storage URL | https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar |
2.2.1.23.2 - 1.1
scpcli scf cloud-function code-file set
--cloud_function_id <value>
--method_name <value>
--class_name <value>
[--obs_url <value>]
Description
Cloud Function 코드 파일 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| method_name required | string | 메소드명 | handleRequest |
| class_name required | string | 클래스명 | com.example.Handler |
| obs_url optional | string | Object Storage URL | https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar |
2.2.1.24 - Update Cloud Function Config
2.2.1.24.1 - 1.2
scpcli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>
Description
Cloud Function 일반 구성 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| timeout required | integer | 제한 시간 | 100 |
| min_scale required | integer | 최소 작업 수 | 1 |
| memory required | integer | 메모리 | 256 |
| max_scale required | integer | 최대 작업 수 | 5 |
2.2.1.24.2 - 1.1
scpcli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>
Description
Cloud Function 일반 구성 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| timeout required | integer | 제한 시간 | 100 |
| min_scale required | integer | 최소 작업 수 | 1 |
| memory required | integer | 메모리 | 256 |
| max_scale required | integer | 최대 작업 수 | 5 |
2.2.1.24.3 - 1.0
scpcli scf cloud-function config set
--cloud_function_id <value>
--timeout <value>
--min_scale <value>
--memory <value>
--max_scale <value>
Description
Cloud Function 일반 구성 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| timeout required | integer | 제한 시간 | 100 |
| min_scale required | integer | 최소 작업 수 | 1 |
| memory required | integer | 메모리 | 256 |
| max_scale required | integer | 최대 작업 수 | 5 |
2.2.1.25 - Update Cloud Function Cronjob Trigger
2.2.1.25.1 - 1.2
scpcli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>
Description
Cloud Function 트리거 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trigger_id required | integer | 트리거 ID | 1 |
| timezone required | string | 타임존 | Asia/Tokyo |
| schedule required | string | 스케쥴 | * * * * 0 |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
2.2.1.25.2 - 1.1
scpcli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>
Description
Cloud Function 트리거 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trigger_id required | integer | 트리거 ID | 1 |
| timezone required | string | 타임존 | Asia/Tokyo |
| schedule required | string | 스케쥴 | * * * * 0 |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
2.2.1.25.3 - 1.0
scpcli scf cloud-function cronjob trigger set
--trigger_id <value>
--timezone <value>
--schedule <value>
--cloud_function_id <value>
Description
Cloud Function 트리거 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trigger_id required | integer | 트리거 ID | 1 |
| timezone required | string | 타임존 | Asia/Tokyo |
| schedule required | string | 스케쥴 | * * * * 0 |
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
2.2.1.26 - Update Cloud Function Url
2.2.1.26.1 - 1.2
scpcli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]
Description
Cloud Function 함수 URL 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| url_enabled required | boolean | URL 사용 | True |
| public_ip_acl_enabled required | boolean | Public IP 접근 제어 사용 | True |
| allow_ips optional | array | 허용 IP | - |
| auth_type optional | string | 인증 유형 | NONE |
2.2.1.26.2 - 1.1
scpcli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]
Description
Cloud Function 함수 URL 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| url_enabled required | boolean | URL 사용 | True |
| public_ip_acl_enabled required | boolean | Public IP 접근 제어 사용 | True |
| allow_ips optional | array | 허용 IP | - |
| auth_type optional | string | 인증 유형 | NONE |
2.2.1.26.3 - 1.0
scpcli scf cloud-function url set
--cloud_function_id <value>
--url_enabled <value>
--public_ip_acl_enabled <value>
[--allow_ips <value>]
[--auth_type <value>]
Description
Cloud Function 함수 URL 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| url_enabled required | boolean | URL 사용 | True |
| public_ip_acl_enabled required | boolean | Public IP 접근 제어 사용 | True |
| allow_ips optional | array | 허용 IP | - |
| auth_type optional | string | 인증 유형 | NONE |
2.2.1.27 - Update Cloud Function Variables
2.2.1.27.1 - 1.2
scpcli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>
Description
Cloud Function 환경 변수 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| variables required | array | 환경 변수 | '{"key": "sample", "value": "sample"}' |
2.2.1.27.2 - 1.1
scpcli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>
Description
Cloud Function 환경 변수 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| variables required | array | 환경 변수 | '{"key": "sample", "value": "sample"}' |
2.2.1.27.3 - 1.0
scpcli scf cloud-function variables set
--cloud_function_id <value>
--variables <value>
Description
Cloud Function 환경 변수 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| variables required | array | 환경 변수 | '{"key": "sample", "value": "sample"}' |
2.2.1.28 - Update PrivateLink Service
2.2.1.28.1 - 1.2
scpcli scf privatelink-service set
--cloud_function_id <value>
--privatelink_service_enabled <value>
Description
PrivateLink Service 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_function_id required | string | Cloud Functions ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| privatelink_service_enabled required | boolean | PrivateLink Service 활성화 | True |
2.3 - Virtual Server
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Virtual Server 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
2.3.1 - CLIs
2.3.1.1 - Accept a volume transfer
2.3.1.1.1 - 1.1
scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>
Description
Accept a volume transfer.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| auth_key required | string | Auth key | f5972fdb456897eb |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| name | 볼륨명 | volume01 |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.1.2 - 1.0
scpcli virtualserver volume transfer accept
--transfer_id <value>
--auth_key <value>
Description
Accept a volume transfer.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| auth_key required | string | Auth key | f5972fdb456897eb |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| name | 볼륨명 | volume01 |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.2 - Attach Virtual Server Security Group
2.3.1.2.1 - 1.0
scpcli virtualserver server add security group
--server_id <value>
--security_group_id <value>
Description
서버에 Security Group을 추가한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| security_group_id required | string | Security Group ID | c09c3f05-03d9-443f-b27a-40e0f973c75f |
Responses
| Name | Description | Example |
|---|
2.3.1.3 - Attach Volume to Virtual Server
2.3.1.3.1 - 1.1
scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]
Description
볼륨을 서버에 연결한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| delete_on_termination optional | boolean | 해지 시 삭제 | False |
Responses
| Name | Description | Example |
|---|---|---|
| delete_on_termination | 해지 시 삭제 | False |
| device | Device name | /dev/vda |
| server_id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.3.2 - 1.0
scpcli virtualserver volume attach server
--volume_id <value>
--server_id <value>
[--delete_on_termination <value>]
Description
볼륨을 서버에 연결한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| delete_on_termination optional | boolean | 해지 시 삭제 | False |
Responses
| Name | Description | Example |
|---|---|---|
| delete_on_termination | 해지 시 삭제 | False |
| device | Device name | /dev/vda |
| server_id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.4 - Create a snapshot
2.3.1.4.1 - 1.1
scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]
Description
Create a snapshot.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| name required | string | 스냅샷명 | snapshot-1 |
| description optional | string | 설명 | description |
| force optional | boolean | Force | True |
| metadata optional | **** | Snapshot metadata | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| description | 설명 | description |
| metadata | Snapshot metadata | |
| name | 스냅샷명 | snapshot-1 |
| size | 볼륨 크기 | 104 |
| status | 볼륨 상태 | available |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.4.2 - 1.0
scpcli virtualserver volume snapshot create
--volume_id <value>
--name <value>
[--description <value>]
[--force <value>]
[--metadata <value>]
Description
Create a snapshot.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| name required | string | 스냅샷명 | snapshot-1 |
| description optional | string | 설명 | description |
| force optional | boolean | Force | True |
| metadata optional | **** | Snapshot metadata | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| description | 설명 | description |
| metadata | Snapshot metadata | |
| name | 스냅샷명 | snapshot-1 |
| size | 볼륨 크기 | 104 |
| status | 볼륨 상태 | available |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.5 - Create a volume transfer
2.3.1.5.1 - 1.1
scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]
Description
Create a volume transfer.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| name optional | string | 볼륨명 | volume01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| auth_key | Auth key | f5972fdb456897eb |
| created_at | 생성일시 | |
| name | 볼륨명 | volume01 |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.5.2 - 1.0
scpcli virtualserver volume transfer create
--volume_id <value>
[--name <value>]
Description
Create a volume transfer.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| name optional | string | 볼륨명 | volume01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| auth_key | Auth key | f5972fdb456897eb |
| created_at | 생성일시 | |
| name | 볼륨명 | volume01 |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.6 - Create Auto-Scaling Group
2.3.1.6.1 - 1.1
scpcli virtualserver auto scaling group create
--subnet_ids <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Auto-Scaling Group을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_ids required | array | Subnet ID 목록 | - |
| server_name_prefix required | string | 서버 이름 접두사 | server-name-prefix |
| name required | string | Auto-Scaling Group 이름 | auto-scaling-group-name |
| min_server_count required | integer | 최소 서버 수 | 1 |
| max_server_count required | integer | 최대 서버 수 | 2 |
| launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
| desired_server_count_editable required | boolean | 목표 서버 수 수정 가능 여부 | True |
| desired_server_count required | integer | 목표 서버 수 | 1 |
| drain_enabled optional | boolean | Drain 사용 여부 | True |
| drain_timeout optional | integer | Drain timeout 값 | 300 |
| lb_server_groups optional | array | LB 서버 그룹 목록 | '{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}' |
| notifications optional | array | Notifications | '{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}' |
| scaling_policies optional | array | Scaling policy list | '{"comparison_operator": "ge", "cooldown_seconds": 300, "evaluation_minutes": 1, "metric_method": "AVG", "metric_type": "CPU", "name": "policy-name", "scale_method": "AMOUNT", "scale_type": "SCALE_OUT", "scale_value": 10, "threshold": 60}' |
| security_group_ids optional | array | Security Group ID 목록 | [ |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 서버 그룹 ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
| port | LB 서버 그룹 포트 | 8080 |
2.3.1.6.2 - 1.0
scpcli virtualserver auto scaling group create
--subnet_ids <value>
--server_name_prefix <value>
--name <value>
--min_server_count <value>
--max_server_count <value>
--launch_configuration_id <value>
--desired_server_count_editable <value>
--desired_server_count <value>
[--drain_enabled <value>]
[--drain_timeout <value>]
[--lb_server_groups <value>]
[--notifications <value>]
[--scaling_policies <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Auto-Scaling Group을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_ids required | array | Subnet ID 목록 | - |
| server_name_prefix required | string | 서버 이름 접두사 | server-name-prefix |
| name required | string | Auto-Scaling Group 이름 | auto-scaling-group-name |
| min_server_count required | integer | 최소 서버 수 | 1 |
| max_server_count required | integer | 최대 서버 수 | 2 |
| launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
| desired_server_count_editable required | boolean | 목표 서버 수 수정 가능 여부 | True |
| desired_server_count required | integer | 목표 서버 수 | 1 |
| drain_enabled optional | boolean | Drain 사용 여부 | True |
| drain_timeout optional | integer | Drain timeout 값 | 300 |
| lb_server_groups optional | array | LB 서버 그룹 목록 | '{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}' |
| notifications optional | array | Notifications | '{"notification_events": ["SCALE_OUT", "SCALE_OUT_FAIL"], "user_ids": ["570907805e5447be84b618450ef52o0t"]}' |
| scaling_policies optional | array | Scaling policy list | '{"comparison_operator": "ge", "cooldown_seconds": 300, "evaluation_minutes": 1, "metric_method": "AVG", "metric_type": "CPU", "name": "policy-name", "scale_method": "AMOUNT", "scale_type": "SCALE_OUT", "scale_value": 10, "threshold": 60}' |
| security_group_ids optional | array | Security Group ID 목록 | [ |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 서버 그룹 ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
| port | LB 서버 그룹 포트 | 8080 |
2.3.1.7 - Create Auto-Scaling Group Notification
2.3.1.7.1 - 1.1
scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>
Description
Auto-Scaling Group 알림을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| user_ids required | array | 사용자 ID 목록 | 570907805e5447be84b618450ef52o0t |
| notification_events required | array | Auto-Scaling Group 알림 이벤트 목록 | SCALE_OUT |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group 알림 이벤트 목록 | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group 알림 상태 | ACTIVE |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
2.3.1.7.2 - 1.0
scpcli virtualserver auto scaling group notification create
--auto_scaling_group_id <value>
--user_ids <value>
--notification_events <value>
Description
Auto-Scaling Group 알림을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| user_ids required | array | 사용자 ID 목록 | 570907805e5447be84b618450ef52o0t |
| notification_events required | array | Auto-Scaling Group 알림 이벤트 목록 | SCALE_OUT |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group 알림 이벤트 목록 | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group 알림 상태 | ACTIVE |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
2.3.1.8 - Create Auto-Scaling Group Policy
2.3.1.8.1 - 1.1
scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>
Description
Auto-Scaling Group 정책을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| threshold required | integer | 임계값 | 60 |
| scale_value required | integer | 스켕일 값 | 10 |
| scale_type required | string | 스케일 유형 | SCALE_OUT |
| scale_method required | string | 스케일 방법 | AMOUNT |
| name required | string | 정책 이름 | policy-name |
| metric_type required | string | 메트릭 유형 | CPU |
| metric_method required | string | 메트릭 방법 | AVG |
| evaluation_minutes required | integer | 평가 시간(분 단위) | 1 |
| cooldown_seconds required | integer | 쿨다운 시간(초 단위) | 300 |
| comparison_operator required | string | 비교 연산자 | ge |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | 비교 연산자 | ge |
| cooldown_seconds | 쿨다운 시간(초 단위) | 300 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | 평가 시간(분 단위) | 1 |
| metric_method | 메트릭 방법 | AVG |
| metric_type | 메트릭 유형 | CPU |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 정책 이름 | policy-name |
| scale_method | 스케일 방법 | AMOUNT |
| scale_type | 스케일 유형 | SCALE_OUT |
| scale_value | 스켕일 값 | 10 |
| state | 정책 상태 | ACTIVE |
| threshold | 임계값 | 60 |
| threshold_unit | 임계값 단위 | % |
2.3.1.8.2 - 1.0
scpcli virtualserver auto scaling group policy create
--auto_scaling_group_id <value>
--threshold <value>
--scale_value <value>
--scale_type <value>
--scale_method <value>
--name <value>
--metric_type <value>
--metric_method <value>
--evaluation_minutes <value>
--cooldown_seconds <value>
--comparison_operator <value>
Description
Auto-Scaling Group 정책을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| threshold required | integer | 임계값 | 60 |
| scale_value required | integer | 스켕일 값 | 10 |
| scale_type required | string | 스케일 유형 | SCALE_OUT |
| scale_method required | string | 스케일 방법 | AMOUNT |
| name required | string | 정책 이름 | policy-name |
| metric_type required | string | 메트릭 유형 | CPU |
| metric_method required | string | 메트릭 방법 | AVG |
| evaluation_minutes required | integer | 평가 시간(분 단위) | 1 |
| cooldown_seconds required | integer | 쿨다운 시간(초 단위) | 300 |
| comparison_operator required | string | 비교 연산자 | ge |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | 비교 연산자 | ge |
| cooldown_seconds | 쿨다운 시간(초 단위) | 300 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | 평가 시간(분 단위) | 1 |
| metric_method | 메트릭 방법 | AVG |
| metric_type | 메트릭 유형 | CPU |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 정책 이름 | policy-name |
| scale_method | 스케일 방법 | AMOUNT |
| scale_type | 스케일 유형 | SCALE_OUT |
| scale_value | 스켕일 값 | 10 |
| state | 정책 상태 | ACTIVE |
| threshold | 임계값 | 60 |
| threshold_unit | 임계값 단위 | % |
2.3.1.9 - Create Auto-Scaling Group Schedule
2.3.1.9.1 - 1.1
scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]
Description
Auto-Scaling Group 스케줄을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| timezone required | string | 시간대 | Asia/Seoul |
| start_date required | string | 시작 날짜 | 2024-01-01 |
| name required | string | 스케쥴 이름 | schedulename |
| minute required | integer | 분 | 0 |
| hour required | integer | 시간 | 9 |
| frequency required | string | 빈도 | WEEKLY |
| day_of_month optional | string | 일 | -1,1 |
| day_of_week optional | string | 요일 | SU,SA |
| description optional | string | 설명 | description |
| desired_server_count optional | integer | 목표 서버 수 | 1 |
| end_date optional | string | 종료 날짜 | 2025-01-01 |
| max_server_count optional | integer | 최대 서버 수 | 2 |
| min_server_count optional | integer | 최소 서버 수 | 1 |
| state optional | string | 스케쥴 상태 | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | 일 | -1,1 |
| day_of_week | 요일 | SU,SA |
| description | 설명 | description |
| desired_server_count | 목표 서버 수 | 1 |
| end_date | 종료 날짜 | 2025-01-01 |
| frequency | 빈도 | WEEKLY |
| hour | 시간 | 9 |
| max_server_count | 최대 서버 수 | 2 |
| min_server_count | 최소 서버 수 | 1 |
| minute | 분 | 0 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 스케쥴 이름 | schedulename |
| start_date | 시작 날짜 | 2024-01-01 |
| state | 스케쥴 상태 | ACTIVE |
| timezone | 시간대 | Asia/Seoul |
2.3.1.9.2 - 1.0
scpcli virtualserver auto scaling group schedule create
--auto_scaling_group_id <value>
--timezone <value>
--start_date <value>
--name <value>
--minute <value>
--hour <value>
--frequency <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--state <value>]
Description
Auto-Scaling Group 스케줄을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| timezone required | string | 시간대 | Asia/Seoul |
| start_date required | string | 시작 날짜 | 2024-01-01 |
| name required | string | 스케쥴 이름 | schedulename |
| minute required | integer | 분 | 0 |
| hour required | integer | 시간 | 9 |
| frequency required | string | 빈도 | WEEKLY |
| day_of_month optional | string | 일 | -1,1 |
| day_of_week optional | string | 요일 | SU,SA |
| description optional | string | 설명 | description |
| desired_server_count optional | integer | 목표 서버 수 | 1 |
| end_date optional | string | 종료 날짜 | 2025-01-01 |
| max_server_count optional | integer | 최대 서버 수 | 2 |
| min_server_count optional | integer | 최소 서버 수 | 1 |
| state optional | string | 스케쥴 상태 | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | 일 | -1,1 |
| day_of_week | 요일 | SU,SA |
| description | 설명 | description |
| desired_server_count | 목표 서버 수 | 1 |
| end_date | 종료 날짜 | 2025-01-01 |
| frequency | 빈도 | WEEKLY |
| hour | 시간 | 9 |
| max_server_count | 최대 서버 수 | 2 |
| min_server_count | 최소 서버 수 | 1 |
| minute | 분 | 0 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 스케쥴 이름 | schedulename |
| start_date | 시작 날짜 | 2024-01-01 |
| state | 스케쥴 상태 | ACTIVE |
| timezone | 시간대 | Asia/Seoul |
2.3.1.10 - Create Image
2.3.1.10.1 - 1.1
scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]
Description
이미지를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| url required | string | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| os_distro required | string | OS 배포판 | alma |
| name required | string | 이미지 이름 | imagename |
| container_format optional | string | 컨테이너 형식 | bare |
| disk_format optional | string | 디스크 형식 | qcow2 |
| min_disk optional | integer | 최소 디스크 | 100 |
| min_ram optional | integer | 최소 RAM | 0 |
| protected optional | boolean | 보호 | False |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| visibility optional | string | 가시성 | private |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | 체크섬 | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | 컨테이너 형식 | bare |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| disk_format | 디스크 형식 | qcow2 |
| file | 파일 | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | 최소 디스크 | 100 |
| min_ram | 최소 RAM | 0 |
| name | 이미지 이름 | imagename |
| os_distro | OS 배포판 | alma |
| os_hash_algo | OS 해시 알고리즘 | sha512 |
| os_hash_value | OS 해시 값 | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS 숨김 여부 | False |
| owner | Owner account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | 소유 account 이름 | AccountName |
| owner_user_name | 소유자 이름 | user@samsung.com |
| protected | 보호 | False |
| root_device_name | 루트 디바이스 이름 | /dev/vda |
| scp_image_type | 이미지 타입 | custom |
| scp_k8s_version | K8S 버전 | v1.28.7 |
| scp_original_image_type | 원본 이미지 타입 | standard |
| scp_os_build_version | OS 빌드 버전 | 20250101 |
| scp_os_version | OS 버전 | 8.8 |
| size | 크기 | 2429747200 |
| status | 상태 | active |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
| url | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | 가상 크기 | 17179869184 |
| visibility | 가시성 | private |
| volumes | 볼륨 | [{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}] |
2.3.1.10.2 - 1.0
scpcli virtualserver image create
--url <value>
--os_distro <value>
--name <value>
[--container_format <value>]
[--disk_format <value>]
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--tags <value>]
[--visibility <value>]
Description
이미지를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| url required | string | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| os_distro required | string | OS 배포판 | alma |
| name required | string | 이미지 이름 | imagename |
| container_format optional | string | 컨테이너 형식 | bare |
| disk_format optional | string | 디스크 형식 | qcow2 |
| min_disk optional | integer | 최소 디스크 | 100 |
| min_ram optional | integer | 최소 RAM | 0 |
| protected optional | boolean | 보호 | False |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| visibility optional | string | 가시성 | private |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | 체크섬 | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | 컨테이너 형식 | bare |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| disk_format | 디스크 형식 | qcow2 |
| file | 파일 | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | 최소 디스크 | 100 |
| min_ram | 최소 RAM | 0 |
| name | 이미지 이름 | imagename |
| os_distro | OS 배포판 | alma |
| os_hash_algo | OS 해시 알고리즘 | sha512 |
| os_hash_value | OS 해시 값 | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS 숨김 여부 | False |
| owner | Owner account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | 소유 account 이름 | AccountName |
| owner_user_name | 소유자 이름 | user@samsung.com |
| protected | 보호 | False |
| root_device_name | 루트 디바이스 이름 | /dev/vda |
| scp_image_type | 이미지 타입 | custom |
| scp_k8s_version | K8S 버전 | v1.28.7 |
| scp_original_image_type | 원본 이미지 타입 | standard |
| scp_os_build_version | OS 빌드 버전 | 20250101 |
| scp_os_version | OS 버전 | 8.8 |
| size | 크기 | 2429747200 |
| status | 상태 | active |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
| url | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | 가상 크기 | 17179869184 |
| visibility | 가시성 | private |
| volumes | 볼륨 | [{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}] |
2.3.1.11 - Create Image member
2.3.1.11.1 - 1.1
scpcli virtualserver image add member
--image_id <value>
--member_id <value>
Description
이미지 멤버를 추가한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id required | string | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| image_id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | 멤버 상태 | pending |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
2.3.1.11.2 - 1.0
scpcli virtualserver image add member
--image_id <value>
--member_id <value>
Description
이미지 멤버를 추가한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id required | string | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| image_id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | 멤버 상태 | pending |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
2.3.1.12 - Create Keypair
2.3.1.12.1 - 1.1
scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]
Description
키페어를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 키페어 이름 | keypairname |
| public_key optional | string | Public Key | publickey |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | 키페어 이름 | keypairname |
| private_key | 비밀 키 | privatekey |
| public_key | Public Key | publickey |
| type | 키페어 유형 | ssh |
2.3.1.12.2 - 1.0
scpcli virtualserver keypair create
--name <value>
[--public_key <value>]
[--tags <value>]
Description
키페어를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 키페어 이름 | keypairname |
| public_key optional | string | Public Key | publickey |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | 키페어 이름 | keypairname |
| private_key | 비밀 키 | privatekey |
| public_key | Public Key | publickey |
| type | 키페어 유형 | ssh |
2.3.1.13 - Create Launch Configuration
2.3.1.13.1 - 1.1
scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]
Description
Launch Configuration을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_type_id required | string | 서버 타입 ID | s1v1m2 |
| name required | string | Launch Configuration 이름 | launch-configuration-name |
| keypair_name required | string | 키페어 이름 | keypairname |
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| user_data optional | string | 사용자 데이터 | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
| volumes optional | array | 볼륨 | '{"boot_index": 0, "size": 104, "type": "SSD"}' |
Responses
| Name | Description | Example |
|---|---|---|
| boot_index | 부팅 장치를 시도하는 순서 | 0 |
| size | 볼륨 크기 | 104 |
| type | 볼륨 타입 | SSD |
2.3.1.13.2 - 1.0
scpcli virtualserver launch configuration create
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--tags <value>]
[--user_data <value>]
[--volumes <value>]
Description
Launch Configuration을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_type_id required | string | 서버 타입 ID | s1v1m2 |
| name required | string | Launch Configuration 이름 | launch-configuration-name |
| keypair_name required | string | 키페어 이름 | keypairname |
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| user_data optional | string | 사용자 데이터 | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
| volumes optional | array | 볼륨 | '{"boot_index": 0, "size": 104, "type": "SSD"}' |
Responses
| Name | Description | Example |
|---|---|---|
| boot_index | 부팅 장치를 시도하는 순서 | 0 |
| size | 볼륨 크기 | 104 |
| type | 볼륨 타입 | SSD |
2.3.1.14 - Create Server Group
2.3.1.14.1 - 1.1
scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]
Description
서버 그룹을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy required | string | 서버 그룹 정책 | anti-affinity |
| name required | string | 서버 그룹 명 | server-group |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | 서버 그룹 멤버 | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | 서버 그룹 명 | server-group |
| partition_size | 파티션 사이즈 | 3 |
| policy | 서버 그룹 정책 | anti-affinity |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
2.3.1.14.2 - 1.0
scpcli virtualserver server group create
--policy <value>
--name <value>
[--tags <value>]
Description
서버 그룹을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy required | string | 서버 그룹 정책 | anti-affinity |
| name required | string | 서버 그룹 명 | server-group |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | 서버 그룹 멤버 | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | 서버 그룹 명 | server-group |
| partition_size | 파티션 사이즈 | 3 |
| policy | 서버 그룹 정책 | anti-affinity |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
2.3.1.15 - Create Server Interface
2.3.1.15.1 - 1.1
scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]
Description
서버 인터페이스를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| fixed_ips optional | array | Fixed Ip list | '{"ip_address": "192.169.3.2"}' |
| port_id optional | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| subnet_id optional | string | 서브넷 ID | 78b2ee3f074145c580ab6abac4821f97 |
Responses
| Name | Description | Example |
|---|---|---|
| ip_address | IP 주소 | 192.169.3.2 |
2.3.1.15.2 - 1.0
scpcli virtualserver server add interface
--server_id <value>
[--fixed_ips <value>]
[--port_id <value>]
[--subnet_id <value>]
Description
서버 인터페이스를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| fixed_ips optional | array | Fixed Ip list | '{"ip_address": "192.169.3.2"}' |
| port_id optional | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| subnet_id optional | string | 서브넷 ID | 78b2ee3f074145c580ab6abac4821f97 |
Responses
| Name | Description | Example |
|---|---|---|
| ip_address | IP 주소 | 192.169.3.2 |
2.3.1.16 - Create Server Interface Nat
2.3.1.16.1 - 1.1
scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>
Description
Create Server Interface Nat.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| publicip_id required | string | 공개 IP ID | 615fa9cd5cff486c9de679b3ce63e601 |
Responses
| Name | Description | Example |
|---|
2.3.1.16.2 - 1.0
scpcli virtualserver server interface add static nat
--port_id <value>
--server_id <value>
--publicip_id <value>
Description
Create Server Interface Nat.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| publicip_id required | string | 공개 IP ID | 615fa9cd5cff486c9de679b3ce63e601 |
Responses
| Name | Description | Example |
|---|
2.3.1.17 - Create Server Interface Private Nat
2.3.1.17.1 - 1.1
scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Create Server Interface Private Nat.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| private_nat_ip_id required | string | 비공개 NAT IP ID | 1f0cb5390c40483592ddc5a282f53496 |
| private_nat_id required | string | Private NAT ID | 3a6c1dc6b1b24e02a444d672c2798a1c |
Responses
| Name | Description | Example |
|---|
2.3.1.17.2 - 1.0
scpcli virtualserver server interface add private static nat
--port_id <value>
--server_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Create Server Interface Private Nat.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| private_nat_ip_id required | string | 비공개 NAT IP ID | 1f0cb5390c40483592ddc5a282f53496 |
| private_nat_id required | string | Private NAT ID | 3a6c1dc6b1b24e02a444d672c2798a1c |
Responses
| Name | Description | Example |
|---|
2.3.1.18 - Create Server Volume
2.3.1.18.1 - 1.1
scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]
Description
서버 볼륨을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id required | string | 볼륨 ID | - |
| delete_on_termination optional | boolean | 해지 시 삭제 | False |
| device optional | string | Device name | /dev/vda |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 연결 ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | 해지 시 삭제 | False |
| device | Device name | /dev/vda |
| server_id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.18.2 - 1.0
scpcli virtualserver server add volume
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
[--device <value>]
Description
서버 볼륨을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id required | string | 볼륨 ID | - |
| delete_on_termination optional | boolean | 해지 시 삭제 | False |
| device optional | string | Device name | /dev/vda |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 연결 ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | 해지 시 삭제 | False |
| device | Device name | /dev/vda |
| server_id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.19 - Create Sharing Image
2.3.1.19.1 - 1.1
scpcli virtualserver sharing image create
--image_id <value>
Description
공유용 이미지를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|
2.3.1.19.2 - 1.0
scpcli virtualserver sharing image create
--image_id <value>
Description
공유용 이미지를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|
2.3.1.20 - Create Virtual Server
2.3.1.20.1 - 1.1
scpcli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]
Description
서버를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_type_id required | string | 서버 타입 ID | s1v1m2 |
| networks required | array | 네트워크 목록 | '{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}' |
| name required | string | 서버 이름 | servername |
| keypair_name required | string | 키페어 이름 | keypairname |
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| lock optional | boolean | 잠김 여부 | False |
| max_count optional | integer | 최대 생성 개수 | 2 |
| metadata optional | object | 메타 데이터 | - |
| partition_number optional | integer | 파티션 넘버 | 1 |
| product_category optional | **** | 상품군 | compute |
| product_offering optional | **** | 상품 | virtual_server |
| security_groups optional | array | Security Group 목록 | [ |
| server_group_id optional | string | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| user_data optional | string | 사용자 데이터 | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
| volumes optional | array | 볼륨 | '{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.20.2 - 1.0
scpcli virtualserver server create
--server_type_id <value>
--networks <value>
--name <value>
--keypair_name <value>
--image_id <value>
[--lock <value>]
[--max_count <value>]
[--metadata <value>]
[--partition_number <value>]
[--product_category <value>]
[--product_offering <value>]
[--security_groups <value>]
[--server_group_id <value>]
[--tags <value>]
[--user_data <value>]
[--volumes <value>]
Description
서버를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_type_id required | string | 서버 타입 ID | s1v1m2 |
| networks required | array | 네트워크 목록 | '{"fixed_ip": "192.169.3.2", "port_id": "91424c08-0b26-49fb-9808-ed042292ceef", "public_ip_id": "615fa9cd5cff486c9de679b3ce63e601", "subnet_id": "78b2ee3f074145c580ab6abac4821f97"}' |
| name required | string | 서버 이름 | servername |
| keypair_name required | string | 키페어 이름 | keypairname |
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| lock optional | boolean | 잠김 여부 | False |
| max_count optional | integer | 최대 생성 개수 | 2 |
| metadata optional | object | 메타 데이터 | - |
| partition_number optional | integer | 파티션 넘버 | 1 |
| product_category optional | **** | 상품군 | compute |
| product_offering optional | **** | 상품 | virtual_server |
| security_groups optional | array | Security Group 목록 | [ |
| server_group_id optional | string | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| user_data optional | string | 사용자 데이터 | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
| volumes optional | array | 볼륨 | '{"boot_index": 0, "delete_on_termination": false, "size": 104, "source_type": "image", "type": "SSD"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.21 - Create Virtual Server Custom Image
2.3.1.21.1 - 1.1
scpcli virtualserver server image create
--server_id <value>
--image_name <value>
Description
서버 커스텀 이미지를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| image_name required | string | 이미지 이름 | imagename |
Responses
| Name | Description | Example |
|---|---|---|
| image_id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
2.3.1.21.2 - 1.0
scpcli virtualserver server image create
--server_id <value>
--image_name <value>
Description
서버 커스텀 이미지를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| image_name required | string | 이미지 이름 | imagename |
Responses
| Name | Description | Example |
|---|---|---|
| image_id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
2.3.1.22 - Create Virtual Server Dump
2.3.1.22.1 - 1.1
scpcli virtualserver server dump create
--server_id <value>
Description
서버 Dump를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.22.2 - 1.0
scpcli virtualserver server dump create
--server_id <value>
Description
서버 Dump를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.23 - Create Volume
2.3.1.23.1 - 1.1
scpcli virtualserver volume create
--size <value>
--name <value>
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]
Description
볼륨 생성을 요청한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size required | integer | 볼륨 크기 | 104 |
| name required | string | 볼륨명 | volume01 |
| snapshot_id optional | string | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| volume_type optional | string | 볼륨 타입 | SSD |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| attached_at | The time when the volume was attached to the server. | |
| device | Device name | /dev/vda |
2.3.1.23.2 - 1.0
scpcli virtualserver volume create
--size <value>
--name <value>
[--snapshot_id <value>]
[--tags <value>]
[--volume_type <value>]
Description
볼륨 생성을 요청한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size required | integer | 볼륨 크기 | 104 |
| name required | string | 볼륨명 | volume01 |
| snapshot_id optional | string | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| tags optional | array | Tags | '{"key": "Key", "value": "Value"}' |
| volume_type optional | string | 볼륨 타입 | SSD |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| attached_at | The time when the volume was attached to the server. | |
| device | Device name | /dev/vda |
2.3.1.24 - Delete a snapshot
2.3.1.24.1 - 1.1
scpcli virtualserver volume snapshot delete
--snapshot_id <value>
Description
Delete a snapshot.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
2.3.1.24.2 - 1.0
scpcli virtualserver volume snapshot delete
--snapshot_id <value>
Description
Delete a snapshot.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
2.3.1.25 - Delete a volume transfer
2.3.1.25.1 - 1.1
scpcli virtualserver volume transfer delete
--transfer_id <value>
Description
Delete a volume transfer.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
2.3.1.25.2 - 1.0
scpcli virtualserver volume transfer delete
--transfer_id <value>
Description
Delete a volume transfer.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
2.3.1.26 - Delete Auto-Scaling Group
2.3.1.26.1 - 1.1
scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>
Description
Auto-Scaling Group을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
2.3.1.26.2 - 1.0
scpcli virtualserver auto scaling group delete
--auto_scaling_group_id <value>
Description
Auto-Scaling Group을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
2.3.1.27 - Delete Auto-Scaling Group Notification
2.3.1.27.1 - 1.1
scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group 알림을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| notification_id required | string | 알림 ID | fa7fd191410744cd810a290c0b4d22b9 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
2.3.1.27.2 - 1.0
scpcli virtualserver auto scaling group notification delete
--notification_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group 알림을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| notification_id required | string | 알림 ID | fa7fd191410744cd810a290c0b4d22b9 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
2.3.1.28 - Delete Auto-Scaling Group Policy
2.3.1.28.1 - 1.1
scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group 정책을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 정책 ID | 0761d76085f54363bab07909baf69841 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
2.3.1.28.2 - 1.0
scpcli virtualserver auto scaling group policy delete
--policy_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group 정책을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 정책 ID | 0761d76085f54363bab07909baf69841 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
2.3.1.29 - Delete Auto-Scaling Group Schedule
2.3.1.29.1 - 1.1
scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group 스케줄을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| schedule_id required | string | 스케줄 ID | 43d4841abd404220af5f0904037aba71 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
2.3.1.29.2 - 1.0
scpcli virtualserver auto scaling group schedule delete
--schedule_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group 스케줄을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| schedule_id required | string | 스케줄 ID | 43d4841abd404220af5f0904037aba71 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
2.3.1.30 - Delete Image
2.3.1.30.1 - 1.1
scpcli virtualserver image delete
--image_id <value>
Description
이미지를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
2.3.1.30.2 - 1.0
scpcli virtualserver image delete
--image_id <value>
Description
이미지를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
2.3.1.31 - Delete Image member
2.3.1.31.1 - 1.1
scpcli virtualserver image remove member
--member_id <value>
--image_id <value>
Description
이미지 멤버를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
2.3.1.31.2 - 1.0
scpcli virtualserver image remove member
--member_id <value>
--image_id <value>
Description
이미지 멤버를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
2.3.1.32 - Delete Keypair
2.3.1.32.1 - 1.1
scpcli virtualserver keypair delete
--keypair_name <value>
Description
키페어를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| keypair_name required | string | 키페어 이름 | keypairname |
2.3.1.32.2 - 1.0
scpcli virtualserver keypair delete
--keypair_name <value>
Description
키페어를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| keypair_name required | string | 키페어 이름 | keypairname |
2.3.1.33 - Delete Launch Configuration
2.3.1.33.1 - 1.1
scpcli virtualserver launch configuration delete
--launch_configuration_id <value>
Description
Launch Configuration을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
2.3.1.33.2 - 1.0
scpcli virtualserver launch configuration delete
--launch_configuration_id <value>
Description
Launch Configuration을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
2.3.1.34 - Delete Server Group
2.3.1.34.1 - 1.1
scpcli virtualserver server group delete
--server_group_id <value>
Description
서버 그룹을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_group_id required | string | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
2.3.1.34.2 - 1.0
scpcli virtualserver server group delete
--server_group_id <value>
Description
서버 그룹을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_group_id required | string | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
2.3.1.35 - Delete Server Interface
2.3.1.35.1 - 1.1
scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>
Description
서버 인터페이스를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.35.2 - 1.0
scpcli virtualserver server remove interface
--port_id <value>
--server_id <value>
Description
서버 인터페이스를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.36 - Delete Server Interface Nat
2.3.1.36.1 - 1.1
scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>
Description
서버 인터페이스 NAT를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_id required | string | NAT ID | 224b80106e6f41b38efe98ac9ddbf280 |
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.36.2 - 1.0
scpcli virtualserver server interface remove static nat
--nat_id <value>
--port_id <value>
--server_id <value>
Description
서버 인터페이스 NAT를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_id required | string | NAT ID | 224b80106e6f41b38efe98ac9ddbf280 |
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.37 - Delete Server Interface Private Nat
2.3.1.37.1 - 1.1
scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>
Description
서버 인터페이스 Private NAT를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_id required | string | NAT ID | 224b80106e6f41b38efe98ac9ddbf280 |
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.37.2 - 1.0
scpcli virtualserver server interface remove private static nat
--nat_id <value>
--port_id <value>
--server_id <value>
Description
서버 인터페이스 Private NAT를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_id required | string | NAT ID | 224b80106e6f41b38efe98ac9ddbf280 |
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.38 - Delete Server Volume
2.3.1.38.1 - 1.1
scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>
Description
서버 볼륨을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.38.2 - 1.0
scpcli virtualserver server remove volume
--volume_id <value>
--server_id <value>
Description
서버 볼륨을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.39 - Delete Virtual Server
2.3.1.39.1 - 1.1
scpcli virtualserver server delete
--server_id <value>
Description
서버를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.39.2 - 1.0
scpcli virtualserver server delete
--server_id <value>
Description
서버를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.40 - Delete Volume
2.3.1.40.1 - 1.1
scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]
Description
볼륨 삭제를 요청한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| cascade optional | boolean | 스냅샷 삭제 여부 | True |
2.3.1.40.2 - 1.0
scpcli virtualserver volume delete
--volume_id <value>
[--cascade <value>]
Description
볼륨 삭제를 요청한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| cascade optional | boolean | 스냅샷 삭제 여부 | True |
2.3.1.41 - Detach Virtual Server Security Group
2.3.1.41.1 - 1.0
scpcli virtualserver server remove security group
--security_group_id <value>
--server_id <value>
Description
서버에서 Security Group을 해제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_id required | string | Security Group ID | c09c3f05-03d9-443f-b27a-40e0f973c75f |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
2.3.1.42 - Detach Volume from Virtual Server
2.3.1.42.1 - 1.1
scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>
Description
볼륨을 서버에서 연결 해제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.42.2 - 1.0
scpcli virtualserver volume detach server
--server_id <value>
--volume_id <value>
Description
볼륨을 서버에서 연결 해제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.43 - Extend Volume
2.3.1.43.1 - 1.1
scpcli virtualserver volume resize
--volume_id <value>
--size <value>
Description
볼륨 용량을 증설 요청한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| size required | integer | 볼륨 크기 | 104 |
2.3.1.43.2 - 1.0
scpcli virtualserver volume resize
--volume_id <value>
--size <value>
Description
볼륨 용량을 증설 요청한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| size required | integer | 볼륨 크기 | 104 |
2.3.1.44 - Get region's maximum partition size.
2.3.1.44.1 - 1.1
scpcli virtualserver server group maximum partition size
Description
해당 리전의 최대 파티션 사이즈를 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|---|---|
| partition_size |
2.3.1.44.2 - 1.0
scpcli virtualserver server group maximum partition size
Description
해당 리전의 최대 파티션 사이즈를 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|---|---|
| partition_size |
2.3.1.45 - Import Image
2.3.1.45.1 - 1.1
scpcli virtualserver image import
--image_id <value>
--url <value>
Description
이미지 파일을 추가한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| url required | string | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
Responses
| Name | Description | Example |
|---|
2.3.1.45.2 - 1.0
scpcli virtualserver image import
--image_id <value>
--url <value>
Description
이미지 파일을 추가한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| url required | string | Object Storage URL for Image file (only qcow2 format allowed) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
Responses
| Name | Description | Example |
|---|
2.3.1.46 - List Auto-Scaling Group LB Server Groups
2.3.1.46.1 - 1.1
scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
Auto-Scaling Group LB 서버 그룹 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| limit optional | integer | 페이지 항목 개수 | 20 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 서버 그룹 이름 | lb-server-group-name |
| port | LB 서버 그룹 포트 | 8080 |
2.3.1.46.2 - 1.0
scpcli virtualserver auto scaling group lb server group list
--auto_scaling_group_id <value>
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
Auto-Scaling Group LB 서버 그룹 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| limit optional | integer | 페이지 항목 개수 | 20 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 서버 그룹 이름 | lb-server-group-name |
| port | LB 서버 그룹 포트 | 8080 |
2.3.1.47 - List Auto-Scaling Group Notifications
2.3.1.47.1 - 1.1
scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
Auto-Scaling Group 알림 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| user_ids optional | array | 사용자 ID 목록 | 570907805e5447be84b618450ef52o0t |
| notification_state optional | string | Auto-Scaling Group 알림 상태 | ACTIVE |
| notification_event optional | string | Auto-Scaling Group 알림 이벤트 | SCALE_OUT |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| limit optional | integer | 페이지 항목 개수 | 20 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group 알림 이벤트 목록 | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group 알림 상태 | ACTIVE |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
2.3.1.47.2 - 1.0
scpcli virtualserver auto scaling group notification list
--auto_scaling_group_id <value>
[--user_ids <value>]
[--notification_state <value>]
[--notification_event <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
Auto-Scaling Group 알림 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| user_ids optional | array | 사용자 ID 목록 | 570907805e5447be84b618450ef52o0t |
| notification_state optional | string | Auto-Scaling Group 알림 상태 | ACTIVE |
| notification_event optional | string | Auto-Scaling Group 알림 이벤트 | SCALE_OUT |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| limit optional | integer | 페이지 항목 개수 | 20 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group 알림 이벤트 목록 | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group 알림 상태 | ACTIVE |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
2.3.1.48 - List Auto-Scaling Group Policies
2.3.1.48.1 - 1.1
scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
Auto-Scaling Group 정책 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| name optional | string | 정책 이름 | policy-name |
| metric_method optional | **** | 메트릭 방법 | AVG |
| metric_type optional | string | 메트릭 유형 | CPU |
| scale_type optional | **** | 스케일 유형 | SCALE_OUT |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| limit optional | integer | 페이지 항목 개수 | 20 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | 비교 연산자 | ge |
| cooldown_seconds | 쿨다운 시간(초 단위) | 300 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | 평가 시간(분 단위) | 1 |
| metric_method | 메트릭 방법 | AVG |
| metric_type | 메트릭 유형 | CPU |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 정책 이름 | policy-name |
| scale_method | 스케일 방법 | AMOUNT |
| scale_type | 스케일 유형 | SCALE_OUT |
| scale_value | 스켕일 값 | 10 |
| state | 정책 상태 | ACTIVE |
| threshold | 임계값 | 60 |
| threshold_unit | 임계값 단위 | % |
2.3.1.48.2 - 1.0
scpcli virtualserver auto scaling group policy list
--auto_scaling_group_id <value>
[--name <value>]
[--metric_method <value>]
[--metric_type <value>]
[--scale_type <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
Description
Auto-Scaling Group 정책 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| name optional | string | 정책 이름 | policy-name |
| metric_method optional | **** | 메트릭 방법 | AVG |
| metric_type optional | string | 메트릭 유형 | CPU |
| scale_type optional | **** | 스케일 유형 | SCALE_OUT |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| limit optional | integer | 페이지 항목 개수 | 20 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | 비교 연산자 | ge |
| cooldown_seconds | 쿨다운 시간(초 단위) | 300 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | 평가 시간(분 단위) | 1 |
| metric_method | 메트릭 방법 | AVG |
| metric_type | 메트릭 유형 | CPU |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 정책 이름 | policy-name |
| scale_method | 스케일 방법 | AMOUNT |
| scale_type | 스케일 유형 | SCALE_OUT |
| scale_value | 스켕일 값 | 10 |
| state | 정책 상태 | ACTIVE |
| threshold | 임계값 | 60 |
| threshold_unit | 임계값 단위 | % |
2.3.1.49 - List Auto-Scaling Group Schedules
2.3.1.49.1 - 1.1
scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]
Description
Auto-Scaling Group 스케줄 목록을 조회한다..
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| frequency optional | **** | 빈도 | WEEKLY |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | 일 | -1,1 |
| day_of_week | 요일 | SU,SA |
| description | 설명 | description |
| desired_server_count | 목표 서버 수 | 1 |
| end_date | 종료 날짜 | 2025-01-01 |
| frequency | 빈도 | WEEKLY |
| hour | 시간 | 9 |
| max_server_count | 최대 서버 수 | 2 |
| min_server_count | 최소 서버 수 | 1 |
| minute | 분 | 0 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 스케쥴 이름 | schedulename |
| start_date | 시작 날짜 | 2024-01-01 |
| state | 스케쥴 상태 | ACTIVE |
| timezone | 시간대 | Asia/Seoul |
2.3.1.49.2 - 1.0
scpcli virtualserver auto scaling group schedule list
--auto_scaling_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--frequency <value>]
Description
Auto-Scaling Group 스케줄 목록을 조회한다..
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| frequency optional | **** | 빈도 | WEEKLY |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | 일 | -1,1 |
| day_of_week | 요일 | SU,SA |
| description | 설명 | description |
| desired_server_count | 목표 서버 수 | 1 |
| end_date | 종료 날짜 | 2025-01-01 |
| frequency | 빈도 | WEEKLY |
| hour | 시간 | 9 |
| max_server_count | 최대 서버 수 | 2 |
| min_server_count | 최소 서버 수 | 1 |
| minute | 분 | 0 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 스케쥴 이름 | schedulename |
| start_date | 시작 날짜 | 2024-01-01 |
| state | 스케쥴 상태 | ACTIVE |
| timezone | 시간대 | Asia/Seoul |
2.3.1.50 - List Auto-Scaling Group Virtual Servers
2.3.1.50.1 - 1.1
scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]
Description
Auto-Scaling Group Virtual Server 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| limit optional | integer | 페이지 항목 개수 | 20 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| addresses | 주소 목록 | |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | 생성일시 | |
| created_by | 생성자 ID | 97e6b22c9a4143789ca522df7457a32f |
| disk_config | 디스크 컨피그 | MANUAL |
| image_id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| is_marketplace | Marketplace 여부 | False |
| keypair_name | 키페어 이름 | keypairname |
| launch_configuration_id | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
| lb_linked_state | Load Balancer 연결 상태 | ATTACHED |
| locked | 잠김 여부 | False |
| metadata | 메타 데이터 | |
| modified_at | 수정일시 | |
| name | 서버 이름 | servername |
| partition_number | 파티션 넘버 | 1 |
| planned_compute_os_type | Planned Compute OS 유형 | windows |
| product_category | 상품군 | compute |
| product_offering | 상품 | virtual_server |
| security_groups | Security Group 목록 | |
| server_group_id | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| server_type | 서버 타입 | |
| state | 서버 상태 | ACTIVE |
| volumes | 볼륨 | |
| vpc_id | VPC ID | cc976b621087484ea5fd527f4b78708b |
2.3.1.50.2 - 1.0
scpcli virtualserver auto scaling group server list
--auto_scaling_group_id <value>
[--marker <value>]
[--limit <value>]
[--sort <value>]
Description
Auto-Scaling Group Virtual Server 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| limit optional | integer | 페이지 항목 개수 | 20 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| addresses | 주소 목록 | |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | 생성일시 | |
| created_by | 생성자 ID | 97e6b22c9a4143789ca522df7457a32f |
| disk_config | 디스크 컨피그 | MANUAL |
| image_id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| is_marketplace | Marketplace 여부 | False |
| keypair_name | 키페어 이름 | keypairname |
| launch_configuration_id | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
| lb_linked_state | Load Balancer 연결 상태 | ATTACHED |
| locked | 잠김 여부 | False |
| metadata | 메타 데이터 | |
| modified_at | 수정일시 | |
| name | 서버 이름 | servername |
| partition_number | 파티션 넘버 | 1 |
| planned_compute_os_type | Planned Compute OS 유형 | windows |
| product_category | 상품군 | compute |
| product_offering | 상품 | virtual_server |
| security_groups | Security Group 목록 | |
| server_group_id | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| server_type | 서버 타입 | |
| state | 서버 상태 | ACTIVE |
| volumes | 볼륨 | |
| vpc_id | VPC ID | cc976b621087484ea5fd527f4b78708b |
2.3.1.51 - List Auto-Scaling Groups
2.3.1.51.1 - 1.1
scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]
Description
Auto-Scaling Group 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Auto-Scaling Group 이름 | auto-scaling-group-name |
| state optional | string | Auto-Scaling Group 상태 | IN_SERVICE |
| launch_configuration_id optional | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
| launch_configuration_name optional | string | Launch Configuration 이름 | launch-configuration-name |
| lb_server_group_id optional | string | LB 서버 그룹 ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
| security_group_id optional | string | Security Group ID | c09c3f05-03d9-443f-b27a-40e0f973c75f |
| subnet_id optional | string | 서브넷 ID | 78b2ee3f074145c580ab6abac4821f97 |
| vpc_id optional | string | VPC ID | cc976b621087484ea5fd527f4b78708b |
| created_by optional | string | 생성자 ID | 97e6b22c9a4143789ca522df7457a32f |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| limit optional | integer | 페이지 항목 개수 | 20 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | 생성 시간 --long 옵션 사용 필요 | 2024-05-17T00:23:17Z |
| created_by | 생성자 --long 옵션 사용 필요 | 90dddfc2b1e04edba54ba2b41539a9ac |
| desired_server_count | 목표 서버 수 | 1 |
| desired_server_count_editable | 목표 서버 수 수정 가능 여부 --long 옵션 사용 필요 | True |
| drain_enabled | Drain 사용 여부 --long 옵션 사용 필요 | True |
| drain_timeout | Drain timeout 값 --long 옵션 사용 필요 | 300 |
| launch_configuration_id | Launch Configuration ID --long 옵션 사용 필요 | b5aea5a675fc4f6b9e0fcd1288354c5f |
| launch_configuration_name | Launch Configuration 이름 | launch-configuration-name |
| lb_server_groups | LB 서버 그룹 목록 --long 옵션 사용 필요 | |
| max_server_count | 최대 서버 수 | 2 |
| min_server_count | 최소 서버 수 | 1 |
| modified_at | 수정 시간 --long 옵션 사용 필요 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 --long 옵션 사용 필요 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Auto-Scaling Group 이름 | auto-scaling-group-name |
| security_group_ids | Security Group ID 목록 --long 옵션 사용 필요 | [‘c09c3f05-03d9-443f-b27a-40e0f973c75f’] |
| server_name_prefix | 서버 이름 접두사 --long 옵션 사용 필요 | server-name-prefix |
| state | Auto-Scaling Group 상태 | IN_SERVICE |
| subnet_ids | Subnet ID 목록 --long 옵션 사용 필요 | |
| vpc_id | VPC ID --long 옵션 사용 필요 | cc976b621087484ea5fd527f4b78708b |
2.3.1.51.2 - 1.0
scpcli virtualserver auto scaling group list
[--name <value>]
[--state <value>]
[--launch_configuration_id <value>]
[--launch_configuration_name <value>]
[--lb_server_group_id <value>]
[--security_group_id <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--created_by <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]
Description
Auto-Scaling Group 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Auto-Scaling Group 이름 | auto-scaling-group-name |
| state optional | string | Auto-Scaling Group 상태 | IN_SERVICE |
| launch_configuration_id optional | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
| launch_configuration_name optional | string | Launch Configuration 이름 | launch-configuration-name |
| lb_server_group_id optional | string | LB 서버 그룹 ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
| security_group_id optional | string | Security Group ID | c09c3f05-03d9-443f-b27a-40e0f973c75f |
| subnet_id optional | string | 서브넷 ID | 78b2ee3f074145c580ab6abac4821f97 |
| vpc_id optional | string | VPC ID | cc976b621087484ea5fd527f4b78708b |
| created_by optional | string | 생성자 ID | 97e6b22c9a4143789ca522df7457a32f |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| limit optional | integer | 페이지 항목 개수 | 20 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | 생성 시간 --long 옵션 사용 필요 | 2024-05-17T00:23:17Z |
| created_by | 생성자 --long 옵션 사용 필요 | 90dddfc2b1e04edba54ba2b41539a9ac |
| desired_server_count | 목표 서버 수 | 1 |
| desired_server_count_editable | 목표 서버 수 수정 가능 여부 --long 옵션 사용 필요 | True |
| drain_enabled | Drain 사용 여부 --long 옵션 사용 필요 | True |
| drain_timeout | Drain timeout 값 --long 옵션 사용 필요 | 300 |
| launch_configuration_id | Launch Configuration ID --long 옵션 사용 필요 | b5aea5a675fc4f6b9e0fcd1288354c5f |
| launch_configuration_name | Launch Configuration 이름 | launch-configuration-name |
| lb_server_groups | LB 서버 그룹 목록 --long 옵션 사용 필요 | |
| max_server_count | 최대 서버 수 | 2 |
| min_server_count | 최소 서버 수 | 1 |
| modified_at | 수정 시간 --long 옵션 사용 필요 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 --long 옵션 사용 필요 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Auto-Scaling Group 이름 | auto-scaling-group-name |
| security_group_ids | Security Group ID 목록 --long 옵션 사용 필요 | [‘c09c3f05-03d9-443f-b27a-40e0f973c75f’] |
| server_name_prefix | 서버 이름 접두사 --long 옵션 사용 필요 | server-name-prefix |
| state | Auto-Scaling Group 상태 | IN_SERVICE |
| subnet_ids | Subnet ID 목록 --long 옵션 사용 필요 | |
| vpc_id | VPC ID --long 옵션 사용 필요 | cc976b621087484ea5fd527f4b78708b |
2.3.1.52 - List Default Configs
2.3.1.52.1 - 1.1
scpcli virtualserver default config list
[--name <value>]
[--category <value>]
Description
기본 설정 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | 이름 | key |
| category optional | string | 분류 | AUTO_SCALING_GROUP |
Responses
| Name | Description | Example |
|---|---|---|
| configs | 설정 값 | (‘key’: ‘value’} |
| count | count | 20 |
2.3.1.52.2 - 1.0
scpcli virtualserver default config list
[--name <value>]
[--category <value>]
Description
기본 설정 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | 이름 | key |
| category optional | string | 분류 | AUTO_SCALING_GROUP |
Responses
| Name | Description | Example |
|---|---|---|
| configs | 설정 값 | (‘key’: ‘value’} |
| count | count | 20 |
2.3.1.53 - List Image members
2.3.1.53.1 - 1.1
scpcli virtualserver image member list
--image_id <value>
Description
이미지 멤버 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| image_id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | 멤버 상태 | pending |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
2.3.1.53.2 - 1.0
scpcli virtualserver image member list
--image_id <value>
Description
이미지 멤버 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| image_id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | 멤버 상태 | pending |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
2.3.1.54 - List Images
2.3.1.54.1 - 1.1
scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]
Description
이미지 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지 항목 개수 | 20 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| scp_image_type optional | string | 이미지 타입 | custom |
| scp_original_image_type optional | string | 원본 이미지 타입 | standard |
| name optional | string | 이미지 이름 | imagename |
| os_distro optional | string | OS 배포판 | alma |
| status optional | string | 상태 | active |
| visibility optional | **** | 가시성 | private |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | 체크섬 --long 옵션 사용 필요 | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | 컨테이너 형식 --long 옵션 사용 필요 | bare |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| disk_format | 디스크 형식 --long 옵션 사용 필요 | qcow2 |
| file | 파일 --long 옵션 사용 필요 | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | 최소 디스크 --long 옵션 사용 필요 | 100 |
| min_ram | 최소 RAM --long 옵션 사용 필요 | 0 |
| name | 이미지 이름 | imagename |
| os_distro | OS 배포판 | alma |
| os_hash_algo | OS 해시 알고리즘 --long 옵션 사용 필요 | sha512 |
| os_hash_value | OS 해시 값 --long 옵션 사용 필요 | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS 숨김 여부 --long 옵션 사용 필요 | False |
| owner | Owner account ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | 소유 account 이름 --long 옵션 사용 필요 | AccountName |
| owner_user_name | 소유자 이름 --long 옵션 사용 필요 | user@samsung.com |
| protected | 보호 --long 옵션 사용 필요 | False |
| root_device_name | 루트 디바이스 이름 --long 옵션 사용 필요 | /dev/vda |
| scp_image_type | 이미지 타입 --long 옵션 사용 필요 | custom |
| scp_k8s_version | K8S 버전 --long 옵션 사용 필요 | v1.28.7 |
| scp_original_image_type | 원본 이미지 타입 --long 옵션 사용 필요 | standard |
| scp_os_build_version | OS 빌드 버전 --long 옵션 사용 필요 | 20250101 |
| scp_os_version | OS 버전 --long 옵션 사용 필요 | 8.8 |
| size | 크기 --long 옵션 사용 필요 | 2429747200 |
| status | 상태 --long 옵션 사용 필요 | active |
| updated_at | 수정일시 --long 옵션 사용 필요 | 2025-07-26T12:00:00Z |
| url | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) --long 옵션 사용 필요 | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | 가상 크기 --long 옵션 사용 필요 | 17179869184 |
| visibility | 가시성 | private |
| volumes | 볼륨 --long 옵션 사용 필요 | [{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}] |
2.3.1.54.2 - 1.0
scpcli virtualserver image list
[--limit <value>]
[--marker <value>]
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--name <value>]
[--os_distro <value>]
[--status <value>]
[--visibility <value>]
[--sort <value>]
[--long]
Description
이미지 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지 항목 개수 | 20 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| scp_image_type optional | string | 이미지 타입 | custom |
| scp_original_image_type optional | string | 원본 이미지 타입 | standard |
| name optional | string | 이미지 이름 | imagename |
| os_distro optional | string | OS 배포판 | alma |
| status optional | string | 상태 | active |
| visibility optional | **** | 가시성 | private |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | 체크섬 --long 옵션 사용 필요 | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | 컨테이너 형식 --long 옵션 사용 필요 | bare |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| disk_format | 디스크 형식 --long 옵션 사용 필요 | qcow2 |
| file | 파일 --long 옵션 사용 필요 | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | 최소 디스크 --long 옵션 사용 필요 | 100 |
| min_ram | 최소 RAM --long 옵션 사용 필요 | 0 |
| name | 이미지 이름 | imagename |
| os_distro | OS 배포판 | alma |
| os_hash_algo | OS 해시 알고리즘 --long 옵션 사용 필요 | sha512 |
| os_hash_value | OS 해시 값 --long 옵션 사용 필요 | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS 숨김 여부 --long 옵션 사용 필요 | False |
| owner | Owner account ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | 소유 account 이름 --long 옵션 사용 필요 | AccountName |
| owner_user_name | 소유자 이름 --long 옵션 사용 필요 | user@samsung.com |
| protected | 보호 --long 옵션 사용 필요 | False |
| root_device_name | 루트 디바이스 이름 --long 옵션 사용 필요 | /dev/vda |
| scp_image_type | 이미지 타입 --long 옵션 사용 필요 | custom |
| scp_k8s_version | K8S 버전 --long 옵션 사용 필요 | v1.28.7 |
| scp_original_image_type | 원본 이미지 타입 --long 옵션 사용 필요 | standard |
| scp_os_build_version | OS 빌드 버전 --long 옵션 사용 필요 | 20250101 |
| scp_os_version | OS 버전 --long 옵션 사용 필요 | 8.8 |
| size | 크기 --long 옵션 사용 필요 | 2429747200 |
| status | 상태 --long 옵션 사용 필요 | active |
| updated_at | 수정일시 --long 옵션 사용 필요 | 2025-07-26T12:00:00Z |
| url | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) --long 옵션 사용 필요 | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | 가상 크기 --long 옵션 사용 필요 | 17179869184 |
| visibility | 가시성 | private |
| volumes | 볼륨 --long 옵션 사용 필요 | [{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}] |
2.3.1.55 - List Keypairs
2.3.1.55.1 - 1.1
scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]
Description
키페어 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지 항목 개수 | 20 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | 키페어 이름 | keypairname |
| public_key | Public Key --long 옵션 사용 필요 | publickey |
| type | 키페어 유형 | ssh |
2.3.1.55.2 - 1.0
scpcli virtualserver keypair list
[--limit <value>]
[--marker <value>]
[--long]
Description
키페어 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지 항목 개수 | 20 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | 키페어 이름 | keypairname |
| public_key | Public Key --long 옵션 사용 필요 | publickey |
| type | 키페어 유형 | ssh |
2.3.1.56 - List Launch Configurations
2.3.1.56.1 - 1.1
scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]
Description
Launch Configuration 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Launch Configuration 이름 | launch-configuration-name |
| image_id optional | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | - |
| limit optional | integer | 페이지 항목 개수 | - |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_count | Launch Configuration에 연결된 Auto-Scaling Group 수 | 1 |
| boot_disk_size | 기본 볼륨 크기 --long 옵션 사용 필요 | 104 |
| created_at | 생성 시간 --long 옵션 사용 필요 | 2024-05-17T00:23:17Z |
| created_by | 생성자 --long 옵션 사용 필요 | 90dddfc2b1e04edba54ba2b41539a9ac |
| extra_disk_size | 추가 볼륨 크기 --long 옵션 사용 필요 | 104 |
| image_id | 이미지 ID --long 옵션 사용 필요 | 70a599e0-31e7-49b7-b260-868f441e862b |
| image_name | 이미지 이름 | imagename |
| keypair_name | 키페어 이름 --long 옵션 사용 필요 | keypairname |
| modified_at | 수정 시간 --long 옵션 사용 필요 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 --long 옵션 사용 필요 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Launch Configuration 이름 | launch-configuration-name |
| public_key | Public Key --long 옵션 사용 필요 | publickey |
| server_type_id | 서버 타입 ID | s1v1m2 |
| state | Launch Configuration 상태 --long 옵션 사용 필요 | ACTIVE |
| user_data | 사용자 데이터 --long 옵션 사용 필요 | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
| volumes | 볼륨 |
2.3.1.56.2 - 1.0
scpcli virtualserver launch configuration list
[--name <value>]
[--image_id <value>]
[--offset <value>]
[--limit <value>]
[--sort <value>]
[--long]
Description
Launch Configuration 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Launch Configuration 이름 | launch-configuration-name |
| image_id optional | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | - |
| limit optional | integer | 페이지 항목 개수 | - |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_count | Launch Configuration에 연결된 Auto-Scaling Group 수 | 1 |
| boot_disk_size | 기본 볼륨 크기 --long 옵션 사용 필요 | 104 |
| created_at | 생성 시간 --long 옵션 사용 필요 | 2024-05-17T00:23:17Z |
| created_by | 생성자 --long 옵션 사용 필요 | 90dddfc2b1e04edba54ba2b41539a9ac |
| extra_disk_size | 추가 볼륨 크기 --long 옵션 사용 필요 | 104 |
| image_id | 이미지 ID --long 옵션 사용 필요 | 70a599e0-31e7-49b7-b260-868f441e862b |
| image_name | 이미지 이름 | imagename |
| keypair_name | 키페어 이름 --long 옵션 사용 필요 | keypairname |
| modified_at | 수정 시간 --long 옵션 사용 필요 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 --long 옵션 사용 필요 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Launch Configuration 이름 | launch-configuration-name |
| public_key | Public Key --long 옵션 사용 필요 | publickey |
| server_type_id | 서버 타입 ID | s1v1m2 |
| state | Launch Configuration 상태 --long 옵션 사용 필요 | ACTIVE |
| user_data | 사용자 데이터 --long 옵션 사용 필요 | IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== |
| volumes | 볼륨 |
2.3.1.57 - List pending Images
2.3.1.57.1 - 1.1
scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]
Description
공유 대기 중인 이미지 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| scp_image_type optional | string | 이미지 타입 | custom |
| scp_original_image_type optional | string | 원본 이미지 타입 | standard |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | 체크섬 --long 옵션 사용 필요 | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | 컨테이너 형식 --long 옵션 사용 필요 | bare |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| disk_format | 디스크 형식 --long 옵션 사용 필요 | qcow2 |
| file | 파일 --long 옵션 사용 필요 | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | 최소 디스크 --long 옵션 사용 필요 | 100 |
| min_ram | 최소 RAM --long 옵션 사용 필요 | 0 |
| name | 이미지 이름 | imagename |
| os_distro | OS 배포판 | alma |
| os_hash_algo | OS 해시 알고리즘 --long 옵션 사용 필요 | sha512 |
| os_hash_value | OS 해시 값 --long 옵션 사용 필요 | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS 숨김 여부 --long 옵션 사용 필요 | False |
| owner | Owner account ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | 소유 account 이름 --long 옵션 사용 필요 | AccountName |
| owner_user_name | 소유자 이름 --long 옵션 사용 필요 | user@samsung.com |
| protected | 보호 --long 옵션 사용 필요 | False |
| root_device_name | 루트 디바이스 이름 --long 옵션 사용 필요 | /dev/vda |
| scp_image_type | 이미지 타입 --long 옵션 사용 필요 | custom |
| scp_k8s_version | K8S 버전 --long 옵션 사용 필요 | v1.28.7 |
| scp_original_image_type | 원본 이미지 타입 --long 옵션 사용 필요 | standard |
| scp_os_build_version | OS 빌드 버전 --long 옵션 사용 필요 | 20250101 |
| scp_os_version | OS 버전 --long 옵션 사용 필요 | 8.8 |
| size | 크기 --long 옵션 사용 필요 | 2429747200 |
| status | 상태 --long 옵션 사용 필요 | active |
| updated_at | 수정일시 --long 옵션 사용 필요 | 2025-07-26T12:00:00Z |
| url | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) --long 옵션 사용 필요 | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | 가상 크기 --long 옵션 사용 필요 | 17179869184 |
| visibility | 가시성 | private |
| volumes | 볼륨 --long 옵션 사용 필요 | [{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}] |
2.3.1.57.2 - 1.0
scpcli virtualserver image pending list
[--scp_image_type <value>]
[--scp_original_image_type <value>]
[--long]
Description
공유 대기 중인 이미지 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| scp_image_type optional | string | 이미지 타입 | custom |
| scp_original_image_type optional | string | 원본 이미지 타입 | standard |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | 체크섬 --long 옵션 사용 필요 | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | 컨테이너 형식 --long 옵션 사용 필요 | bare |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| disk_format | 디스크 형식 --long 옵션 사용 필요 | qcow2 |
| file | 파일 --long 옵션 사용 필요 | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | 최소 디스크 --long 옵션 사용 필요 | 100 |
| min_ram | 최소 RAM --long 옵션 사용 필요 | 0 |
| name | 이미지 이름 | imagename |
| os_distro | OS 배포판 | alma |
| os_hash_algo | OS 해시 알고리즘 --long 옵션 사용 필요 | sha512 |
| os_hash_value | OS 해시 값 --long 옵션 사용 필요 | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS 숨김 여부 --long 옵션 사용 필요 | False |
| owner | Owner account ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | 소유 account 이름 --long 옵션 사용 필요 | AccountName |
| owner_user_name | 소유자 이름 --long 옵션 사용 필요 | user@samsung.com |
| protected | 보호 --long 옵션 사용 필요 | False |
| root_device_name | 루트 디바이스 이름 --long 옵션 사용 필요 | /dev/vda |
| scp_image_type | 이미지 타입 --long 옵션 사용 필요 | custom |
| scp_k8s_version | K8S 버전 --long 옵션 사용 필요 | v1.28.7 |
| scp_original_image_type | 원본 이미지 타입 --long 옵션 사용 필요 | standard |
| scp_os_build_version | OS 빌드 버전 --long 옵션 사용 필요 | 20250101 |
| scp_os_version | OS 버전 --long 옵션 사용 필요 | 8.8 |
| size | 크기 --long 옵션 사용 필요 | 2429747200 |
| status | 상태 --long 옵션 사용 필요 | active |
| updated_at | 수정일시 --long 옵션 사용 필요 | 2025-07-26T12:00:00Z |
| url | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) --long 옵션 사용 필요 | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | 가상 크기 --long 옵션 사용 필요 | 17179869184 |
| visibility | 가시성 | private |
| volumes | 볼륨 --long 옵션 사용 필요 | [{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}] |
2.3.1.58 - List Server Groups
2.3.1.58.1 - 1.1
scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]
Description
서버 그룹 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지 항목 개수 | 20 |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | 계정 ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | 서버 그룹 멤버 --long 옵션 사용 필요 | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | 서버 그룹 명 | server-group |
| partition_size | 파티션 사이즈 --long 옵션 사용 필요 | 3 |
| policy | 서버 그룹 정책 | anti-affinity |
| user_id | 사용자 ID --long 옵션 사용 필요 | 570907805e5447be84b618450ef52o0t |
2.3.1.58.2 - 1.0
scpcli virtualserver server group list
[--limit <value>]
[--offset <value>]
[--long]
Description
서버 그룹 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지 항목 개수 | 20 |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | 계정 ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | 서버 그룹 멤버 --long 옵션 사용 필요 | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | 서버 그룹 명 | server-group |
| partition_size | 파티션 사이즈 --long 옵션 사용 필요 | 3 |
| policy | 서버 그룹 정책 | anti-affinity |
| user_id | 사용자 ID --long 옵션 사용 필요 | 570907805e5447be84b618450ef52o0t |
2.3.1.59 - List Server Interfaces
2.3.1.59.1 - 1.1
scpcli virtualserver server interface list
--server_id <value>
Description
서버 인터페이스 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| fixed_ips | Fixed Ip list | |
| mac_addr | MAC 주소 | fa:16:3e:c0:71:2b |
| port_id | 포트 ID | f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc |
| port_state | Port State | ACTIVE |
| private_static_nat | Private Static NAT | |
| static_nat | Public Static NAT | |
| subnet_id | 서브넷 ID | 183c6c30df0c4fcbb16422aa2d64aa21 |
2.3.1.59.2 - 1.0
scpcli virtualserver server interface list
--server_id <value>
Description
서버 인터페이스 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| fixed_ips | Fixed Ip list | |
| mac_addr | MAC 주소 | fa:16:3e:c0:71:2b |
| port_id | 포트 ID | f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc |
| port_state | Port State | ACTIVE |
| private_static_nat | Private Static NAT | |
| static_nat | Public Static NAT | |
| subnet_id | 서브넷 ID | 183c6c30df0c4fcbb16422aa2d64aa21 |
2.3.1.60 - List Server Ips
2.3.1.60.1 - 1.1
scpcli virtualserver server ip list
--server_id <value>
Description
서버 IP 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| ip_addresses | IP 주소 목록 | |
| subnet_name | 서브넷 이름 | subnetname |
2.3.1.60.2 - 1.0
scpcli virtualserver server ip list
--server_id <value>
Description
서버 IP 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| ip_addresses | IP 주소 목록 | |
| subnet_name | 서브넷 이름 | subnetname |
2.3.1.61 - List Server Types
2.3.1.61.1 - 1.1
scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]
Description
서버 타입 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지 항목 개수 | 20 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| min_disk optional | integer | 최소 디스크 크기 | 0 |
| min_ram optional | integer | 최소 램 크기 | 2048 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 타입 ID | s1v1m2 |
| description | 설명 | description |
| disk | 루트 디스크 크기 | 100 |
| ephemeral | 임시 디스크 크기 | 0 |
| extra_specs | 추가 스펙 | |
| name | 서버 타입 이름 | s1v1m2 |
| ram | RAM 크기 | 2 |
| swap | 전용 스왑 디스크 크기 | 0 |
| vcpus | CPU 수 | 1 |
2.3.1.61.2 - 1.0
scpcli virtualserver server type list
[--limit <value>]
[--marker <value>]
[--min_disk <value>]
[--min_ram <value>]
[--sort <value>]
Description
서버 타입 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지 항목 개수 | 20 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| min_disk optional | integer | 최소 디스크 크기 | 0 |
| min_ram optional | integer | 최소 램 크기 | 2048 |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 타입 ID | s1v1m2 |
| description | 설명 | description |
| disk | 루트 디스크 크기 | 100 |
| ephemeral | 임시 디스크 크기 | 0 |
| extra_specs | 추가 스펙 | |
| name | 서버 타입 이름 | s1v1m2 |
| ram | RAM 크기 | 2 |
| swap | 전용 스왑 디스크 크기 | 0 |
| vcpus | CPU 수 | 1 |
2.3.1.62 - List Server Volumes
2.3.1.62.1 - 1.1
scpcli virtualserver server volume list
--server_id <value>
Description
서버 볼륨 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 연결 ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | 해지 시 삭제 | False |
| device | Device name | /dev/vda |
| server_id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.62.2 - 1.0
scpcli virtualserver server volume list
--server_id <value>
Description
서버 볼륨 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 연결 ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | 해지 시 삭제 | False |
| device | Device name | /dev/vda |
| server_id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.63 - List snapshots and details
2.3.1.63.1 - 1.1
scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]
Description
List snapshots and details.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id optional | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| limit optional | integer | 페이지 항목 개수 | 20 |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| with_count optional | boolean | 총 개수 여부 | True |
| name optional | string | 스냅샷명 | snapshot-1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| description | 설명 | description |
| metadata | Snapshot metadata | |
| name | 스냅샷명 | snapshot-1 |
| size | 볼륨 크기 | 104 |
| status | 볼륨 상태 | available |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.63.2 - 1.0
scpcli virtualserver volume snapshot list
[--volume_id <value>]
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--with_count <value>]
[--name <value>]
Description
List snapshots and details.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id optional | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| limit optional | integer | 페이지 항목 개수 | 20 |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| with_count optional | boolean | 총 개수 여부 | True |
| name optional | string | 스냅샷명 | snapshot-1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| description | 설명 | description |
| metadata | Snapshot metadata | |
| name | 스냅샷명 | snapshot-1 |
| size | 볼륨 크기 | 104 |
| status | 볼륨 상태 | available |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.64 - List Virtual Server Security Group
2.3.1.64.1 - 1.1
scpcli virtualserver server security group list
--server_id <value>
Description
서버 Security Group 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | Server Group owner’s account ID | 6f70656e737461636b20342065766572 |
| description | Security group description | Security group description |
| name | Security Group 이름 | securitygroup |
| rules | Security group rules |
2.3.1.64.2 - 1.0
scpcli virtualserver server security group list
--server_id <value>
Description
서버 Security Group 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | Server Group owner’s account ID | 6f70656e737461636b20342065766572 |
| description | Security group description | Security group description |
| name | Security Group 이름 | securitygroup |
| rules | Security group rules |
2.3.1.65 - List Virtual Servers
2.3.1.65.1 - 1.1
scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]
Description
서버 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | 서버 이름 | servername |
| ip optional | string | IP 주소 | 192.169.3.2 |
| state optional | string | 서버 상태 | ACTIVE |
| product_category optional | **** | 상품군 | compute |
| product_offering optional | array | 상품 | 'v' |
| vpc_id optional | string | VPC ID | cc976b621087484ea5fd527f4b78708b |
| server_type_id optional | string | 서버 타입 ID | s1v1m2 |
| limit optional | integer | 페이지 항목 개수 | 20 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
| auto_scaling_group_id optional | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account_id | 계정 ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| addresses | 주소 목록 | |
| auto_scaling_group_id | Auto-Scaling Group ID --long 옵션 사용 필요 | 52613bd852b04b39adcb15a8364d856d |
| created_at | 생성일시 --long 옵션 사용 필요 | |
| created_by | 생성자 ID --long 옵션 사용 필요 | 97e6b22c9a4143789ca522df7457a32f |
| disk_config | 디스크 컨피그 --long 옵션 사용 필요 | MANUAL |
| image_id | 이미지 ID --long 옵션 사용 필요 | 70a599e0-31e7-49b7-b260-868f441e862b |
| is_marketplace | Marketplace 여부 --long 옵션 사용 필요 | False |
| keypair_name | 키페어 이름 --long 옵션 사용 필요 | keypairname |
| launch_configuration_id | Launch Configuration ID --long 옵션 사용 필요 | b5aea5a675fc4f6b9e0fcd1288354c5f |
| locked | 잠김 여부 --long 옵션 사용 필요 | False |
| metadata | 메타 데이터 --long 옵션 사용 필요 | |
| modified_at | 수정일시 --long 옵션 사용 필요 | |
| name | 서버 이름 | servername |
| partition_number | 파티션 넘버 --long 옵션 사용 필요 | 1 |
| planned_compute_os_type | Planned Compute OS 유형 --long 옵션 사용 필요 | windows |
| product_category | 상품군 --long 옵션 사용 필요 | compute |
| product_offering | 상품 --long 옵션 사용 필요 | virtual_server |
| security_groups | Security Group 목록 --long 옵션 사용 필요 | |
| server_group_id | 서버 그룹 ID --long 옵션 사용 필요 | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| server_type | 서버 타입 | |
| state | 서버 상태 | ACTIVE |
| volumes | 볼륨 --long 옵션 사용 필요 | |
| vpc_id | VPC ID --long 옵션 사용 필요 | cc976b621087484ea5fd527f4b78708b |
2.3.1.65.2 - 1.0
scpcli virtualserver server list
[--name <value>]
[--ip <value>]
[--state <value>]
[--product_category <value>]
[--product_offering <value>]
[--vpc_id <value>]
[--server_type_id <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--auto_scaling_group_id <value>]
[--long]
Description
서버 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | 서버 이름 | servername |
| ip optional | string | IP 주소 | 192.169.3.2 |
| state optional | string | 서버 상태 | ACTIVE |
| product_category optional | **** | 상품군 | compute |
| product_offering optional | array | 상품 | 'v' |
| vpc_id optional | string | VPC ID | cc976b621087484ea5fd527f4b78708b |
| server_type_id optional | string | 서버 타입 ID | s1v1m2 |
| limit optional | integer | 페이지 항목 개수 | 20 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
| auto_scaling_group_id optional | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account_id | 계정 ID --long 옵션 사용 필요 | a8f10467abfc4b87b64614ab36eb9ae4 |
| addresses | 주소 목록 | |
| auto_scaling_group_id | Auto-Scaling Group ID --long 옵션 사용 필요 | 52613bd852b04b39adcb15a8364d856d |
| created_at | 생성일시 --long 옵션 사용 필요 | |
| created_by | 생성자 ID --long 옵션 사용 필요 | 97e6b22c9a4143789ca522df7457a32f |
| disk_config | 디스크 컨피그 --long 옵션 사용 필요 | MANUAL |
| image_id | 이미지 ID --long 옵션 사용 필요 | 70a599e0-31e7-49b7-b260-868f441e862b |
| is_marketplace | Marketplace 여부 --long 옵션 사용 필요 | False |
| keypair_name | 키페어 이름 --long 옵션 사용 필요 | keypairname |
| launch_configuration_id | Launch Configuration ID --long 옵션 사용 필요 | b5aea5a675fc4f6b9e0fcd1288354c5f |
| locked | 잠김 여부 --long 옵션 사용 필요 | False |
| metadata | 메타 데이터 --long 옵션 사용 필요 | |
| modified_at | 수정일시 --long 옵션 사용 필요 | |
| name | 서버 이름 | servername |
| partition_number | 파티션 넘버 --long 옵션 사용 필요 | 1 |
| planned_compute_os_type | Planned Compute OS 유형 --long 옵션 사용 필요 | windows |
| product_category | 상품군 --long 옵션 사용 필요 | compute |
| product_offering | 상품 --long 옵션 사용 필요 | virtual_server |
| security_groups | Security Group 목록 --long 옵션 사용 필요 | |
| server_group_id | 서버 그룹 ID --long 옵션 사용 필요 | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| server_type | 서버 타입 | |
| state | 서버 상태 | ACTIVE |
| volumes | 볼륨 --long 옵션 사용 필요 | |
| vpc_id | VPC ID --long 옵션 사용 필요 | cc976b621087484ea5fd527f4b78708b |
2.3.1.66 - List volume transfers
2.3.1.66.1 - 1.1
scpcli virtualserver volume transfer list
Description
List volume transfers.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| name | 볼륨명 | volume01 |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.66.2 - 1.0
scpcli virtualserver volume transfer list
Description
List volume transfers.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| name | 볼륨명 | volume01 |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.67 - List volume types and details
2.3.1.67.1 - 1.1
scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]
Description
볼륨 유형 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지 항목 개수 | 20 |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 유형 ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | 추가 스펙 | |
| name | 볼륨 유형명 | SSD |
2.3.1.67.2 - 1.0
scpcli virtualserver volume type list
[--limit <value>]
[--offset <value>]
[--marker <value>]
[--sort <value>]
Description
볼륨 유형 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지 항목 개수 | 20 |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 유형 ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | 추가 스펙 | |
| name | 볼륨 유형명 | SSD |
2.3.1.68 - List volumes and details
2.3.1.68.1 - 1.1
scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]
Description
볼륨 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | boolean | 총 개수 여부 | True |
| limit optional | integer | 페이지 항목 개수 | 20 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| name optional | string | 볼륨명 | volume01 |
| state optional | string | 볼륨 상태 | available |
| bootable optional | boolean | 부트 디스크 여부 | False |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | 부트 디스크 여부 | False |
| created_at | 생성일시 | |
| encrypted | 암호화 여부 --long 옵션 사용 필요 | True |
| modified_at | 수정일시 --long 옵션 사용 필요 | 2025-07-26T12:00:00Z |
| multiattach | 다중 연결 --long 옵션 사용 필요 | False |
| name | 볼륨명 | volume01 |
| servers | Attached servers --long 옵션 사용 필요 | |
| size | 볼륨 크기 | 104 |
| snapshot_id | 스냅샷 ID --long 옵션 사용 필요 | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | 볼륨 상태 | available |
| user_id | 사용자 ID --long 옵션 사용 필요 | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | 볼륨 이미지 메타데이터 --long 옵션 사용 필요 | |
| volume_type | 볼륨 타입 | SSD |
| volume_type_id | 볼륨 유형 ID --long 옵션 사용 필요 | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
2.3.1.68.2 - 1.0
scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]
Description
볼륨 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | boolean | 총 개수 여부 | True |
| limit optional | integer | 페이지 항목 개수 | 20 |
| marker optional | string | 이전 요청에서 마지막으로 반환된 항목 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| sort optional | string | 쉼표로 구분된 정렬 목록이며 <키>[:<방향>] 형식으로 지정 | created_at:desc |
| offset optional | integer | 목록에서 시작할 지점의 인덱스 | 0 |
| name optional | string | 볼륨명 | volume01 |
| state optional | string | 볼륨 상태 | available |
| bootable optional | boolean | 부트 디스크 여부 | False |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | 부트 디스크 여부 | False |
| created_at | 생성일시 | |
| encrypted | 암호화 여부 --long 옵션 사용 필요 | True |
| modified_at | 수정일시 --long 옵션 사용 필요 | 2025-07-26T12:00:00Z |
| multiattach | 다중 연결 --long 옵션 사용 필요 | False |
| name | 볼륨명 | volume01 |
| servers | Attached servers --long 옵션 사용 필요 | |
| size | 볼륨 크기 | 104 |
| snapshot_id | 스냅샷 ID --long 옵션 사용 필요 | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | 볼륨 상태 | available |
| user_id | 사용자 ID --long 옵션 사용 필요 | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | 볼륨 이미지 메타데이터 --long 옵션 사용 필요 | |
| volume_type | 볼륨 타입 | SSD |
| volume_type_id | 볼륨 유형 ID --long 옵션 사용 필요 | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
2.3.1.69 - Lock Virtual Server
2.3.1.69.1 - 1.1
scpcli virtualserver server lock
--server_id <value>
Description
서버에 Lock을 건다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.69.2 - 1.0
scpcli virtualserver server lock
--server_id <value>
Description
서버에 Lock을 건다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.70 - Reboot Virtual Server
2.3.1.70.1 - 1.1
scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]
Description
서버를 재시작한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| reboot_type optional | **** | 재시작 유형 | SOFT |
Responses
| Name | Description | Example |
|---|
2.3.1.70.2 - 1.0
scpcli virtualserver server reboot
--server_id <value>
[--reboot_type <value>]
Description
서버를 재시작한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| reboot_type optional | **** | 재시작 유형 | SOFT |
Responses
| Name | Description | Example |
|---|
2.3.1.71 - Rebuild Virtual Server
2.3.1.71.1 - 1.1
scpcli virtualserver server rebuild
--server_id <value>
Description
서버를 재빌드한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.71.2 - 1.0
scpcli virtualserver server rebuild
--server_id <value>
Description
서버를 재빌드한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.72 - Revert Volume to snapshot
2.3.1.72.1 - 1.1
scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>
Description
Revert Volume to snapshot.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| snapshot_id required | string | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
Responses
| Name | Description | Example |
|---|
2.3.1.72.2 - 1.0
scpcli virtualserver volume revert
--volume_id <value>
--snapshot_id <value>
Description
Revert Volume to snapshot.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| snapshot_id required | string | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
Responses
| Name | Description | Example |
|---|
2.3.1.73 - Show a snapshot’s details
2.3.1.73.1 - 1.1
scpcli virtualserver volume snapshot show
--snapshot_id <value>
Description
Show a snapshot’s details.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| description | 설명 | description |
| metadata | Snapshot metadata | |
| name | 스냅샷명 | snapshot-1 |
| size | 볼륨 크기 | 104 |
| status | 볼륨 상태 | available |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.73.2 - 1.0
scpcli virtualserver volume snapshot show
--snapshot_id <value>
Description
Show a snapshot’s details.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| description | 설명 | description |
| metadata | Snapshot metadata | |
| name | 스냅샷명 | snapshot-1 |
| size | 볼륨 크기 | 104 |
| status | 볼륨 상태 | available |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.74 - Show Auto-Scaling Group
2.3.1.74.1 - 1.1
scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>
Description
Auto-Scaling Group을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 서버 그룹 ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
| port | LB 서버 그룹 포트 | 8080 |
2.3.1.74.2 - 1.0
scpcli virtualserver auto scaling group show
--auto_scaling_group_id <value>
Description
Auto-Scaling Group을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 서버 그룹 ID | d06e87d3-ca9a-461b-8e88-077a542a7335 |
| port | LB 서버 그룹 포트 | 8080 |
2.3.1.75 - Show Auto-Scaling Group Notification
2.3.1.75.1 - 1.1
scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group 알림을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| notification_id required | string | 알림 ID | fa7fd191410744cd810a290c0b4d22b9 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group 알림 이벤트 목록 | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group 알림 상태 | ACTIVE |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
2.3.1.75.2 - 1.0
scpcli virtualserver auto scaling group notification show
--notification_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group 알림을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| notification_id required | string | 알림 ID | fa7fd191410744cd810a290c0b4d22b9 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| notification_events | Auto-Scaling Group 알림 이벤트 목록 | [‘SCALE_OUT’, ‘SCALE_OUT_FAIL’] |
| notification_state | Auto-Scaling Group 알림 상태 | ACTIVE |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
| user_name | User name | scpuser |
2.3.1.76 - Show Auto-Scaling Group Policy
2.3.1.76.1 - 1.1
scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group 정책을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 정책 ID | 0761d76085f54363bab07909baf69841 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | 비교 연산자 | ge |
| cooldown_seconds | 쿨다운 시간(초 단위) | 300 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | 평가 시간(분 단위) | 1 |
| metric_method | 메트릭 방법 | AVG |
| metric_type | 메트릭 유형 | CPU |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 정책 이름 | policy-name |
| scale_method | 스케일 방법 | AMOUNT |
| scale_type | 스케일 유형 | SCALE_OUT |
| scale_value | 스켕일 값 | 10 |
| state | 정책 상태 | ACTIVE |
| threshold | 임계값 | 60 |
| threshold_unit | 임계값 단위 | % |
2.3.1.76.2 - 1.0
scpcli virtualserver auto scaling group policy show
--policy_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group 정책을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 정책 ID | 0761d76085f54363bab07909baf69841 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| auto_scaling_group_id | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator | 비교 연산자 | ge |
| cooldown_seconds | 쿨다운 시간(초 단위) | 300 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| evaluation_minutes | 평가 시간(분 단위) | 1 |
| metric_method | 메트릭 방법 | AVG |
| metric_type | 메트릭 유형 | CPU |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 정책 이름 | policy-name |
| scale_method | 스케일 방법 | AMOUNT |
| scale_type | 스케일 유형 | SCALE_OUT |
| scale_value | 스켕일 값 | 10 |
| state | 정책 상태 | ACTIVE |
| threshold | 임계값 | 60 |
| threshold_unit | 임계값 단위 | % |
2.3.1.77 - Show Auto-Scaling Group Schedule
2.3.1.77.1 - 1.1
scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| schedule_id required | string | 스케줄 ID | 43d4841abd404220af5f0904037aba71 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | 일 | -1,1 |
| day_of_week | 요일 | SU,SA |
| description | 설명 | description |
| desired_server_count | 목표 서버 수 | 1 |
| end_date | 종료 날짜 | 2025-01-01 |
| frequency | 빈도 | WEEKLY |
| hour | 시간 | 9 |
| max_server_count | 최대 서버 수 | 2 |
| min_server_count | 최소 서버 수 | 1 |
| minute | 분 | 0 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 스케쥴 이름 | schedulename |
| start_date | 시작 날짜 | 2024-01-01 |
| state | 스케쥴 상태 | ACTIVE |
| timezone | 시간대 | Asia/Seoul |
2.3.1.77.2 - 1.0
scpcli virtualserver auto scaling group schedule show
--schedule_id <value>
--auto_scaling_group_id <value>
Description
Auto-Scaling Group을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| schedule_id required | string | 스케줄 ID | 43d4841abd404220af5f0904037aba71 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| day_of_month | 일 | -1,1 |
| day_of_week | 요일 | SU,SA |
| description | 설명 | description |
| desired_server_count | 목표 서버 수 | 1 |
| end_date | 종료 날짜 | 2025-01-01 |
| frequency | 빈도 | WEEKLY |
| hour | 시간 | 9 |
| max_server_count | 최대 서버 수 | 2 |
| min_server_count | 최소 서버 수 | 1 |
| minute | 분 | 0 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 스케쥴 이름 | schedulename |
| start_date | 시작 날짜 | 2024-01-01 |
| state | 스케쥴 상태 | ACTIVE |
| timezone | 시간대 | Asia/Seoul |
2.3.1.78 - Show default Volume type’s details
2.3.1.78.1 - 1.1
scpcli virtualserver volume type default show
Description
기본 볼륨 유형을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 유형 ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | 추가 스펙 | |
| name | 볼륨 유형명 | SSD |
2.3.1.78.2 - 1.0
scpcli virtualserver volume type default show
Description
기본 볼륨 유형을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 유형 ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | 추가 스펙 | |
| name | 볼륨 유형명 | SSD |
2.3.1.79 - Show Image
2.3.1.79.1 - 1.1
scpcli virtualserver image show
--image_id <value>
Description
이미지를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | 체크섬 | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | 컨테이너 형식 | bare |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| disk_format | 디스크 형식 | qcow2 |
| file | 파일 | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | 최소 디스크 | 100 |
| min_ram | 최소 RAM | 0 |
| name | 이미지 이름 | imagename |
| os_distro | OS 배포판 | alma |
| os_hash_algo | OS 해시 알고리즘 | sha512 |
| os_hash_value | OS 해시 값 | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS 숨김 여부 | False |
| owner | Owner account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | 소유 account 이름 | AccountName |
| owner_user_name | 소유자 이름 | user@samsung.com |
| protected | 보호 | False |
| root_device_name | 루트 디바이스 이름 | /dev/vda |
| scp_image_type | 이미지 타입 | custom |
| scp_k8s_version | K8S 버전 | v1.28.7 |
| scp_original_image_type | 원본 이미지 타입 | standard |
| scp_os_build_version | OS 빌드 버전 | 20250101 |
| scp_os_version | OS 버전 | 8.8 |
| size | 크기 | 2429747200 |
| status | 상태 | active |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
| url | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | 가상 크기 | 17179869184 |
| visibility | 가시성 | private |
| volumes | 볼륨 | [{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}] |
2.3.1.79.2 - 1.0
scpcli virtualserver image show
--image_id <value>
Description
이미지를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| checksum | 체크섬 | 7538e0fcb56e0e272cfd89eb384d6613 |
| container_format | 컨테이너 형식 | bare |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| disk_format | 디스크 형식 | qcow2 |
| file | 파일 | /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file |
| min_disk | 최소 디스크 | 100 |
| min_ram | 최소 RAM | 0 |
| name | 이미지 이름 | imagename |
| os_distro | OS 배포판 | alma |
| os_hash_algo | OS 해시 알고리즘 | sha512 |
| os_hash_value | OS 해시 값 | c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 |
| os_hidden | OS 숨김 여부 | False |
| owner | Owner account ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| owner_account_name | 소유 account 이름 | AccountName |
| owner_user_name | 소유자 이름 | user@samsung.com |
| protected | 보호 | False |
| root_device_name | 루트 디바이스 이름 | /dev/vda |
| scp_image_type | 이미지 타입 | custom |
| scp_k8s_version | K8S 버전 | v1.28.7 |
| scp_original_image_type | 원본 이미지 타입 | standard |
| scp_os_build_version | OS 빌드 버전 | 20250101 |
| scp_os_version | OS 버전 | 8.8 |
| size | 크기 | 2429747200 |
| status | 상태 | active |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
| url | 이미지 파일에 대한 Object Storage URL (qcow2 형식만 허용) | https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 |
| virtual_size | 가상 크기 | 17179869184 |
| visibility | 가시성 | private |
| volumes | 볼륨 | [{“tag”: null, “volume_id”: null, “encryption_options”: null, “encryption_secret_uuid”: null, “encryption_format”: null, “device_name”: “/dev/vda”, “disk_bus”: “virtio”, “volume_type”: null, “encrypted”: null, “image_id”: null, “device_type”: “disk”, “source_type”: “snapshot”, “delete_on_termination”: false, “volume_size”: 104, “guest_format”: null, “boot_index”: 0, “destination_type”: “volume”, “snapshot_id”: “abde9e38-2ed5-4ecd-b23c-b0120e30690e”, “no_device”: null}] |
2.3.1.80 - Show Image member
2.3.1.80.1 - 1.1
scpcli virtualserver image member show
--member_id <value>
--image_id <value>
Description
이미지 멤버를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| image_id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | 멤버 상태 | pending |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
2.3.1.80.2 - 1.0
scpcli virtualserver image member show
--member_id <value>
--image_id <value>
Description
이미지 멤버를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| image_id | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| member_id | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| status | 멤버 상태 | pending |
| updated_at | 수정일시 | 2025-07-26T12:00:00Z |
2.3.1.81 - Show Keypair
2.3.1.81.1 - 1.1
scpcli virtualserver keypair show
--keypair_name <value>
Description
키페어를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| keypair_name required | string | 키페어 이름 | keypairname |
Responses
| Name | Description | Example |
|---|---|---|
| id | 키페어 ID | 1 |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | 키페어 이름 | keypairname |
| public_key | Public Key | publickey |
| type | 키페어 유형 | ssh |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
2.3.1.81.2 - 1.0
scpcli virtualserver keypair show
--keypair_name <value>
Description
키페어를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| keypair_name required | string | 키페어 이름 | keypairname |
Responses
| Name | Description | Example |
|---|---|---|
| id | 키페어 ID | 1 |
| created_at | 생성일시 | 2025-07-22T09:00:00Z |
| fingerprint | Fingerprint | 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd |
| name | 키페어 이름 | keypairname |
| public_key | Public Key | publickey |
| type | 키페어 유형 | ssh |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
2.3.1.82 - Show Launch Configuration
2.3.1.82.1 - 1.1
scpcli virtualserver launch configuration show
--launch_configuration_id <value>
Description
Launch Configuration을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
Responses
| Name | Description | Example |
|---|---|---|
| boot_index | 부팅 장치를 시도하는 순서 | 0 |
| size | 볼륨 크기 | 104 |
| type | 볼륨 타입 | SSD |
2.3.1.82.2 - 1.0
scpcli virtualserver launch configuration show
--launch_configuration_id <value>
Description
Launch Configuration을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| launch_configuration_id required | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
Responses
| Name | Description | Example |
|---|---|---|
| boot_index | 부팅 장치를 시도하는 순서 | 0 |
| size | 볼륨 크기 | 104 |
| type | 볼륨 타입 | SSD |
2.3.1.83 - Show Server Group
2.3.1.83.1 - 1.1
scpcli virtualserver server group show
--server_group_id <value>
Description
서버 그룹을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_group_id required | string | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | 서버 그룹 멤버 | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | 서버 그룹 명 | server-group |
| partition_size | 파티션 사이즈 | 3 |
| policy | 서버 그룹 정책 | anti-affinity |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
2.3.1.83.2 - 1.0
scpcli virtualserver server group show
--server_group_id <value>
Description
서버 그룹을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_group_id required | string | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 그룹 ID | 616fb98f-46ca-475e-917e-2563e5a8cd19 |
| account_id | 계정 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| members | 서버 그룹 멤버 | [‘2a9be312-5d4b-4bc8-b2ae-35100fa9241f’] |
| name | 서버 그룹 명 | server-group |
| partition_size | 파티션 사이즈 | 3 |
| policy | 서버 그룹 정책 | anti-affinity |
| user_id | 사용자 ID | 570907805e5447be84b618450ef52o0t |
2.3.1.84 - Show Server Interface
2.3.1.84.1 - 1.1
scpcli virtualserver server interface show
--port_id <value>
--server_id <value>
Description
서버 인터페이스를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| fixed_ips | Fixed Ip list | |
| mac_addr | MAC 주소 | fa:16:3e:c0:71:2b |
| port_id | 포트 ID | f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc |
| port_state | Port State | ACTIVE |
| private_static_nat | Private Static NAT | |
| static_nat | Public Static NAT | |
| subnet_id | 서브넷 ID | 183c6c30df0c4fcbb16422aa2d64aa21 |
2.3.1.84.2 - 1.0
scpcli virtualserver server interface show
--port_id <value>
--server_id <value>
Description
서버 인터페이스를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| fixed_ips | Fixed Ip list | |
| mac_addr | MAC 주소 | fa:16:3e:c0:71:2b |
| port_id | 포트 ID | f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc |
| port_state | Port State | ACTIVE |
| private_static_nat | Private Static NAT | |
| static_nat | Public Static NAT | |
| subnet_id | 서브넷 ID | 183c6c30df0c4fcbb16422aa2d64aa21 |
2.3.1.85 - Show Server Ip
2.3.1.85.1 - 1.1
scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>
Description
서버 IP를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | 서브넷 ID | 78b2ee3f074145c580ab6abac4821f97 |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| ip_address | IP 주소 | 192.169.3.2 |
| version | IP 주소 버전 | 4 |
2.3.1.85.2 - 1.0
scpcli virtualserver server ip show
--subnet_id <value>
--server_id <value>
Description
서버 IP를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | 서브넷 ID | 78b2ee3f074145c580ab6abac4821f97 |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| ip_address | IP 주소 | 192.169.3.2 |
| version | IP 주소 버전 | 4 |
2.3.1.86 - Show Server Quota Set
2.3.1.86.1 - 1.1
scpcli virtualserver quota set show
Description
서버 쿼터 셋을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 쿼터 셋 ID | fc7283354c6143a58629b59f4c3e16b2 |
| cores | 코어 한도 | |
| instances | 인스턴스 한도 | |
| keypairs | 키페어 한도 | |
| metadata_items | 메타 데이터 항목 한도 | |
| ram | 램 한도 | |
| server_group_members | 서버 그룹 멤버 한도 | |
| server_groups | 서버 그룹 한도 |
2.3.1.86.2 - 1.0
scpcli virtualserver quota set show
Description
서버 쿼터 셋을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 쿼터 셋 ID | fc7283354c6143a58629b59f4c3e16b2 |
| cores | 코어 한도 | |
| instances | 인스턴스 한도 | |
| keypairs | 키페어 한도 | |
| metadata_items | 메타 데이터 항목 한도 | |
| ram | 램 한도 | |
| server_group_members | 서버 그룹 멤버 한도 | |
| server_groups | 서버 그룹 한도 |
2.3.1.87 - Show Server Type
2.3.1.87.1 - 1.1
scpcli virtualserver server type show
--server_type_id <value>
Description
서버 타입을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_type_id required | string | 서버 타입 ID | s1v1m2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 타입 ID | s1v1m2 |
| description | 설명 | description |
| disk | 루트 디스크 크기 | 100 |
| ephemeral | 임시 디스크 크기 | 0 |
| extra_specs | 추가 스펙 | |
| name | 서버 타입 이름 | s1v1m2 |
| ram | RAM 크기 | 2 |
| swap | 전용 스왑 디스크 크기 | 0 |
| vcpus | CPU 수 | 1 |
2.3.1.87.2 - 1.0
scpcli virtualserver server type show
--server_type_id <value>
Description
서버 타입을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_type_id required | string | 서버 타입 ID | s1v1m2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 타입 ID | s1v1m2 |
| description | 설명 | description |
| disk | 루트 디스크 크기 | 100 |
| ephemeral | 임시 디스크 크기 | 0 |
| extra_specs | 추가 스펙 | |
| name | 서버 타입 이름 | s1v1m2 |
| ram | RAM 크기 | 2 |
| swap | 전용 스왑 디스크 크기 | 0 |
| vcpus | CPU 수 | 1 |
2.3.1.88 - Show Server Volume
2.3.1.88.1 - 1.1
scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>
Description
서버 볼륨을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 연결 ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | 해지 시 삭제 | False |
| device | Device name | /dev/vda |
| server_id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.88.2 - 1.0
scpcli virtualserver server volume show
--volume_id <value>
--server_id <value>
Description
서버 볼륨을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 연결 ID | 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c |
| delete_on_termination | 해지 시 삭제 | False |
| device | Device name | /dev/vda |
| server_id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.89 - Show Virtual Server
2.3.1.89.1 - 1.1
scpcli virtualserver server show
--server_id <value>
Description
서버를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| ip_addresses | IP 주소 목록 | |
| subnet_name | 서브넷 이름 | subnetname |
2.3.1.89.2 - 1.0
scpcli virtualserver server show
--server_id <value>
Description
서버를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|---|---|
| ip_addresses | IP 주소 목록 | |
| subnet_name | 서브넷 이름 | subnetname |
2.3.1.90 - Show Virtual Server Console Log
2.3.1.90.1 - 1.1
scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]
Description
서버 콘솔 로그를 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| line_size optional | integer | Number of log lines to get | 1 |
Responses
| Name | Description | Example |
|---|---|---|
| output | Server console log output | FAKE CONSOLE OUTPUT |
2.3.1.90.2 - 1.0
scpcli virtualserver server console log show
--server_id <value>
[--line_size <value>]
Description
서버 콘솔 로그를 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| line_size optional | integer | Number of log lines to get | 1 |
Responses
| Name | Description | Example |
|---|---|---|
| output | Server console log output | FAKE CONSOLE OUTPUT |
2.3.1.91 - Show Virtual Server Password
2.3.1.91.1 - 1.1
scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]
Description
서버 비밀번호를 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| private_key optional | string | 비밀 키 | privatekey |
Responses
| Name | Description | Example |
|---|---|---|
| password | Server password | password |
2.3.1.91.2 - 1.0
scpcli virtualserver server password show
--server_id <value>
[--private_key <value>]
Description
서버 비밀번호를 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| private_key optional | string | 비밀 키 | privatekey |
Responses
| Name | Description | Example |
|---|---|---|
| password | Server password | password |
2.3.1.92 - Show Volume Quota Set
2.3.1.92.1 - 1.1
scpcli virtualserver volume quota set show
Description
볼륨 쿼터 셋을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 쿼터 셋 ID | fc7283354c6143a58629b59f4c3e16b2 |
| per_volume_size | 볼륨 별 크기 한도 | |
| snapshots | Snapshot Quota | |
| usages | 사용량 한도 | |
| volumes | Volume Quota |
2.3.1.92.2 - 1.0
scpcli virtualserver volume quota set show
Description
볼륨 쿼터 셋을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 쿼터 셋 ID | fc7283354c6143a58629b59f4c3e16b2 |
| per_volume_size | 볼륨 별 크기 한도 | |
| snapshots | Snapshot Quota | |
| usages | 사용량 한도 | |
| volumes | Volume Quota |
2.3.1.93 - Show volume transfer detail
2.3.1.93.1 - 1.1
scpcli virtualserver volume transfer show
--transfer_id <value>
Description
Show volume transfer detail.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| created_at | 생성일시 | |
| name | 볼륨명 | volume01 |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.93.2 - 1.0
scpcli virtualserver volume transfer show
--transfer_id <value>
Description
Show volume transfer detail.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transfer_id required | string | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transfer ID | 1ac231be-823b-4a4d-8ff0-aac503a7118a |
| created_at | 생성일시 | |
| name | 볼륨명 | volume01 |
| volume_id | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
2.3.1.94 - Show Volume type’s details
2.3.1.94.1 - 1.1
scpcli virtualserver volume type show
--volume_type_id <value>
Description
볼륨 유형을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_type_id required | string | 볼륨 유형 ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 유형 ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | 추가 스펙 | |
| name | 볼륨 유형명 | SSD |
2.3.1.94.2 - 1.0
scpcli virtualserver volume type show
--volume_type_id <value>
Description
볼륨 유형을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_type_id required | string | 볼륨 유형 ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 유형 ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
| description | Volume type description | Volume type description |
| extra_specs | 추가 스펙 | |
| name | 볼륨 유형명 | SSD |
2.3.1.95 - Show Volume's details
2.3.1.95.1 - 1.1
scpcli virtualserver volume show
--volume_id <value>
Description
볼륨을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| attached_at | The time when the volume was attached to the server. | |
| device | Device name | /dev/vda |
2.3.1.95.2 - 1.0
scpcli virtualserver volume show
--volume_id <value>
Description
볼륨을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| attached_at | The time when the volume was attached to the server. | |
| device | Device name | /dev/vda |
2.3.1.96 - Start Virtual Server
2.3.1.96.1 - 1.1
scpcli virtualserver server start
--server_id <value>
Description
서버를 시작한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.96.2 - 1.0
scpcli virtualserver server start
--server_id <value>
Description
서버를 시작한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.97 - Stop Virtual Server
2.3.1.97.1 - 1.1
scpcli virtualserver server stop
--server_id <value>
Description
서버를 중지한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.97.2 - 1.0
scpcli virtualserver server stop
--server_id <value>
Description
서버를 중지한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.98 - Unlock Virtual Server
2.3.1.98.1 - 1.1
scpcli virtualserver server unlock
--server_id <value>
Description
서버 Lock을 푼다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.98.2 - 1.0
scpcli virtualserver server unlock
--server_id <value>
Description
서버 Lock을 푼다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
Responses
| Name | Description | Example |
|---|
2.3.1.99 - Update a snapshot
2.3.1.99.1 - 1.1
scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]
Description
Update a snapshot.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| name required | string | 스냅샷명 | snapshot-1 |
| description optional | string | 설명 | description |
2.3.1.99.2 - 1.0
scpcli virtualserver volume snapshot set
--snapshot_id <value>
--name <value>
[--description <value>]
Description
Update a snapshot.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| name required | string | 스냅샷명 | snapshot-1 |
| description optional | string | 설명 | description |
2.3.1.100 - Update Auto-Scaling Group
2.3.1.100.1 - 1.1
scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]
Description
Auto-Scaling Group을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| desired_server_count_editable optional | boolean | 목표 서버 수 수정 가능 여부 | True |
| drain_enabled optional | boolean | Drain 사용 여부 | True |
| drain_timeout optional | integer | Drain timeout 값 | 300 |
| launch_configuration_id optional | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
| security_group_ids optional | array | Security Group ID 목록 | [ |
2.3.1.100.2 - 1.0
scpcli virtualserver auto scaling group set
--auto_scaling_group_id <value>
[--desired_server_count_editable <value>]
[--drain_enabled <value>]
[--drain_timeout <value>]
[--launch_configuration_id <value>]
[--security_group_ids <value>]
Description
Auto-Scaling Group을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| desired_server_count_editable optional | boolean | 목표 서버 수 수정 가능 여부 | True |
| drain_enabled optional | boolean | Drain 사용 여부 | True |
| drain_timeout optional | integer | Drain timeout 값 | 300 |
| launch_configuration_id optional | string | Launch Configuration ID | b5aea5a675fc4f6b9e0fcd1288354c5f |
| security_group_ids optional | array | Security Group ID 목록 | [ |
2.3.1.101 - Update Auto-Scaling Group LB Server Groups
2.3.1.101.1 - 1.1
scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>
Description
Auto-Scaling Group LB 서버 그룹을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| lb_server_groups required | array | LB 서버 그룹 목록 | '{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}' |
2.3.1.101.2 - 1.0
scpcli virtualserver auto scaling group lb server group set
--auto_scaling_group_id <value>
--lb_server_groups <value>
Description
Auto-Scaling Group LB 서버 그룹을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| lb_server_groups required | array | LB 서버 그룹 목록 | '{"id": "d06e87d3-ca9a-461b-8e88-077a542a7335", "port": 8080}' |
2.3.1.102 - Update Auto-Scaling Group Notification
2.3.1.102.1 - 1.1
scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]
Description
Auto-Scaling Group 알림을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| notification_id required | string | 알림 ID | fa7fd191410744cd810a290c0b4d22b9 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| notification_events optional | array | Auto-Scaling Group 알림 이벤트 목록 | SCALE_OUT |
| notification_state optional | string | Auto-Scaling Group 알림 상태 | ACTIVE |
2.3.1.102.2 - 1.0
scpcli virtualserver auto scaling group notification update
--notification_id <value>
--auto_scaling_group_id <value>
[--notification_events <value>]
[--notification_state <value>]
Description
Auto-Scaling Group 알림을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| notification_id required | string | 알림 ID | fa7fd191410744cd810a290c0b4d22b9 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| notification_events optional | array | Auto-Scaling Group 알림 이벤트 목록 | SCALE_OUT |
| notification_state optional | string | Auto-Scaling Group 알림 상태 | ACTIVE |
2.3.1.103 - Update Auto-Scaling Group Policy
2.3.1.103.1 - 1.1
scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--name <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]
Description
Auto-Scaling Group 정책을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 정책 ID | 0761d76085f54363bab07909baf69841 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator optional | string | 비교 연산자 | ge |
| cooldown_seconds optional | integer | 쿨다운 시간(초 단위) | 300 |
| evaluation_minutes optional | integer | 평가 시간(분 단위) | 1 |
| metric_method optional | string | 메트릭 방법 | AVG |
| metric_type optional | string | 메트릭 유형 | CPU |
| name optional | string | 정책 이름 | policy-name |
| scale_method optional | string | 스케일 방법 | AMOUNT |
| scale_type optional | string | 스케일 유형 | SCALE_OUT |
| scale_value optional | integer | 스켕일 값 | 10 |
| state optional | string | 정책 상태 | ACTIVE |
| threshold optional | integer | 임계값 | 60 |
2.3.1.103.2 - 1.0
scpcli virtualserver auto scaling group policy set
--policy_id <value>
--auto_scaling_group_id <value>
[--comparison_operator <value>]
[--cooldown_seconds <value>]
[--evaluation_minutes <value>]
[--metric_method <value>]
[--metric_type <value>]
[--name <value>]
[--scale_method <value>]
[--scale_type <value>]
[--scale_value <value>]
[--state <value>]
[--threshold <value>]
Description
Auto-Scaling Group 정책을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 정책 ID | 0761d76085f54363bab07909baf69841 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| comparison_operator optional | string | 비교 연산자 | ge |
| cooldown_seconds optional | integer | 쿨다운 시간(초 단위) | 300 |
| evaluation_minutes optional | integer | 평가 시간(분 단위) | 1 |
| metric_method optional | string | 메트릭 방법 | AVG |
| metric_type optional | string | 메트릭 유형 | CPU |
| name optional | string | 정책 이름 | policy-name |
| scale_method optional | string | 스케일 방법 | AMOUNT |
| scale_type optional | string | 스케일 유형 | SCALE_OUT |
| scale_value optional | integer | 스켕일 값 | 10 |
| state optional | string | 정책 상태 | ACTIVE |
| threshold optional | integer | 임계값 | 60 |
2.3.1.104 - Update Auto-Scaling Group Schedule
2.3.1.104.1 - 1.1
scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]
Description
Auto-Scaling Group 스케줄을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| schedule_id required | string | 스케줄 ID | 43d4841abd404220af5f0904037aba71 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| day_of_month optional | string | 일 | -1,1 |
| day_of_week optional | string | 요일 | SU,SA |
| description optional | string | 설명 | description |
| desired_server_count optional | integer | 목표 서버 수 | 1 |
| end_date optional | string | 종료 날짜 | 2025-01-01 |
| frequency optional | **** | 빈도 | WEEKLY |
| hour optional | integer | 시간 | 9 |
| max_server_count optional | integer | 최대 서버 수 | 2 |
| min_server_count optional | integer | 최소 서버 수 | 1 |
| minute optional | integer | 분 | 0 |
| name optional | string | 스케쥴 이름 | schedulename |
| start_date optional | string | 시작 날짜 | 2024-01-01 |
| state optional | string | 스케쥴 상태 | ACTIVE |
| timezone optional | string | 시간대 | Asia/Seoul |
2.3.1.104.2 - 1.0
scpcli virtualserver auto scaling group schedule set
--schedule_id <value>
--auto_scaling_group_id <value>
[--day_of_month <value>]
[--day_of_week <value>]
[--description <value>]
[--desired_server_count <value>]
[--end_date <value>]
[--frequency <value>]
[--hour <value>]
[--max_server_count <value>]
[--min_server_count <value>]
[--minute <value>]
[--name <value>]
[--start_date <value>]
[--state <value>]
[--timezone <value>]
Description
Auto-Scaling Group 스케줄을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| schedule_id required | string | 스케줄 ID | 43d4841abd404220af5f0904037aba71 |
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| day_of_month optional | string | 일 | -1,1 |
| day_of_week optional | string | 요일 | SU,SA |
| description optional | string | 설명 | description |
| desired_server_count optional | integer | 목표 서버 수 | 1 |
| end_date optional | string | 종료 날짜 | 2025-01-01 |
| frequency optional | **** | 빈도 | WEEKLY |
| hour optional | integer | 시간 | 9 |
| max_server_count optional | integer | 최대 서버 수 | 2 |
| min_server_count optional | integer | 최소 서버 수 | 1 |
| minute optional | integer | 분 | 0 |
| name optional | string | 스케쥴 이름 | schedulename |
| start_date optional | string | 시작 날짜 | 2024-01-01 |
| state optional | string | 스케쥴 상태 | ACTIVE |
| timezone optional | string | 시간대 | Asia/Seoul |
2.3.1.105 - Update Auto-Scaling Group server count
2.3.1.105.1 - 1.1
scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]
Description
Auto-Scaling Group 서버 수를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| desired_server_count optional | integer | 목표 서버 수 | 1 |
| max_server_count optional | integer | 최대 서버 수 | 2 |
| min_server_count optional | integer | 최소 서버 수 | 1 |
2.3.1.105.2 - 1.0
scpcli virtualserver auto scaling group server count set
--auto_scaling_group_id <value>
[--desired_server_count <value>]
[--max_server_count <value>]
[--min_server_count <value>]
Description
Auto-Scaling Group 서버 수를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auto_scaling_group_id required | string | Auto-Scaling Group ID | 52613bd852b04b39adcb15a8364d856d |
| desired_server_count optional | integer | 목표 서버 수 | 1 |
| max_server_count optional | integer | 최대 서버 수 | 2 |
| min_server_count optional | integer | 최소 서버 수 | 1 |
2.3.1.106 - Update Image
2.3.1.106.1 - 1.1
scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]
Description
이미지를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| min_disk optional | integer | 최소 디스크 | 100 |
| min_ram optional | integer | 최소 RAM | 0 |
| protected optional | boolean | 보호 | False |
| visibility optional | string | 가시성 | private |
2.3.1.106.2 - 1.0
scpcli virtualserver image set
--image_id <value>
[--min_disk <value>]
[--min_ram <value>]
[--protected <value>]
[--visibility <value>]
Description
이미지를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| min_disk optional | integer | 최소 디스크 | 100 |
| min_ram optional | integer | 최소 RAM | 0 |
| protected optional | boolean | 보호 | False |
| visibility optional | string | 가시성 | private |
2.3.1.107 - Update Image member
2.3.1.107.1 - 1.1
scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>
Description
이미지 멤버를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| status required | string | 멤버 상태 | pending |
2.3.1.107.2 - 1.0
scpcli virtualserver image member set
--member_id <value>
--image_id <value>
--status <value>
Description
이미지 멤버를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | 멤버 ID | a8f10467abfc4b87b64614ab36eb9ae4 |
| image_id required | string | 이미지 ID | 70a599e0-31e7-49b7-b260-868f441e862b |
| status required | string | 멤버 상태 | pending |
2.3.1.108 - Update Server Interface
2.3.1.108.1 - 1.1
scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]
Description
서버 인터페이스를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| fixed_ip_address optional | string | IP 주소 | 192.169.3.2 |
| subnet_id optional | string | 서브넷 ID | - |
2.3.1.108.2 - 1.0
scpcli virtualserver server interface set
--port_id <value>
--server_id <value>
[--fixed_ip_address <value>]
[--subnet_id <value>]
Description
서버 인터페이스를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | 포트 ID | 91424c08-0b26-49fb-9808-ed042292ceef |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| fixed_ip_address optional | string | IP 주소 | 192.169.3.2 |
| subnet_id optional | string | 서브넷 ID | - |
2.3.1.109 - Update Server Volume
2.3.1.109.1 - 1.1
scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
Description
서버 볼륨을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| delete_on_termination optional | boolean | 해지 시 삭제 | False |
2.3.1.109.2 - 1.0
scpcli virtualserver server volume set
--volume_id <value>
--server_id <value>
--volume_id <value>
[--delete_on_termination <value>]
Description
서버 볼륨을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| delete_on_termination optional | boolean | 해지 시 삭제 | False |
2.3.1.110 - Update Virtual Server
2.3.1.110.1 - 1.1
scpcli virtualserver server set
--server_id <value>
--name <value>
Description
서버를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| name required | string | 서버 이름 | servername |
2.3.1.110.2 - 1.0
scpcli virtualserver server set
--server_id <value>
--name <value>
Description
서버를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| name required | string | 서버 이름 | servername |
2.3.1.111 - Update Virtual Server type
2.3.1.111.1 - 1.1
scpcli virtualserver server type set
--server_id <value>
--server_type <value>
Description
서버 타입을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| server_type required | string | 서버 타입 | s1v1m2 |
Responses
| Name | Description | Example |
|---|
2.3.1.111.2 - 1.0
scpcli virtualserver server type set
--server_id <value>
--server_type <value>
Description
서버 타입을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_id required | string | 서버 ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| server_type required | string | 서버 타입 | s1v1m2 |
Responses
| Name | Description | Example |
|---|
2.3.1.112 - Update Volume
2.3.1.112.1 - 1.1
scpcli virtualserver volume set
--volume_id <value>
[--name <value>]
Description
볼륨을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| name optional | string | 볼륨명 | volume01 |
2.3.1.112.2 - 1.0
scpcli virtualserver volume set
--volume_id <value>
[--name <value>]
Description
볼륨을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| name optional | string | 볼륨명 | volume01 |
3 - Storage
3.1 - Archive Storage
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Archive Storage 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
3.1.1 - CLIs
3.1.1.1 - CancelArchiving
3.1.1.1.1 - 1.1
scpcli archivestorage archiving history cancel
--bucket_id <value>
--id <value>
Description
아카이빙을 취소한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 3d036efe-f576-48b0-8375-6d3704a95b63 |
| id required | string | 아카이빙 이력 아이디 | EXE-8f35b491-a060-453b-b825-e78440ca46de |
3.1.1.1.2 - 1.0
scpcli archivestorage archiving history cancel
--bucket_id <value>
--id <value>
Description
아카이빙을 취소한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 3d036efe-f576-48b0-8375-6d3704a95b63 |
| id required | string | 아카이빙 이력 아이디 | EXE-8f35b491-a060-453b-b825-e78440ca46de |
3.1.1.2 - CancelRecovery
3.1.1.2.1 - 1.1
scpcli archivestorage recovery history cancel
--bucket_id <value>
--id <value>
Description
복구를 취소한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 7d8d8c2b-d02a-421e-a6e3-5b981bfb507f |
| id required | string | 복구 이력 아이디 | EXE-9df439a5-9e6d-46a4-806e-1e9991520763 |
3.1.1.2.2 - 1.0
scpcli archivestorage recovery history cancel
--bucket_id <value>
--id <value>
Description
복구를 취소한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 7d8d8c2b-d02a-421e-a6e3-5b981bfb507f |
| id required | string | 복구 이력 아이디 | EXE-9df439a5-9e6d-46a4-806e-1e9991520763 |
3.1.1.3 - CreateArchivingPolicy
3.1.1.3.1 - 1.1
scpcli archivestorage archiving policy create
--bucket_id <value>
--object_path <value>
--object_lifecycle <value>
--archiving_source_bucket_name <value>
Description
아카이빙 정책을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| object_path required | string | 오브젝트 경로 | / |
| object_lifecycle required | string | Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 | 1 |
| archiving_source_bucket_name required | string | 아카이빙 소스 버킷 이름 | obs-bucket-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| bucket_id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| archiving_source | 아카이빙 소스 | |
| object_lifecycle | Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 | 1 |
| state | 아카이빙 정책 상태 | ACTIVE |
3.1.1.3.2 - 1.0
scpcli archivestorage archiving policy create
--bucket_id <value>
--object_path <value>
--object_lifecycle <value>
--archiving_source_bucket_name <value>
Description
아카이빙 정책을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| object_path required | string | 오브젝트 경로 | / |
| object_lifecycle required | string | Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 | 1 |
| archiving_source_bucket_name required | string | 아카이빙 소스 버킷 이름 | obs-bucket-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| bucket_id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| archiving_source | 아카이빙 소스 | |
| object_lifecycle | Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 | 1 |
| state | 아카이빙 정책 상태 | ACTIVE |
3.1.1.4 - CreateBucket
3.1.1.4.1 - 1.1
scpcli archivestorage bucket create
--name <value>
[--tags <value>]
Description
버킷을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 버킷 이름 | astest |
| tags optional | array | 태그 목록 | '{"key": "key", "value": "value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
3.1.1.4.2 - 1.0
scpcli archivestorage bucket create
--name <value>
[--tags <value>]
Description
버킷을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 버킷 이름 | astest |
| tags optional | array | 태그 목록 | '{"key": "key", "value": "value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
3.1.1.5 - DeleteBucket
3.1.1.5.1 - 1.1
scpcli archivestorage bucket delete
--bucket_id <value>
Description
버킷을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
3.1.1.5.2 - 1.0
scpcli archivestorage bucket delete
--bucket_id <value>
Description
버킷을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
3.1.1.6 - DeleteBucketObjects
3.1.1.6.1 - 1.1
scpcli archivestorage bucket object delete
--bucket_id <value>
--paths <value>
Description
버킷 오브젝트를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| paths required | array | 오브젝트 경로 목록 | test/ |
3.1.1.6.2 - 1.0
scpcli archivestorage bucket object delete
--bucket_id <value>
--paths <value>
Description
버킷 오브젝트를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| paths required | array | 오브젝트 경로 목록 | test/ |
3.1.1.7 - DeleteBucketObjectVersions
3.1.1.7.1 - 1.1
scpcli archivestorage bucket object version delete
--bucket_id <value>
--versions <value>
--path <value>
Description
버킷 오브젝트 버전을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| versions required | array | 오브젝트 버전 목록 | Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl |
| path required | string | 오브젝트 경로 | hello/my_file.txt |
3.1.1.8 - ListArchivingHistories
3.1.1.8.1 - 1.1
scpcli archivestorage archiving history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]
Description
아카이빙 이력 목록을 검색한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| start_at_to required | string | 시작일까지 | 2025-04-30T23:59:59+09:00 |
| start_at_from required | string | 시작일부터 | 2025-04-01T00:00:00+09:00 |
| bucket_id required | string | 버킷 아이디 | 3d036efe-f576-48b0-8375-6d3704a95b63 |
| state optional | string | 상태 | SUCCESS |
| limit optional | integer | 조회 개수 | 20 |
| offset optional | integer | 오프셋 | 0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 아카이빙 이력 아이디 | EXE-8f35b491-a060-453b-b825-e78440ca46de |
| archiving_id | 아카이빙 아이디 | SCH-02d48456-0f35-47e2-8056-b00e09366cac |
| state | 상태 | SUCCESS |
| archiving_policy_id | 아카이빙 정책 아이디 | SCH-02d48456-0f35-47e2-8056-b00e09366cac |
| start_at | 시작 일시 | 2025-04-01T00:00:00+09:00 |
| end_at | 종료 일시 | 2025-04-30T23:59:59+09:00 |
3.1.1.8.2 - 1.0
scpcli archivestorage archiving history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]
Description
아카이빙 이력 목록을 검색한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| start_at_to required | string | 시작일까지 | 2025-04-30T23:59:59+09:00 |
| start_at_from required | string | 시작일부터 | 2025-04-01T00:00:00+09:00 |
| bucket_id required | string | 버킷 아이디 | 3d036efe-f576-48b0-8375-6d3704a95b63 |
| state optional | string | 상태 | SUCCESS |
| limit optional | integer | 조회 개수 | 20 |
| offset optional | integer | 오프셋 | 0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 아카이빙 이력 아이디 | EXE-8f35b491-a060-453b-b825-e78440ca46de |
| archiving_id | 아카이빙 아이디 | SCH-02d48456-0f35-47e2-8056-b00e09366cac |
| state | 상태 | SUCCESS |
| archiving_policy_id | 아카이빙 정책 아이디 | SCH-02d48456-0f35-47e2-8056-b00e09366cac |
| start_at | 시작 일시 | 2025-04-01T00:00:00+09:00 |
| end_at | 종료 일시 | 2025-04-30T23:59:59+09:00 |
3.1.1.9 - ListArchivingPolicies
3.1.1.9.1 - 1.1
scpcli archivestorage archiving policy list
--bucket_id <value>
Description
아카이빙 정책 목록을 검색한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| object_lifecycle | Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 | 1 |
| object_path | 오브젝트 경로 | / |
| state | 아카이빙 정책 상태 | ACTIVE |
3.1.1.9.2 - 1.0
scpcli archivestorage archiving policy list
--bucket_id <value>
Description
아카이빙 정책 목록을 검색한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| object_lifecycle | Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 | 1 |
| object_path | 오브젝트 경로 | / |
| state | 아카이빙 정책 상태 | ACTIVE |
3.1.1.10 - ListBucketObjects
3.1.1.10.1 - 1.1
scpcli archivestorage bucket object list
--bucket_id <value>
[--marker <value>]
[--object_path <value>]
[--object_name <value>]
[--object_type <value>]
[--limit <value>]
Description
버킷 오브젝트 목록을 검색한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| marker optional | string | 마커 | TODO.txt |
| object_path optional | string | 오브젝트 경로 | / |
| object_name optional | string | 오브젝트 이름 | hello/TODO.txt |
| object_type optional | string | 오브젝트 타입 | FILE |
| limit optional | integer | 조회 개수 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| object_name | 오브젝트 이름 | hello/TODO.txt |
| object_type | 오브젝트 타입 | FILE |
| object_size | 오브젝트 크기 | 3581 |
| modified_at | 수정일 | 2025-04-09T05:54:46.244000+00:00 |
3.1.1.10.2 - 1.0
scpcli archivestorage bucket object list
--bucket_id <value>
[--marker <value>]
[--object_path <value>]
[--object_name <value>]
[--object_type <value>]
[--limit <value>]
Description
버킷 오브젝트 목록을 검색한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| marker optional | string | 마커 | TODO.txt |
| object_path optional | string | 오브젝트 경로 | / |
| object_name optional | string | 오브젝트 이름 | hello/TODO.txt |
| object_type optional | string | 오브젝트 타입 | FILE |
| limit optional | integer | 조회 개수 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| object_name | 오브젝트 이름 | hello/TODO.txt |
| object_type | 오브젝트 타입 | FILE |
| object_size | 오브젝트 크기 | 3581 |
| modified_at | 수정일 | 2025-04-09T05:54:46.244000+00:00 |
3.1.1.11 - ListBucketObjectVersions
3.1.1.11.1 - 1.1
scpcli archivestorage bucket object version list
--bucket_id <value>
--object_path <value>
[--offset <value>]
[--limit <value>]
Description
버킷 오브젝트 버전 목록을 검색한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| object_path required | string | 오브젝트 경로 | hello/my_file.txt |
| offset optional | integer | 오프셋 | 0 |
| limit optional | integer | 조회 개수 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| object_path | 오브젝트 경로 | hello/my_file.txt |
| object_version_id | 오브젝트 버전 아이디 | Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl |
| latest | 오브젝트의 최신버전 | True |
| modified_at | 수정일 | 2025-04-09T05:54:46.244000+00:00 |
| etag | ETag | 4f6094f1e0619a6504efcb5e69e63bec |
| size | 크기 | 20 |
3.1.1.12 - ListBuckets
3.1.1.12.1 - 1.1
scpcli archivestorage bucket list
[--name <value>]
[--limit <value>]
Description
버킷 목록을 검색한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | 버킷 이름 | astest |
| limit optional | integer | 조회 개수 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| name | 버킷 이름 | astest |
3.1.1.12.2 - 1.0
scpcli archivestorage bucket list
[--name <value>]
[--limit <value>]
Description
버킷 목록을 검색한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | 버킷 이름 | astest |
| limit optional | integer | 조회 개수 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| name | 버킷 이름 | astest |
3.1.1.13 - ListRecoveryHistories
3.1.1.13.1 - 1.1
scpcli archivestorage recovery history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]
Description
복구 이력 목록을 검색한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| start_at_to required | string | 시작일까지 | 2025-04-30T23:59:59+09:00 |
| start_at_from required | string | 시작일부터 | 2025-04-01T00:00:00+09:00 |
| bucket_id required | string | 버킷 아이디 | 7d8d8c2b-d02a-421e-a6e3-5b981bfb507f |
| state optional | string | 상태 | SUCCESS |
| limit optional | integer | 조회 개수 | 20 |
| offset optional | integer | 오프셋 | 0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 복구 이력 아이디 | EXE-9df439a5-9e6d-46a4-806e-1e9991520763 |
| recovery_id | 복구 아이디 | ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5 |
| state | 상태 | SUCCESS |
| recovery_target_bucket_name | 복구 대상 버킷 이름 | test-obs-bucket |
| start_at | 시작 일시 | 2025-04-01T00:00:00+09:00 |
| end_at | 종료 일시 | 2025-04-30T23:59:59+09:00 |
3.1.1.13.2 - 1.0
scpcli archivestorage recovery history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]
Description
복구 이력 목록을 검색한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| start_at_to required | string | 시작일까지 | 2025-04-30T23:59:59+09:00 |
| start_at_from required | string | 시작일부터 | 2025-04-01T00:00:00+09:00 |
| bucket_id required | string | 버킷 아이디 | 7d8d8c2b-d02a-421e-a6e3-5b981bfb507f |
| state optional | string | 상태 | SUCCESS |
| limit optional | integer | 조회 개수 | 20 |
| offset optional | integer | 오프셋 | 0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 복구 이력 아이디 | EXE-9df439a5-9e6d-46a4-806e-1e9991520763 |
| recovery_id | 복구 아이디 | ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5 |
| state | 상태 | SUCCESS |
| recovery_target_bucket_name | 복구 대상 버킷 이름 | test-obs-bucket |
| start_at | 시작 일시 | 2025-04-01T00:00:00+09:00 |
| end_at | 종료 일시 | 2025-04-30T23:59:59+09:00 |
3.1.1.14 - RecoverObjects
3.1.1.14.1 - 1.1
scpcli archivestorage bucket object recover
--bucket_id <value>
--overwrite <value>
--recovery_infos <value>
--recovery_target_bucket_name <value>
Description
오브젝트를 오브젝트 스토리지에 복구한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| overwrite required | boolean | 덮어쓰기 | True |
| recovery_infos required | array | 오브젝트 복구 정보 목록 | '{"source_object_path": "/", "object_type": "FILE"}' |
| recovery_target_bucket_name required | string | 복구 대상 버킷 이름 | obs-bucket-name |
3.1.1.14.2 - 1.0
scpcli archivestorage bucket object recover
--bucket_id <value>
--overwrite <value>
--recovery_infos <value>
--recovery_target_bucket_name <value>
Description
오브젝트를 오브젝트 스토리지에 복구한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| overwrite required | boolean | 덮어쓰기 | True |
| recovery_infos required | array | 오브젝트 복구 정보 목록 | '{"source_object_path": "/", "object_type": "FILE"}' |
| recovery_target_bucket_name required | string | 복구 대상 버킷 이름 | obs-bucket-name |
3.1.1.15 - RecoverObjectVersions
3.1.1.15.1 - 1.1
scpcli archivestorage bucket object recover versions
--bucket_id <value>
--overwrite <value>
--source_object_version <value>
--source_object_path <value>
--recovery_target_bucket_name <value>
Description
오브젝트 버전을 오브젝트 스토리지에 복구한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| overwrite required | boolean | 덮어쓰기 | True |
| source_object_version required | string | 복구 소스 오브젝트 버전 | Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl |
| source_object_path required | string | 복구 소스 오브젝트 경로 | / |
| recovery_target_bucket_name required | string | 복구 대상 버킷 이름 | obs-bucket-name |
3.1.1.16 - SetArchivingPolicy
3.1.1.16.1 - 1.1
scpcli archivestorage archiving policy set
--archiving_policy_id <value>
--bucket_id <value>
--object_lifecycle <value>
Description
아카이빙 정책을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| archiving_policy_id required | string | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| object_lifecycle required | string | Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 | 1 |
3.1.1.16.2 - 1.0
scpcli archivestorage archiving policy set
--archiving_policy_id <value>
--bucket_id <value>
--object_lifecycle <value>
Description
아카이빙 정책을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| archiving_policy_id required | string | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| object_lifecycle required | string | Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 | 1 |
3.1.1.17 - SetArchivingPolicyState
3.1.1.17.1 - 1.1
scpcli archivestorage archiving policy state set
--archiving_policy_id <value>
--bucket_id <value>
--state <value>
Description
아카이빙 정책 상태를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| archiving_policy_id required | string | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| state required | string | 아카이빙 정책 상태 | ACTIVE |
3.1.1.18 - SetBucketEncryption
3.1.1.18.1 - 1.1
scpcli archivestorage bucket encryption set
--bucket_id <value>
--enabled <value>
Description
버킷 암호화 정보를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| enabled required | boolean | 암호화 여부 | True |
3.1.1.18.2 - 1.0
scpcli archivestorage bucket encryption set
--bucket_id <value>
--enabled <value>
Description
버킷 암호화 정보를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| enabled required | boolean | 암호화 여부 | True |
3.1.1.19 - SetBucketVersioning
3.1.1.19.1 - 1.1
scpcli archivestorage bucket versioning set
--bucket_id <value>
--enabled <value>
Description
버킷 버저닝을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| enabled required | boolean | 버저닝 여부 | True |
3.1.1.20 - ShowArchivingHistory
3.1.1.20.1 - 1.1
scpcli archivestorage archiving history show
--bucket_id <value>
--id <value>
Description
아카이빙 이력을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 3d036efe-f576-48b0-8375-6d3704a95b63 |
| id required | string | 아카이빙 이력 아이디 | EXE-8f35b491-a060-453b-b825-e78440ca46de |
Responses
| Name | Description | Example |
|---|---|---|
| source_object_path | 소스 오브젝트 경로 | example_source_object_path/ |
| usage | 사용량 | 1024 |
| total_object_count | 총 오브젝트 개수 | 100 |
| archiving_object_count | 아카이빙 오브젝트 개수 | 50 |
| archiving_rate | 아카이빙 진행률 | 100 |
3.1.1.20.2 - 1.0
scpcli archivestorage archiving history show
--bucket_id <value>
--id <value>
Description
아카이빙 이력을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 3d036efe-f576-48b0-8375-6d3704a95b63 |
| id required | string | 아카이빙 이력 아이디 | EXE-8f35b491-a060-453b-b825-e78440ca46de |
Responses
| Name | Description | Example |
|---|---|---|
| source_object_path | 소스 오브젝트 경로 | example_source_object_path/ |
| usage | 사용량 | 1024 |
| total_object_count | 총 오브젝트 개수 | 100 |
| archiving_object_count | 아카이빙 오브젝트 개수 | 50 |
| archiving_rate | 아카이빙 진행률 | 100 |
3.1.1.21 - ShowArchivingPolicy
3.1.1.21.1 - 1.1
scpcli archivestorage archiving policy show
--archiving_policy_id <value>
--bucket_id <value>
Description
아카이빙 정책을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| archiving_policy_id required | string | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| bucket_id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| archiving_source | 아카이빙 소스 | |
| object_lifecycle | Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 | 1 |
| state | 아카이빙 정책 상태 | ACTIVE |
3.1.1.21.2 - 1.0
scpcli archivestorage archiving policy show
--archiving_policy_id <value>
--bucket_id <value>
Description
아카이빙 정책을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| archiving_policy_id required | string | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 아카이빙 정책 아이디 | SCH-XXXXXXX |
| bucket_id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| archiving_source | 아카이빙 소스 | |
| object_lifecycle | Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 | 1 |
| state | 아카이빙 정책 상태 | ACTIVE |
3.1.1.22 - ShowBucket
3.1.1.22.1 - 1.1
scpcli archivestorage bucket show
--bucket_id <value>
Description
버킷을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| name | 버킷 이름 | astest |
| state | 버킷 상태 | ACTIVE |
| usage | 버킷 사용량 | 10 |
| archiving_source_bucket_name | 아카이빙 소스 버킷 이름 | obstest |
3.1.1.22.2 - 1.0
scpcli archivestorage bucket show
--bucket_id <value>
Description
버킷을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| name | 버킷 이름 | astest |
| state | 버킷 상태 | ACTIVE |
| usage | 버킷 사용량 | 10 |
| archiving_source_bucket_name | 아카이빙 소스 버킷 이름 | obstest |
3.1.1.23 - ShowBucketEncryption
3.1.1.23.1 - 1.1
scpcli archivestorage bucket encryption show
--bucket_id <value>
Description
버킷 암호화 정보를 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| enabled | 암호화 여부 | True |
3.1.1.23.2 - 1.0
scpcli archivestorage bucket encryption show
--bucket_id <value>
Description
버킷 암호화 정보를 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| enabled | 암호화 여부 | True |
3.1.1.24 - ShowBucketVersioning
3.1.1.24.1 - 1.1
scpcli archivestorage bucket versioning show
--bucket_id <value>
Description
버킷 버저닝 정보를 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 버킷 아이디 | 138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 |
| enabled | 암호화 여부 | True |
3.1.1.25 - ShowRecoveryHistory
3.1.1.25.1 - 1.1
scpcli archivestorage recovery history show
--bucket_id <value>
--id <value>
Description
복구 이력을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 7d8d8c2b-d02a-421e-a6e3-5b981bfb507f |
| id required | string | 복구 이력 아이디 | EXE-9df439a5-9e6d-46a4-806e-1e9991520763 |
Responses
| Name | Description | Example |
|---|---|---|
| source_object_path | 소스 오브젝트 경로 | example_source_object_path/ |
| usage | 사용량 | 1024 |
| total_object_count | 총 오브젝트 개수 | 100 |
| recovery_object_count | 복구 오브젝트 개수 | 50 |
| recovery_rate | 복구 진행률 | 50 |
3.1.1.25.2 - 1.0
scpcli archivestorage recovery history show
--bucket_id <value>
--id <value>
Description
복구 이력을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| bucket_id required | string | 버킷 아이디 | 7d8d8c2b-d02a-421e-a6e3-5b981bfb507f |
| id required | string | 복구 이력 아이디 | EXE-9df439a5-9e6d-46a4-806e-1e9991520763 |
Responses
| Name | Description | Example |
|---|---|---|
| source_object_path | 소스 오브젝트 경로 | example_source_object_path/ |
| usage | 사용량 | 1024 |
| total_object_count | 총 오브젝트 개수 | 100 |
| recovery_object_count | 복구 오브젝트 개수 | 50 |
| recovery_rate | 복구 진행률 | 50 |
3.2 - Backup
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Backup 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260331 |
| 1.1 | CURRENT | - |
3.2.1 - CLIs
3.2.1.1 - Check Backup Master Connection State
3.2.1.1.1 - 1.1
scpcli backup backup agent connection state check
--backup_agent_id <value>
Description
백업 마스터 연결 상태 확인
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_agent_id required | string | Backup Agent ID | BACKUP_AGENT-abcd |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.1.2 - 1.0
scpcli backup backup agent connection state check
--backup_agent_id <value>
Description
백업 마스터 연결 상태 확인
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_agent_id required | string | Backup Agent ID | BACKUP_AGENT-abcd |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.2 - Check Backup Name Duplicate
3.2.1.2.1 - 1.1
scpcli backup backup name duplicate check
--backup_name <value>
Description
Backup명을 중복 체크한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_name required | string | Backup명 | backup-001 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
3.2.1.2.2 - 1.0
scpcli backup backup name duplicate check
--backup_name <value>
Description
Backup명을 중복 체크한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_name required | string | Backup명 | backup-001 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
3.2.1.3 - Check Backup Restore Server Name Duplicate
3.2.1.3.1 - 1.1
scpcli backup backup restore server name duplicate check
--restore_server_name <value>
Description
복구 서버명을 중복 체크한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| restore_server_name required | string | 복구 서버명 | restoretest1 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
3.2.1.3.2 - 1.0
scpcli backup backup restore server name duplicate check
--restore_server_name <value>
Description
복구 서버명을 중복 체크한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| restore_server_name required | string | 복구 서버명 | restoretest1 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
3.2.1.4 - Check Filesystem Path Duplication
3.2.1.4.1 - 1.1
scpcli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>
Description
Filesystem 경로 중복 체크
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_uuid required | string | Backup 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| filesystem_path required | string | 백업 대상 파일 시스템 경로 | /aaa |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
3.2.1.4.2 - 1.0
scpcli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>
Description
Filesystem 경로 중복 체크
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_uuid required | string | Backup 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| filesystem_path required | string | 백업 대상 파일 시스템 경로 | /aaa |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
3.2.1.5 - Create Backup
3.2.1.5.1 - 1.1
scpcli backup backup create
--server_uuid <value>
--server_category <value>
--schedules <value>
--policy_type <value>
--policy_category <value>
--name <value>
[--dr_enabled <value>]
[--encrypt_enabled <value>]
[--filesystem_paths <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]
Description
Backup을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_uuid required | string | Backup 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| server_category required | string | 대상 서버 카테고리 | ```VIRTUAL_SERVER |
| schedules required | array | 스케줄 목록 | '{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}' |
| policy_type required | string | Backup 정책 유형 | VM_IMAGE |
| policy_category required | string | Backup 정책 카테고리 | AGENTLESS |
| name required | string | Backup명 | backup-001 |
| dr_enabled optional | boolean | DR 사용 여부 | - |
| encrypt_enabled optional | boolean | 암호화 사용 여부 | True |
| filesystem_paths optional | array | 백업 대상 파일 시스템 경로 | /aaa |
| region optional | string | 위치 | kr-west1 |
| retention_period optional | string | Backup 보관 기간 | WEEK_2 |
| server_guid optional | string | Backup 서버 GUID | 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 |
| tags optional | array | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.5.2 - 1.0
scpcli backup backup create
--server_uuid <value>
--server_category <value>
--schedules <value>
--policy_type <value>
--policy_category <value>
--name <value>
[--encrypt_enabled <value>]
[--filesystem_paths <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]
Description
Backup을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_uuid required | string | Backup 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| server_category required | string | 대상 서버 카테고리 | ```VIRTUAL_SERVER |
| schedules required | array | 스케줄 목록 | '{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}' |
| policy_type required | string | Backup 정책 유형 | VM_IMAGE |
| policy_category required | string | Backup 정책 카테고리 | AGENTLESS |
| name required | string | Backup명 | backup-001 |
| encrypt_enabled optional | boolean | 암호화 사용 여부 | True |
| filesystem_paths optional | array | 백업 대상 파일 시스템 경로 | /aaa |
| region optional | string | 위치 | kr-west1 |
| retention_period optional | string | Backup 보관 기간 | WEEK_2 |
| server_guid optional | string | Backup 서버 GUID | 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 |
| tags optional | array | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.6 - Create Backup Agent
3.2.1.6.1 - 1.1
scpcli backup backup agent create
--server_uuid <value>
[--tags <value>]
Description
Backup Agent을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_uuid required | string | Backup Agent 대상 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| tags optional | array | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.6.2 - 1.0
scpcli backup backup agent create
--server_uuid <value>
[--tags <value>]
Description
Backup Agent을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_uuid required | string | Backup Agent 대상 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| tags optional | array | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.7 - Delete Backup
3.2.1.7.1 - 1.1
scpcli backup backup delete
--backup_id <value>
Description
Backup을 해지한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
3.2.1.7.2 - 1.0
scpcli backup backup delete
--backup_id <value>
Description
Backup을 해지한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
3.2.1.8 - Delete Backup Agent
3.2.1.8.1 - 1.1
scpcli backup backup agent delete
--backup_agent_id <value>
Description
Backup Agent를 해지한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_agent_id required | string | Backup Agent ID | BACKUP_AGENT-abcd |
3.2.1.8.2 - 1.0
scpcli backup backup agent delete
--backup_agent_id <value>
Description
Backup Agent를 해지한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_agent_id required | string | Backup Agent ID | BACKUP_AGENT-abcd |
3.2.1.9 - Delete Backup Restore Target
3.2.1.9.1 - 1.1
scpcli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>
Description
복구 대상을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| restore_target_ids required | array | 복구 대상 목록 | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
3.2.1.9.2 - 1.0
scpcli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>
Description
복구 대상을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| restore_target_ids required | array | 복구 대상 목록 | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
3.2.1.10 - List Agent Backup Restore Target Servers
3.2.1.10.1 - 1.1
scpcli backup agent backup restore target server list
--backup_id <value>
[--server_name <value>]
[--page <value>]
[--size <value>]
Description
복구 대상 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| server_name optional | string | Backup 서버명 | server-001 |
| page optional | integer | 페이지 | 0 |
| size optional | integer | 항목 수 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| server_name | Backup 서버명 | server-001 |
| server_os_version | 서버의 OS Type 과 버전 | UBUNTU 22.04 |
| server_uuid | Backup 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
3.2.1.10.2 - 1.0
scpcli backup agent backup restore target server list
--backup_id <value>
[--server_name <value>]
[--page <value>]
[--size <value>]
Description
복구 대상 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| server_name optional | string | Backup 서버명 | server-001 |
| page optional | integer | 페이지 | 0 |
| size optional | integer | 항목 수 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| server_name | Backup 서버명 | server-001 |
| server_os_version | 서버의 OS Type 과 버전 | UBUNTU 22.04 |
| server_uuid | Backup 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
3.2.1.11 - List Backup Agents
3.2.1.11.1 - 1.1
scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]
Description
Backup 대상 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Backup Agent명 | agent_abcd12 |
| server_backup_agent_ip optional | string | 대상 서버 Backup Agent IP | 11.22.33.44 |
| server_name optional | string | Backup Agent 대상 서버명 | server-001 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Backup Agent ID | BACKUP_AGENT-abcd |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| backup_policy_count | Backup 정책 수 | 3 |
| connection_state | Backup Agent 연결 상태 | SUCCESS |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup Agent명 | agent_abcd12 |
| server_backup_agent_ip | 대상 서버 Backup Agent IP | 11.22.33.44 |
| server_name | Backup 서버명 | server-001 |
| state | Backup Agent 상태 | AVAILABLE |
3.2.1.11.2 - 1.0
scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]
Description
Backup 대상 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
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 | Backup Agent명 | agent_abcd12 |
| server_backup_agent_ip optional | string | 대상 서버 Backup Agent IP | 11.22.33.44 |
| server_name optional | string | Backup Agent 대상 서버명 | server-001 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Backup Agent ID | BACKUP_AGENT-abcd |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| backup_policy_count | Backup 정책 수 | 3 |
| connection_state | Backup Agent 연결 상태 | SUCCESS |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup Agent명 | agent_abcd12 |
| server_backup_agent_ip | 대상 서버 Backup Agent IP | 11.22.33.44 |
| server_name | Backup 서버명 | server-001 |
| state | Backup Agent 상태 | AVAILABLE |
3.2.1.12 - List Backup Histories
3.2.1.12.1 - 1.1
scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
Backup 이력을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_start_time optional | string | 시작 일시 | 2024-09-30T15:00:00Z |
| backup_end_time optional | string | 검색 종료 일시 | 2024-10-31T14:59:59Z |
| backup_job_state optional | **** | Backup 이력 상태 | SUCCESS |
| page optional | integer | 페이지 | 0 |
| size optional | integer | 항목 수 | 20 |
| sort optional | string | 정렬 조건 | backup_start_time:desc |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_time | 검색 종료 일시 | 2024-10-31T14:59:59Z |
| backup_job_guid | Backup job GUID | 3b1da7ba-3f38-45cb-9538-e921826f80d7 |
| backup_job_state | Backup 이력 상태 | SUCCESS |
| backup_start_time | 시작 일시 | 2024-09-30T15:00:00Z |
| schedule_id | 스케줄 ID | f5b8e22b-0d88-4698-9996-fb44217c8227 |
| schedule_name | 스케줄명 | INCREMENTAL_DAILY_15:00:00-chg4By |
3.2.1.12.2 - 1.0
scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
Backup 이력을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_start_time optional | string | 시작 일시 | 2024-09-30T15:00:00Z |
| backup_end_time optional | string | 검색 종료 일시 | 2024-10-31T14:59:59Z |
| backup_job_state optional | **** | Backup 이력 상태 | SUCCESS |
| page optional | integer | 페이지 | 0 |
| size optional | integer | 항목 수 | 20 |
| sort optional | string | 정렬 조건 | backup_start_time:desc |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_time | 검색 종료 일시 | 2024-10-31T14:59:59Z |
| backup_job_guid | Backup job GUID | 3b1da7ba-3f38-45cb-9538-e921826f80d7 |
| backup_job_state | Backup 이력 상태 | SUCCESS |
| backup_start_time | 시작 일시 | 2024-09-30T15:00:00Z |
| schedule_id | 스케줄 ID | f5b8e22b-0d88-4698-9996-fb44217c8227 |
| schedule_name | 스케줄명 | INCREMENTAL_DAILY_15:00:00-chg4By |
3.2.1.13 - List Backup Region Relationship
3.2.1.13.1 - 1.1
scpcli backup backup region relationship list
[--from_region <value>]
[--from_availability_zone <value>]
[--to_region <value>]
[--to_availability_zone <value>]
[--backup_master_type <value>]
Description
List Backup Region Relationship.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| from_region optional | string | 위치 | kr-west1 |
| from_availability_zone optional | string | Availability Zone명 | kr-west1 |
| to_region optional | string | 위치 | kr-west1 |
| to_availability_zone optional | string | Availability Zone명 | kr-west1 |
| backup_master_type optional | **** | Backup Master 유형 | AGENTLESS |
Responses
| Name | Description | Example |
|---|---|---|
| from_availability_zone | Availability Zone명 | kr-west1 |
| from_region | 위치 | kr-west1 |
| to_availability_zone | Availability Zone명 | kr-west1 |
| to_region | 위치 | kr-west1 |
3.2.1.13.2 - 1.0
scpcli backup backup region relationship list
[--from_region <value>]
[--from_availability_zone <value>]
[--to_region <value>]
[--to_availability_zone <value>]
Description
List Backup Region Relationship.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| from_region optional | string | 위치 | kr-west1 |
| from_availability_zone optional | string | Availability Zone명 | kr-west1 |
| to_region optional | string | 위치 | kr-west1 |
| to_availability_zone optional | string | Availability Zone명 | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| from_availability_zone | Availability Zone명 | kr-west1 |
| from_region | 위치 | kr-west1 |
| to_availability_zone | Availability Zone명 | kr-west1 |
| to_region | 위치 | kr-west1 |
3.2.1.14 - List Backup Restore Histories
3.2.1.14.1 - 1.1
scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]
Description
복구 이력을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| page optional | integer | 페이지 | 0 |
| size optional | integer | 항목 수 | 20 |
| sort optional | string | 정렬 조건 | backup_start_time:desc |
| restore_state optional | **** | 복구 상태 | COMPLETED |
| start_time optional | string | 시작 일시 | 2024-09-30T15:00:00Z |
| end_time optional | string | 검색 종료 일시 | 2024-10-31T14:59:59Z |
Responses
| Name | Description | Example |
|---|---|---|
| backup_id | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_start_time | Backup 일시 | 2024-10-28T05:38:48 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| restore_end_time | 복구 완료 일시 | 2024-10-28T05:52:47 |
| restore_server_id | 복구 서버 ID | 26895cb7-2059-49e7-b6fe-9c9c4b0d3db0 |
| restore_server_name | 복구 서버명 | restoretest1 |
| restore_start_time | 복구 시작 일시 | 2024-10-28T05:52:47 |
| restore_state | 복구 상태 | COMPLETED |
| schedule_name | 스케줄명 | INCREMENTAL_DAILY_15:00:00-chg4By |
3.2.1.14.2 - 1.0
scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]
Description
복구 이력을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| page optional | integer | 페이지 | 0 |
| size optional | integer | 항목 수 | 20 |
| sort optional | string | 정렬 조건 | backup_start_time:desc |
| restore_state optional | **** | 복구 상태 | COMPLETED |
| start_time optional | string | 시작 일시 | 2024-09-30T15:00:00Z |
| end_time optional | string | 검색 종료 일시 | 2024-10-31T14:59:59Z |
Responses
| Name | Description | Example |
|---|---|---|
| backup_id | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_start_time | Backup 일시 | 2024-10-28T05:38:48 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| restore_end_time | 복구 완료 일시 | 2024-10-28T05:52:47 |
| restore_server_id | 복구 서버 ID | 26895cb7-2059-49e7-b6fe-9c9c4b0d3db0 |
| restore_server_name | 복구 서버명 | restoretest1 |
| restore_start_time | 복구 시작 일시 | 2024-10-28T05:52:47 |
| restore_state | 복구 상태 | COMPLETED |
| schedule_name | 스케줄명 | INCREMENTAL_DAILY_15:00:00-chg4By |
3.2.1.15 - List Backup Restore Subnets
3.2.1.15.1 - 1.1
scpcli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]
Description
원본 서버와 다른 위치에 복구하기 위해 서브넷 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| region required | string | 서버를 복구할 리전 | kr-west1 |
| vpc_id optional | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| state optional | string | Subnet 상태 | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서브넷 ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| gateway_ip_address | Gateway IP | 192.167.1.1 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet명 | subnetName |
| state | Subnet 상태 | ACTIVE |
| type | Subnet 유형 | GENERAL |
| vpc_id | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC명 | vpcName |
3.2.1.15.2 - 1.0
scpcli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]
Description
원본 서버와 다른 위치에 복구하기 위해 서브넷 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| region required | string | 서버를 복구할 리전 | kr-west1 |
| vpc_id optional | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| state optional | string | Subnet 상태 | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서브넷 ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| gateway_ip_address | Gateway IP | 192.167.1.1 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet명 | subnetName |
| state | Subnet 상태 | ACTIVE |
| type | Subnet 유형 | GENERAL |
| vpc_id | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC명 | vpcName |
3.2.1.16 - List Backup Restore Targets
3.2.1.16.1 - 1.1
scpcli backup backup restore target list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
복구 대상 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_start_time optional | string | 시작 일시 | 2024-09-30T15:00:00Z |
| backup_end_time optional | string | 검색 종료 일시 | 2024-10-31T14:59:59Z |
| page optional | integer | 페이지 | 0 |
| size optional | integer | 항목 수 | 20 |
| sort optional | string | 정렬 조건 | backup_start_time:desc |
Responses
| Name | Description | Example |
|---|---|---|
| backup_start_time | 시작 일시 | 2024-09-30T15:00:00Z |
| is_restore_available | 해당 백업 Image로 복구 가능 여부 | true |
| restore_target_id | 복구 대상 목록 | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
| retention_period | Backup 보관 기간 | WEEK_2 |
| schedule_id | 스케줄 ID | f5b8e22b-0d88-4698-9996-fb44217c8227 |
| schedule_name | 스케줄명 | INCREMENTAL_DAILY_15:00:00-chg4By |
| usage_gb | 백업 용량(GB) | 123.4 |
3.2.1.16.2 - 1.0
scpcli backup backup restore target list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
복구 대상 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_start_time optional | string | 시작 일시 | 2024-09-30T15:00:00Z |
| backup_end_time optional | string | 검색 종료 일시 | 2024-10-31T14:59:59Z |
| page optional | integer | 페이지 | 0 |
| size optional | integer | 항목 수 | 20 |
| sort optional | string | 정렬 조건 | backup_start_time:desc |
Responses
| Name | Description | Example |
|---|---|---|
| backup_start_time | 시작 일시 | 2024-09-30T15:00:00Z |
| is_restore_available | 해당 백업 Image로 복구 가능 여부 | true |
| restore_target_id | 복구 대상 목록 | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
| retention_period | Backup 보관 기간 | WEEK_2 |
| schedule_id | 스케줄 ID | f5b8e22b-0d88-4698-9996-fb44217c8227 |
| schedule_name | 스케줄명 | INCREMENTAL_DAILY_15:00:00-chg4By |
| usage_gb | 백업 용량(GB) | 123.4 |
3.2.1.17 - List Backup Schedules
3.2.1.17.1 - 1.1
scpcli backup backup schedule list
--backup_id <value>
Description
스케줄 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| backup_id | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| frequency | 스케줄 주기 유형 | DAILY |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 스케줄명 | INCREMENTAL_DAILY_15:00:00-chg4By |
| start_day | 스케줄 시작 요일 | MON |
| start_time | 스케줄 시작 시간 | 14:00:00 |
| start_week | 스케줄 시작 주 | WEEK_1 |
| state | Backup 스케줄 상태 | AVAILABLE |
| type | 스케줄 유형 | FULL |
3.2.1.17.2 - 1.0
scpcli backup backup schedule list
--backup_id <value>
Description
스케줄 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| backup_id | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| frequency | 스케줄 주기 유형 | DAILY |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 스케줄명 | INCREMENTAL_DAILY_15:00:00-chg4By |
| start_day | 스케줄 시작 요일 | MON |
| start_time | 스케줄 시작 시간 | 14:00:00 |
| start_week | 스케줄 시작 주 | WEEK_1 |
| state | Backup 스케줄 상태 | AVAILABLE |
| type | 스케줄 유형 | FULL |
3.2.1.18 - List Backup Targets
3.2.1.18.1 - 1.1
scpcli backup backup target list
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]
Description
Backup 대상 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_category required | **** | 대상 서버 카테고리 | ```VIRTUAL_SERVER |
| server_name optional | string | Backup 서버명 | server-001 |
| region optional | string | 위치 | kr-west1 |
| page optional | integer | 페이지 | 0 |
| size optional | integer | 항목 수 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| server_guid | Backup 서버 GUID | 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 |
| server_name | Backup 서버명 | server-001 |
| server_os_version | 서버의 OS Type 과 버전 | UBUNTU 22.04 |
| server_type | 백업 서버 타입 | s1v1m2 |
| server_uuid | Backup 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
3.2.1.18.2 - 1.0
scpcli backup backup target list
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]
Description
Backup 대상 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_category required | **** | 대상 서버 카테고리 | ```VIRTUAL_SERVER |
| server_name optional | string | Backup 서버명 | server-001 |
| region optional | string | 위치 | kr-west1 |
| page optional | integer | 페이지 | 0 |
| size optional | integer | 항목 수 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| server_guid | Backup 서버 GUID | 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 |
| server_name | Backup 서버명 | server-001 |
| server_os_version | 서버의 OS Type 과 버전 | UBUNTU 22.04 |
| server_type | 백업 서버 타입 | s1v1m2 |
| server_uuid | Backup 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
3.2.1.19 - List Backups
3.2.1.19.1 - 1.1
scpcli backup backup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_name <value>]
Description
Backup 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Backup명 | backup-001 |
| server_name optional | string | Backup 서버명 | server-001 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup명 | backup-001 |
| policy_type | Backup 정책 유형 | VM_IMAGE |
| retention_period | Backup 보관 기간 | WEEK_2 |
| role_type | 백업 역할 유형 | ORIGINAL |
| server_name | Backup 서버명 | server-001 |
| state | Backup 상태 | AVAILABLE |
3.2.1.19.2 - 1.0
scpcli backup backup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_name <value>]
Description
Backup 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
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 | Backup명 | backup-001 |
| server_name optional | string | Backup 서버명 | server-001 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup명 | backup-001 |
| policy_type | Backup 정책 유형 | VM_IMAGE |
| retention_period | Backup 보관 기간 | WEEK_2 |
| role_type | 백업 역할 유형 | ORIGINAL |
| server_name | Backup 서버명 | server-001 |
| state | Backup 상태 | AVAILABLE |
3.2.1.20 - List Targets of Backup Agent
3.2.1.20.1 - 1.1
scpcli backup backup agent target list
--server_category <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
Description
Backup Agent 대상 서버 목록
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_category required | string | 대상 서버 카테고리 | BAREMETAL_SERVER |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | 정렬 조건 | - |
| server_name optional | string | Backup 서버명 | server-001 |
Responses
| Name | Description | Example |
|---|---|---|
| server_backup_agent_ip | 대상 서버 Backup Agent IP | 11.22.33.44 |
| server_name | Backup Agent 대상 서버명 | server-001 |
| server_state | Backup 서버 상태 | RUNNING |
| server_uuid | Backup Agent 대상 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
3.2.1.20.2 - 1.0
scpcli backup backup agent target list
--server_category <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
Description
Backup Agent 대상 서버 목록
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_category required | string | 대상 서버 카테고리 | BAREMETAL_SERVER |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | 정렬 조건 | - |
| server_name optional | string | Backup 서버명 | server-001 |
Responses
| Name | Description | Example |
|---|---|---|
| server_backup_agent_ip | 대상 서버 Backup Agent IP | 11.22.33.44 |
| server_name | Backup Agent 대상 서버명 | server-001 |
| server_state | Backup 서버 상태 | RUNNING |
| server_uuid | Backup Agent 대상 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
3.2.1.21 - Manual Backup
3.2.1.21.1 - 1.1
scpcli backup backup manual backup create
--backup_id <value>
Description
즉시 Backup을 수행한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.21.2 - 1.0
scpcli backup backup manual backup create
--backup_id <value>
Description
즉시 Backup을 수행한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.22 - Restore Agent Backup
3.2.1.22.1 - 1.1
scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]
Description
백업을 복구한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| restore_target_id required | string | 복구 대상 목록 | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
| restore_server_uuid required | string | 복구 서버 ID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| filesystem_paths required | array | 백업 대상 파일 시스템 경로 | '{"destination": "/data", "source": "/data"}' |
| overwrite optional | boolean | 덮어쓰기 | True |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.22.2 - 1.0
scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]
Description
백업을 복구한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| restore_target_id required | string | 복구 대상 목록 | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
| restore_server_uuid required | string | 복구 서버 ID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| filesystem_paths required | array | 백업 대상 파일 시스템 경로 | '{"destination": "/data", "source": "/data"}' |
| overwrite optional | boolean | 덮어쓰기 | True |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.23 - Restore Backup
3.2.1.23.1 - 1.1
scpcli backup backup restore
--backup_id <value>
--server_type_id <value>
--restore_target_id <value>
--restore_server_name <value>
[--networks <value>]
[--restore_region <value>]
[--security_groups <value>]
Description
백업을 복구한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| server_type_id required | string | 서버 유형 ID | s1v1m2 |
| restore_target_id required | string | 복구 대상 목록 | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
| restore_server_name required | string | 복구 서버명 | restoretest1 |
| networks optional | array | 복구용 네트워크 정보 | '{"subnet_id": "023c57b14f11483689338d085e061492"}' |
| restore_region optional | string | 서버를 복구할 리전 | kr-west1 |
| security_groups optional | array | Security Group ID 목록 | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.23.2 - 1.0
scpcli backup backup restore
--backup_id <value>
--server_type_id <value>
--restore_target_id <value>
--restore_server_name <value>
[--networks <value>]
[--restore_region <value>]
[--security_groups <value>]
Description
백업을 복구한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| server_type_id required | string | 서버 유형 ID | s1v1m2 |
| restore_target_id required | string | 복구 대상 목록 | ca1a8e76-af49-40ea-93f8-a5989ffe138b |
| restore_server_name required | string | 복구 서버명 | restoretest1 |
| networks optional | array | 복구용 네트워크 정보 | '{"subnet_id": "023c57b14f11483689338d085e061492"}' |
| restore_region optional | string | 서버를 복구할 리전 | kr-west1 |
| security_groups optional | array | Security Group ID 목록 | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 ID | |
| resource | 자원 |
3.2.1.24 - Set Backup Schedule
3.2.1.24.1 - 1.1
scpcli backup backup schedule set
--backup_id <value>
--schedules <value>
Description
스케줄 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| schedules required | array | Backup 스케줄 목록 | '{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}' |
3.2.1.24.2 - 1.0
scpcli backup backup schedule set
--backup_id <value>
--schedules <value>
Description
스케줄 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| schedules required | array | Backup 스케줄 목록 | '{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}' |
3.2.1.25 - Set Filesystem Path
3.2.1.25.1 - 1.1
scpcli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>
Description
파일 시스템 경로 설정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_filesystem_paths required | array | 백업 대상 파일 시스템 경로 | /aaa |
3.2.1.25.2 - 1.0
scpcli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>
Description
파일 시스템 경로 설정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| backup_filesystem_paths required | array | 백업 대상 파일 시스템 경로 | /aaa |
3.2.1.26 - Show Backup
3.2.1.26.1 - 1.1
scpcli backup backup show
--backup_id <value>
Description
Backup을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| backup_agent_id | Backup Agent ID | BACKUP_AGENT-abcd |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| dr_enabled | DR 사용 여부 | |
| dr_region | DR Region | kr-west1 |
| encrypt_enabled | 암호화 사용 여부 | False |
| filesystem_paths | 백업 대상 파일 시스템 경로 | [’/aaa’, ‘/bbb’] |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup명 | backup-001 |
| origin_backup_id | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| policy_category | Backup 정책 카테고리 | AGENTLESS |
| policy_type | Backup 정책 유형 | VM_IMAGE |
| region | 위치 | kr-west1 |
| replica_backup_id | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| retention_period | Backup 보관 기간 | WEEK_2 |
| role_type | 백업 역할 유형 | ORIGINAL |
| server_category | 대상 서버 카테고리 | VIRTUAL_SERVER |
| server_name | Backup 서버명 | server-001 |
| server_os_type | 서버 OS Type | WINDOWS |
| server_region | 위치 | kr-west1 |
| server_uuid | Backup 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| state | Backup 상태 | AVAILABLE |
3.2.1.26.2 - 1.0
scpcli backup backup show
--backup_id <value>
Description
Backup을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| backup_agent_id | Backup Agent ID | BACKUP_AGENT-abcd |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| encrypt_enabled | 암호화 사용 여부 | False |
| filesystem_paths | 백업 대상 파일 시스템 경로 | [’/aaa’, ‘/bbb’] |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup명 | backup-001 |
| policy_category | Backup 정책 카테고리 | AGENTLESS |
| policy_type | Backup 정책 유형 | VM_IMAGE |
| region | 위치 | kr-west1 |
| retention_period | Backup 보관 기간 | WEEK_2 |
| role_type | 백업 역할 유형 | ORIGINAL |
| server_category | 대상 서버 카테고리 | VIRTUAL_SERVER |
| server_name | Backup 서버명 | server-001 |
| server_os_type | 서버 OS Type | WINDOWS |
| server_region | 위치 | kr-west1 |
| server_uuid | Backup 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| state | Backup 상태 | AVAILABLE |
3.2.1.27 - Show Backup Agent
3.2.1.27.1 - 1.1
scpcli backup backup agent show
--backup_agent_id <value>
Description
Backup Agent를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_agent_id required | string | Backup Agent ID | BACKUP_AGENT-abcd |
Responses
| Name | Description | Example |
|---|---|---|
| id | Backup Agent ID | BACKUP_AGENT-abcd |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| backup_master_ip | Backup Master IP | 33.44.55.66 |
| backup_master_name | Backup Master명 | backupmastertest |
| backup_policy_count | Backup 정책 수 | 3 |
| connection_check_time | Backup Agent 연결 확인 시간 | 2024-11-11T09:13:48Z |
| connection_state | Backup Agent 연결 상태 | SUCCESS |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| install_file_path | 설치 파일 경로 | http://linux-agent |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup Agent명 | agent_abcd12 |
| server_backup_agent_ip | 대상 서버 Backup Agent IP | 11.22.33.44 |
| server_category | 대상 서버 카테고리 | VIRTUAL_SERVER |
| server_gateway_ip | 서버 Gateway IP | 22.33.44.55 |
| server_name | Backup Agent 대상 서버명 | server-001 |
| server_os_type | 서버 OS Type | WINDOWS |
| server_uuid | Backup Agent 대상 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| state | Backup Agent 상태 | AVAILABLE |
3.2.1.27.2 - 1.0
scpcli backup backup agent show
--backup_agent_id <value>
Description
Backup Agent를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_agent_id required | string | Backup Agent ID | BACKUP_AGENT-abcd |
Responses
| Name | Description | Example |
|---|---|---|
| id | Backup Agent ID | BACKUP_AGENT-abcd |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| backup_master_ip | Backup Master IP | 33.44.55.66 |
| backup_master_name | Backup Master명 | backupmastertest |
| backup_policy_count | Backup 정책 수 | 3 |
| connection_check_time | Backup Agent 연결 확인 시간 | 2024-11-11T09:13:48Z |
| connection_state | Backup Agent 연결 상태 | SUCCESS |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| install_file_path | 설치 파일 경로 | http://linux-agent |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup Agent명 | agent_abcd12 |
| server_backup_agent_ip | 대상 서버 Backup Agent IP | 11.22.33.44 |
| server_category | 대상 서버 카테고리 | VIRTUAL_SERVER |
| server_gateway_ip | 서버 Gateway IP | 22.33.44.55 |
| server_name | Backup Agent 대상 서버명 | server-001 |
| server_os_type | 서버 OS Type | WINDOWS |
| server_uuid | Backup Agent 대상 서버 UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| state | Backup Agent 상태 | AVAILABLE |
3.2.1.28 - Show Backup Agent Install File Path
3.2.1.28.1 - 1.1
scpcli backup backup agent install file path show
--os_type <value>
Description
Backup Agent 설치 파일 경로 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| os_type required | string | OS 유형 | - |
Responses
| Name | Description | Example |
|---|---|---|
| install_file_path | 설치 파일 경로 | http://linux-agent |
3.2.1.28.2 - 1.0
scpcli backup backup agent install file path show
--os_type <value>
Description
Backup Agent 설치 파일 경로 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| os_type required | string | OS 유형 | - |
Responses
| Name | Description | Example |
|---|---|---|
| install_file_path | 설치 파일 경로 | http://linux-agent |
3.2.1.29 - Update Replication Use
3.2.1.29.1 - 1.1
scpcli backup backup replication use set
--backup_id <value>
--dr_enabled <value>
Description
복제 사용 여부를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| dr_enabled required | boolean | DR 사용 여부 | False |
3.2.1.29.2 - 1.0
scpcli backup backup replication use set
--backup_id <value>
--dr_enabled <value>
Description
복제 사용 여부를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| dr_enabled required | boolean | DR 사용 여부 | False |
3.2.1.30 - Update Retention Period
3.2.1.30.1 - 1.1
scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>
Description
보관 기간을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| retention_period required | string | Backup 보관 기간 | WEEK_2 |
3.2.1.30.2 - 1.0
scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>
Description
보관 기간을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| backup_id required | string | Backup ID | 00cd2538fbf94d12b36aabbdd607e974 |
| retention_period required | string | Backup 보관 기간 | WEEK_2 |
3.3 - Block Storage(BM)
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Block Storage(BM) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | DEPRECATED | 20260331 |
| 1.2 | CURRENT | - |
3.3.1 - CLIs
3.3.1.1 - Add Volume Group Member on Volume Group
3.3.1.1.1 - 1.2
scpcli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>
Description
볼륨 그룹에 볼륨 그룹 멤버를 추가한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
3.3.1.1.2 - 1.1
scpcli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>
Description
볼륨 그룹에 볼륨 그룹 멤버를 추가한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
3.3.1.1.3 - 1.0
scpcli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>
Description
볼륨 그룹에 볼륨 그룹 멤버를 추가한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
3.3.1.2 - Attach Volume
3.3.1.2.1 - 1.2
scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>
Description
서버에 볼륨을 연결한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| attachments required | array | 서버 id, 유형 목록 | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
Responses
| Name | Description | Example |
|---|---|---|
| object_id | Object id | 83c3c73d457345e3829ee6d5557c0016 |
| object_type | Object 유형 |
3.3.1.2.2 - 1.1
scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>
Description
서버에 볼륨을 연결한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| attachments required | array | 서버 id, 유형 목록 | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 상세 정보 |
3.3.1.2.3 - 1.0
scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>
Description
서버에 볼륨을 연결한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| attachments required | array | 서버 id, 유형 목록 | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 상세 정보 |
3.3.1.3 - Create Volume
3.3.1.3.1 - 1.2
scpcli baremetal-blockstorage volume create
--throughput <value>
--iops <value>
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]
Description
볼륨을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| throughput required | integer | Enter the value between at least 125MB/s and up to 1,000MB/s. | 125 |
| iops required | integer | Enter the value between at least 3,000 IOPS and up to 16,000 IOPS. | 3000 |
| size_gb required | integer | Volume capacity(GB) | 10 |
| name required | string | 볼륨명 | bs-01 |
| disk_type required | string | 디스크 유형 | - |
| attachments required | array | 서버 id, 유형 목록 | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
| tags optional | array | 태그 | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.3.2 - 1.1
scpcli baremetal-blockstorage volume create
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]
Description
볼륨을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size_gb required | integer | Volume capacity(GB) | 10 |
| name required | string | 볼륨명 | bs-01 |
| disk_type required | string | 디스크 유형 | - |
| attachments required | array | 서버 id, 유형 목록 | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
| tags optional | array | 태그 | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.3.3 - 1.0
scpcli baremetal-blockstorage volume create
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]
Description
볼륨을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size_gb required | integer | Volume capacity(GB) | 10 |
| name required | string | 볼륨명 | bs-01 |
| disk_type required | string | 디스크 유형 | - |
| attachments required | array | 서버 id, 유형 목록 | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
| tags optional | array | 태그 | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.4 - Create Volume Group
3.3.1.4.1 - 1.2
scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]
Description
볼륨 그룹을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_ids required | array | List of volume(Block Storage) id to add | 17e0b4fd27784dfb843440ec08bdd148 |
| name required | string | 볼륨 그룹명 | vg-01 |
| tags optional | array | 태그 | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.4.2 - 1.1
scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]
Description
볼륨 그룹을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_ids required | array | List of volume(Block Storage) id to add | 17e0b4fd27784dfb843440ec08bdd148 |
| name required | string | 볼륨 그룹명 | vg-01 |
| tags optional | array | 태그 | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.4.3 - 1.0
scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]
Description
볼륨 그룹을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_ids required | array | List of volume(Block Storage) id to add | 17e0b4fd27784dfb843440ec08bdd148 |
| name required | string | 볼륨 그룹명 | vg-01 |
| tags optional | array | 태그 | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.5 - Create Volume Group Recovery
3.3.1.5.1 - 1.2
scpcli baremetal-blockstorage volume-group recovery create
--volume_group_id <value>
--snapshot_id <value>
--block_storage_name_prefix <value>
Description
복구본 볼륨 그룹을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| block_storage_name_prefix required | string | Block Storage명 접두사 | prefix- |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.5.2 - 1.1
scpcli baremetal-blockstorage volume-group recovery create
--volume_group_id <value>
--snapshot_id <value>
--block_storage_name_prefix <value>
Description
복구본 볼륨 그룹을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| block_storage_name_prefix required | string | Block Storage명 접두사 | prefix- |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.6 - Create Volume Group Replication
3.3.1.6.1 - 1.2
scpcli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>
Description
복제본 볼륨 그룹을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| replication_volume_name_prefix required | string | 복제본 볼륨명 접두사 | dr |
| region required | string | 리전 | kr-west1 |
| name required | string | 복제본 볼륨 그룹명 | replica-vg-01 |
| cycle required | string | 복제 주기 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.6.2 - 1.1
scpcli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>
Description
복제본 볼륨 그룹을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| replication_volume_name_prefix required | string | 복제본 볼륨명 접두사 | dr |
| region required | string | 리전 | kr-west1 |
| name required | string | 복제본 볼륨 그룹명 | replica-vg-01 |
| cycle required | string | 복제 주기 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.6.3 - 1.0
scpcli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>
Description
복제본 볼륨 그룹을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| replication_volume_name_prefix required | string | 복제본 볼륨명 접두사 | dr |
| region required | string | 리전 | kr-west1 |
| name required | string | 복제본 볼륨 그룹명 | replica-vg-01 |
| cycle required | string | 복제 주기 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.7 - Create Volume Group Snapshot
3.3.1.7.1 - 1.2
scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>
Description
볼륨 그룹 스냅샷을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | 계정 id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_group_id | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.7.2 - 1.1
scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>
Description
볼륨 그룹 스냅샷을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | 계정 id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_group_id | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.7.3 - 1.0
scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>
Description
볼륨 그룹 스냅샷을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | 계정 id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_group_id | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.8 - Create Volume Group Snapshot Schedule
3.3.1.8.1 - 1.2
scpcli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 그룹 스냅샷 스케줄을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|---|---|
| day_of_week | 요일 | |
| frequency | 주기 DAILY | WEEKLY |
| hour | 시간 | 18 |
| volume_group_id | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.8.2 - 1.1
scpcli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 그룹 스냅샷 스케줄을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|---|---|
| day_of_week | 요일 | |
| frequency | 주기 DAILY | WEEKLY |
| hour | 시간 | 18 |
| volume_group_id | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.8.3 - 1.0
scpcli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 그룹 스냅샷 스케줄을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|---|---|
| day_of_week | 요일 | |
| frequency | 주기 DAILY | WEEKLY |
| hour | 시간 | 18 |
| volume_group_id | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.9 - Create Volume Recovery
3.3.1.9.1 - 1.2
scpcli baremetal-blockstorage volume recovery create
--volume_id <value>
--snapshot_id <value>
--name <value>
Description
복구본 볼륨을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| name required | string | 복구 볼륨명 | recovery-volume |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.9.2 - 1.1
scpcli baremetal-blockstorage volume recovery create
--volume_id <value>
--snapshot_id <value>
--name <value>
Description
복구본 볼륨을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| name required | string | 복구 볼륨명 | recovery-volume |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.10 - Create Volume Replication
3.3.1.10.1 - 1.2
scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>
Description
복제본 볼륨을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| region required | string | 리전 | kr-west1 |
| name required | string | 복제본 볼륨 목록 | replica-bs-01 |
| cycle required | string | 복제 주기 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.10.2 - 1.1
scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>
Description
복제본 볼륨을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| region required | string | 리전 | kr-west1 |
| name required | string | 복제본 볼륨 목록 | replica-bs-01 |
| cycle required | string | 복제 주기 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.10.3 - 1.0
scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>
Description
복제본 볼륨을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| region required | string | 리전 | kr-west1 |
| name required | string | 복제본 볼륨 목록 | replica-bs-01 |
| cycle required | string | 복제 주기 | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | 요청 id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | 자원 id | 8bf55e738d4e44b5a21dbe133a42ecbe |
3.3.1.11 - Create Volume Snapshot
3.3.1.11.1 - 1.2
scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>
Description
볼륨 스냅샷을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | 계정 id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_id | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.11.2 - 1.1
scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>
Description
볼륨 스냅샷을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | 계정 id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_id | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.11.3 - 1.0
scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>
Description
볼륨 스냅샷을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | 계정 id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_id | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.12 - Create Volume Snapshot Rate
3.3.1.12.1 - 1.2
scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>
Description
볼륨 스냅샷 용량을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| snapshot_rate required | integer | 스냅샷 용량 | 100 |
Responses
| Name | Description | Example |
|---|---|---|
| is_snapshot_activated | 스냅샷 활성화 여부 | True |
| snapshot_rate | 스냅샷 용량 | 100 |
| volume_id | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.12.2 - 1.1
scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>
Description
볼륨 스냅샷 용량을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| snapshot_rate required | integer | 스냅샷 용량 | 100 |
Responses
| Name | Description | Example |
|---|---|---|
| is_snapshot_activated | 스냅샷 활성화 여부 | True |
| snapshot_rate | 스냅샷 용량 | 100 |
| volume_id | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.12.3 - 1.0
scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>
Description
볼륨 스냅샷 용량을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| snapshot_rate required | integer | 스냅샷 용량 | 100 |
Responses
| Name | Description | Example |
|---|---|---|
| is_snapshot_activated | 스냅샷 활성화 여부 | True |
| snapshot_rate | 스냅샷 용량 | 100 |
| volume_id | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.13 - Create Volume Snapshot Schedule
3.3.1.13.1 - 1.2
scpcli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 스냅샷 스케줄을 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|---|---|
| day_of_week | 요일 | |
| frequency | 주기 DAILY | WEEKLY |
| hour | 시간 | 18 |
| volume_id | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.13.2 - 1.1
scpcli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 스냅샷 스케줄을 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|---|---|
| day_of_week | 요일 | |
| frequency | 주기 DAILY | WEEKLY |
| hour | 시간 | 18 |
| volume_id | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.13.3 - 1.0
scpcli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 스냅샷 스케줄을 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|---|---|
| day_of_week | 요일 | |
| frequency | 주기 DAILY | WEEKLY |
| hour | 시간 | 18 |
| volume_id | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.14 - Delete Volume
3.3.1.14.1 - 1.2
scpcli baremetal-blockstorage volume delete
--volume_id <value>
Description
볼륨을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.14.2 - 1.1
scpcli baremetal-blockstorage volume delete
--volume_id <value>
Description
볼륨을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.14.3 - 1.0
scpcli baremetal-blockstorage volume delete
--volume_id <value>
Description
볼륨을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.15 - Delete Volume Group Replication
3.3.1.15.1 - 1.2
scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>
Description
복제본 볼륨 그룹을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.15.2 - 1.1
scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>
Description
복제본 볼륨 그룹을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.15.3 - 1.0
scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>
Description
복제본 볼륨 그룹을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.16 - Delete Volume Group Snapshot
3.3.1.16.1 - 1.2
scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>
Description
볼륩 그룹 스냅샷을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.16.2 - 1.1
scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>
Description
볼륩 그룹 스냅샷을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.16.3 - 1.0
scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>
Description
볼륩 그룹 스냅샷을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.17 - Delete Volume Group Snapshot Schedule
3.3.1.17.1 - 1.2
scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>
Description
볼륨 그룹 스냅샷 스케줄을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.17.2 - 1.1
scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>
Description
볼륨 그룹 스냅샷 스케줄을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.17.3 - 1.0
scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>
Description
볼륨 그룹 스냅샷 스케줄을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.18 - Delete Volume Replication
3.3.1.18.1 - 1.2
scpcli baremetal-blockstorage volume replication delete
--volume_id <value>
Description
복제본 볼륨을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.18.2 - 1.1
scpcli baremetal-blockstorage volume replication delete
--volume_id <value>
Description
복제본 볼륨을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.18.3 - 1.0
scpcli baremetal-blockstorage volume replication delete
--volume_id <value>
Description
복제본 볼륨을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.19 - Delete Volume Snapshot
3.3.1.19.1 - 1.2
scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
볼륨 스냅샷을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.19.2 - 1.1
scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
볼륨 스냅샷을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.19.3 - 1.0
scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
볼륨 스냅샷을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.20 - Delete Volume Snapshot Rate
3.3.1.20.1 - 1.2
scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>
Description
볼륨 스냅샷 용량을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.20.2 - 1.1
scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>
Description
볼륨 스냅샷 용량을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.20.3 - 1.0
scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>
Description
볼륨 스냅샷 용량을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.21 - Delete Volume Snapshot Schedule
3.3.1.21.1 - 1.2
scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>
Description
볼륨 스냅샷 스케줄을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.21.2 - 1.1
scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>
Description
볼륨 스냅샷 스케줄을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.21.3 - 1.0
scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>
Description
볼륨 스냅샷 스케줄을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.22 - Detach Volume
3.3.1.22.1 - 1.2
scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>
Description
서버에 연결된 볼륨을 분리한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| attachments required | array | 연결해지 object id 목록 | - |
3.3.1.22.2 - 1.1
scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>
Description
서버에 연결된 볼륨을 분리한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| attachments required | array | 연결해지 object id 목록 | - |
3.3.1.22.3 - 1.0
scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>
Description
서버에 연결된 볼륨을 분리한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| attachments required | array | 연결해지 object id 목록 | - |
3.3.1.23 - List Volume Group Snapshots
3.3.1.23.1 - 1.2
scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>
Description
볼륨 그룹 스냅샷의 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| created_dt | 생성일시 | 2024-08-01T07:07:23.315Z |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
3.3.1.23.2 - 1.1
scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>
Description
볼륨 그룹 스냅샷의 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| created_dt | 생성일시 | 2024-08-01T07:07:23.315Z |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
3.3.1.23.3 - 1.0
scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>
Description
볼륨 그룹 스냅샷의 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| created_dt | 생성일시 | 2024-08-01T07:07:23.315Z |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
3.3.1.24 - List Volume Groups
3.3.1.24.1 - 1.2
scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
Description
볼륨 그룹 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지에 표시될 번호 | 20 |
| offset optional | integer | Offset | 0 |
| sort optional | string | 정렬 | column1:asc,column2:desc |
| name optional | string | 볼륨 그룹명 | vg-01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| account_id | 계정 id | 36827d9b643f46c2ae6bb7e63d633bfe |
| created_at | 생성일시 | 2024-08-01T07:06:23.315Z |
| created_by | 생성자 | samsung-cloud-platform1@samsung.com |
| modified_at | 수정일시 | 2024-08-01T07:06:25.315Z |
| modified_by | 수정자 | samsung-cloud-platform2@samsung.com |
| name | 볼륨 그룹명 | vg-01 |
| num_of_block_storages | 볼륨 수 | 2 |
| purpose | 볼륨 그룹 구분 | ORG |
| state | 현재 상태 |
3.3.1.24.2 - 1.1
scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
Description
볼륨 그룹 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지에 표시될 번호 | 20 |
| offset optional | integer | Offset | 0 |
| sort optional | string | 정렬 | column1:asc,column2:desc |
| name optional | string | 볼륨 그룹명 | vg-01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| account_id | 계정 id | 36827d9b643f46c2ae6bb7e63d633bfe |
| created_at | 생성일시 | 2024-08-01T07:06:23.315Z |
| created_by | 생성자 | samsung-cloud-platform1@samsung.com |
| modified_at | 수정일시 | 2024-08-01T07:06:25.315Z |
| modified_by | 수정자 | samsung-cloud-platform2@samsung.com |
| name | 볼륨 그룹명 | vg-01 |
| num_of_block_storages | 볼륨 수 | 2 |
| purpose | 볼륨 그룹 구분 | ORG |
| state | 현재 상태 |
3.3.1.24.3 - 1.0
scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
Description
볼륨 그룹 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지에 표시될 번호 | 20 |
| offset optional | integer | Offset | 0 |
| sort optional | string | 정렬 | column1:asc,column2:desc |
| name optional | string | 볼륨 그룹명 | vg-01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| account_id | 계정 id | 36827d9b643f46c2ae6bb7e63d633bfe |
| created_at | 생성일시 | 2024-08-01T07:06:23.315Z |
| created_by | 생성자 | samsung-cloud-platform1@samsung.com |
| modified_at | 수정일시 | 2024-08-01T07:06:25.315Z |
| modified_by | 수정자 | samsung-cloud-platform2@samsung.com |
| name | 볼륨 그룹명 | vg-01 |
| num_of_block_storages | 볼륨 수 | 2 |
| purpose | 볼륨 그룹 구분 | ORG |
| state | 현재 상태 |
3.3.1.25 - List Volume Snapshots
3.3.1.25.1 - 1.2
scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>
Description
볼륨 스냅샷 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| created_dt | 생성일시 | 2024-08-01T07:07:23.315Z |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| snapshot_size_mb | 스냅샷 크기(MB) | 0 |
3.3.1.25.2 - 1.1
scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>
Description
볼륨 스냅샷 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| created_dt | 생성일시 | 2024-08-01T07:07:23.315Z |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| snapshot_size_mb | 스냅샷 크기(MB) | 0 |
3.3.1.25.3 - 1.0
scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>
Description
볼륨 스냅샷 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| created_dt | 생성일시 | 2024-08-01T07:07:23.315Z |
| snapshot_id | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | 스냅샷 이름 | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| snapshot_size_mb | 스냅샷 크기(MB) | 0 |
3.3.1.26 - List Volumes
3.3.1.26.1 - 1.2
scpcli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]
Description
볼륨 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지에 표시될 번호 | 20 |
| offset optional | integer | Offset | 0 |
| sort optional | string | 정렬 | column1:asc,column2:desc |
| name optional | string | 볼륨명 | bs-01 |
| object_name optional | string | 연결 서버명 | baremetal-server-name |
| volume_group_name optional | string | 볼륨 그룹명 | vg-01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | 7239779c01e3405f82bb71c7f4b55fcd |
| attachments | 연결 서버 | [{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}] |
| created_at | 생성일시 | |
| created_by | 생성자 | samsung-cloud-platform1@samsung.com |
| disk_type | 디스크 유형 | |
| has_relation | 관계 존재 여부 | False |
| is_in_volume_group | 볼륨 그룹 소속 여부 | False |
| is_snapshot_activated | 스냅샷 활성화 여부 | True |
| iscsi_target_ips | iscsi ip 목록 | {‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]} |
| modified_at | 수정일시 | |
| modified_by | 수정자 | samsung-cloud-platform2@samsung.com |
| name | 볼륨명 | bs-01 |
| purpose | 볼륨 구분 | |
| size_gb | 볼륨 용량(GB) | 10 |
| state | 현재 상태 | |
| volume_group | 볼륨 그룹 |
3.3.1.26.2 - 1.1
scpcli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]
Description
볼륨 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지에 표시될 번호 | 20 |
| offset optional | integer | Offset | 0 |
| sort optional | string | 정렬 | column1:asc,column2:desc |
| name optional | string | 볼륨명 | bs-01 |
| object_name optional | string | 연결 서버명 | baremetal-server-name |
| volume_group_name optional | string | 볼륨 그룹명 | vg-01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | 7239779c01e3405f82bb71c7f4b55fcd |
| attachments | 연결 서버 | [{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}] |
| created_at | 생성일시 | |
| created_by | 생성자 | samsung-cloud-platform1@samsung.com |
| disk_type | 디스크 유형 | |
| has_relation | 관계 존재 여부 | False |
| is_in_volume_group | 볼륨 그룹 소속 여부 | False |
| is_snapshot_activated | 스냅샷 활성화 여부 | True |
| iscsi_target_ips | iscsi ip 목록 | {‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]} |
| modified_at | 수정일시 | |
| modified_by | 수정자 | samsung-cloud-platform2@samsung.com |
| name | 볼륨명 | bs-01 |
| purpose | 볼륨 구분 | |
| size_gb | 볼륨 용량(GB) | 10 |
| state | 현재 상태 | |
| volume_group | 볼륨 그룹 |
3.3.1.26.3 - 1.0
scpcli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]
Description
볼륨 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | 페이지에 표시될 번호 | 20 |
| offset optional | integer | Offset | 0 |
| sort optional | string | 정렬 | column1:asc,column2:desc |
| name optional | string | 볼륨명 | bs-01 |
| object_name optional | string | 연결 서버명 | baremetal-server-name |
| volume_group_name optional | string | 볼륨 그룹명 | vg-01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | 7239779c01e3405f82bb71c7f4b55fcd |
| attachments | 연결 서버 | [{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}] |
| created_at | 생성일시 | |
| created_by | 생성자 | samsung-cloud-platform1@samsung.com |
| disk_type | 디스크 유형 | |
| has_relation | 관계 존재 여부 | False |
| is_in_volume_group | 볼륨 그룹 소속 여부 | False |
| is_snapshot_activated | 스냅샷 활성화 여부 | True |
| iscsi_target_ips | iscsi ip 목록 | {‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]} |
| modified_at | 수정일시 | |
| modified_by | 수정자 | samsung-cloud-platform2@samsung.com |
| name | 볼륨명 | bs-01 |
| purpose | 볼륨 구분 | |
| size_gb | 볼륨 용량(GB) | 10 |
| state | 현재 상태 | |
| volume_group | 볼륨 그룹 |
3.3.1.27 - Remove Volume Group Member on Volume Group
3.3.1.27.1 - 1.2
scpcli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>
Description
볼륨 그룹에서 볼륨 그룹 멤버를 제거한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
3.3.1.27.2 - 1.1
scpcli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>
Description
볼륨 그룹에서 볼륨 그룹 멤버를 제거한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
3.3.1.27.3 - 1.0
scpcli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>
Description
볼륨 그룹에서 볼륨 그룹 멤버를 제거한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
3.3.1.28 - Restore Volume Group Snapshot
3.3.1.28.1 - 1.2
scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>
Description
볼륨 그룹 스냅샷을 복원한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.28.2 - 1.1
scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>
Description
볼륨 그룹 스냅샷을 복원한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.28.3 - 1.0
scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>
Description
볼륨 그룹 스냅샷을 복원한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
3.3.1.29 - Restore Volume Snapshot
3.3.1.29.1 - 1.2
scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>
Description
스냅샷에서 볼륨을 복원한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.29.2 - 1.1
scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>
Description
스냅샷에서 볼륨을 복원한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.29.3 - 1.0
scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>
Description
스냅샷에서 볼륨을 복원한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
3.3.1.30 - Set Volume Group Replication Cycle
3.3.1.30.1 - 1.2
scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>
Description
볼륨 그룹 복제 주기를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| cycle required | string | 복제 주기 | - |
3.3.1.30.2 - 1.1
scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>
Description
볼륨 그룹 복제 주기를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| cycle required | string | 복제 주기 | - |
3.3.1.30.3 - 1.0
scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>
Description
볼륨 그룹 복제 주기를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| cycle required | string | 복제 주기 | - |
3.3.1.31 - Set Volume Group Replication Policy
3.3.1.31.1 - 1.2
scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>
Description
볼륨 그룹 복제 정책을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| policy required | string | 정책 | - |
3.3.1.31.2 - 1.1
scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>
Description
볼륨 그룹 복제 정책을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| policy required | string | 정책 | - |
3.3.1.31.3 - 1.0
scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>
Description
볼륨 그룹 복제 정책을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| policy required | string | 정책 | - |
3.3.1.32 - Set Volume Group Snapshot Schedule
3.3.1.32.1 - 1.2
scpcli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 그룹 스냅샷 스케줄을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
3.3.1.32.2 - 1.1
scpcli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 그룹 스냅샷 스케줄을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
3.3.1.32.3 - 1.0
scpcli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 그룹 스냅샷 스케줄을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
3.3.1.33 - Set Volume QoS
3.3.1.33.1 - 1.2
scpcli baremetal-blockstorage volume qos set
--volume_id <value>
[--iops <value>]
[--throughput <value>]
Description
볼륨 QoS를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| iops optional | integer | IOPS. If omitted, the existing value will be retained. | 3000 |
| throughput optional | integer | Throughput. If omitted, the existing value will be retained. | 125 |
3.3.1.34 - Set Volume Replication Cycle
3.3.1.34.1 - 1.2
scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>
Description
복제본 볼륨 주기를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| cycle required | string | 복제 주기 | 5MIN |
3.3.1.34.2 - 1.1
scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>
Description
복제본 볼륨 주기를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| cycle required | string | 복제 주기 | 5MIN |
3.3.1.34.3 - 1.0
scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>
Description
복제본 볼륨 주기를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| cycle required | string | 복제 주기 | 5MIN |
3.3.1.35 - Set Volume Replication Policy
3.3.1.35.1 - 1.2
scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>
Description
복제본 볼륨 정책을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| policy required | string | 정책 | - |
3.3.1.35.2 - 1.1
scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>
Description
복제본 볼륨 정책을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| policy required | string | 정책 | - |
3.3.1.35.3 - 1.0
scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>
Description
복제본 볼륨 정책을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| policy required | string | 정책 | - |
3.3.1.36 - Set Volume Snapshot Rate
3.3.1.36.1 - 1.2
scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>
Description
볼륨 스냅샷 용량을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| snapshot_rate required | integer | 스냅샷 용량 | 100 |
3.3.1.36.2 - 1.1
scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>
Description
볼륨 스냅샷 용량을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| snapshot_rate required | integer | 스냅샷 용량 | 100 |
3.3.1.36.3 - 1.0
scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>
Description
볼륨 스냅샷 용량을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| snapshot_rate required | integer | 스냅샷 용량 | 100 |
3.3.1.37 - Set Volume Snapshot Schedule
3.3.1.37.1 - 1.2
scpcli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 스냅샷 스케줄을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
3.3.1.37.2 - 1.1
scpcli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 스냅샷 스케줄을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
3.3.1.37.3 - 1.0
scpcli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
볼륨 스냅샷 스케줄을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
| hour required | integer | 시간 | 18 |
| day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
3.3.1.38 - Show Volume
3.3.1.38.1 - 1.2
scpcli baremetal-blockstorage volume show
--volume_id <value>
Description
볼륨을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 상세 정보 |
3.3.1.38.2 - 1.1
scpcli baremetal-blockstorage volume show
--volume_id <value>
Description
볼륨을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 상세 정보 |
3.3.1.38.3 - 1.0
scpcli baremetal-blockstorage volume show
--volume_id <value>
Description
볼륨을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 상세 정보 |
3.3.1.39 - Show Volume Group
3.3.1.39.1 - 1.2
scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>
Description
볼륨 그룹을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 그룹 상세 정보 |
3.3.1.39.2 - 1.1
scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>
Description
볼륨 그룹을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 그룹 상세 정보 |
3.3.1.39.3 - 1.0
scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>
Description
볼륨 그룹을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 그룹 상세 정보 |
3.3.1.40 - Show Volume Group Replication
3.3.1.40.1 - 1.2
scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>
Description
복제본 볼륨 그룹을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 그룹 복제 정보 |
3.3.1.40.2 - 1.1
scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>
Description
복제본 볼륨 그룹을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 그룹 복제 정보 |
3.3.1.40.3 - 1.0
scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>
Description
복제본 볼륨 그룹을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_group_id required | string | 볼륨 그룹 id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 그룹 복제 정보 |
3.3.1.41 - Show Volume Replication
3.3.1.41.1 - 1.2
scpcli baremetal-blockstorage volume replication show
--volume_id <value>
Description
복제본 볼륨을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 복제 정보 |
3.3.1.41.2 - 1.1
scpcli baremetal-blockstorage volume replication show
--volume_id <value>
Description
복제본 볼륨을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 복제 정보 |
3.3.1.41.3 - 1.0
scpcli baremetal-blockstorage volume replication show
--volume_id <value>
Description
복제본 볼륨을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 볼륨 복제 정보 |
3.4 - File Storage
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 File Storage 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
3.4.1 - CLIs
3.4.1.1 - CreateSnapshot
3.4.1.1.1 - 1.1
scpcli filestorage volume snapshot create
--volume_id <value>
Description
파일스토리지 스냅샷을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| name | 스냅샷 이름 | my_volume.2024-10-01_14215 |
| state | 스냅샷 상태 | available |
| size | 스냅샷 크기 | 100 |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| volume_id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.1.2 - 1.0
scpcli filestorage volume snapshot create
--volume_id <value>
Description
파일스토리지 스냅샷을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| name | 스냅샷 이름 | my_volume.2024-10-01_14215 |
| state | 스냅샷 상태 | available |
| size | 스냅샷 크기 | 100 |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| volume_id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.2 - CreateSnapshotSchedule
3.4.1.2.1 - 1.1
scpcli filestorage volume snapshot schedule create
--hour <value>
--frequency <value>
--volume_id <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]
Description
파일스토리지 스냅샷 스케줄을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hour required | string | 스냅샷 스케줄 시간 | 23 |
| frequency required | string | 스냅샷 주기 | WEEKLY |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| snapshot_retention_count optional | integer | 보관 개수 | 10 |
| day_of_week optional | string | 스냅샷 스케줄 설정 요일 | MON |
Responses
| Name | Description | Example |
|---|---|---|
| frequency | 스냅샷 주기 | WEEKLY |
| day_of_week | 스냅샷 스케줄 설정 요일 | MON |
| hour | 스냅샷 스케줄 시간 | 23 |
3.4.1.2.2 - 1.0
scpcli filestorage volume snapshot schedule create
--hour <value>
--frequency <value>
--volume_id <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]
Description
파일스토리지 스냅샷 스케줄을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hour required | string | 스냅샷 스케줄 시간 | 23 |
| frequency required | string | 스냅샷 주기 | WEEKLY |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| snapshot_retention_count optional | integer | 보관 개수 | 10 |
| day_of_week optional | string | 스냅샷 스케줄 설정 요일 | MON |
Responses
| Name | Description | Example |
|---|---|---|
| frequency | 스냅샷 주기 | WEEKLY |
| day_of_week | 스냅샷 스케줄 설정 요일 | MON |
| hour | 스냅샷 스케줄 시간 | 23 |
3.4.1.3 - CreateVolume
3.4.1.3.1 - 1.1
scpcli filestorage volume create
--type_name <value>
--protocol <value>
--name <value>
[--snapshot_id <value>]
[--cifs_password <value>]
[--tags <value>]
Description
파일스토리지를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type_name required | string | 볼륨 유형 이름 | HDD |
| protocol required | string | 프로토콜 | NFS |
| name required | string | 볼륨 이름 | my_volume |
| snapshot_id optional | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| cifs_password optional | string | CIFS 비밀번호 | cifspwd0!! |
| tags optional | array | '{"key": "key", "value": "value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| protocol | 프로토콜 | NFS |
| snapshot_id | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| type_name | 볼륨 유형 이름 | HDD |
| volume_id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| volume_name | 볼륨 이름 | my_volume |
3.4.1.3.2 - 1.0
scpcli filestorage volume create
--type_name <value>
--protocol <value>
--name <value>
[--snapshot_id <value>]
[--cifs_password <value>]
[--tags <value>]
Description
파일스토리지를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type_name required | string | 볼륨 유형 이름 | HDD |
| protocol required | string | 프로토콜 | NFS |
| name required | string | 볼륨 이름 | my_volume |
| snapshot_id optional | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| cifs_password optional | string | CIFS 비밀번호 | cifspwd0!! |
| tags optional | array | '{"key": "key", "value": "value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| protocol | 프로토콜 | NFS |
| snapshot_id | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| type_name | 볼륨 유형 이름 | HDD |
| volume_id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| volume_name | 볼륨 이름 | my_volume |
3.4.1.4 - CreateVolumeReplication
3.4.1.4.1 - 1.1
scpcli filestorage volume replication create
--replication_type <value>
--volume_id <value>
--region <value>
--replication_frequency <value>
--name <value>
[--cifs_password <value>]
[--backup_retention_count <value>]
Description
파일스토리지 복제를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replication_type required | string | 복제 유형 | replication |
| volume_id required | string | 원본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| region required | string | 복제본 리전 | kr-west1 |
| replication_frequency required | string | 복제 주기 | 5min |
| name required | string | 복제본 볼륨 이름 | my_volume |
| cifs_password optional | string | CIFS 비밀번호 | cifspwd0!! |
| backup_retention_count optional | integer | 백업 보관 개수 | 2 |
Responses
| Name | Description | Example |
|---|---|---|
| replication_id | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_status | 복제 상태 | creating |
| source_volume_id | 원본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| source_volume_region | 원본 리전 | kr-west1 |
| protocol | 프로토콜 | NFS |
| replication_volume_id | 복제본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_volume_region | 복제본 리전 | kr-west1 |
3.4.1.4.2 - 1.0
scpcli filestorage volume replication create
--replication_type <value>
--volume_id <value>
--region <value>
--replication_frequency <value>
--name <value>
[--cifs_password <value>]
[--backup_retention_count <value>]
Description
파일스토리지 복제를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replication_type required | string | 복제 유형 | replication |
| volume_id required | string | 원본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| region required | string | 복제본 리전 | kr-west1 |
| replication_frequency required | string | 복제 주기 | 5min |
| name required | string | 복제본 볼륨 이름 | my_volume |
| cifs_password optional | string | CIFS 비밀번호 | cifspwd0!! |
| backup_retention_count optional | integer | 백업 보관 개수 | 2 |
Responses
| Name | Description | Example |
|---|---|---|
| replication_id | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_status | 복제 상태 | creating |
| source_volume_id | 원본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| source_volume_region | 원본 리전 | kr-west1 |
| protocol | 프로토콜 | NFS |
| replication_volume_id | 복제본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_volume_region | 복제본 리전 | kr-west1 |
3.4.1.5 - DeleteSnapshot
3.4.1.5.1 - 1.1
scpcli filestorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.5.2 - 1.0
scpcli filestorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.6 - DeleteSnapshotSchedule
3.4.1.6.1 - 1.1
scpcli filestorage volume snapshot schedule delete
--snapshot_schedule_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷 스케줄을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_schedule_id required | string | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.6.2 - 1.0
scpcli filestorage volume snapshot schedule delete
--snapshot_schedule_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷 스케줄을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_schedule_id required | string | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.7 - DeleteVolume
3.4.1.7.1 - 1.1
scpcli filestorage volume delete
--volume_id <value>
Description
파일스토리지를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.7.2 - 1.0
scpcli filestorage volume delete
--volume_id <value>
Description
파일스토리지를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.8 - DeleteVolumeReplication
3.4.1.8.1 - 1.1
scpcli filestorage volume replication delete
--replication_id <value>
--volume_id <value>
Description
파일스토리지 복제를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.8.2 - 1.0
scpcli filestorage volume replication delete
--replication_id <value>
--volume_id <value>
Description
파일스토리지 복제를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.9 - ListAccessRules
3.4.1.9.1 - 1.1
scpcli filestorage volume access rule list
--volume_id <value>
Description
접근제어 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| access_rule_state | 접근제어 상태 | active |
| object_type | 오브젝트 유형 | VM |
| object_id | 오브젝트 아이디 | 43fq3347-02q4-4aa8-ccf9-affe4917bb6f |
3.4.1.9.2 - 1.0
scpcli filestorage volume access rule list
--volume_id <value>
Description
접근제어 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| access_rule_state | 접근제어 상태 | active |
| object_type | 오브젝트 유형 | VM |
| object_id | 오브젝트 아이디 | 43fq3347-02q4-4aa8-ccf9-affe4917bb6f |
3.4.1.10 - ListSnapshots
3.4.1.10.1 - 1.1
scpcli filestorage volume snapshot list
--volume_id <value>
Description
파일스토리지 스냅샷 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| name | 스냅샷 이름 | my_volume.2024-10-01_14215 |
| state | 스냅샷 상태 | available |
| size | 스냅샷 크기 | 100 |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
3.4.1.10.2 - 1.0
scpcli filestorage volume snapshot list
--volume_id <value>
Description
파일스토리지 스냅샷 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| name | 스냅샷 이름 | my_volume.2024-10-01_14215 |
| state | 스냅샷 상태 | available |
| size | 스냅샷 크기 | 100 |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
3.4.1.11 - ListSnapshotSchedule
3.4.1.11.1 - 1.1
scpcli filestorage volume snapshot schedule list
--volume_id <value>
Description
파일스토리지 스냅샷 스케줄 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
| frequency | 스냅샷 주기 | WEEKLY |
| day_of_week | 스냅샷 스케줄 설정 요일 | MON |
| hour | 스냅샷 스케줄 시간 | 23 |
3.4.1.11.2 - 1.0
scpcli filestorage volume snapshot schedule list
--volume_id <value>
Description
파일스토리지 스냅샷 스케줄 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
| frequency | 스냅샷 주기 | WEEKLY |
| day_of_week | 스냅샷 스케줄 설정 요일 | MON |
| hour | 스냅샷 스케줄 시간 | 23 |
3.4.1.12 - ListVolumeReplicationRegion
3.4.1.12.1 - 1.1
scpcli filestorage volume replication region list
--replication_type <value>
--source_region_name <value>
[--type_name <value>]
Description
파일스토리지 복제 리전 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replication_type required | string | 복제 유형 | replication |
| source_region_name required | string | 리전 | kr-west1 |
| type_name optional | string | 볼륨 유형 이름 | HDD |
Responses
| Name | Description | Example |
|---|---|---|
| regions | 복제 리전 목록 | [‘kr-west1’] |
3.4.1.12.2 - 1.0
scpcli filestorage volume replication region list
--replication_type <value>
--source_region_name <value>
[--type_name <value>]
Description
파일스토리지 복제 리전 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replication_type required | string | 복제 유형 | replication |
| source_region_name required | string | 리전 | kr-west1 |
| type_name optional | string | 볼륨 유형 이름 | HDD |
Responses
| Name | Description | Example |
|---|---|---|
| regions | 복제 리전 목록 | [‘kr-west1’] |
3.4.1.13 - ListVolumeReplications
3.4.1.13.1 - 1.1
scpcli filestorage volume replication list
--volume_id <value>
Description
파일스토리지 복제 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| replication_id | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_frequency | 복제 주기 | 5min |
| source_volume_id | 원본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| source_volume_region | 원본 리전 | kr-west1 |
| source_volume_access_level | 원본 접근 레벨 | ro |
| replication_volume_id | 복제본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_volume_region | 복제본 리전 | kr-west1 |
| replication_volume_access_level | 복제본 접근 레벨 | ro |
| replication_type | 복제 유형 | replication |
3.4.1.13.2 - 1.0
scpcli filestorage volume replication list
--volume_id <value>
Description
파일스토리지 복제 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| replication_id | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_frequency | 복제 주기 | 5min |
| source_volume_id | 원본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| source_volume_region | 원본 리전 | kr-west1 |
| source_volume_access_level | 원본 접근 레벨 | ro |
| replication_volume_id | 복제본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_volume_region | 복제본 리전 | kr-west1 |
| replication_volume_access_level | 복제본 접근 레벨 | ro |
| replication_type | 복제 유형 | replication |
3.4.1.14 - ListVolumes
3.4.1.14.1 - 1.1
scpcli filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--type_name <value>]
[--sort <value>]
Description
파일스토리지 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| offset optional | integer | offset | - |
| limit optional | integer | limit | - |
| name optional | string | 볼륨 이름 | my_volume |
| type_name optional | string | 볼륨 유형 이름 | HDD |
| sort optional | string | 정렬 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| protocol | 프로토콜 | NFS |
| state | 볼륨 상태 | available |
| account_id | Account 아이디 | rwww523320dfvwbbefefsdvwdadsfa24c |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| type_id | 볼륨 유형 아이디 | jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu |
| type_name | 볼륨 유형 이름 | HDD |
| purpose | 볼륨 용도 | replication |
3.4.1.14.2 - 1.0
scpcli filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--type_name <value>]
[--sort <value>]
Description
파일스토리지 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| offset optional | integer | offset | - |
| limit optional | integer | limit | - |
| name optional | string | 볼륨 이름 | my_volume |
| type_name optional | string | 볼륨 유형 이름 | HDD |
| sort optional | string | 정렬 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| protocol | 프로토콜 | NFS |
| state | 볼륨 상태 | available |
| account_id | Account 아이디 | rwww523320dfvwbbefefsdvwdadsfa24c |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| type_id | 볼륨 유형 아이디 | jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu |
| type_name | 볼륨 유형 이름 | HDD |
| purpose | 볼륨 용도 | replication |
3.4.1.15 - RestoreSnapshot
3.4.1.15.1 - 1.1
scpcli filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷을 복구한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.15.2 - 1.0
scpcli filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷을 복구한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.4.1.16 - SetAccessRule
3.4.1.16.1 - 1.1
scpcli filestorage volume access rule set
--volume_id <value>
--action <value>
--object_type <value>
--object_id <value>
Description
파일스토리지 접근제어를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| action required | string | 접근제어 액션 | add |
| object_type required | string | 오브젝트 유형 | VM |
| object_id required | string | 오브젝트 아이디 | 43fq3347-02q4-4aa8-ccf9-affe4917bb6f |
3.4.1.16.2 - 1.0
scpcli filestorage volume access rule set
--volume_id <value>
--action <value>
--object_type <value>
--object_id <value>
Description
파일스토리지 접근제어를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| action required | string | 접근제어 액션 | add |
| object_type required | string | 오브젝트 유형 | VM |
| object_id required | string | 오브젝트 아이디 | 43fq3347-02q4-4aa8-ccf9-affe4917bb6f |
3.4.1.17 - SetSnapshotSchedule
3.4.1.17.1 - 1.1
scpcli filestorage volume snapshot schedule set
--snapshot_schedule_id <value>
--volume_id <value>
--hour <value>
--frequency <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]
Description
파일스토리지 스냅샷 스케줄을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_schedule_id required | string | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| hour required | string | 스냅샷 스케줄 시간 | 23 |
| frequency required | string | 스냅샷 주기 | WEEKLY |
| snapshot_retention_count optional | integer | 보관 개수 | 10 |
| day_of_week optional | string | 스냅샷 스케줄 설정 요일 | MON |
3.4.1.17.2 - 1.0
scpcli filestorage volume snapshot schedule set
--snapshot_schedule_id <value>
--volume_id <value>
--hour <value>
--frequency <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]
Description
파일스토리지 스냅샷 스케줄을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_schedule_id required | string | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| hour required | string | 스냅샷 스케줄 시간 | 23 |
| frequency required | string | 스냅샷 주기 | WEEKLY |
| snapshot_retention_count optional | integer | 보관 개수 | 10 |
| day_of_week optional | string | 스냅샷 스케줄 설정 요일 | MON |
3.4.1.18 - SetVolume
3.4.1.18.1 - 1.1
scpcli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>
Description
파일스토리지를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| file_unit_recovery_enabled required | boolean | 볼륨 파일 단위 복구 사용 여부 | True |
3.4.1.18.2 - 1.0
scpcli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>
Description
파일스토리지를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| file_unit_recovery_enabled required | boolean | 볼륨 파일 단위 복구 사용 여부 | True |
3.4.1.19 - SetVolumeReplication
3.4.1.19.1 - 1.1
scpcli filestorage volume replication set
--replication_id <value>
--volume_id <value>
--replication_update_type <value>
[--replication_policy <value>]
[--replication_frequency <value>]
[--backup_retention_count <value>]
Description
파일스토리지 복제를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_update_type required | string | 복제 수정 유형 | policy |
| replication_policy optional | **** | 복제 정책 | use |
| replication_frequency optional | **** | 복제 주기 | 5min |
| backup_retention_count optional | integer | 백업 보관 개수 | 2 |
3.4.1.19.2 - 1.0
scpcli filestorage volume replication set
--replication_id <value>
--volume_id <value>
--replication_update_type <value>
[--replication_policy <value>]
[--replication_frequency <value>]
[--backup_retention_count <value>]
Description
파일스토리지 복제를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_update_type required | string | 복제 수정 유형 | policy |
| replication_policy optional | **** | 복제 정책 | use |
| replication_frequency optional | **** | 복제 주기 | 5min |
| backup_retention_count optional | integer | 백업 보관 개수 | 2 |
3.4.1.20 - ShowVolume
3.4.1.20.1 - 1.1
scpcli filestorage volume show
--volume_id <value>
Description
파일스토리지를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| protocol | 프로토콜 | NFS |
| state | 볼륨 상태 | available |
| account_id | Account 아이디 | rwww523320dfvwbbefefsdvwdadsfa24c |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| type_id | 볼륨 유형 아이디 | jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu |
| type_name | 볼륨 유형 이름 | HDD |
| purpose | 볼륨 용도 | replication |
| path | 볼륨 마운트 경로 | xxx.xx.xxx:/xxxxxxxx |
| usage | 볼륨 사용량 | 100000 |
| encryption_enabled | 볼륨 암호화 사용 여부 | True |
| file_unit_recovery_enabled | 볼륨 파일 단위 복구 사용 여부 | True |
| cifs_id | CIFS 아이디 | cifsid |
| endpoint_path | 볼륨 엔드포인트 경로 | xxx.xx.xxx.xxx |
3.4.1.20.2 - 1.0
scpcli filestorage volume show
--volume_id <value>
Description
파일스토리지를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| protocol | 프로토콜 | NFS |
| state | 볼륨 상태 | available |
| account_id | Account 아이디 | rwww523320dfvwbbefefsdvwdadsfa24c |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| type_id | 볼륨 유형 아이디 | jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu |
| type_name | 볼륨 유형 이름 | HDD |
| purpose | 볼륨 용도 | replication |
| path | 볼륨 마운트 경로 | xxx.xx.xxx:/xxxxxxxx |
| usage | 볼륨 사용량 | 100000 |
| encryption_enabled | 볼륨 암호화 사용 여부 | True |
| file_unit_recovery_enabled | 볼륨 파일 단위 복구 사용 여부 | True |
| cifs_id | CIFS 아이디 | cifsid |
| endpoint_path | 볼륨 엔드포인트 경로 | xxx.xx.xxx.xxx |
3.4.1.21 - ShowVolumeReplication
3.4.1.21.1 - 1.1
scpcli filestorage volume replication show
--replication_id <value>
--volume_id <value>
Description
파일스토리지 복제를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| replication_id | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_frequency | 복제 주기 | 5min |
| source_volume_id | 원본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| source_volume_region | 원본 리전 | kr-west1 |
| source_volume_access_level | 원본 접근 레벨 | ro |
| replication_volume_id | 복제본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_volume_region | 복제본 리전 | kr-west1 |
| replication_volume_access_level | 복제본 접근 레벨 | ro |
| replication_type | 복제 유형 | replication |
| source_volume_name | 원본 볼륨 이름 | my_volume |
| replication_policy | 복제 정책 | use |
| replication_status | 복제 상태 | creating |
| replication_volume_name | 복제본 볼륨 이름 | my_volume |
| backup_retention_count | 백업 보관 개수 | 2 |
3.4.1.21.2 - 1.0
scpcli filestorage volume replication show
--replication_id <value>
--volume_id <value>
Description
파일스토리지 복제를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| replication_id | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_frequency | 복제 주기 | 5min |
| source_volume_id | 원본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| source_volume_region | 원본 리전 | kr-west1 |
| source_volume_access_level | 원본 접근 레벨 | ro |
| replication_volume_id | 복제본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| replication_volume_region | 복제본 리전 | kr-west1 |
| replication_volume_access_level | 복제본 접근 레벨 | ro |
| replication_type | 복제 유형 | replication |
| source_volume_name | 원본 볼륨 이름 | my_volume |
| replication_policy | 복제 정책 | use |
| replication_status | 복제 상태 | creating |
| replication_volume_name | 복제본 볼륨 이름 | my_volume |
| backup_retention_count | 백업 보관 개수 | 2 |
3.5 - Parallel File Storage
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Parallel File Storage 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
3.5.1 - CLIs
3.5.1.1 - CreateSnapshot
3.5.1.1.1 - 1.0
scpcli parallel-filestorage snapshot create
--volume_id <value>
Description
병렬 파일스토리지 스냅샷을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| snapshot | 스냅샷 |
3.5.1.2 - CreateVolume
3.5.1.2.1 - 1.0
scpcli parallel-filestorage volume create
--capacity_tb <value>
--name <value>
[--tags <value>]
Description
병렬 파일스토리지를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| capacity_tb required | integer | 볼륨 용량 | 100 |
| name required | string | 볼륨 이름 | my_volume |
| tags optional | array | '{"key": "key", "value": "value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| state | 볼륨 상태 | available |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| capacity_tb | 볼륨 용량 | 100 |
| account_id | 어카운트 아이디 | rwww523320dfvwbbefefsdvwdadsfa24c |
3.5.1.3 - DeleteSnapshot
3.5.1.3.1 - 1.0
scpcli parallel-filestorage snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
병렬 파일스토리지 스냅샷을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| snapshot_id required | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.5.1.4 - DeleteVolume
3.5.1.4.1 - 1.0
scpcli parallel-filestorage volume delete
--volume_id <value>
Description
병렬 파일스토리지를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
3.5.1.5 - ListAccessRule
3.5.1.5.1 - 1.0
scpcli parallel-filestorage access rule list
--volume_id <value>
Description
병렬 파일스토리지 접근제어 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| object_id | 오브젝트 아이디 | 43fq3347-02q4-4aa8-ccf9-affe4917bb6f |
| object_type | 오브젝트 유형 | GPU_NODE |
| object_name | 오브젝트 이름 | objectname |
| object_state | 오브젝트 상태 | RUNNING |
| access_state | 접근제어 상태 | all |
| access_ip_list |
3.5.1.6 - ListSnapshots
3.5.1.6.1 - 1.0
scpcli parallel-filestorage snapshot list
--volume_id <value>
Description
병렬 파일스토리지 스냅샷 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| name | 스냅샷 이름 | snapshot.2025-10-30_121212 |
| size | 스냅샷 크기 | 100 |
| state | 스냅샷 상태 | available |
| created_at | 생성 시간 | 2024-10-30T04:54:33.219373 |
3.5.1.7 - ListVolumes
3.5.1.7.1 - 1.0
scpcli parallel-filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--sort <value>]
Description
병렬 파일스토리지 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| offset optional | integer | offset | - |
| limit optional | integer | limit | - |
| name optional | string | 볼륨 이름 | my_volume |
| sort optional | string | 정렬 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| state | 볼륨 상태 | available |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| capacity_tb | 볼륨 용량 | 100 |
| account_id | 어카운트 아이디 | rwww523320dfvwbbefefsdvwdadsfa24c |
3.5.1.8 - SetAccessRule
3.5.1.8.1 - 1.0
scpcli parallel-filestorage access rule set
--volume_id <value>
--remove_access_rules <value>
--add_access_rules <value>
Description
병렬 파일스토리지 접근제어를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| remove_access_rules required | array | '{"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f", "object_type": "GPU_NODE"}' | |
| add_access_rules required | array | '{"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f", "object_type": "GPU_NODE"}' |
3.5.1.9 - SetVolumeCapacity
3.5.1.9.1 - 1.0
scpcli parallel-filestorage volume capacity set
--volume_id <value>
--capacity_tb <value>
Description
병렬 파일스토리지 용량을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| capacity_tb required | integer | 볼륨 용량 | 100 |
3.5.1.10 - ShowVolume
3.5.1.10.1 - 1.0
scpcli parallel-filestorage volume show
--volume_id <value>
Description
병렬 파일스토리지를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| state | 볼륨 상태 | available |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| capacity_tb | 볼륨 용량 | 100 |
| account_id | 어카운트 아이디 | rwww523320dfvwbbefefsdvwdadsfa24c |
| mount_path | 볼륨 마운트 경로 | xxx.xx.xxx:/xxxxxxxx |
4 - Container
4.1 - Container Registry
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Container Registry 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | SUPPORTED | 20260630 |
| 1.1 | CURRENT | - |
4.1.1 - CLIs
4.1.1.1 - Check Registry Name Duplication
4.1.1.1.1 - 1.1
scpcli scr registry name-duplication show
--name <value>
Description
Registry명 중복 여부
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Registry명 | sample |
Responses
| Name | Description | Example |
|---|---|---|
| result | 이름 중복 여부 | True |
4.1.1.1.2 - 1.0
scpcli scr registry name-duplication show
--name <value>
Description
Registry명 중복 여부
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Registry명 | sample |
Responses
| Name | Description | Example |
|---|---|---|
| result | 이름 중복 여부 | True |
4.1.1.2 - Check Repository Name Duplication
4.1.1.2.1 - 1.1
scpcli scr repository name-duplication show
--name <value>
--registry_id <value>
Description
Registry명 중복 여부
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Repository명 | sample |
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 이름 중복 여부 | True |
4.1.1.2.2 - 1.0
scpcli scr repository name-duplication show
--name <value>
--registry_id <value>
Description
Registry명 중복 여부
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Repository명 | sample |
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
Responses
| Name | Description | Example |
|---|---|---|
| result | 이름 중복 여부 | True |
4.1.1.3 - Check Tags Vulnerability
4.1.1.3.1 - 1.1
scpcli scr tags scan set
--tags_id <value>
Description
취약점 검사 수행
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
4.1.1.3.2 - 1.0
scpcli scr tags scan set
--tags_id <value>
Description
취약점 검사 수행
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
4.1.1.4 - Create Registry
4.1.1.4.1 - 1.1
scpcli scr registry create
--public_visible_enabled <value>
--public_acl_resources <value>
--private_acl_resources <value>
--private_acl_enabled <value>
--name <value>
[--public_acl_enabled <value>]
[--public_endpoint_enabled <value>]
[--tags <value>]
Description
Registry 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_visible_enabled required | boolean | 가시성 Public 선택 여부 | True |
| public_acl_resources required | array | Public 접근 허용 리소스 리스트 | '{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}' |
| private_acl_resources required | array | Private 접근 허용 리소스 리스트 | '{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}' |
| private_acl_enabled required | boolean | Private 접근 제어 활성화 | True |
| name required | string | Registry명 | sample |
| public_acl_enabled optional | boolean | Public 접근 제어 활성화 | True |
| public_endpoint_enabled optional | boolean | Public Endpoint 활성화 | True |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| message | 설명 | Carpe diem. |
| state | Registry 상태 | Running |
4.1.1.4.2 - 1.0
scpcli scr registry create
--public_visible_enabled <value>
--public_acl_resources <value>
--private_acl_resources <value>
--private_acl_enabled <value>
--name <value>
[--public_acl_enabled <value>]
[--public_endpoint_enabled <value>]
[--tags <value>]
Description
Registry 생성
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_visible_enabled required | boolean | 가시성 Public 선택 여부 | True |
| public_acl_resources required | array | Public 접근 허용 리소스 리스트 | '{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}' |
| private_acl_resources required | array | Private 접근 허용 리소스 리스트 | '{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}' |
| private_acl_enabled required | boolean | Private 접근 제어 활성화 | True |
| name required | string | Registry명 | sample |
| public_acl_enabled optional | boolean | Public 접근 제어 활성화 | True |
| public_endpoint_enabled optional | boolean | Public Endpoint 활성화 | True |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| message | 설명 | Carpe diem. |
| state | Registry 상태 | Running |
4.1.1.5 - Create Repository
4.1.1.5.1 - 1.1
scpcli scr repository create
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
--locked <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_tag_expression <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>
--registry_id <value>
--name <value>
--description <value>
[--tags <value>]
[--critical_limit <value>]
[--high_limit <value>]
Description
Repository 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| severity_limit required | string | 취약점 레벨 | High |
| secret_excepted required | boolean | Secret 제외 여부 | True |
| scan_policy_enabled required | boolean | 스캔 제외 정책 여부 | True |
| language_excepted required | boolean | Language 제외 여부 | True |
| fixed_version_excepted required | boolean | Fixed version 제외 여부 | True |
| auto_scan_enabled required | boolean | 이미지 자동 스캔 여부 | True |
| vulnerable_image_pull_prevented required | boolean | 취약점이 있는 이미지 Pull 제한 여부 | True |
| unscanned_image_pull_prevented required | boolean | 스캔 되지 않은 이미지 Pull 제한 여부 | True |
| unmodified_excepted required | boolean | 수정 버전이 없는 취약점 제외 여부 | True |
| locked required | boolean | Locked | True |
| untagged_rule_enabled required | boolean | Untagged Image 자동 삭제 활성화 | True |
| untagged_rule_duration required | integer | Untagged Image 자동 삭제 기한 | 90 |
| outdated_rule_tag_expression required | string | Tagged rule tag expression | * |
| outdated_rule_enabled required | boolean | Tagged rule enabled | True |
| outdated_rule_duration required | integer | Tagged rule duration | 90 |
| lifecycle_policy_enabled required | boolean | Lifecycle 정책 활성화 | True |
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| name required | string | Repository명 | sample |
| description required | string | 설명 | Carpe diem. |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
| critical_limit optional | integer | Critical 심각도 | 20 |
| high_limit optional | integer | High 심각도 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| message | 설명 | Carpe diem. |
| state | Repository 상태 | Active |
4.1.1.5.2 - 1.0
scpcli scr repository create
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
--locked <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>
--registry_id <value>
--name <value>
--description <value>
[--tags <value>]
[--critical_limit <value>]
[--high_limit <value>]
Description
Repository 생성
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| severity_limit required | string | 취약점 레벨 | High |
| secret_excepted required | boolean | Secret 제외 여부 | True |
| scan_policy_enabled required | boolean | 스캔 제외 정책 여부 | True |
| language_excepted required | boolean | Language 제외 여부 | True |
| fixed_version_excepted required | boolean | Fixed version 제외 여부 | True |
| auto_scan_enabled required | boolean | 이미지 자동 스캔 여부 | True |
| vulnerable_image_pull_prevented required | boolean | 취약점이 있는 이미지 Pull 제한 여부 | True |
| unscanned_image_pull_prevented required | boolean | 스캔 되지 않은 이미지 Pull 제한 여부 | True |
| unmodified_excepted required | boolean | 수정 버전이 없는 취약점 제외 여부 | True |
| locked required | boolean | Locked | True |
| untagged_rule_enabled required | boolean | Untagged Image 자동 삭제 활성화 | True |
| untagged_rule_duration required | integer | Untagged Image 자동 삭제 기한 | 90 |
| outdated_rule_enabled required | boolean | Tagged rule enabled | True |
| outdated_rule_duration required | integer | Tagged rule duration | 90 |
| lifecycle_policy_enabled required | boolean | Lifecycle 정책 활성화 | True |
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| name required | string | Repository명 | sample |
| description required | string | 설명 | Carpe diem. |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
| critical_limit optional | integer | Critical 심각도 | 20 |
| high_limit optional | integer | High 심각도 | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| message | 설명 | Carpe diem. |
| state | Repository 상태 | Active |
4.1.1.6 - Delete Image
4.1.1.6.1 - 1.1
scpcli scr image delete
--image_id <value>
Description
Image 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
4.1.1.6.2 - 1.0
scpcli scr image delete
--image_id <value>
Description
Image 삭제
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
4.1.1.7 - Delete Registry
4.1.1.7.1 - 1.1
scpcli scr registry delete
--registry_id <value>
Description
Registry 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
4.1.1.7.2 - 1.0
scpcli scr registry delete
--registry_id <value>
Description
Registry 삭제
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
4.1.1.8 - Delete Repository
4.1.1.8.1 - 1.1
scpcli scr repository delete
--repository_id <value>
Description
Repository 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
4.1.1.8.2 - 1.0
scpcli scr repository delete
--repository_id <value>
Description
Repository 삭제
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
4.1.1.9 - Delete Tags
4.1.1.9.1 - 1.1
scpcli scr tag delete
--tags_id <value>
--tag_names <value>
Description
Tags 복수 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| tag_names required | array | 태그명 | [ |
4.1.1.9.2 - 1.0
scpcli scr tag delete
--tags_id <value>
--tag_names <value>
Description
Tags 복수 삭제
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| tag_names required | array | 태그명 | [ |
4.1.1.10 - Delete Tagses
4.1.1.10.1 - 1.1
scpcli scr tags delete
--tags_ids <value>
Description
Tags 복수 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_ids required | array | 태그 ID 목록 | [ |
4.1.1.10.2 - 1.0
scpcli scr tags delete
--tags_ids <value>
Description
Tags 복수 삭제
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_ids required | array | 태그 ID 목록 | [ |
4.1.1.11 - Download Manifest
4.1.1.11.1 - 1.1
scpcli scr tags manifest show
--tags_id <value>
Description
매니페스트 파일 다운로드
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
Responses
| Name | Description | Example |
|---|
4.1.1.11.2 - 1.0
scpcli scr tags manifest show
--tags_id <value>
Description
매니페스트 파일 다운로드
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
Responses
| Name | Description | Example |
|---|
4.1.1.12 - List Connectable Resources
4.1.1.12.1 - 1.1
scpcli scr registry connectable-resource list
Description
get connectable domains
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 558496f6c49d43459e61e191fb3c08fe |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| name | Registry명 | sample |
| private_domain | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com |
| public_domain | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com |
| type | 자원 타입 | container-registry |
4.1.1.12.2 - 1.0
scpcli scr registry connectable-resource list
Description
get connectable domains
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 558496f6c49d43459e61e191fb3c08fe |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| name | Registry명 | sample |
| private_domain | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com |
| public_domain | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com |
| type | 자원 타입 | container-registry |
4.1.1.13 - List Images
4.1.1.13.1 - 1.1
scpcli scr repository image list
--repository_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
Description
Image 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| name optional | string | 이미지명 | sample |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| created_at | 생성일시 | 2024-08-15T13:05:09.701645823+09:00 |
| modified_at | 수정일시 | 2024-08-16T16:06:09.701645823+09:00 |
| name | 이미지명 | sample |
| private_endpoint_url | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817 |
| public_endpoint_url | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817 |
| pull_count | Pull 횟수 | 20 |
| registry_id | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| repository_id | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| state | 이미지 상태 | Active |
4.1.1.13.2 - 1.0
scpcli scr repository image list
--repository_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
Description
Image 목록 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| name optional | string | 이미지명 | sample |
Responses
| Name | Description | Example |
|---|---|---|
| id | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| created_at | 생성일시 | 2024-08-15T13:05:09.701645823+09:00 |
| modified_at | 수정일시 | 2024-08-16T16:06:09.701645823+09:00 |
| name | 이미지명 | sample |
| private_endpoint_url | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817 |
| public_endpoint_url | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817 |
| pull_count | Pull 횟수 | 20 |
| registry_id | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| repository_id | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| state | 이미지 상태 | Active |
4.1.1.14 - List Registries
4.1.1.14.1 - 1.1
scpcli scr registry list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
Description
Registry 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| name optional | string | Registry명 | sample |
| state optional | string | Registry 상태 | Running |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| bucket_name | Bucket명 | 4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Registry명 | sample |
| private_domain | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com |
| public_domain | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com |
| public_visible_enabled | 가시성 Public 선택 여부 | True |
| state | Registry 상태 | Running |
4.1.1.14.2 - 1.0
scpcli scr registry list
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
[--state <value>]
Description
Registry 목록 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| name optional | string | Registry명 | sample |
| state optional | string | Registry 상태 | Running |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| bucket_name | Bucket명 | 4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Registry명 | sample |
| private_domain | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com |
| public_domain | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com |
| public_visible_enabled | 가시성 Public 선택 여부 | True |
| state | Registry 상태 | Running |
4.1.1.15 - List Repositories
4.1.1.15.1 - 1.1
scpcli scr registry repository list
--registry_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
Description
Repository 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| name optional | string | Repository명 | sample |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Repository명 | sample |
| registry_id | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| state | Repository 상태 | Active |
4.1.1.15.2 - 1.0
scpcli scr registry repository list
--registry_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--name <value>]
Description
Repository 목록 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| name optional | string | Repository명 | sample |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Repository명 | sample |
| registry_id | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| state | Repository 상태 | Active |
4.1.1.16 - List Tagses
4.1.1.16.1 - 1.1
scpcli scr image tags list
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]
Description
Tags 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| reference_tags optional | string | 참조 중인 tags 목록 | ["sample"] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| hash_digest | Hash digest | |
| last_scanned_at | 마지막 스캔 일시 | 2024-08-15T13:05:09.701645823+09:00 |
| lock_policy | Lock 정책 | |
| modified_at | 수정일시 | 2024-08-16T16:06:09.701645823+09:00 |
| private_endpoint_url | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd |
| public_endpoint_url | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd |
| re_scan_needed | 취약점 점검 재시도 필요 여부 | True |
| reference_tags | 참조 중인 tags 목록 | [“sample”] |
| referenced_by | 참조 여부 | |
| scan_state | 스캔 상태 | Scanning state |
| scan_summary | ||
| size | 크기 | 10 |
| state | 태그 상태 | Active |
4.1.1.16.2 - 1.0
scpcli scr image tags list
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]
Description
Tags 목록 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| reference_tags optional | string | 참조 중인 tags 목록 | ["sample"] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| hash_digest | Hash digest | |
| last_scanned_at | 마지막 스캔 일시 | 2024-08-15T13:05:09.701645823+09:00 |
| lock_policy | Lock 정책 | |
| modified_at | 수정일시 | 2024-08-16T16:06:09.701645823+09:00 |
| private_endpoint_url | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd |
| public_endpoint_url | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd |
| re_scan_needed | 취약점 점검 재시도 필요 여부 | True |
| reference_tags | 참조 중인 tags 목록 | [“sample”] |
| referenced_by | 참조 여부 | |
| scan_state | 스캔 상태 | Scanning state |
| scan_summary | ||
| size | 크기 | 10 |
| state | 태그 상태 | Active |
4.1.1.17 - Run Image Lifecycle Policy Preview
4.1.1.17.1 - 1.1
scpcli scr image lifecycle-policy-preview run
--image_id <value>
Description
Lifecycle 정책 Preview 실행
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
Responses
| Name | Description | Example |
|---|
4.1.1.17.2 - 1.0
scpcli scr image lifecycle-policy-preview run
--image_id <value>
Description
Lifecycle 정책 Preview 실행
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
Responses
| Name | Description | Example |
|---|
4.1.1.18 - Show Image
4.1.1.18.1 - 1.1
scpcli scr image show
--image_id <value>
Description
Image 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Carpe diem. |
| lifecycle_policy | Lifecycle 정책 | |
| lock_policy | Lock 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 이미지명 | sample |
| pull_count | Pull 횟수 | 100 |
| pull_policy | Pull 정책 | |
| registry_id | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| repository_id | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| scan_policy | Scan 정책 | |
| state | 이미지 상태 | Active |
4.1.1.18.2 - 1.0
scpcli scr image show
--image_id <value>
Description
Image 상세 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Carpe diem. |
| lifecycle_policy | Lifecycle 정책 | |
| lock_policy | Lock 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 이미지명 | sample |
| pull_count | Pull 횟수 | 100 |
| pull_policy | Pull 정책 | |
| registry_id | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| repository_id | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| scan_policy | Scan 정책 | |
| state | 이미지 상태 | Active |
4.1.1.19 - Show Image Lifecycle Policy Preview
4.1.1.19.1 - 1.1
scpcli scr image lifecycle-policy-preview show
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]
Description
Lifecycle 정책 Preview 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| reference_tags optional | string | 참조 중인 tags 목록 | ["sample"] |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2024-08-15T13:05:09.701645823+09:00 |
| hash_digest | Hash digest | |
| reference_tags | 참조 중인 tags 목록 | [“sample”] |
| state | 태그 상태 | Active |
4.1.1.19.2 - 1.0
scpcli scr image lifecycle-policy-preview show
--image_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--reference_tags <value>]
Description
Lifecycle 정책 Preview 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| reference_tags optional | string | 참조 중인 tags 목록 | ["sample"] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| hash_digest | Hash digest | |
| last_scanned_at | 마지막 스캔 일시 | 2024-08-15T13:05:09.701645823+09:00 |
| lock_policy | Lock 정책 | |
| modified_at | 수정일시 | 2024-08-16T16:06:09.701645823+09:00 |
| private_endpoint_url | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd |
| public_endpoint_url | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo/sample_20240817@sha256:1234…abcd |
| re_scan_needed | 취약점 점검 재시도 필요 여부 | True |
| reference_tags | 참조 중인 tags 목록 | [“sample”] |
| referenced_by | 참조 여부 | |
| scan_state | 스캔 상태 | Scanning state |
| scan_summary | ||
| size | 크기 | 10 |
| state | 태그 상태 | Active |
4.1.1.20 - Show Registry
4.1.1.20.1 - 1.1
scpcli scr registry show
--registry_id <value>
Description
Registry 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| bucket_id | Bucket ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| bucket_name | Bucket명 | 4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup |
| bucket_usage | Bucket 사용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Registry명 | sample |
| private_acl_enabled | Private 접근 제어 활성화 | True |
| private_acl_resources | Private 접근 허용 리소스 리스트 | |
| private_domain | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com |
| public_acl_enabled | Public 접근 제어 활성화 | True |
| public_acl_resources | Public 접근 허용 리소스 리스트 | |
| public_domain | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com |
| public_endpoint_enabled | Public Endpoint 활성화 | True |
| public_visible_enabled | 가시성 Public 선택 여부 | True |
| state | Registry 상태 | Running |
4.1.1.20.2 - 1.0
scpcli scr registry show
--registry_id <value>
Description
Registry 상세 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| bucket_id | Bucket ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| bucket_name | Bucket명 | 4663afe94e7c4a2099968d90064ce218.scr.{region}.zgpsrpup |
| bucket_usage | Bucket 사용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Registry명 | sample |
| private_acl_enabled | Private 접근 제어 활성화 | True |
| private_acl_resources | Private 접근 허용 리소스 리스트 | |
| private_domain | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com |
| public_acl_enabled | Public 접근 제어 활성화 | True |
| public_acl_resources | Public 접근 허용 리소스 리스트 | |
| public_domain | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com |
| public_endpoint_enabled | Public Endpoint 활성화 | True |
| public_visible_enabled | 가시성 Public 선택 여부 | True |
| state | Registry 상태 | Running |
4.1.1.21 - Show Repository
4.1.1.21.1 - 1.1
scpcli scr repository show
--repository_id <value>
Description
Repository 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Carpe diem. |
| lifecycle_policy | Lifecycle 정책 | |
| lock_policy | Lock 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Repository명 | sample |
| private_endpoint_url | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo |
| public_endpoint_url | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo |
| pull_policy | Pull 정책 | |
| registry_id | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| scan_policy | Scan 정책 | |
| state | Repository 상태 | Active |
4.1.1.21.2 - 1.0
scpcli scr repository show
--repository_id <value>
Description
Repository 상세 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Carpe diem. |
| lifecycle_policy | Lifecycle 정책 | |
| lock_policy | Lock 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Repository명 | sample |
| private_endpoint_url | Private Endpoint URL | sample.scr.private.{region}.{environment}.samsungsdscloud.com:30748/sample-repo |
| public_endpoint_url | Public Endpoint URL | sample.scr.{region}.{environment}.samsungsdscloud.com:30748/sample-repo |
| pull_policy | Pull 정책 | |
| registry_id | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| scan_policy | Scan 정책 | |
| state | Repository 상태 | Active |
4.1.1.22 - Show Tags
4.1.1.22.1 - 1.1
scpcli scr tags show
--tags_id <value>
Description
Tags 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| created_at | 생성일시 | 2024-08-15T13:05:09.701645823+09:00 |
| hash_digest | Hash digest | |
| image_id | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| lock_policy | Lock 정책 | |
| manifest | 매니페스트 | |
| manifest_media_type | Manifest 미디어 타입 | |
| modified_at | 수정일시 | 2024-08-16T16:06:09.701645823+09:00 |
| reference_tags | 참조 중인 tags 목록 | [“sample”] |
| registry_id | ||
| repository_id | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| state | 태그 상태 | Active |
4.1.1.22.2 - 1.0
scpcli scr tags show
--tags_id <value>
Description
Tags 목록 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| created_at | 생성일시 | 2024-08-15T13:05:09.701645823+09:00 |
| hash_digest | Hash digest | |
| image_id | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| lock_policy | Lock 정책 | |
| manifest | 매니페스트 | |
| manifest_media_type | Manifest 미디어 타입 | |
| modified_at | 수정일시 | 2024-08-16T16:06:09.701645823+09:00 |
| reference_tags | 참조 중인 tags 목록 | [“sample”] |
| registry_id | ||
| repository_id | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| state | 태그 상태 | Active |
4.1.1.23 - Show Tags Packages
4.1.1.23.1 - 1.1
scpcli scr tags package show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]
Description
Package 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| os_language optional | string | OS 이름 또는 언어 이름 | Java |
| package_name optional | string | 패키지명 | com.example.sample |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| category | 카테고리 | Language |
| os_language | OS 이름 또는 언어 이름 | Java |
| package_name | 패키지명 | com.example.sample |
| scan_summary | ||
| type | Pipeline 유형 | os-pkg(binary) |
| version | OS 배포 버전 | 0.7.2-r3 |
4.1.1.23.2 - 1.0
scpcli scr tags package show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]
Description
Package 목록 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| os_language optional | string | OS 이름 또는 언어 이름 | Java |
| package_name optional | string | 패키지명 | com.example.sample |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
Responses
| Name | Description | Example |
|---|---|---|
| category | 카테고리 | Language |
| os_language | OS 이름 또는 언어 이름 | Java |
| package_name | 패키지명 | com.example.sample |
| scan_summary | ||
| type | Pipeline 유형 | os-pkg(binary) |
| version | OS 배포 버전 | 0.7.2-r3 |
4.1.1.24 - Show Tags Secrets
4.1.1.24.1 - 1.1
scpcli scr tags secret show
--tags_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--file_name <value>]
Description
Secret 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| file_name optional | string | 시크릿 파일명 | /certs/sample-key1.key |
Responses
| Name | Description | Example |
|---|---|---|
| category | 카테고리 | Language |
| file_name | 시크릿 파일명 | /certs/sample-key1.key |
| match | 시크릿 매치 | —–BEGIN SAMPLE KEY—–*********************… |
| rule_id | 시크릿 룰 ID | private-key |
| severity | 심각도 | High |
| start_line | 시크릿 시작점 | 1 |
| target | 대상 | /certs/sample-key1.key |
| title | 시크릿 제목 | Asymmetric Private Key |
| vulnerability_class | 시크릿 취약점 클래스 | secret |
4.1.1.24.2 - 1.0
scpcli scr tags secret show
--tags_id <value>
[--sort <value>]
[--page <value>]
[--size <value>]
[--file_name <value>]
Description
Secret 목록 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| file_name optional | string | 시크릿 파일명 | /certs/sample-key1.key |
Responses
| Name | Description | Example |
|---|---|---|
| category | 카테고리 | Language |
| file_name | 시크릿 파일명 | /certs/sample-key1.key |
| match | 시크릿 매치 | —–BEGIN SAMPLE KEY—–*********************… |
| rule_id | 시크릿 룰 ID | private-key |
| severity | 심각도 | High |
| start_line | 시크릿 시작점 | 1 |
| target | 대상 | /certs/sample-key1.key |
| title | 시크릿 제목 | Asymmetric Private Key |
| vulnerability_class | 시크릿 취약점 클래스 | secret |
4.1.1.25 - Show Tags Vulnerabilities
4.1.1.25.1 - 1.1
scpcli scr tags vulnerability show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]
[--update_version_available <value>]
[--severity <value>]
[--category <value>]
Description
취약점 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| os_language optional | string | OS 이름 또는 언어 이름 | Java |
| package_name optional | string | 패키지명 | com.example.sample |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| update_version_available optional | boolean | 수정 버전 | True |
| severity optional | array | 심각도 | H |
| category optional | string | 카테고리 | Language |
Responses
| Name | Description | Example |
|---|---|---|
| attack_complexity | 공격 복잡성 | |
| attack_vector | 공격 벡터 | |
| availability | 가용성 | |
| confidentiality | 기밀성 | |
| integrity | 무결성 | |
| privileges_required | 필요한 권한 | |
| scope | 공격 범위 | |
| user_interaction | 사용자 참여 정도 |
4.1.1.25.2 - 1.0
scpcli scr tags vulnerability show
--tags_id <value>
[--os_language <value>]
[--package_name <value>]
[--sort <value>]
[--page <value>]
[--size <value>]
[--update_version_available <value>]
[--severity <value>]
[--category <value>]
Description
취약점 목록 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| os_language optional | string | OS 이름 또는 언어 이름 | Java |
| package_name optional | string | 패키지명 | com.example.sample |
| sort optional | string | sort | name:asc |
| page optional | integer | page | 0 |
| size optional | integer | size | 20 |
| update_version_available optional | boolean | 수정 버전 | True |
| severity optional | array | 심각도 | H |
| category optional | string | 카테고리 | Language |
Responses
| Name | Description | Example |
|---|---|---|
| attack_complexity | 공격 복잡성 | |
| attack_vector | 공격 벡터 | |
| availability | 가용성 | |
| confidentiality | 기밀성 | |
| integrity | 무결성 | |
| privileges_required | 필요한 권한 | |
| scope | 공격 범위 | |
| user_interaction | 사용자 참여 정도 |
4.1.1.26 - Update Image Description
4.1.1.26.1 - 1.1
scpcli scr image description set
--image_id <value>
--description <value>
Description
Image 설명 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| description required | string | 설명 | Carpe diem. |
4.1.1.26.2 - 1.0
scpcli scr image description set
--image_id <value>
--description <value>
Description
Image 설명 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| description required | string | 설명 | Carpe diem. |
4.1.1.27 - Update Image Lifecycle Policy
4.1.1.27.1 - 1.1
scpcli scr image lifecycle-policy set
--image_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_tag_expression <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>
Description
Lifecycle 정책 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| untagged_rule_enabled required | boolean | Untagged Image 자동 삭제 활성화 | True |
| untagged_rule_duration required | integer | Untagged Image 자동 삭제 기한 | 90 |
| outdated_rule_tag_expression required | string | Tagged rule tag expression | * |
| outdated_rule_enabled required | boolean | Tagged rule enabled | True |
| outdated_rule_duration required | integer | Tagged rule duration | 90 |
| lifecycle_policy_enabled required | boolean | Lifecycle 정책 활성화 | True |
4.1.1.27.2 - 1.0
scpcli scr image lifecycle-policy set
--image_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>
Description
Lifecycle 정책 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| untagged_rule_enabled required | boolean | Untagged Image 자동 삭제 활성화 | True |
| untagged_rule_duration required | integer | Untagged Image 자동 삭제 기한 | 90 |
| outdated_rule_enabled required | boolean | Tagged rule enabled | True |
| outdated_rule_duration required | integer | Tagged rule duration | 90 |
| lifecycle_policy_enabled required | boolean | Lifecycle 정책 활성화 | True |
4.1.1.28 - Update Image Lock Policy
4.1.1.28.1 - 1.1
scpcli scr image lock-policy set
--image_id <value>
--locked <value>
Description
Lock 정책 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| locked required | boolean | Locked | True |
4.1.1.28.2 - 1.0
scpcli scr image lock-policy set
--image_id <value>
--locked <value>
Description
Lock 정책 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| locked required | boolean | Locked | True |
4.1.1.29 - Update Image Pull Policy
4.1.1.29.1 - 1.1
scpcli scr image pull-policy set
--image_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]
Description
Pull 정책 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| vulnerable_image_pull_prevented required | boolean | 취약점이 있는 이미지 Pull 제한 여부 | True |
| unscanned_image_pull_prevented required | boolean | 스캔 되지 않은 이미지 Pull 제한 여부 | True |
| unmodified_excepted required | boolean | 수정 버전이 없는 취약점 제외 여부 | True |
| critical_limit optional | integer | Critical 심각도 | 20 |
| high_limit optional | integer | High 심각도 | 20 |
4.1.1.29.2 - 1.0
scpcli scr image pull-policy set
--image_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]
Description
Pull 정책 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| vulnerable_image_pull_prevented required | boolean | 취약점이 있는 이미지 Pull 제한 여부 | True |
| unscanned_image_pull_prevented required | boolean | 스캔 되지 않은 이미지 Pull 제한 여부 | True |
| unmodified_excepted required | boolean | 수정 버전이 없는 취약점 제외 여부 | True |
| critical_limit optional | integer | Critical 심각도 | 20 |
| high_limit optional | integer | High 심각도 | 20 |
4.1.1.30 - Update Image Scan Policy
4.1.1.30.1 - 1.1
scpcli scr image scan-policy set
--image_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>
Description
Scan 정책 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| severity_limit required | string | 취약점 레벨 | High |
| secret_excepted required | boolean | Secret 제외 여부 | True |
| scan_policy_enabled required | boolean | 스캔 제외 정책 여부 | True |
| language_excepted required | boolean | Language 제외 여부 | True |
| fixed_version_excepted required | boolean | Fixed version 제외 여부 | True |
| auto_scan_enabled required | boolean | 이미지 자동 스캔 여부 | True |
4.1.1.30.2 - 1.0
scpcli scr image scan-policy set
--image_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>
Description
Scan 정책 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | 이미지 ID | 5b5ed4f2881a440583536fc1a8c39a28 |
| severity_limit required | string | 취약점 레벨 | High |
| secret_excepted required | boolean | Secret 제외 여부 | True |
| scan_policy_enabled required | boolean | 스캔 제외 정책 여부 | True |
| language_excepted required | boolean | Language 제외 여부 | True |
| fixed_version_excepted required | boolean | Fixed version 제외 여부 | True |
| auto_scan_enabled required | boolean | 이미지 자동 스캔 여부 | True |
4.1.1.31 - Update Private Acl
4.1.1.31.1 - 1.1
scpcli scr registry private-acl set
--registry_id <value>
--private_acl_resources <value>
--private_acl_enabled <value>
Description
Private 접근 제어 설정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| private_acl_resources required | array | Private 접근 허용 리소스 리스트 | '{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}' |
| private_acl_enabled required | boolean | Private 접근 제어 활성화 | True |
4.1.1.31.2 - 1.0
scpcli scr registry private-acl set
--registry_id <value>
--private_acl_resources <value>
--private_acl_enabled <value>
Description
Private 접근 제어 설정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| private_acl_resources required | array | Private 접근 허용 리소스 리스트 | '{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}' |
| private_acl_enabled required | boolean | Private 접근 제어 활성화 | True |
4.1.1.32 - Update Public Acl
4.1.1.32.1 - 1.1
scpcli scr registry public-acl set
--registry_id <value>
--public_acl_resources <value>
--public_acl_enabled <value>
Description
Public 접근 제어 설정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| public_acl_resources required | array | Public 접근 허용 리소스 리스트 | '{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}' |
| public_acl_enabled required | boolean | Public 접근 제어 활성화 | True |
4.1.1.32.2 - 1.0
scpcli scr registry public-acl set
--registry_id <value>
--public_acl_resources <value>
--public_acl_enabled <value>
Description
Public 접근 제어 설정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| public_acl_resources required | array | Public 접근 허용 리소스 리스트 | '{"resource_id": "558496f6c49d43459e61e191fb3c08fe", "resource_ips": "[]", "resource_name": "sample", "resource_type": "virtualServer"}' |
| public_acl_enabled required | boolean | Public 접근 제어 활성화 | True |
4.1.1.33 - Update Public Endpoint Enabled
4.1.1.33.1 - 1.1
scpcli scr registry public-endpoint-enabled set
--registry_id <value>
--public_endpoint_enabled <value>
Description
Public Endpoint 활성화
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| public_endpoint_enabled required | boolean | Public Endpoint 활성화 | True |
4.1.1.33.2 - 1.0
scpcli scr registry public-endpoint-enabled set
--registry_id <value>
--public_endpoint_enabled <value>
Description
Public Endpoint 활성화
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| registry_id required | string | Registry ID | rpqtmqgec3174541bbf77eecf2cd3585 |
| public_endpoint_enabled required | boolean | Public Endpoint 활성화 | True |
4.1.1.34 - Update Repository Description
4.1.1.34.1 - 1.1
scpcli scr repository description set
--repository_id <value>
--description <value>
Description
Repository 설명 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| description required | string | 설명 | Carpe diem. |
4.1.1.34.2 - 1.0
scpcli scr repository description set
--repository_id <value>
--description <value>
Description
Repository 설명 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| description required | string | 설명 | Carpe diem. |
4.1.1.35 - Update Repository Lifecycle Policy
4.1.1.35.1 - 1.1
scpcli scr repository lifecycle-policy set
--repository_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_tag_expression <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>
Description
Lifecycle 정책 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| untagged_rule_enabled required | boolean | Untagged Image 자동 삭제 활성화 | True |
| untagged_rule_duration required | integer | Untagged Image 자동 삭제 기한 | 90 |
| outdated_rule_tag_expression required | string | Tagged rule tag expression | * |
| outdated_rule_enabled required | boolean | Tagged rule enabled | True |
| outdated_rule_duration required | integer | Tagged rule duration | 90 |
| lifecycle_policy_enabled required | boolean | Lifecycle 정책 활성화 | True |
4.1.1.35.2 - 1.0
scpcli scr repository lifecycle-policy set
--repository_id <value>
--untagged_rule_enabled <value>
--untagged_rule_duration <value>
--outdated_rule_enabled <value>
--outdated_rule_duration <value>
--lifecycle_policy_enabled <value>
Description
Lifecycle 정책 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| untagged_rule_enabled required | boolean | Untagged Image 자동 삭제 활성화 | True |
| untagged_rule_duration required | integer | Untagged Image 자동 삭제 기한 | 90 |
| outdated_rule_enabled required | boolean | Tagged rule enabled | True |
| outdated_rule_duration required | integer | Tagged rule duration | 90 |
| lifecycle_policy_enabled required | boolean | Lifecycle 정책 활성화 | True |
4.1.1.36 - Update Repository Lock Policy
4.1.1.36.1 - 1.1
scpcli scr repository lock-policy set
--repository_id <value>
--locked <value>
Description
Lock 정책 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| locked required | boolean | Locked | True |
4.1.1.36.2 - 1.0
scpcli scr repository lock-policy set
--repository_id <value>
--locked <value>
Description
Lock 정책 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| locked required | boolean | Locked | True |
4.1.1.37 - Update Repository Pull Policy
4.1.1.37.1 - 1.1
scpcli scr repository pull-policy set
--repository_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]
Description
Pull 정책 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| vulnerable_image_pull_prevented required | boolean | 취약점이 있는 이미지 Pull 제한 여부 | True |
| unscanned_image_pull_prevented required | boolean | 스캔 되지 않은 이미지 Pull 제한 여부 | True |
| unmodified_excepted required | boolean | 수정 버전이 없는 취약점 제외 여부 | True |
| critical_limit optional | integer | Critical 심각도 | 20 |
| high_limit optional | integer | High 심각도 | 20 |
4.1.1.37.2 - 1.0
scpcli scr repository pull-policy set
--repository_id <value>
--vulnerable_image_pull_prevented <value>
--unscanned_image_pull_prevented <value>
--unmodified_excepted <value>
[--critical_limit <value>]
[--high_limit <value>]
Description
Pull 정책 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| vulnerable_image_pull_prevented required | boolean | 취약점이 있는 이미지 Pull 제한 여부 | True |
| unscanned_image_pull_prevented required | boolean | 스캔 되지 않은 이미지 Pull 제한 여부 | True |
| unmodified_excepted required | boolean | 수정 버전이 없는 취약점 제외 여부 | True |
| critical_limit optional | integer | Critical 심각도 | 20 |
| high_limit optional | integer | High 심각도 | 20 |
4.1.1.38 - Update Repository Scan Policy
4.1.1.38.1 - 1.1
scpcli scr repository scan-policy set
--repository_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>
Description
Scan 정책 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| severity_limit required | string | 취약점 레벨 | High |
| secret_excepted required | boolean | Secret 제외 여부 | True |
| scan_policy_enabled required | boolean | 스캔 제외 정책 여부 | True |
| language_excepted required | boolean | Language 제외 여부 | True |
| fixed_version_excepted required | boolean | Fixed version 제외 여부 | True |
| auto_scan_enabled required | boolean | 이미지 자동 스캔 여부 | True |
4.1.1.38.2 - 1.0
scpcli scr repository scan-policy set
--repository_id <value>
--severity_limit <value>
--secret_excepted <value>
--scan_policy_enabled <value>
--language_excepted <value>
--fixed_version_excepted <value>
--auto_scan_enabled <value>
Description
Scan 정책 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| repository_id required | string | Repository ID | e5611ca6c1484df480668c5adce8b078 |
| severity_limit required | string | 취약점 레벨 | High |
| secret_excepted required | boolean | Secret 제외 여부 | True |
| scan_policy_enabled required | boolean | 스캔 제외 정책 여부 | True |
| language_excepted required | boolean | Language 제외 여부 | True |
| fixed_version_excepted required | boolean | Fixed version 제외 여부 | True |
| auto_scan_enabled required | boolean | 이미지 자동 스캔 여부 | True |
4.1.1.39 - Update Tags Lock Policy
4.1.1.39.1 - 1.1
scpcli scr tags lock-policy set
--tags_id <value>
--locked <value>
Description
태그 잠금 갱신
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| locked required | boolean | Locked | True |
4.1.1.39.2 - 1.0
scpcli scr tags lock-policy set
--tags_id <value>
--locked <value>
Description
태그 잠금 갱신
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags_id required | string | Tags ID | b48210c7a226460fa15b6e3e221b30b0 |
| locked required | boolean | Locked | True |
4.2 - Kubernetes
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Kubernetes 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
4.2.1 - CLIs
4.2.1.1 - Create Cluster
4.2.1.1.1 - 1.1
scpcli ske cluster create
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--service_watch_logging_enabled <value>
--security_group_id_list <value>
--name <value>
--kubernetes_version <value>
--cloud_logging_enabled <value>
[--private_endpoint_access_control_resources <value>]
[--public_endpoint_access_control_ip <value>]
[--tags <value>]
Description
create a cluster V1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| volume_id required | string | 볼륨 ID | ['bfdbabf2-04d9-4e8b-a205-020f8e6da438'] |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| service_watch_logging_enabled required | boolean | Service Watch 사용 여부 | true |
| security_group_id_list required | array | Security group ID 목록 | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| name required | string | 클러스터 이름 | sample-cluster |
| kubernetes_version required | string | 클러스터 버전 | v1.29.8 |
| cloud_logging_enabled required | boolean | 클라우드 로깅 사용 여부 | true |
| private_endpoint_access_control_resources optional | array | Private Endpoint 접근 제어 리소스 목록 | '{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}' |
| public_endpoint_access_control_ip optional | string | Public Endpoint 접근 제어 IP | 192.168.0.0 |
| tags optional | array | 태그 목록 | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| request_id | 요청 ID | 80a599e031e749b7b260868f441e862b |
| resource_id | 자원 ID | 70a599e031e749b7b260868f441e862b |
4.2.1.1.2 - 1.0
scpcli ske cluster create
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--name <value>
--kubernetes_version <value>
--cloud_logging_enabled <value>
[--private_endpoint_access_control_resources <value>]
[--public_endpoint_access_control_ip <value>]
[--tags <value>]
Description
create a cluster
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| volume_id required | string | 볼륨 ID | ['bfdbabf2-04d9-4e8b-a205-020f8e6da438'] |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| security_group_id_list required | array | Security group ID 목록 | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| name required | string | 클러스터 이름 | sample-cluster |
| kubernetes_version required | string | 클러스터 버전 | v1.29.8 |
| cloud_logging_enabled required | boolean | 클라우드 로깅 사용 여부 | true |
| private_endpoint_access_control_resources optional | array | Private Endpoint 접근 제어 리소스 목록 | '{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}' |
| public_endpoint_access_control_ip optional | string | Public Endpoint 접근 제어 IP | 192.168.0.0 |
| tags optional | array | 태그 목록 | '{"key": "Key", "value": "Value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| request_id | 요청 ID | 80a599e031e749b7b260868f441e862b |
| resource_id | 자원 ID | 70a599e031e749b7b260868f441e862b |
4.2.1.2 - Create Cluster Kubeconfig
4.2.1.2.1 - 1.1
scpcli ske cluster kubeconfig create
--cluster_id <value>
--kubeconfig_type <value>
Description
Create kubeconfig file for the cluster
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| kubeconfig_type required | **** | Kubeconfig 타입 (private/public) | private |
Responses
| Name | Description | Example |
|---|
4.2.1.2.2 - 1.0
scpcli ske cluster kubeconfig create
--cluster_id <value>
--kubeconfig_type <value>
Description
Create kubeconfig file for the cluster
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| kubeconfig_type required | **** | Kubeconfig 타입 (private/public) | private |
Responses
| Name | Description | Example |
|---|
4.2.1.3 - Create Nodepool
4.2.1.3.1 - 1.1
scpcli ske nodepool create
--pod_max_pids <value>
--max_pods <value>
--image_gc_low_threshold <value>
--image_gc_high_threshold <value>
--container_log_max_size <value>
--container_log_max_files <value>
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--server_group_id <value>]
[--taints <value>]
[--allowed_unsafe_sysctls <value>]
Description
create a nodepool V1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| pod_max_pids required | integer | 파드 최대 PID 수 | 4096 |
| max_pods required | integer | 노드당 최대 파드 수 | 110 |
| image_gc_low_threshold required | integer | 이미지 GC 하한 퍼센트 | 80 |
| image_gc_high_threshold required | integer | 이미지 GC 상한 퍼센트 | 85 |
| container_log_max_size required | integer | 컨테이너 로그 최대 사이즈 MB | 10 |
| container_log_max_files required | integer | 컨테이너 로그 최대 파일 수 | 5 |
| volume_type_name required | string | 볼륨 타입 이름 | SSD |
| volume_size required | integer | 볼륨 크기 | 104 |
| server_type_id required | string | 서버 타입 ID | 10a599e031e749b7b260868f441e862b |
| name required | string | 노드풀 이름 | sample-nodepool |
| kubernetes_version required | string | 쿠버네티스 버전 | v1.29.8 |
| keypair_name required | string | 키페어 이름 | test_keypair |
| is_auto_scale required | boolean | 자동 확장 사용 여부 | true |
| is_auto_recovery required | boolean | 자동 복구 사용 여부 | true |
| image_os_version required | string | 이미지 OS 버전 | 22.04 |
| image_os required | string | 이미지 OS | ubuntu |
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| custom_image_id optional | string | 커스텀 이미지 ID | 10a599e031e749b7b260868f441e862b |
| desired_node_count optional | integer | Desired node count (is_auto_scale = false) | 2 |
| labels optional | array | 노드풀 레이블 목록 | '{"key": "example.com/my-app", "value": "bar"}' |
| max_node_count optional | integer | Maximum node count (is_auto_scale = true) | 5 |
| min_node_count optional | integer | Minimum node count (is_auto_scale = true) | 1 |
| server_group_id optional | string | 서버 그룹 ID | 2b8d33d5-4de5-40a5-a34c-7e30204133xc |
| taints optional | array | 노드풀 테인트 목록 | '{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}' |
| allowed_unsafe_sysctls optional | string | unsafe sysctl 허용 | kernel.msg*,net.ipv4.route.min_pmtu |
Responses
| Name | Description | Example |
|---|---|---|
| id | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| advanced_settings | 노드풀 고급 설정 | |
| auto_recovery_enabled | 자동 복구 사용 여부 | true |
| auto_scale_enabled | 자동 확장 사용 여부 | true |
| cluster | 클러스터 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_node_count | 현재 노드 수 | 1 |
| desired_node_count | 요청 노드 수 | 2 |
| image | 이미지 | |
| keypair | 키페어 이름 | |
| kubernetes_version | 쿠버네티스 버전 | v1.29.8 |
| labels | 노드풀 레이블 목록 | |
| max_node_count | 최대 노드 수 | 5 |
| min_node_count | 최소 노드 수 | 1 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 노드풀 이름 | sample-nodepool |
| server_group_id | 서버 그룹 ID | 2b8d33d5-4de5-40a5-a34c-7e30204133xc |
| server_type | 서버 타입 | |
| status | 노드풀 상태 | Running |
| taints | 노드풀 테인트 목록 | |
| volume_size | 볼륨 크기 | 104 |
| volume_type | 볼륨 타입 |
4.2.1.3.2 - 1.0
scpcli ske nodepool create
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--taints <value>]
Description
create a nodepool
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_type_name required | string | 볼륨 타입 이름 | SSD |
| volume_size required | integer | 볼륨 크기 | 104 |
| server_type_id required | string | 서버 타입 ID | 10a599e031e749b7b260868f441e862b |
| name required | string | 노드풀 이름 | sample-nodepool |
| kubernetes_version required | string | 쿠버네티스 버전 | v1.29.8 |
| keypair_name required | string | 키페어 이름 | test_keypair |
| is_auto_scale required | boolean | 자동 확장 사용 여부 | true |
| is_auto_recovery required | boolean | 자동 복구 사용 여부 | true |
| image_os_version required | string | 이미지 OS 버전 | 22.04 |
| image_os required | string | 이미지 OS | ubuntu |
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| custom_image_id optional | string | 커스텀 이미지 ID | 10a599e031e749b7b260868f441e862b |
| desired_node_count optional | integer | Desired node count (is_auto_scale = false) | 2 |
| labels optional | array | 노드풀 레이블 목록 | '{"key": "example.com/my-app", "value": "bar"}' |
| max_node_count optional | integer | Maximum node count (is_auto_scale = true) | 5 |
| min_node_count optional | integer | Minimum node count (is_auto_scale = true) | 1 |
| taints optional | array | 노드풀 테인트 목록 | '{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| auto_recovery_enabled | 자동 복구 사용 여부 | true |
| auto_scale_enabled | 자동 확장 사용 여부 | true |
| cluster | 클러스터 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_node_count | 현재 노드 수 | 1 |
| desired_node_count | 요청 노드 수 | 2 |
| image | 이미지 | |
| keypair | 키페어 이름 | |
| kubernetes_version | 쿠버네티스 버전 | v1.29.8 |
| labels | 노드풀 레이블 목록 | |
| max_node_count | 최대 노드 수 | 5 |
| min_node_count | 최소 노드 수 | 1 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 노드풀 이름 | sample-nodepool |
| server_type | 서버 타입 | |
| status | 노드풀 상태 | Running |
| taints | 노드풀 테인트 목록 | |
| volume_size | 볼륨 크기 | 104 |
| volume_type | 볼륨 타입 |
4.2.1.4 - Delete Cluster
4.2.1.4.1 - 1.1
scpcli ske cluster delete
--cluster_id <value>
Description
delete a specific cluster
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
4.2.1.4.2 - 1.0
scpcli ske cluster delete
--cluster_id <value>
Description
delete a specific cluster
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
4.2.1.5 - Delete Nodepool
4.2.1.5.1 - 1.1
scpcli ske nodepool delete
--nodepool_id <value>
Description
delete a nodepool
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
4.2.1.5.2 - 1.0
scpcli ske nodepool delete
--nodepool_id <value>
Description
delete a nodepool
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
4.2.1.6 - List Clusters
4.2.1.6.1 - 1.1
scpcli ske cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--status <value>]
[--kubernetes_version <value>]
[--subnet_id <value>]
Description
get clusters list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 클러스터 이름 | sample-cluster |
| status optional | array | 클러스터 상태 | R |
| kubernetes_version optional | array | 클러스터 버전 | v |
| subnet_id optional | string | 클러스터 Subnet ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| created_at | 생성 시간 | 2025-03-31T00:23:17Z |
| kubernetes_version | 클러스터 버전 | v1.29.8 |
| modified_at | 수정 시간 | 2025-03-31T00:23:17Z |
| name | 클러스터 이름 | sample-cluster |
| node_count | 클러스터 노드 수 | 5 |
| status | 클러스터 상태 | RUNNING |
| subnet_id | 클러스터 Subnet ID | 023c57b14f11483689338d085e061492 |
4.2.1.6.2 - 1.0
scpcli ske cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--status <value>]
[--kubernetes_version <value>]
[--subnet_id <value>]
Description
get clusters list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 클러스터 이름 | sample-cluster |
| status optional | array | 클러스터 상태 | R |
| kubernetes_version optional | array | 클러스터 버전 | v |
| subnet_id optional | string | 클러스터 Subnet ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| created_at | 생성 시간 | 2025-03-31T00:23:17Z |
| kubernetes_version | 클러스터 버전 | v1.29.8 |
| modified_at | 수정 시간 | 2025-03-31T00:23:17Z |
| name | 클러스터 이름 | sample-cluster |
| node_count | 클러스터 노드 수 | 5 |
| status | 클러스터 상태 | RUNNING |
| subnet_id | 클러스터 Subnet ID | 023c57b14f11483689338d085e061492 |
4.2.1.7 - List Nodepool Nodes
4.2.1.7.1 - 1.1
scpcli ske nodepool node list
--nodepool_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--node_name <value>]
Description
Get nodepool node list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| node_name optional | string | 노드 이름 | ske-aug-rhel-0805-1-84d799f767-8dr2p |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| kubernetes_version | 쿠버네티스 버전 | v1.29.8 |
| name | 노드 이름 | ske-aug-rhel-0805-1-84d799f767-8dr2p |
| status | 노드풀 상태 | RUNNING |
4.2.1.7.2 - 1.0
scpcli ske nodepool node list
--nodepool_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--node_name <value>]
Description
Get nodepool node list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| node_name optional | string | 노드 이름 | ske-aug-rhel-0805-1-84d799f767-8dr2p |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| kubernetes_version | 쿠버네티스 버전 | v1.29.8 |
| name | 노드 이름 | ske-aug-rhel-0805-1-84d799f767-8dr2p |
| status | 노드풀 상태 | RUNNING |
4.2.1.8 - List Nodepools
4.2.1.8.1 - 1.1
scpcli ske nodepool list
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--nodepool_name <value>]
Description
get nodepools list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| nodepool_name optional | string | 노드풀 이름 | sample-nodepool |
Responses
| Name | Description | Example |
|---|---|---|
| id | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| auto_recovery_enabled | 자동 복구 사용 여부 | |
| auto_scale_enabled | 자동 확장 사용 여부 | |
| current_node_count | 현재 노드 수 | 1 |
| desired_node_count | 요청 노드 수 | 2 |
| image | 이미지 | |
| kubernetes_version | 쿠버네티스 버전 | v1.29.8 |
| name | 노드풀 이름 | sample-nodepool |
| server_type | 서버 타입 | |
| status | 노드풀 상태 | Running |
| volume_type | 볼륨 타입 |
4.2.1.8.2 - 1.0
scpcli ske nodepool list
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--nodepool_name <value>]
Description
get nodepools list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| nodepool_name optional | string | 노드풀 이름 | sample-nodepool |
Responses
| Name | Description | Example |
|---|---|---|
| id | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| auto_recovery_enabled | 자동 복구 사용 여부 | |
| auto_scale_enabled | 자동 확장 사용 여부 | |
| current_node_count | 현재 노드 수 | 1 |
| desired_node_count | 요청 노드 수 | 2 |
| image | 이미지 | |
| kubernetes_version | 쿠버네티스 버전 | v1.29.8 |
| name | 노드풀 이름 | sample-nodepool |
| server_type | 서버 타입 | |
| status | 노드풀 상태 | Running |
| volume_type | 볼륨 타입 |
4.2.1.9 - Set Cluster Logging
4.2.1.9.1 - 1.1
scpcli ske cluster logging set
--cluster_id <value>
--cloud_logging_enabled <value>
Description
Set logging on the cluster
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| cloud_logging_enabled required | boolean | 클라우드 로깅 사용 여부 | true |
4.2.1.9.2 - 1.0
scpcli ske cluster logging set
--cluster_id <value>
--cloud_logging_enabled <value>
Description
Set logging on the cluster
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| cloud_logging_enabled required | boolean | 클라우드 로깅 사용 여부 | true |
4.2.1.10 - Set Cluster Private Access Control
4.2.1.10.1 - 1.1
scpcli ske cluster private access control set
--cluster_id <value>
--private_endpoint_access_control_resources <value>
Description
set a private access control specific cluster
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| private_endpoint_access_control_resources required | array | '{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}' |
4.2.1.10.2 - 1.0
scpcli ske cluster private access control set
--cluster_id <value>
--private_endpoint_access_control_resources <value>
Description
set a private access control specific cluster
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| private_endpoint_access_control_resources required | array | '{"id": "2a9be312-5d4b-4bc8-b2ae-35100fa9241f", "name": "sample-name", "type": "vm"}' |
4.2.1.11 - Set Cluster Public Access Control
4.2.1.11.1 - 1.1
scpcli ske cluster public access control set
--cluster_id <value>
--public_endpoint_access_control_ip <value>
Description
set a public access control specific cluster
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| public_endpoint_access_control_ip required | string | Public Endpoint 접근 제어 IP | 192.168.0.0 |
4.2.1.11.2 - 1.0
scpcli ske cluster public access control set
--cluster_id <value>
--public_endpoint_access_control_ip <value>
Description
set a public access control specific cluster
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| public_endpoint_access_control_ip required | string | Public Endpoint 접근 제어 IP | 192.168.0.0 |
4.2.1.12 - Set Cluster Security Groups
4.2.1.12.1 - 1.1
scpcli ske cluster security group set
--cluster_id <value>
--security_group_id_list <value>
Description
Set Cluster Security Groups
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| security_group_id_list required | array | Security group ID 목록 | b |
4.2.1.12.2 - 1.0
scpcli ske cluster security group set
--cluster_id <value>
--security_group_id_list <value>
Description
Set Cluster Security Groups
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| security_group_id_list required | array | Security group ID 목록 | b |
4.2.1.13 - Set Cluster Service Watch Logging
4.2.1.13.1 - 1.1
scpcli ske cluster service watch logging set
--cluster_id <value>
--service_watch_logging_enabled <value>
Description
Set Service Watch logging on the cluster
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| service_watch_logging_enabled required | boolean | Service Watch 사용 여부 | true |
4.2.1.14 - Set Cluster Upgrade
4.2.1.14.1 - 1.1
scpcli ske cluster upgrade set
--cluster_id <value>
--kubernetes_version <value>
Description
upgrade a specific cluster
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| kubernetes_version required | string | 쿠버네티스 버전 | v1.29.8 |
4.2.1.14.2 - 1.0
scpcli ske cluster upgrade set
--cluster_id <value>
--kubernetes_version <value>
Description
upgrade a specific cluster
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| kubernetes_version required | string | 쿠버네티스 버전 | v1.29.8 |
4.2.1.15 - Set Nodepool
4.2.1.15.1 - 1.1
scpcli ske nodepool set
--nodepool_id <value>
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--max_node_count <value>]
[--min_node_count <value>]
Description
set a nodepool
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| desired_node_count optional | integer | 요청 노드 수 | 2 |
| is_auto_recovery optional | boolean | 자동 복구 사용 여부 | true |
| is_auto_scale optional | boolean | 자동 확장 사용 여부 | true |
| max_node_count optional | integer | 최대 노드 수 | 5 |
| min_node_count optional | integer | 최소 노드 수 | 1 |
4.2.1.15.2 - 1.0
scpcli ske nodepool set
--nodepool_id <value>
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--max_node_count <value>]
[--min_node_count <value>]
Description
set a nodepool
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| desired_node_count optional | integer | 요청 노드 수 | 2 |
| is_auto_recovery optional | boolean | 자동 복구 사용 여부 | true |
| is_auto_scale optional | boolean | 자동 확장 사용 여부 | true |
| max_node_count optional | integer | 최대 노드 수 | 5 |
| min_node_count optional | integer | 최소 노드 수 | 1 |
4.2.1.16 - Set Nodepool Labels
4.2.1.16.1 - 1.1
scpcli ske nodepool labels set
--nodepool_id <value>
--labels <value>
Description
set nodepool labels
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| labels required | array | '{"key": "example.com/my-app", "value": "bar"}' |
4.2.1.16.2 - 1.0
scpcli ske nodepool labels set
--nodepool_id <value>
--labels <value>
Description
set nodepool labels
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| labels required | array | '{"key": "example.com/my-app", "value": "bar"}' |
4.2.1.17 - Set Nodepool Taints
4.2.1.17.1 - 1.1
scpcli ske nodepool taints set
--nodepool_id <value>
--taints <value>
Description
set nodepool taints
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| taints required | array | '{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}' |
4.2.1.17.2 - 1.0
scpcli ske nodepool taints set
--nodepool_id <value>
--taints <value>
Description
set nodepool taints
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| taints required | array | '{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}' |
4.2.1.18 - Set Nodepool Upgrade
4.2.1.18.1 - 1.1
scpcli ske nodepool upgrade set
--nodepool_id <value>
--os_version <value>
Description
upgrade a nodepool
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| os_version required | string | 이미지 OS 버전 | 22.04 |
4.2.1.18.2 - 1.0
scpcli ske nodepool upgrade set
--nodepool_id <value>
Description
upgrade a nodepool
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
4.2.1.19 - Show Cluster
4.2.1.19.1 - 1.1
scpcli ske cluster show
--cluster_id <value>
Description
show a cluster
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| cloud_logging_enabled | 클라우드 로깅 사용 여부 | true |
| cluster_namespace | 클러스터 네임스페이스 | sample-cluster-12345 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| kubernetes_version | 클러스터 버전 | v1.29.8 |
| managed_security_group | Managed Security Group | |
| max_node_count | 클러스터 최대 노드 수 | 5 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 클러스터 이름 | sample-cluster |
| node_count | 클러스터 노드 수 | 5 |
| private_endpoint_access_control_resources | Private Endpoint 접근 제어 리소스 목록 | |
| private_endpoint_url | Private Kubeconfig Download Yn | N |
| private_kubeconfig_download_yn | Cluster의 Private Endpoint URL | https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443 |
| public_endpoint_access_control_ip | Public Endpoint 접근 제어 IP | 192.168.0.0 |
| public_endpoint_url | Public Endpoint 접근 제어 IP | https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443 |
| public_kubeconfig_download_yn | Public Kubeconfig Download Yn | N |
| security_group_list | 연결된 Security Group | |
| service_watch_logging_enabled | Service Watch 사용 여부 | true |
| status | 클러스터 상태 | RUNNING |
| subnet | Cluster가 사용하는 Subnet | |
| volume | 연결된 File Storage | |
| vpc | Cluster가 사용하는 VPC |
4.2.1.19.2 - 1.0
scpcli ske cluster show
--cluster_id <value>
Description
show a cluster
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| cloud_logging_enabled | 클라우드 로깅 사용 여부 | true |
| cluster_namespace | 클러스터 네임스페이스 | sample-cluster-12345 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| kubernetes_version | 클러스터 버전 | v1.29.8 |
| managed_security_group | Managed Security Group | |
| max_node_count | 클러스터 최대 노드 수 | 5 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 클러스터 이름 | sample-cluster |
| node_count | 클러스터 노드 수 | 5 |
| private_endpoint_access_control_resources | Private Endpoint 접근 제어 리소스 목록 | |
| private_endpoint_url | Private Kubeconfig Download Yn | N |
| private_kubeconfig_download_yn | Cluster의 Private Endpoint URL | https://sample-cluster.ske.private.kr-west1.samsungsdscloud.com:6443 |
| public_endpoint_access_control_ip | Public Endpoint 접근 제어 IP | 192.168.0.0 |
| public_endpoint_url | Public Endpoint 접근 제어 IP | https://sample-cluster.ske.kr-west1.samsungsdscloud.com:6443 |
| public_kubeconfig_download_yn | Public Kubeconfig Download Yn | N |
| security_group_list | 연결된 Security Group | |
| status | 클러스터 상태 | RUNNING |
| subnet | Cluster가 사용하는 Subnet | |
| volume | 연결된 File Storage | |
| vpc | Cluster가 사용하는 VPC |
4.2.1.20 - Show Cluster User Kubeconfig
4.2.1.20.1 - 1.1
scpcli ske cluster user kubeconfig show
--cluster_id <value>
--kubeconfig_type <value>
Description
Show user kubeconfig for the cluster
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| kubeconfig_type required | **** | Kubeconfig 타입 (private/public) | private |
Responses
| Name | Description | Example |
|---|
4.2.1.20.2 - 1.0
scpcli ske cluster user kubeconfig show
--cluster_id <value>
--kubeconfig_type <value>
Description
Show user kubeconfig for the cluster
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | 클러스터 ID | 70a599e031e749b7b260868f441e862b |
| kubeconfig_type required | **** | Kubeconfig 타입 (private/public) | private |
Responses
| Name | Description | Example |
|---|
4.2.1.21 - Show Nodepool
4.2.1.21.1 - 1.1
scpcli ske nodepool show
--nodepool_id <value>
Description
show a nodepool
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| advanced_settings | 노드풀 고급 설정 | |
| auto_recovery_enabled | 자동 복구 사용 여부 | true |
| auto_scale_enabled | 자동 확장 사용 여부 | true |
| cluster | 클러스터 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_node_count | 현재 노드 수 | 1 |
| desired_node_count | 요청 노드 수 | 2 |
| image | 이미지 | |
| keypair | 키페어 이름 | |
| kubernetes_version | 쿠버네티스 버전 | v1.29.8 |
| labels | 노드풀 레이블 목록 | |
| max_node_count | 최대 노드 수 | 5 |
| min_node_count | 최소 노드 수 | 1 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 노드풀 이름 | sample-nodepool |
| server_group_id | 서버 그룹 ID | 2b8d33d5-4de5-40a5-a34c-7e30204133xc |
| server_type | 서버 타입 | |
| status | 노드풀 상태 | Running |
| taints | 노드풀 테인트 목록 | |
| volume_size | 볼륨 크기 | 104 |
| volume_type | 볼륨 타입 |
4.2.1.21.2 - 1.0
scpcli ske nodepool show
--nodepool_id <value>
Description
show a nodepool
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nodepool_id required | string | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 노드풀 ID | bdfda539-bd2e-4a5c-9021-ec6d52d1ca79 |
| account_id | Account ID | 617b3d0e90c24a5fa1f65a3824861354 |
| auto_recovery_enabled | 자동 복구 사용 여부 | true |
| auto_scale_enabled | 자동 확장 사용 여부 | true |
| cluster | 클러스터 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_node_count | 현재 노드 수 | 1 |
| desired_node_count | 요청 노드 수 | 2 |
| image | 이미지 | |
| keypair | 키페어 이름 | |
| kubernetes_version | 쿠버네티스 버전 | v1.29.8 |
| labels | 노드풀 레이블 목록 | |
| max_node_count | 최대 노드 수 | 5 |
| min_node_count | 최소 노드 수 | 1 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 노드풀 이름 | sample-nodepool |
| server_type | 서버 타입 | |
| status | 노드풀 상태 | Running |
| taints | 노드풀 테인트 목록 | |
| volume_size | 볼륨 크기 | 104 |
| volume_type | 볼륨 타입 |
5 - Networking
5.1 - Direct Connect
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Direct Connect 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
5.1.1 - CLIs
5.1.1.1 - Create Direct Connect
5.1.1.1.1 - 1.0
scpcli direct-connect direct-connect create
--vpc_id <value>
--name <value>
--bandwidth <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Direct Connect를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| name required | string | Direct Connect명 | - |
| bandwidth required | integer | 포트용량 | - |
| description optional | string | Direct Connect 설명 | - |
| firewall_enabled optional | boolean | Firewall 사용 | - |
| firewall_loggable optional | boolean | 방화벽 로깅 가능 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | |
| account_id | Account ID | |
| bandwidth | 포트용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect 설명 | |
| firewall_id | Firewall ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect명 | |
| state | 상태 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.1.1.2 - Create Routing Rule
5.1.1.2.1 - 1.0
scpcli direct-connect routing-rule create
--direct_connect_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
[--destination_resource_id <value>]
Description
Routing Rule을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | - |
| destination_type required | string | 목적지 타입 | - |
| destination_cidr required | string | 목적지 CIDR | - |
| description optional | string | 설명 | - |
| destination_resource_id optional | string | 목적지 자원 ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| destination_cidr | 목적지 CIDR | |
| destination_resource_id | 목적지 자원 ID | |
| destination_resource_name | 목적지 자원명 | |
| destination_type | 목적지 타입 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| owner_id | Routing Rule 소유자 ID | |
| owner_type | Routing Rule 소유자 타입 | |
| state | 상태 |
5.1.1.3 - Delete Direct Connect
5.1.1.3.1 - 1.0
scpcli direct-connect direct-connect delete
--direct_connect_id <value>
Description
Direct Connect를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | - |
5.1.1.4 - Delete Routing Rule
5.1.1.4.1 - 1.0
scpcli direct-connect routing-rule delete
--routing_rule_id <value>
--direct_connect_id <value>
Description
Routing Rule을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| direct_connect_id required | string | Direct Connect ID | - |
5.1.1.5 - List Direct Connects
5.1.1.5.1 - 1.0
scpcli 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
Direct Connect 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Direct Connect ID | - |
| name optional | string | Direct Connect명 | - |
| state optional | **** | 상태 | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | |
| account_id | Account ID | |
| bandwidth | 포트용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect 설명 | |
| firewall_id | Firewall ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect명 | |
| state | 상태 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.1.1.6 - List Routing Rules
5.1.1.6.1 - 1.0
scpcli 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
Routing Rule 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | - |
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | - |
| destination_type optional | **** | 목적지 타입 | - |
| destination_cidr optional | string | 목적지 CIDR | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| destination_cidr | 목적지 CIDR | |
| destination_resource_id | 목적지 자원 ID | |
| destination_resource_name | 목적지 자원명 | |
| destination_type | 목적지 타입 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| owner_id | Routing Rule 소유자 ID | |
| owner_type | Routing Rule 소유자 타입 | |
| state | 상태 |
5.1.1.7 - Set Direct Connect
5.1.1.7.1 - 1.0
scpcli direct-connect direct-connect set
--direct_connect_id <value>
--description <value>
Description
Direct Connect를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | - |
| description required | string | Direct Connect 설명 | - |
5.1.1.8 - Show Direct Connect
5.1.1.8.1 - 1.0
scpcli direct-connect direct-connect show
--direct_connect_id <value>
Description
Direct Connect를 상세조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | |
| account_id | Account ID | |
| bandwidth | 포트용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect 설명 | |
| firewall_id | Firewall ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect명 | |
| state | 상태 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.2 - DNS
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 DNS 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | DEPRECATED | 20260331 |
| 1.2 | DEPRECATED | 20260331 |
| 1.3 | CURRENT | - |
5.2.1 - CLIs
5.2.1.1 - Activate Private DNS
5.2.1.1.1 - 1.3
scpcli dns private-dns activate
--name <value>
Description
Activate Private DNS
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.2.1.1.2 - 1.2
scpcli dns private-dns activate
--name <value>
Description
Activate Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
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 |
5.2.1.1.3 - 1.1
scpcli dns private-dns activate
--name <value>
Description
Activate Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 |
5.2.1.1.4 - 1.0
scpcli dns private-dns activate
--name <value>
Description
Activate Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
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 |
5.2.1.2 - Create Hosted Zone
5.2.1.2.1 - 1.3
scpcli dns hosted-zone create
--type <value>
--name <value>
[--description <value>]
[--private_dns_id <value>]
[--tags <value>]
Description
Create a new hosted zone.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type required | string | Type of zone | - |
| name required | string | name | my-zone.com |
| description optional | string | description | This is description |
| private_dns_id optional | string | Private DNS ID | - |
| 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 |
5.2.1.2.2 - 1.2
scpcli dns hosted-zone create
--name <value>
--email <value>
[--description <value>]
[--private_dns_id <value>]
[--tags <value>]
[--type <value>]
Description
Create a new hosted zone.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | name | - |
| email required | string | - | |
| description optional | string | description | - |
| private_dns_id optional | string | Private DNS ID | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| type optional | string | Type of zone | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| attributes | Key:Value pairs of information about this zone | |
| created_at | Created Date | |
| description | description | |
| hosted_zone_type | Hosted Zone type | |
| links | Links to resource | |
| masters | The servers to slave from to get DNS information | |
| name | name | |
| pool_id | Designate Pool ID | |
| private_dns_id | Private DNS ID | |
| private_dns_name | Private DNS Name | |
| project_id | ProjectID | |
| serial | serial number | |
| shared | True if the zone is shared with another account | |
| status | The status | |
| transferred_at | The last time an update was retrieved from the master servers | |
| ttl | TTL for the zone. | |
| type | Type of zone | |
| updated_at | Updated Date | |
| version | Version |
5.2.1.2.3 - 1.1
scpcli dns hosted-zone create
--name <value>
--email <value>
[--description <value>]
[--tags <value>]
[--type <value>]
Description
Create a new hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | name | - |
| email required | string | - | |
| description optional | string | description | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| type optional | string | Type of zone | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| attributes | Key:Value pairs of information about this zone | |
| created_at | Created Date | |
| description | description | |
| hosted_zone_type | Hosted Zone type | |
| links | Links to resource | |
| masters | The servers to slave from to get DNS information | |
| name | name | |
| pool_id | Designate Pool ID | |
| project_id | ProjectID | |
| serial | serial number | |
| shared | True if the zone is shared with another account | |
| status | The status | |
| transferred_at | The last time an update was retrieved from the master servers | |
| ttl | TTL for the zone. | |
| type | Type of zone | |
| updated_at | Updated Date | |
| version | Version |
5.2.1.2.4 - 1.0
scpcli dns hosted-zone create
--name <value>
--email <value>
[--description <value>]
[--tags <value>]
[--type <value>]
Description
Create a new hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | name | - |
| email required | string | - | |
| description optional | string | description | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| type optional | string | Type of zone | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| attributes | Key:Value pairs of information about this zone | |
| created_at | Created Date | |
| description | description | |
| hosted_zone_type | Hosted Zone type | |
| links | Links to resource | |
| masters | The servers to slave from to get DNS information | |
| name | name | |
| pool_id | Designate Pool ID | |
| project_id | ProjectID | |
| serial | serial number | |
| shared | True if the zone is shared with another account | |
| status | The status | |
| transferred_at | The last time an update was retrieved from the master servers | |
| ttl | TTL for the zone. | |
| type | Type of zone | |
| updated_at | Updated Date | |
| version | Version |
5.2.1.3 - Create Hosted Zone Record
5.2.1.3.1 - 1.3
scpcli 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
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| type required | string | Type of the record | - |
| records required | array | A list of data for this record | - |
| name required | string | name | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | records for the record | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.4 - Create Private DNS
5.2.1.4.1 - 1.3
scpcli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]
Description
Create Private DNS
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.2.1.4.2 - 1.2
scpcli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]
Description
Create Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
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 |
5.2.1.4.3 - 1.1
scpcli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]
Description
Create Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 |
5.2.1.4.4 - 1.0
scpcli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]
Description
Create Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
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 |
5.2.1.5 - Create Public Domain
5.2.1.5.1 - 1.2
scpcli 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 record
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| register_telno required | string | Register telephone number | - |
| register_name_ko required | string | Register Name Domestic | - |
| register_name_en required | string | Register Name Overseas | - |
| register_email required | string | Register email | - |
| postal_code required | string | Postal code | - |
| overseas_third_address required | string | Overseas address - State & Country | - |
| overseas_second_address required | string | Overseas address - City | - |
| overseas_first_address required | string | Overseas address - Address | - |
| name required | string | name | - |
| domestic_second_address_ko required | string | Domestic second address (KO) | - |
| domestic_second_address_en required | string | Domestic second address (EN) | - |
| domestic_first_address_ko required | string | Domestic first address (KO) | - |
| domestic_first_address_en required | string | Domestic first address (EN) | - |
| address_type required | string | Address type | - |
| auto_extension optional | boolean | Auto extension flag | - |
| description optional | string | description | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| address_type | Address type | |
| auto_extension | Auto extension flag | |
| created_at | Created Date | |
| created_by | Created By_ | |
| description | description | |
| domestic_address_en | Domestic Address (EN) | |
| domestic_address_ko | Domestic Address (KO) | |
| domestic_first_address_en | Domestic first address (EN) | |
| domestic_first_address_ko | Domestic first address (KO) | |
| domestic_second_address_en | Domestic second address (EN) | |
| domestic_second_address_ko | Domestic second address (KO) | |
| expired_date | Expired date | |
| modified_at | Modified Date | |
| modified_by | Modified By_ | |
| name | Public Domain Name | |
| overseas_address | Overseas Address | |
| overseas_first_address | Overseas address - Address | |
| overseas_second_address | Overseas address - City | |
| overseas_third_address | Overseas address - State & Country | |
| postal_code | Postal code | |
| register_email | Register email | |
| register_name_en | Register Name Overseas | |
| register_name_ko | Register Name Domestic | |
| register_telno | Register telephone number | |
| start_date | Start date | |
| status | The status |
5.2.1.5.2 - 1.1
scpcli 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 record
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| register_telno required | string | Register telephone number | - |
| register_name_ko required | string | Register Name Domestic | - |
| register_name_en required | string | Register Name Overseas | - |
| register_email required | string | Register email | - |
| postal_code required | string | Postal code | - |
| overseas_third_address required | string | Overseas address - State & Country | - |
| overseas_second_address required | string | Overseas address - City | - |
| overseas_first_address required | string | Overseas address - Address | - |
| name required | string | name | - |
| domestic_second_address_ko required | string | Domestic second address (KO) | - |
| domestic_second_address_en required | string | Domestic second address (EN) | - |
| domestic_first_address_ko required | string | Domestic first address (KO) | - |
| domestic_first_address_en required | string | Domestic first address (EN) | - |
| address_type required | string | Address type | - |
| auto_extension optional | boolean | Auto extension flag | - |
| description optional | string | description | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| address_type | Address type | |
| auto_extension | Auto extension flag | |
| created_at | Created Date | |
| created_by | Created By_ | |
| description | description | |
| domestic_address_en | Domestic Address (EN) | |
| domestic_address_ko | Domestic Address (KO) | |
| domestic_first_address_en | Domestic first address (EN) | |
| domestic_first_address_ko | Domestic first address (KO) | |
| domestic_second_address_en | Domestic second address (EN) | |
| domestic_second_address_ko | Domestic second address (KO) | |
| expired_date | Expired date | |
| modified_at | Modified Date | |
| modified_by | Modified By_ | |
| name | Public Domain Name | |
| overseas_address | Overseas Address | |
| overseas_first_address | Overseas address - Address | |
| overseas_second_address | Overseas address - City | |
| overseas_third_address | Overseas address - State & Country | |
| postal_code | Postal code | |
| register_email | Register email | |
| register_name_en | Register Name Overseas | |
| register_name_ko | Register Name Domestic | |
| register_telno | Register telephone number | |
| start_date | Start date | |
| status | The status |
5.2.1.5.3 - 1.0
scpcli 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 record
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| register_telno required | string | Register telephone number | - |
| register_name_ko required | string | Register Name Domestic | - |
| register_name_en required | string | Register Name Overseas | - |
| register_email required | string | Register email | - |
| postal_code required | string | Postal code | - |
| overseas_third_address required | string | Overseas address - State & Country | - |
| overseas_second_address required | string | Overseas address - City | - |
| overseas_first_address required | string | Overseas address - Address | - |
| name required | string | name | - |
| domestic_second_address_ko required | string | Domestic second address (KO) | - |
| domestic_second_address_en required | string | Domestic second address (EN) | - |
| domestic_first_address_ko required | string | Domestic first address (KO) | - |
| domestic_first_address_en required | string | Domestic first address (EN) | - |
| address_type required | string | Address type | - |
| auto_extension optional | boolean | Auto extension flag | - |
| description optional | string | description | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| address_type | Address type | |
| auto_extension | Auto extension flag | |
| created_at | Created Date | |
| created_by | Created By_ | |
| description | description | |
| domestic_address_en | Domestic Address (EN) | |
| domestic_address_ko | Domestic Address (KO) | |
| domestic_first_address_en | Domestic first address (EN) | |
| domestic_first_address_ko | Domestic first address (KO) | |
| domestic_second_address_en | Domestic second address (EN) | |
| domestic_second_address_ko | Domestic second address (KO) | |
| expired_date | Expired date | |
| modified_at | Modified Date | |
| modified_by | Modified By_ | |
| name | Public Domain Name | |
| overseas_address | Overseas Address | |
| overseas_first_address | Overseas address - Address | |
| overseas_second_address | Overseas address - City | |
| overseas_third_address | Overseas address - State & Country | |
| postal_code | Postal code | |
| register_email | Register email | |
| register_name_en | Register Name Overseas | |
| register_name_ko | Register Name Domestic | |
| register_telno | Register telephone number | |
| start_date | Start date | |
| status | The status |
5.2.1.6 - Create Public Domain Name
5.2.1.6.1 - 1.3
scpcli 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
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| register_telno required | string | Register telephone number | - |
| register_name_ko required | string | Register Name Domestic | - |
| register_name_en required | string | Register Name Overseas | - |
| register_email required | string | Register email | - |
| postal_code required | string | Postal code | - |
| overseas_third_address required | string | Overseas address - State & Country | - |
| overseas_second_address required | string | Overseas address - City | - |
| overseas_first_address required | string | Overseas address - Address | - |
| name required | string | name | - |
| domestic_second_address_ko required | string | Domestic second address (KO) | - |
| domestic_second_address_en required | string | Domestic second address (EN) | - |
| domestic_first_address_ko required | string | Domestic first address (KO) | - |
| domestic_first_address_en required | string | Domestic first address (EN) | - |
| address_type required | string | Address type | - |
| auto_extension optional | boolean | Auto extension flag | - |
| description optional | string | description | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| address_type | Address type | |
| auto_extension | Auto extension flag | |
| created_at | Created Date | |
| created_by | Created By_ | |
| description | description | |
| domestic_address_en | Domestic Address (EN) | |
| domestic_address_ko | Domestic Address (KO) | |
| domestic_first_address_en | Domestic first address (EN) | |
| domestic_first_address_ko | Domestic first address (KO) | |
| domestic_second_address_en | Domestic second address (EN) | |
| domestic_second_address_ko | Domestic second address (KO) | |
| expired_date | Expired date | |
| modified_at | Modified Date | |
| modified_by | Modified By_ | |
| name | Public Domain Name | |
| overseas_address | Overseas Address | |
| overseas_first_address | Overseas address - Address | |
| overseas_second_address | Overseas address - City | |
| overseas_third_address | Overseas address - State & Country | |
| postal_code | Postal code | |
| register_email | Register email | |
| register_name_en | Register Name Overseas | |
| register_name_ko | Register Name Domestic | |
| register_telno | Register telephone number | |
| start_date | Start date | |
| status | The status |
5.2.1.7 - Create Record
5.2.1.7.1 - 1.2
scpcli dns 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
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| type required | string | Type of the record | - |
| records required | array | A list of data for this record | - |
| name required | string | name | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | records for the record | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.7.2 - 1.1
scpcli dns 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
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| type required | string | Type of the record | - |
| records required | array | A list of data for this record | - |
| name required | string | name | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | records for the record | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.7.3 - 1.0
scpcli dns 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
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| type required | string | Type of the record | - |
| records required | array | A list of data for this record | - |
| name required | string | name | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | records for the record | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.8 - Delete Hosted Zone
5.2.1.8.1 - 1.3
scpcli dns hosted-zone delete
--hosted_zone_id <value>
Description
Delete a hosted zone
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
5.2.1.8.2 - 1.2
scpcli dns hosted-zone delete
--hosted_zone_id <value>
Description
Delete a hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
5.2.1.8.3 - 1.1
scpcli dns hosted-zone delete
--hosted_zone_id <value>
Description
Delete a hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
5.2.1.8.4 - 1.0
scpcli dns hosted-zone delete
--hosted_zone_id <value>
Description
Delete a hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
5.2.1.9 - Delete Hosted Zone Record
5.2.1.9.1 - 1.3
scpcli dns hosted-zone-record delete
--record_id <value>
--hosted_zone_id <value>
Description
Delete hosted zone record
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
5.2.1.10 - Delete Private DNS
5.2.1.10.1 - 1.3
scpcli dns private-dns delete
--private_dns_id <value>
Description
Delete Private DNS
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_dns_id required | string | Private DNS ID | 10fjkewefprivatedns3193rud543 |
5.2.1.10.2 - 1.2
scpcli dns private-dns delete
--private_dns_id <value>
Description
Delete Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_dns_id required | string | Private DNS ID | 10fjkewefprivatedns3193rud543 |
5.2.1.10.3 - 1.1
scpcli dns private-dns delete
--private_dns_id <value>
Description
Delete Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_dns_id required | string | Private DNS ID | 10fjkewefprivatedns3193rud543 |
5.2.1.10.4 - 1.0
scpcli dns private-dns delete
--private_dns_id <value>
Description
Delete Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_dns_id required | string | Private DNS ID | 10fjkewefprivatedns3193rud543 |
5.2.1.11 - Delete Record
5.2.1.11.1 - 1.2
scpcli dns record delete
--record_id <value>
--hosted_zone_id <value>
Description
Delete a recordset
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
5.2.1.11.2 - 1.1
scpcli dns record delete
--record_id <value>
--hosted_zone_id <value>
Description
Delete a recordset
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
5.2.1.11.3 - 1.0
scpcli dns record delete
--record_id <value>
--hosted_zone_id <value>
Description
Delete a recordset
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
5.2.1.12 - Get Public Domain Detail
5.2.1.12.1 - 1.2
scpcli dns public-domain-name show
--public_domain_id <value>
Description
Retrieve detailed information for a specific public domain by ID
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| address_type | Address type | |
| auto_extension | Auto extension flag | |
| created_at | Created Date | |
| created_by | Created By_ | |
| description | description | |
| domestic_address_en | Domestic Address (EN) | |
| domestic_address_ko | Domestic Address (KO) | |
| domestic_first_address_en | Domestic first address (EN) | |
| domestic_first_address_ko | Domestic first address (KO) | |
| domestic_second_address_en | Domestic second address (EN) | |
| domestic_second_address_ko | Domestic second address (KO) | |
| expired_date | Expired date | |
| modified_at | Modified Date | |
| modified_by | Modified By_ | |
| name | Public Domain Name | |
| overseas_address | Overseas Address | |
| overseas_first_address | Overseas address - Address | |
| overseas_second_address | Overseas address - City | |
| overseas_third_address | Overseas address - State & Country | |
| postal_code | Postal code | |
| register_email | Register email | |
| register_name_en | Register Name Overseas | |
| register_name_ko | Register Name Domestic | |
| register_telno | Register telephone number | |
| start_date | Start date | |
| status | The status |
5.2.1.12.2 - 1.1
scpcli dns public-domain-name show
--public_domain_id <value>
Description
Retrieve detailed information for a specific public domain by ID
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| address_type | Address type | |
| auto_extension | Auto extension flag | |
| created_at | Created Date | |
| created_by | Created By_ | |
| description | description | |
| domestic_address_en | Domestic Address (EN) | |
| domestic_address_ko | Domestic Address (KO) | |
| domestic_first_address_en | Domestic first address (EN) | |
| domestic_first_address_ko | Domestic first address (KO) | |
| domestic_second_address_en | Domestic second address (EN) | |
| domestic_second_address_ko | Domestic second address (KO) | |
| expired_date | Expired date | |
| modified_at | Modified Date | |
| modified_by | Modified By_ | |
| name | Public Domain Name | |
| overseas_address | Overseas Address | |
| overseas_first_address | Overseas address - Address | |
| overseas_second_address | Overseas address - City | |
| overseas_third_address | Overseas address - State & Country | |
| postal_code | Postal code | |
| register_email | Register email | |
| register_name_en | Register Name Overseas | |
| register_name_ko | Register Name Domestic | |
| register_telno | Register telephone number | |
| start_date | Start date | |
| status | The status |
5.2.1.12.3 - 1.0
scpcli dns public-domain-name show
--public_domain_id <value>
Description
Retrieve detailed information for a specific public domain by ID
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| address_type | Address type | |
| auto_extension | Auto extension flag | |
| created_at | Created Date | |
| created_by | Created By_ | |
| description | description | |
| domestic_address_en | Domestic Address (EN) | |
| domestic_address_ko | Domestic Address (KO) | |
| domestic_first_address_en | Domestic first address (EN) | |
| domestic_first_address_ko | Domestic first address (KO) | |
| domestic_second_address_en | Domestic second address (EN) | |
| domestic_second_address_ko | Domestic second address (KO) | |
| expired_date | Expired date | |
| modified_at | Modified Date | |
| modified_by | Modified By_ | |
| name | Public Domain Name | |
| overseas_address | Overseas Address | |
| overseas_first_address | Overseas address - Address | |
| overseas_second_address | Overseas address - City | |
| overseas_third_address | Overseas address - State & Country | |
| postal_code | Postal code | |
| register_email | Register email | |
| register_name_en | Register Name Overseas | |
| register_name_ko | Register Name Domestic | |
| register_telno | Register telephone number | |
| start_date | Start date | |
| status | The status |
5.2.1.13 - List Hosted Zone Records
5.2.1.13.1 - 1.3
scpcli 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
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| limit optional | integer | limit | - |
| marker optional | string | marker | - |
| sort_dir optional | string | sort direction | - |
| sort_key optional | string | sort key | - |
| name optional | string | name | - |
| exact_name optional | string | name | - |
| type optional | string | Type of the record | - |
| data optional | string | Record data | - |
| status optional | string | The status | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | A list of data for this record | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.14 - List Hosted Zones
5.2.1.14.1 - 1.3
scpcli dns hosted-zone list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--type <value>]
[--status <value>]
Description
Return list of hosted zones
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.2.1.14.2 - 1.2
scpcli dns hosted-zone list
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--email <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
Return list of hosted zones
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | name | - |
| exact_name optional | string | name | - |
| type optional | string | Type of zone | - |
| email optional | string | - | |
| status optional | string | The status | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
| page optional | integer | Page | - |
| size optional | integer | Size | - |
| sort optional | string | Sort | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| attributes | Key:Value pairs of information about this zone | |
| created_at | Created Date | |
| description | description | |
| hosted_zone_type | Hosted Zone type | |
| links | Links to resource | |
| masters | The servers to slave from to get DNS information | |
| name | name | |
| pool_id | Designate Pool ID | |
| private_dns_id | Private DNS ID | |
| private_dns_name | Private DNS Name | |
| project_id | ProjectID | |
| serial | serial number | |
| shared | True if the zone is shared with another account | |
| status | The status | |
| transferred_at | The last time an update was retrieved from the master servers | |
| ttl | TTL for the zone. | |
| type | Type of zone | |
| updated_at | Updated Date | |
| version | Version |
5.2.1.14.3 - 1.1
scpcli dns hosted-zone list
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--email <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
Return list of hosted zones
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | name | - |
| exact_name optional | string | name | - |
| type optional | string | Type of zone | - |
| email optional | string | - | |
| status optional | string | The status | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
| page optional | integer | Page | - |
| size optional | integer | Size | - |
| sort optional | string | Sort | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| attributes | Key:Value pairs of information about this zone | |
| created_at | Created Date | |
| description | description | |
| hosted_zone_type | Hosted Zone type | |
| links | Links to resource | |
| masters | The servers to slave from to get DNS information | |
| name | name | |
| pool_id | Designate Pool ID | |
| project_id | ProjectID | |
| serial | serial number | |
| shared | True if the zone is shared with another account | |
| status | The status | |
| transferred_at | The last time an update was retrieved from the master servers | |
| ttl | TTL for the zone. | |
| type | Type of zone | |
| updated_at | Updated Date | |
| version | Version |
5.2.1.14.4 - 1.0
scpcli dns hosted-zone list
[--limit <value>]
[--marker <value>]
[--sort_dir <value>]
[--sort_key <value>]
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--email <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]
Description
Return list of hosted zones
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | limit | - |
| marker optional | string | marker | - |
| sort_dir optional | string | sort direction | - |
| sort_key optional | string | sort key | - |
| name optional | string | name | - |
| exact_name optional | string | name | - |
| type optional | string | Type of zone | - |
| email optional | string | - | |
| status optional | string | The status | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| attributes | Key:Value pairs of information about this zone | |
| created_at | Created Date | |
| description | description | |
| hosted_zone_type | Hosted Zone type | |
| links | Links to resource | |
| masters | The servers to slave from to get DNS information | |
| name | name | |
| pool_id | Designate Pool ID | |
| project_id | ProjectID | |
| serial | serial number | |
| shared | True if the zone is shared with another account | |
| status | The status | |
| transferred_at | The last time an update was retrieved from the master servers | |
| ttl | TTL for the zone. | |
| type | Type of zone | |
| updated_at | Updated Date | |
| version | Version |
5.2.1.15 - List Private DNS
5.2.1.15.1 - 1.3
scpcli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]
Description
List all Private DNS
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.2.1.15.2 - 1.2
scpcli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]
Description
List all Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
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 |
5.2.1.15.3 - 1.1
scpcli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]
Description
List all Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 |
5.2.1.15.4 - 1.0
scpcli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]
Description
List all Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 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 |
5.2.1.16 - List Public Domain Names
5.2.1.16.1 - 1.3
scpcli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]
Description
Return list of Public Domain Names
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | - |
| created_by optional | string | Created By_ | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| created_at | Start date | |
| created_by | Start date | |
| expired_date | Expired date | |
| modified_at | Start date | |
| modified_by | Start date | |
| name | name | |
| register_email | Register email | |
| start_date | Start date | |
| status | The status |
5.2.1.17 - List Public Domains
5.2.1.17.1 - 1.2
scpcli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]
Description
List all Public Domains
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
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 | - |
| created_by optional | string | Created By_ | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| created_at | Start date | |
| created_by | Start date | |
| expired_date | Expired date | |
| modified_at | Start date | |
| modified_by | Start date | |
| name | name | |
| register_email | Register email | |
| start_date | Start date | |
| status | The status |
5.2.1.17.2 - 1.1
scpcli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]
Description
List all Public Domains
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 | - |
| created_by optional | string | Created By_ | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| created_at | Start date | |
| created_by | Start date | |
| expired_date | Expired date | |
| modified_at | Start date | |
| modified_by | Start date | |
| name | name | |
| register_email | Register email | |
| start_date | Start date | |
| status | The status |
5.2.1.17.3 - 1.0
scpcli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]
Description
List all Public Domains
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | name | - |
| created_by optional | string | Created By_ | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| created_at | Start date | |
| created_by | Start date | |
| expired_date | Expired date | |
| modified_at | Start date | |
| modified_by | Start date | |
| name | name | |
| register_email | Register email | |
| start_date | Start date | |
| status | The status |
5.2.1.18 - List Records
5.2.1.18.1 - 1.2
scpcli dns 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 recordset list in a hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| limit optional | integer | limit | - |
| marker optional | string | marker | - |
| sort_dir optional | string | sort direction | - |
| sort_key optional | string | sort key | - |
| name optional | string | name | - |
| exact_name optional | string | name | - |
| type optional | string | Type of the record | - |
| data optional | string | Record data | - |
| status optional | string | The status | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | A list of data for this record | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.18.2 - 1.1
scpcli dns 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 recordset list in a hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| limit optional | integer | limit | - |
| marker optional | string | marker | - |
| sort_dir optional | string | sort direction | - |
| sort_key optional | string | sort key | - |
| name optional | string | name | - |
| exact_name optional | string | name | - |
| type optional | string | Type of the record | - |
| data optional | string | Record data | - |
| status optional | string | The status | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | A list of data for this record | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.18.3 - 1.0
scpcli dns 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 recordset list in a hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| limit optional | integer | limit | - |
| marker optional | string | marker | - |
| sort_dir optional | string | sort direction | - |
| sort_key optional | string | sort key | - |
| name optional | string | name | - |
| exact_name optional | string | name | - |
| type optional | string | Type of the record | - |
| data optional | string | Record data | - |
| status optional | string | The status | - |
| description optional | string | description | - |
| ttl optional | integer | TTL for the zone. | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | A list of data for this record | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.19 - Set Hosted Zone Record
5.2.1.19.1 - 1.3
scpcli dns hosted-zone-record set
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]
Description
Update Hosted Zone record
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
| records optional | array | A list of data for this record | - |
| ttl optional | integer | TTL for the record | - |
5.2.1.20 - Set Private DNS
5.2.1.20.1 - 1.3
scpcli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]
Description
Update Private DNS
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.2.1.20.2 - 1.2
scpcli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]
Description
Update Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
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 |
5.2.1.20.3 - 1.1
scpcli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]
Description
Update Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 |
5.2.1.20.4 - 1.0
scpcli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]
Description
Update Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
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 |
5.2.1.21 - Set Public Domain Name
5.2.1.21.1 - 1.3
scpcli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]
Description
Update Public Domain Name
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
| auto_extension optional | boolean | Auto extension flag | - |
| description optional | string | description | - |
5.2.1.22 - Set Public Domain Name Whois Info
5.2.1.22.1 - 1.3
scpcli 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
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
| register_telno required | string | Register telephone number | - |
| register_email required | string | Register email | - |
| postal_code required | string | Postal code | - |
| overseas_third_address required | string | Overseas address - State & Country | - |
| overseas_second_address required | string | Overseas address - City | - |
| overseas_first_address required | string | Overseas address - Address | - |
| domestic_second_address_ko required | string | Domestic second address (KO) | - |
| domestic_second_address_en required | string | Domestic second address (EN) | - |
| domestic_first_address_ko required | string | Domestic first address (KO) | - |
| domestic_first_address_en required | string | Domestic first address (EN) | - |
| address_type required | string | Address type | - |
5.2.1.23 - Show Hosted Zone
5.2.1.23.1 - 1.3
scpcli dns hosted-zone show
--hosted_zone_id <value>
Description
Return details of a hosted zone.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
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 |
5.2.1.23.2 - 1.2
scpcli dns hosted-zone show
--hosted_zone_id <value>
Description
Return details of a hosted zone.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| attributes | Key:Value pairs of information about this zone | |
| created_at | Created Date | |
| description | description | |
| hosted_zone_type | Hosted Zone type | |
| links | Links to resource | |
| masters | The servers to slave from to get DNS information | |
| name | name | |
| pool_id | Designate Pool ID | |
| private_dns_id | Private DNS ID | |
| private_dns_name | Private DNS Name | |
| project_id | ProjectID | |
| serial | serial number | |
| shared | True if the zone is shared with another account | |
| status | The status | |
| transferred_at | The last time an update was retrieved from the master servers | |
| ttl | TTL for the zone. | |
| type | Type of zone | |
| updated_at | Updated Date | |
| version | Version |
5.2.1.23.3 - 1.1
scpcli dns hosted-zone show
--hosted_zone_id <value>
Description
Return details of a hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| attributes | Key:Value pairs of information about this zone | |
| created_at | Created Date | |
| description | description | |
| hosted_zone_type | Hosted Zone type | |
| links | Links to resource | |
| masters | The servers to slave from to get DNS information | |
| name | name | |
| pool_id | Designate Pool ID | |
| project_id | ProjectID | |
| serial | serial number | |
| shared | True if the zone is shared with another account | |
| status | The status | |
| transferred_at | The last time an update was retrieved from the master servers | |
| ttl | TTL for the zone. | |
| type | Type of zone | |
| updated_at | Updated Date | |
| version | Version |
5.2.1.23.4 - 1.0
scpcli dns hosted-zone show
--hosted_zone_id <value>
Description
Return details of a hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| attributes | Key:Value pairs of information about this zone | |
| created_at | Created Date | |
| description | description | |
| hosted_zone_type | Hosted Zone type | |
| links | Links to resource | |
| masters | The servers to slave from to get DNS information | |
| name | name | |
| pool_id | Designate Pool ID | |
| project_id | ProjectID | |
| serial | serial number | |
| shared | True if the zone is shared with another account | |
| status | The status | |
| transferred_at | The last time an update was retrieved from the master servers | |
| ttl | TTL for the zone. | |
| type | Type of zone | |
| updated_at | Updated Date | |
| version | Version |
5.2.1.24 - Show Hosted Zone Record
5.2.1.24.1 - 1.3
scpcli dns hosted-zone-record show
--record_id <value>
--hosted_zone_id <value>
Description
Get details of a hosted zone record
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | records for the record. | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.25 - Show Private DNS
5.2.1.25.1 - 1.3
scpcli dns private-dns show
--private_dns_id <value>
Description
Show Private DNS
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.2.1.25.2 - 1.2
scpcli dns private-dns show
--private_dns_id <value>
Description
Show Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
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 |
5.2.1.25.3 - 1.1
scpcli dns private-dns show
--private_dns_id <value>
Description
Show Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 |
5.2.1.25.4 - 1.0
scpcli dns private-dns show
--private_dns_id <value>
Description
Show Private DNS
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
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 |
5.2.1.26 - Show Public Domain Name
5.2.1.26.1 - 1.3
scpcli dns public-domain-name show
--public_domain_id <value>
Description
Return details of a public domain name
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| address_type | Address type | |
| auto_extension | Auto extension flag | |
| created_at | Created Date | |
| created_by | Created By_ | |
| description | description | |
| domestic_address_en | Domestic Address (EN) | |
| domestic_address_ko | Domestic Address (KO) | |
| domestic_first_address_en | Domestic first address (EN) | |
| domestic_first_address_ko | Domestic first address (KO) | |
| domestic_second_address_en | Domestic second address (EN) | |
| domestic_second_address_ko | Domestic second address (KO) | |
| expired_date | Expired date | |
| modified_at | Modified Date | |
| modified_by | Modified By_ | |
| name | Public Domain Name | |
| overseas_address | Overseas Address | |
| overseas_first_address | Overseas address - Address | |
| overseas_second_address | Overseas address - City | |
| overseas_third_address | Overseas address - State & Country | |
| postal_code | Postal code | |
| register_email | Register email | |
| register_name_en | Register Name Overseas | |
| register_name_ko | Register Name Domestic | |
| register_telno | Register telephone number | |
| start_date | Start date | |
| status | The status |
5.2.1.27 - Show Record
5.2.1.27.1 - 1.2
scpcli dns record show
--record_id <value>
--hosted_zone_id <value>
Description
Get details of a recordset
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | records for the record. | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.27.2 - 1.1
scpcli dns record show
--record_id <value>
--hosted_zone_id <value>
Description
Get details of a recordset
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | records for the record. | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.27.3 - 1.0
scpcli dns record show
--record_id <value>
--hosted_zone_id <value>
Description
Get details of a recordset
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Id | |
| action | current action in progress | |
| created_at | Created Date | |
| description | description | |
| links | Links to resource | |
| name | name | |
| project_id | ProjectID | |
| records | records for the record. | |
| status | The status | |
| ttl | TTL for the zone. | |
| type | Type of the record | |
| updated_at | Updated Date | |
| version | Version | |
| zone_id | ID for the zone that contains this record | |
| zone_name | The name of the zone that contains this record |
5.2.1.28 - Transfer Public Domain Name
5.2.1.28.1 - 1.3
scpcli dns public-domain-name-transfer update
--public_domain_id <value>
--type <value>
[--target_account_id <value>]
Description
Transfer Public Domain Name
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
| type required | string | Transfer operation type | - |
| target_account_id optional | string | Target account id (required when type=REQUEST) | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| auto_extension | Auto extension flag | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | description | |
| expired_date | Expired date | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Public Domain Name | |
| start_date | Start date | |
| state | State |
5.2.1.29 - Update auto_extension or description
5.2.1.29.1 - 1.2
scpcli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]
Description
Update auto_extension or description of a Public Domain
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
| auto_extension optional | boolean | Auto extension flag | - |
| description optional | string | description | - |
5.2.1.29.2 - 1.1
scpcli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]
Description
Update auto_extension or description of a Public Domain
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
| auto_extension optional | boolean | Auto extension flag | - |
| description optional | string | description | - |
5.2.1.29.3 - 1.0
scpcli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]
Description
Update auto_extension or description of a Public Domain
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
| auto_extension optional | boolean | Auto extension flag | - |
| description optional | string | description | - |
5.2.1.30 - Update Hosted Zone
5.2.1.30.1 - 1.3
scpcli dns hosted-zone set
--hosted_zone_id <value>
[--description <value>]
Description
Update a hosted zone.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| description optional | string | description | This is description |
5.2.1.30.2 - 1.2
scpcli dns hosted-zone update
--hosted_zone_id <value>
[--description <value>]
[--email <value>]
Description
Update a hosted zone.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| description optional | string | description | - |
| email optional | string | - |
5.2.1.30.3 - 1.1
scpcli dns hosted-zone update
--hosted_zone_id <value>
[--description <value>]
[--email <value>]
Description
Update a hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| description optional | string | description | - |
| email optional | string | - |
5.2.1.30.4 - 1.0
scpcli dns hosted-zone update
--hosted_zone_id <value>
[--description <value>]
[--email <value>]
Description
Update a hosted zone
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| hosted_zone_id required | string | Id | - |
| description optional | string | description | - |
| email optional | string | - |
5.2.1.31 - Update Record
5.2.1.31.1 - 1.2
scpcli dns record update
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]
Description
Update a recordset
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
| records optional | array | A list of data for this record | - |
| ttl optional | integer | TTL for the record | - |
5.2.1.31.2 - 1.1
scpcli dns record update
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]
Description
Update a recordset
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
| records optional | array | A list of data for this record | - |
| ttl optional | integer | TTL for the record | - |
5.2.1.31.3 - 1.0
scpcli dns record update
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]
Description
Update a recordset
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| record_id required | string | Record ID | - |
| hosted_zone_id required | string | Zone ID | - |
| records optional | array | A list of data for this record | - |
| ttl optional | integer | TTL for the record | - |
5.2.1.32 - Update WHOIS info for Public Domain
5.2.1.32.1 - 1.2
scpcli 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 WHOIS information and sync with DB for a public domain
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
| register_telno required | string | Register telephone number | - |
| register_email required | string | Register email | - |
| postal_code required | string | Postal code | - |
| overseas_third_address required | string | Overseas address - State & Country | - |
| overseas_second_address required | string | Overseas address - City | - |
| overseas_first_address required | string | Overseas address - Address | - |
| domestic_second_address_ko required | string | Domestic second address (KO) | - |
| domestic_second_address_en required | string | Domestic second address (EN) | - |
| domestic_first_address_ko required | string | Domestic first address (KO) | - |
| domestic_first_address_en required | string | Domestic first address (EN) | - |
| address_type required | string | Address type | - |
5.2.1.32.2 - 1.1
scpcli 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 WHOIS information and sync with DB for a public domain
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
| register_telno required | string | Register telephone number | - |
| register_email required | string | Register email | - |
| postal_code required | string | Postal code | - |
| overseas_third_address required | string | Overseas address - State & Country | - |
| overseas_second_address required | string | Overseas address - City | - |
| overseas_first_address required | string | Overseas address - Address | - |
| domestic_second_address_ko required | string | Domestic second address (KO) | - |
| domestic_second_address_en required | string | Domestic second address (EN) | - |
| domestic_first_address_ko required | string | Domestic first address (KO) | - |
| domestic_first_address_en required | string | Domestic first address (EN) | - |
| address_type required | string | Address type | - |
5.2.1.32.3 - 1.0
scpcli 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 WHOIS information and sync with DB for a public domain
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| public_domain_id required | string | Id | - |
| register_telno required | string | Register telephone number | - |
| register_email required | string | Register email | - |
| postal_code required | string | Postal code | - |
| overseas_third_address required | string | Overseas address - State & Country | - |
| overseas_second_address required | string | Overseas address - City | - |
| overseas_first_address required | string | Overseas address - Address | - |
| domestic_second_address_ko required | string | Domestic second address (KO) | - |
| domestic_second_address_en required | string | Domestic second address (EN) | - |
| domestic_first_address_ko required | string | Domestic first address (KO) | - |
| domestic_first_address_en required | string | Domestic first address (EN) | - |
| address_type required | string | Address type | - |
5.3 - Firewall
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다. 본 가이드는 Firewall 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
5.3.1 - CLIs
5.3.1.1 - Create Firewall Rule
5.3.1.1.1 - 1.0
scpcli 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
firewall rule 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| status required | string | Firewall rule 사용 여부 | - |
| source_address required | array | 출발지 주소 | 192.168.1.1 |
| service required | array | 서비스 포트 | '{"service_type": "TCP", "service_value": "443"}' |
| direction required | string | Firewall rule 방향 | - |
| destination_address required | array | 목적지 주소 | 10.0.0.1 |
| action required | string | Firewall rule 동작 | - |
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| description optional | string | Firewall rule 설명 | Firewall rule description example |
| order_direction optional | string | 순서 방향 | - |
| order_rule_id optional | string | 순서 규칙 ID | 043aa63459da466faad71fe4fe587031 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall rule ID | b156740b6335468d8354eb9ef8eddf5a |
| action | Firewall rule 동작 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall rule 설명 | Firewall rule description example |
| destination_address | 목적지 주소 | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | 목적지 인터페이스 이름 | IFW1-v1001dn |
| direction | Firewall rule 방향 | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall rule 이름 | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall rule 순서 | 100 |
| service | 서비스 포트 | |
| source_address | 출발지 주소 | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | 출발지 인터페이스 이름 | IFW1-v2501up |
| state | Firewall rule 상태 | |
| status | Firewall rule 사용 여부 | |
| vendor_rule_id | 벤더 규칙 ID | 72 |
5.3.1.2 - Delete Firewall Rule
5.3.1.2.1 - 1.0
scpcli firewall firewall-rule delete
--firewall_rule_id <value>
Description
firewall rule 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_rule_id required | string | Firewall rule ID | b156740b6335468d8354eb9ef8eddf5a |
5.3.1.3 - List Firewall Rules
5.3.1.3.1 - 1.0
scpcli 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
firewall rule 목록 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 출발지 IP | 192.168.1.1 |
| dst_ip optional | string | 목적지 IP | 192.168.1.1 |
| description optional | string | Firewall rule 설명 | Firewall rule description example |
| state optional | array | Firewall rule 상태 | - |
| status optional | **** | Firewall rule 사용 여부 | - |
| fetch_all optional | boolean | Firewall rule 전체 조회 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall rule ID | b156740b6335468d8354eb9ef8eddf5a |
| action | Firewall rule 동작 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall rule 설명 | Firewall rule description example |
| destination_address | 목적지 주소 | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | 목적지 인터페이스 이름 | IFW1-v1001dn |
| direction | Firewall rule 방향 | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall rule 이름 | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall rule 순서 | 100 |
| service | 서비스 포트 | |
| source_address | 출발지 주소 | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | 출발지 인터페이스 이름 | IFW1-v2501up |
| state | Firewall rule 상태 | |
| status | Firewall rule 사용 여부 | |
| vendor_rule_id | 벤더 규칙 ID | 72 |
5.3.1.4 - List Firewalls
5.3.1.4.1 - 1.0
scpcli firewall firewall list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_name <value>]
[--product_type <value>]
[--state <value>]
Description
firewall 목록 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 이름 | FW_IGW_secuVPC |
| vpc_name optional | string | VPC 명 | secuVPC |
| product_type optional | array | Firewall 상품 유형 | - |
| state optional | array | Firewall 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| flavor_name | Firewall 사이즈 이름 | SMALL |
| flavor_rule_quota | Firewall 규칙 수 제한 | 100 |
| fw_resource_id | FW 리소스 ID | 005fd1d30dea11f08a2c56773bef875b |
| loggable | 로그 사용 여부 | False |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall 이름 | FW_IGW_secuVPC |
| pre_product_id | 선행 상품 ID | 76479b7ffee1431198d9beb4502cda08 |
| product_type | Firewall 상품 유형 | |
| state | Firewall 상태 | |
| status | Firewall 활성 여부 | |
| total_rule_count | 전체 규칙 개수 | 8 |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | secuVPC |
5.3.1.5 - Set Firewall
5.3.1.5.1 - 1.0
scpcli firewall firewall set
--firewall_id <value>
[--flavor_name <value>]
[--loggable <value>]
Description
firewall 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_id required | string | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| flavor_name optional | string | Firewall 사이즈 이름 | - |
| loggable optional | boolean | 로그 사용 여부 | False |
5.3.1.6 - Set Firewall Rule
5.3.1.6.1 - 1.0
scpcli firewall firewall-rule set
--firewall_rule_id <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
[--description <value>]
Description
firewall rule 수정한다,
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_rule_id required | string | Firewall rule ID | b156740b6335468d8354eb9ef8eddf5a |
| source_address required | array | 출발지 주소 | 192.168.1.1 |
| service required | array | 서비스 포트 | '{"service_type": "TCP", "service_value": "443"}' |
| direction required | string | Firewall rule 방향 | - |
| destination_address required | array | 목적지 주소 | 10.0.0.1 |
| action required | string | Firewall rule 동작 | - |
| description optional | string | Firewall rule 설명 | Firewall rule description example |
5.3.1.7 - Show Firewall
5.3.1.7.1 - 1.0
scpcli firewall firewall show
--firewall_id <value>
Description
firewall 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| flavor_name | Firewall 사이즈 이름 | SMALL |
| flavor_rule_quota | Firewall 규칙 수 제한 | 100 |
| fw_resource_id | FW 리소스 ID | 005fd1d30dea11f08a2c56773bef875b |
| loggable | 로그 사용 여부 | False |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall 이름 | FW_IGW_secuVPC |
| pre_product_id | 선행 상품 ID | 76479b7ffee1431198d9beb4502cda08 |
| product_type | Firewall 상품 유형 | |
| state | Firewall 상태 | |
| status | Firewall 활성 여부 | |
| total_rule_count | 전체 규칙 개수 | 8 |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | secuVPC |
5.3.1.8 - Show Firewall Rule
5.3.1.8.1 - 1.0
scpcli firewall firewall-rule show
--firewall_rule_id <value>
Description
firewall rule 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 동작 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Firewall rule 설명 | Firewall rule description example |
| destination_address | 목적지 주소 | [‘10.0.0.1’, ‘10.0.0.2’] |
| destination_interface | 목적지 인터페이스 이름 | IFW1-v1001dn |
| direction | Firewall rule 방향 | |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Firewall rule 이름 | b156740b6335468d8354eb9ef8eddf5a |
| sequence | Firewall rule 순서 | 100 |
| service | 서비스 포트 | |
| source_address | 출발지 주소 | [‘192.168.1.1’, ‘192.168.1.2’] |
| source_interface | 출발지 인터페이스 이름 | IFW1-v2501up |
| state | Firewall rule 상태 | |
| status | Firewall rule 사용 여부 | |
| vendor_rule_id | 벤더 규칙 ID | 72 |
5.4 - Global CDN
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Global CDN 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
5.4.1 - CLIs
5.4.1.1 - Create Cdn Service
5.4.1.1.1 - 1.0
scpcli 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
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.4.1.2 - Delete Cdn Service
5.4.1.2.1 - 1.0
scpcli cdn cdn service delete
--id <value>
Description
delete cdn service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | cdn service id | - |
5.4.1.3 - Detail Cdn Service
5.4.1.3.1 - 1.0
scpcli cdn cdn service detail
--id <value>
Description
detail cdn service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.4.1.4 - List Cdn Service
5.4.1.4.1 - 1.0
scpcli 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
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.4.1.5 - Purge Cdn Service
5.4.1.5.1 - 1.0
scpcli cdn cdn service purge
--id <value>
--target_url <value>
--target_content <value>
[--custom_url <value>]
Description
purge cdn service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.4.1.6 - Start Cdn Service
5.4.1.6.1 - 1.0
scpcli cdn cdn service start
--id <value>
Description
start cdn service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.4.1.7 - Stop Cdn Service
5.4.1.7.1 - 1.0
scpcli cdn cdn service stop
--id <value>
Description
stop cdn service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
5.4.1.8 - Update Cdn Service
5.4.1.8.1 - 1.0
scpcli 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
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | - |
5.4.1.9 - Update Description of Cdn Service
5.4.1.9.1 - 1.0
scpcli cdn description update
--id <value>
--description <value>
Description
Update description of cdn service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | cdn service id | - |
| description required | string | Description | - |
5.5 - GSLB
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 GSLB 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | SUPPORTED | 20260531 |
| 1.1 | CURRENT | - |
5.5.1 - CLIs
5.5.1.1 - CreateGslb
5.5.1.1.1 - 1.1
scpcli 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
GSLB 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| protocol required | string | The GSLB Health Check Protocol. | - |
| resources required | array | '{"description": "", "destination": "", "region": "", "weight": 0}' | |
| name required | string | GSLB 이름 | - |
| env_usage required | string | GSLB 용도 | - |
| algorithm required | string | The GSLB Algorithm. | - |
| description optional | string | 설명 | - |
| tags optional | array | 태그 목록 | '{"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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| env_usage | GSLB 용도 | |
| health_check | ||
| linked_resource_count | GSLB 연결 대상 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | GSLB 이름 | |
| state | GSLB 상태. |
5.5.1.1.2 - 1.0
scpcli 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
GSLB 생성
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | GSLB 이름 | - |
| env_usage required | string | GSLB 용도 | - |
| algorithm required | string | The GSLB Algorithm. | - |
| description optional | string | 설명 | - |
| tags optional | array | 태그 목록 | '{"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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| env_usage | GSLB 용도 | |
| health_check | ||
| linked_resource_count | GSLB 연결 대상 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | GSLB 이름 | |
| state | GSLB 상태. |
5.5.1.2 - DeleteGslb
5.5.1.2.1 - 1.1
scpcli gslb gslb delete
--gslb_id <value>
Description
GSLB 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
5.5.1.2.2 - 1.0
scpcli gslb gslb delete
--gslb_id <value>
Description
GSLB 삭제
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
5.5.1.3 - ListGslbResources
5.5.1.3.1 - 1.1
scpcli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
GSLB Resource 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| destination | GSLB Resource 목적지. | |
| health_check_status | GSLB Resource 연결 상태 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| region | GSLB Resource 위치 | |
| status | GSLB Resource 사용 여부 | |
| weight | GSLB Resource 가중치. |
5.5.1.3.2 - 1.0
scpcli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
GSLB Resource 목록 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| destination | GSLB Resource 목적지. | |
| disabled | GSLB Resource 사용 여부. | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| region | GSLB Resource 위치 | |
| weight | GSLB Resource 가중치. |
5.5.1.4 - ListGslbs
5.5.1.4.1 - 1.1
scpcli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]
Description
GSLB 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | GSLB 상태. | - |
| name optional | string | GSLB 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| env_usage | GSLB 용도 | |
| linked_resource_count | GSLB 연결 대상 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | GSLB 이름 | |
| state | GSLB 상태. |
5.5.1.4.2 - 1.0
scpcli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]
Description
GSLB 목록 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | GSLB 상태. | - |
| name optional | string | GSLB 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| env_usage | GSLB 용도 | |
| linked_resource_count | GSLB 연결 대상 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | GSLB 이름 | |
| state | GSLB 상태. |
5.5.1.5 - ListGslbsRegionalRoutingControl
5.5.1.5.1 - 1.1
scpcli gslb gslb regional routing list
[--size <value>]
[--page <value>]
[--sort <value>]
[--region <value>]
[--status <value>]
[--name <value>]
Description
GSLB Region 별 Resource 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | GSLB Resource 위치 | - |
| status optional | string | GSLB Resource 사용 여부 | - |
| name optional | string | GSLB 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| env_usage | GSLB 용도 | |
| linked_regional_resource_count | GSLB 위치별 연결 대상 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | GSLB 이름 | |
| region | GSLB Resource 위치 | |
| status | GSLB Resource 사용 여부 |
5.5.1.6 - SetGslb
5.5.1.6.1 - 1.1
scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]
Description
GSLB 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| algorithm optional | string | The GSLB Algorithm. | - |
| description optional | string | 설명 | - |
5.5.1.6.2 - 1.0
scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]
Description
GSLB 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| algorithm optional | string | The GSLB Algorithm. | - |
| description optional | string | 설명 | - |
5.5.1.7 - SetGslbHealthCheck
5.5.1.7.1 - 1.1
scpcli 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
GSLB Health Check 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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.5.1.7.2 - 1.0
scpcli 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
GSLB Health Check 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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.5.1.8 - SetGslbRegionalRoutingControl
5.5.1.8.1 - 1.1
scpcli gslb gslb-regional-routing-set
--gslb_id <value>
--status <value>
--region <value>
Description
GSLB Regional Routing 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| status required | string | GSLB Resource 사용 여부 | - |
| region required | string | GSLB Resource 위치 | - |
5.5.1.9 - SetGslbResources
5.5.1.9.1 - 1.1
scpcli gslb gslb-resource update
--gslb_id <value>
--resources <value>
Description
GSLB Resource 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| resources required | array | '{"description": "", "destination": "", "region": "", "weight": 0}' |
5.5.1.9.2 - 1.0
scpcli gslb gslb-resource update
--gslb_id <value>
--resources <value>
Description
GSLB Resource 수정
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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.5.1.10 - ShowGslb
5.5.1.10.1 - 1.1
scpcli gslb gslb show
--gslb_id <value>
Description
GSLB 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| env_usage | GSLB 용도 | |
| health_check | ||
| linked_resource_count | GSLB 연결 대상 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | GSLB 이름 | |
| state | GSLB 상태. |
5.5.1.10.2 - 1.0
scpcli gslb gslb show
--gslb_id <value>
Description
GSLB 상세 조회
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| env_usage | GSLB 용도 | |
| health_check | ||
| linked_resource_count | GSLB 연결 대상 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | GSLB 이름 | |
| state | GSLB 상태. |
5.6 - Load Balancer
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 LOADBALANCER 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251023 |
| 1.1 | DEPRECATED | 20260331 |
| 1.2 | CURRENT | - |
5.6.1 - CLIs
5.6.1.1 - AddLbServerGroupMembers
5.6.1.1.1 - 1.2
scpcli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>
Description
Member를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | Lb Server Group ID | - |
| 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 |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| lb_server_group_id | Lb Server Group ID | |
| member_ip | Member ID | |
| member_port | Member 포트 | |
| member_state | Member State of Member | |
| member_weight | Weight of Member | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Member 명 | |
| object_id | Member 대상 서버의 ID | |
| object_type | Member의 대상 서버 타입 | |
| state | State of Member | |
| subnet_id | Sunbet ID | |
| uuid | UUID of Member |
5.6.1.1.2 - 1.1
scpcli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>
Description
Member를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | Lb Server Group ID | - |
| 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 |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| lb_server_group_id | Lb Server Group ID | |
| member_ip | Member ID | |
| member_port | Member 포트 | |
| member_state | Member State of Member | |
| member_weight | Weight of Member | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Member 명 | |
| object_id | Member 대상 서버의 ID | |
| object_type | Member의 대상 서버 타입 | |
| state | State of Member | |
| subnet_id | Sunbet ID | |
| uuid | UUID of Member |
5.6.1.2 - CreateLBHealthCheck
5.6.1.2.1 - 1.2
scpcli 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
LB 헬스 체크를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | 프로토콜 | TCP |
| name required | string | LB 헬스 체크명 | ServerGroup01 |
| description optional | string | 설명 | this is an lb server group |
| health_check_count optional | integer | 탐지 횟수 | 3 |
| health_check_interval optional | integer | 헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. | 5 |
| health_check_port optional | integer | 헬스 체크 포트 | 80 |
| health_check_timeout optional | integer | 대기 시간 | 5 |
| health_check_url optional | string | URL 모니터 | /test |
| http_method optional | **** | LB 헬스 체크 HTTP 방식 | GET |
| request_data optional | string | 요청 문자열 | username=admin&password=1234 |
| response_code optional | string | 응답 코드 | 200 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | this is an lb server group |
| health_check_count | 탐지 횟수 | 3 |
| health_check_interval | 헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. | 5 |
| health_check_port | 헬스 체크 포트 | 80 |
| health_check_timeout | 대기 시간 | 5 |
| health_check_type | LB 헬스 체크 유형 | DEFAULT |
| health_check_url | URL 모니터 | /test |
| http_method | LB 헬스 체크 HTTP 방식 | GET |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 헬스 체크명 | Test-LbMonitor-01 |
| protocol | 프로토콜 | TCP |
| request_data | 요청 문자열 | username=admin&password=1234 |
| response_code | 응답 코드 | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
5.6.1.2.2 - 1.1
scpcli 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
LB 헬스 체크를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | 프로토콜 | TCP |
| name required | string | LB 헬스 체크명 | ServerGroup01 |
| description optional | string | 설명 | this is an lb server group |
| health_check_count optional | integer | 탐지 횟수 | 3 |
| health_check_interval optional | integer | 헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. | 5 |
| health_check_port optional | integer | 헬스 체크 포트 | 80 |
| health_check_timeout optional | integer | 대기 시간 | 5 |
| health_check_url optional | string | URL 모니터 | /test |
| http_method optional | **** | LB 헬스 체크 HTTP 방식 | GET |
| request_data optional | string | 요청 문자열 | username=admin&password=1234 |
| response_code optional | string | 응답 코드 | 200 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | this is an lb server group |
| health_check_count | 탐지 횟수 | 3 |
| health_check_interval | 헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. | 5 |
| health_check_port | 헬스 체크 포트 | 80 |
| health_check_timeout | 대기 시간 | 5 |
| health_check_type | LB 헬스 체크 유형 | DEFAULT |
| health_check_url | URL 모니터 | /test |
| http_method | LB 헬스 체크 HTTP 방식 | GET |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 헬스 체크명 | Test-LbMonitor-01 |
| protocol | 프로토콜 | TCP |
| request_data | 요청 문자열 | username=admin&password=1234 |
| response_code | 응답 코드 | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
5.6.1.3 - CreateLbListener
5.6.1.3.1 - 1.2
scpcli loadbalancer lb-listener create
--service_port <value>
--routing_action <value>
--protocol <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>]
Description
Listener를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_port required | integer | 서비스 포트 | - |
| routing_action required | string | The routing action of the listener. | - |
| protocol required | string | 프로토콜 | - |
| name required | string | Listener 명 | - |
| loadbalancer_id required | string | LB 아이디 | - |
| condition_type optional | **** | The condition type of the listener. | - |
| description optional | string | 설명 | - |
| insert_client_ip optional | boolean | Whether the client IP should be inserted. | - |
| persistence optional | string | 지속성 유형 | - |
| response_timeout optional | integer | 응답 시간 초과 | - |
| server_group_id optional | string | LB 서버 그룹 아이디 | - |
| session_duration_time optional | integer | The session duration time. | - |
| sni_certificate optional | array | The sni certificate of the listener. | '{"domain_name": "", "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 | URL 처리 | - |
| 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 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| condition_type | The condition type of the listener. | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| https_redirection | The https redirection of the listener. | |
| insert_client_ip | Whether the client IP should be inserted. | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Listener 명 | |
| persistence | 지속성 유형 | |
| protocol | 프로토콜 | |
| response_timeout | 응답 시간 초과 | |
| routing_action | The routing action of the listener. | |
| server_group_id | LB 서버 그룹 아이디 | |
| server_group_name | LB 서버 그룹 명 | |
| service_port | 서비스 포트 | |
| session_duration_time | The session duration time. | |
| sni_certificate | The sni certificate of the listener. | |
| ssl_certificate | SSL 인증서 | |
| state | Listener 상태 | |
| support_http2 | Whether the HTTP 2.0 is supported | |
| url_handler | URL 처리 | |
| 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. |
5.6.1.3.2 - 1.1
scpcli loadbalancer lb-listener create
--service_port <value>
--routing_action <value>
--protocol <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>]
Description
Listener를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_port required | integer | 서비스 포트 | - |
| routing_action required | string | The routing action of the listener. | - |
| protocol required | string | 프로토콜 | - |
| name required | string | Listener 명 | - |
| loadbalancer_id required | string | LB 아이디 | - |
| condition_type optional | **** | The condition type of the listener. | - |
| description optional | string | 설명 | - |
| insert_client_ip optional | boolean | Whether the client IP should be inserted. | - |
| persistence optional | string | 지속성 유형 | - |
| response_timeout optional | integer | 응답 시간 초과 | - |
| server_group_id optional | string | LB 서버 그룹 아이디 | - |
| session_duration_time optional | integer | The session duration time. | - |
| sni_certificate optional | array | The sni certificate of the listener. | '{"domain_name": "", "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 | URL 처리 | - |
| 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 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| condition_type | The condition type of the listener. | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| https_redirection | The https redirection of the listener. | |
| insert_client_ip | Whether the client IP should be inserted. | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Listener 명 | |
| persistence | 지속성 유형 | |
| protocol | 프로토콜 | |
| response_timeout | 응답 시간 초과 | |
| routing_action | The routing action of the listener. | |
| server_group_id | LB 서버 그룹 아이디 | |
| server_group_name | LB 서버 그룹 명 | |
| service_port | 서비스 포트 | |
| session_duration_time | The session duration time. | |
| sni_certificate | The sni certificate of the listener. | |
| ssl_certificate | SSL 인증서 | |
| state | Listener 상태 | |
| support_http2 | Whether the HTTP 2.0 is supported | |
| url_handler | URL 처리 | |
| 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. |
5.6.1.4 - CreateLBServerGroup
5.6.1.4.1 - 1.2
scpcli 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
LB 서버 그룹을 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | 프로토콜 | TCP |
| name required | string | LB 헬스 체크명 | ServerGroup01 |
| lb_method required | string | 부하 분산 | ROUND_ROBIN |
| description optional | string | 설명 | this is an lb server group |
| lb_health_check_id optional | string | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | this is an lb server group |
| lb_health_check_id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method | 부하 분산 | ROUND_ROBIN |
| lb_name | Load Balancer 명 | Test-LB-01 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 서버 그룹 명 | ServerGroup01 |
| protocol | 프로토콜 | TCP |
| state | LB 서버 그룹 상태 | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
5.6.1.4.2 - 1.1
scpcli 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
LB 서버 그룹을 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| subnet_id required | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| protocol required | string | 프로토콜 | TCP |
| name required | string | LB 헬스 체크명 | ServerGroup01 |
| lb_method required | string | 부하 분산 | ROUND_ROBIN |
| description optional | string | 설명 | this is an lb server group |
| lb_health_check_id optional | string | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | this is an lb server group |
| lb_health_check_id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method | 부하 분산 | ROUND_ROBIN |
| lb_name | Load Balancer 명 | Test-LB-01 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 서버 그룹 명 | ServerGroup01 |
| protocol | 프로토콜 | TCP |
| state | LB 서버 그룹 상태 | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
5.6.1.5 - CreateLoadbalancer
5.6.1.5.1 - 1.2
scpcli 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
LoadBalancer를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | 이름 | - |
| layer_type required | string | 계층 타입 | - |
| description optional | string | 설명 | - |
| firewall_enabled optional | boolean | 방화벽 사용 여부 | - |
| firewall_logging_enabled optional | boolean | 방화벽 로깅 여부 | - |
| 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 | LoadBalancer 서비스 IP | - |
| source_nat_ip optional | string | Source NAT IP | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | |
| account_id | LoadBalancer account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| layer_type | 계층 타입 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 이름 | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.6.1.5.2 - 1.1
scpcli 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
LoadBalancer를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | 이름 | - |
| layer_type required | string | 계층 타입 | - |
| description optional | string | 설명 | - |
| firewall_enabled optional | boolean | 방화벽 사용 여부 | - |
| firewall_logging_enabled optional | boolean | 방화벽 로깅 여부 | - |
| 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 | LoadBalancer 서비스 IP | - |
| source_nat_ip optional | string | Source NAT IP | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | |
| account_id | LoadBalancer account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| layer_type | 계층 타입 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 이름 | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.6.1.6 - CreateLoadbalancerPublicNatIp
5.6.1.6.1 - 1.2
scpcli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>
Description
LoadBalancer Public NAT를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| external_ip_address | external_ip_address | |
| internal_ip_address | internal_ip_address | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| 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 |
5.6.1.6.2 - 1.1
scpcli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>
Description
LoadBalancer Public NAT를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| external_ip_address | external_ip_address | |
| internal_ip_address | internal_ip_address | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| 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 |
5.6.1.7 - DeleteLBHealthCheck
5.6.1.7.1 - 1.2
scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>
Description
LB 헬스 체크를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB 헬스 체크 ID | e3cd678b11784734bc366148aa37580e |
5.6.1.7.2 - 1.1
scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>
Description
LB 헬스 체크를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB 헬스 체크 ID | e3cd678b11784734bc366148aa37580e |
5.6.1.8 - DeleteLbListener
5.6.1.8.1 - 1.2
scpcli loadbalancer lb-listener delete
--listener_id <value>
Description
Listener를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | Listener 아이디 | - |
5.6.1.8.2 - 1.1
scpcli loadbalancer lb-listener delete
--listener_id <value>
Description
Listener를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | Listener 아이디 | - |
5.6.1.9 - DeleteLBServerGroup
5.6.1.9.1 - 1.2
scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>
Description
LB 서버 그룹을 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
5.6.1.9.2 - 1.1
scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>
Description
LB 서버 그룹을 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
5.6.1.10 - DeleteLoadbalancer
5.6.1.10.1 - 1.2
scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>
Description
LoadBalancer를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | 자원 ID | - |
5.6.1.10.2 - 1.1
scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>
Description
LoadBalancer를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | 자원 ID | - |
5.6.1.11 - DeleteLoadbalancerPublicNatIp
5.6.1.11.1 - 1.2
scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>
Description
LoadBalancer Public NAT를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | 자원 ID | - |
5.6.1.11.2 - 1.1
scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>
Description
LoadBalancer Public NAT를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | 자원 ID | - |
5.6.1.12 - ListLBHealthChecks
5.6.1.12.1 - 1.2
scpcli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
Description
LB 헬스 체크 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | LB 헬스 체크명 | Test-LbMonitor-01 |
| protocol optional | array | 프로토콜 | 'TCP' |
| subnet_id optional | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| health_check_type | LB 헬스 체크 유형 | DEFAULT |
| lb_server_group_count | LB 서버 그룹 수 | 2 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 헬스 체크명 | Test-LbMonitor-01 |
| protocol | 프로토콜 | TCP |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
5.6.1.12.2 - 1.1
scpcli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]
Description
LB 헬스 체크 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 헬스 체크명 | Test-LbMonitor-01 |
| protocol optional | array | 프로토콜 | 'TCP' |
| subnet_id optional | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| health_check_type | LB 헬스 체크 유형 | DEFAULT |
| lb_server_group_count | LB 서버 그룹 수 | 2 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 헬스 체크명 | Test-LbMonitor-01 |
| protocol | 프로토콜 | TCP |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
5.6.1.13 - ListLbListeners
5.6.1.13.1 - 1.2
scpcli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]
Description
Listener 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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 | LB 아이디 | - |
| state optional | string | Listener 상태 | - |
| name optional | string | Listener 명 | - |
| service_port optional | integer | 서비스 포트 | - |
| protocol optional | array | 프로토콜 | 'TCP' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Listener 명 | |
| protocol | 프로토콜 | |
| service_port | 서비스 포트 | |
| state | Listener 상태 |
5.6.1.13.2 - 1.1
scpcli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]
Description
Listener 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 | LB 아이디 | - |
| state optional | string | Listener 상태 | - |
| name optional | string | Listener 명 | - |
| service_port optional | integer | 서비스 포트 | - |
| protocol optional | array | 프로토콜 | 'TCP' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Listener 명 | |
| protocol | 프로토콜 | |
| service_port | 서비스 포트 | |
| state | Listener 상태 |
5.6.1.14 - ListLbServerGroupMembers
5.6.1.14.1 - 1.2
scpcli 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
Member 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | Lb Server Group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Member 명 | - |
| member_ip optional | string | Member ID | - |
| member_port optional | integer | Member 포트 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| health_state | Member의 Health State | |
| lb_server_group_id | Lb Server Group ID | |
| member_ip | Member ID | |
| member_port | Member 포트 | |
| member_state | Member State of Member | |
| member_weight | Weight of Member | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Member 명 | |
| object_id | Member 대상 서버의 ID | |
| object_type | Member의 대상 서버 타입 | |
| state | State of Member |
5.6.1.14.2 - 1.1
scpcli 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
Member 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | Lb Server Group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Member 명 | - |
| member_ip optional | string | Member ID | - |
| member_port optional | integer | Member 포트 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| health_state | Member의 Health State | |
| lb_server_group_id | Lb Server Group ID | |
| member_ip | Member ID | |
| member_port | Member 포트 | |
| member_state | Member State of Member | |
| member_weight | Weight of Member | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Member 명 | |
| object_id | Member 대상 서버의 ID | |
| object_type | Member의 대상 서버 타입 | |
| state | State of Member |
5.6.1.15 - ListLBServerGroups
5.6.1.15.1 - 1.2
scpcli 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
LB 서버 그룹 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | LB 서버 그룹 명 | ServerGroup01 |
| protocol optional | array | 프로토콜 | 'TCP' |
| subnet_id optional | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id optional | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| lb_health_check_id optional | string | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method optional | array | 부하 분산 | 'R' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| lb_health_check_id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| lb_name | Load Balancer 명 | Test-LB-01 |
| lb_server_group_member_count | 서버 멤버 수 | 2 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 서버 그룹 명 | ServerGroup01 |
| protocol | 프로토콜 | TCP |
| state | LB 서버 그룹 상태 | ACTIVE |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
5.6.1.15.2 - 1.1
scpcli 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
LB 서버 그룹 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 서버 그룹 명 | ServerGroup01 |
| protocol optional | array | 프로토콜 | 'TCP' |
| subnet_id optional | string | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id optional | string | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
| lb_health_check_id optional | string | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method optional | array | 부하 분산 | 'R' |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| lb_health_check_id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| lb_name | Load Balancer 명 | Test-LB-01 |
| lb_server_group_member_count | 서버 멤버 수 | 2 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 서버 그룹 명 | ServerGroup01 |
| protocol | 프로토콜 | TCP |
| state | LB 서버 그룹 상태 | ACTIVE |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
5.6.1.16 - ListLoadbalancerCertificates
5.6.1.16.1 - 1.2
scpcli loadbalancer loadbalancer-certificate list
Description
인증서 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| cert_kind | ||
| cn | ||
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | ||
| not_after_dt | ||
| not_before_dt | ||
| state |
5.6.1.16.2 - 1.1
scpcli loadbalancer loadbalancer-certificate list
Description
인증서 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| cert_kind | ||
| cn | ||
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | ||
| not_after_dt | ||
| not_before_dt | ||
| state |
5.6.1.17 - ListLoadbalancers
5.6.1.17.1 - 1.2
scpcli 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
LoadBalancer 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | LoadBalancer 명 | - |
| state optional | **** | The state of the load balancer. | - |
| service_ip optional | string | LoadBalancer 서비스 IP | - |
| subnet_id optional | string | Subnet ID | - |
| layer_type optional | **** | 계층 타입 | - |
| vpc_id optional | string | VPC ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| firewall_id | 방화벽 ID | |
| layer_type | 계층 타입 | |
| listener_count | Listener 개수 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LoadBalancer 명 | |
| public_nat_enabled | Public NAT Enabled Status | |
| service_ip | LoadBalancer 서비스 IP | |
| source_nat_ip | Source NAT IP | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.6.1.17.2 - 1.1
scpcli 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
LoadBalancer 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 | LoadBalancer 명 | - |
| state optional | **** | The state of the load balancer. | - |
| service_ip optional | string | LoadBalancer 서비스 IP | - |
| subnet_id optional | string | Subnet ID | - |
| layer_type optional | **** | 계층 타입 | - |
| vpc_id optional | string | VPC ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| firewall_id | 방화벽 ID | |
| layer_type | 계층 타입 | |
| listener_count | Listener 개수 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LoadBalancer 명 | |
| public_nat_enabled | Public NAT Enabled Status | |
| service_ip | LoadBalancer 서비스 IP | |
| source_nat_ip | Source NAT IP | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.6.1.18 - RemoveLbServerGroupMember
5.6.1.18.1 - 1.2
scpcli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>
Description
Member를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | Lb Server Group ID | - |
5.6.1.18.2 - 1.1
scpcli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>
Description
Member를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | Lb Server Group ID | - |
5.6.1.19 - RemoveLbServerGroupMembers
5.6.1.19.1 - 1.2
scpcli loadbalancer lb-server-group-members remove
--lb_server_group_id <value>
--member_id_list <value>
Description
Remove Lb Server Group Members
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | Lb Server Group ID | - |
| member_id_list required | array | ID list of Member | - |
5.6.1.20 - SetLBHealthCheck
5.6.1.20.1 - 1.2
scpcli 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
LB 헬스 체크를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB 헬스 체크 ID | e3cd678b11784734bc366148aa37580e |
| description optional | string | 설명 | this is an lb server group |
| health_check_count optional | integer | 탐지 횟수 | 3 |
| health_check_interval optional | integer | 헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. | 5 |
| health_check_port optional | integer | 헬스 체크 포트 | 80 |
| health_check_timeout optional | integer | 대기 시간 | 5 |
| health_check_url optional | string | URL 모니터 | /test |
| http_method optional | **** | LB 헬스 체크 HTTP 방식 | GET |
| protocol optional | **** | 프로토콜 | TCP |
| request_data optional | string | 요청 문자열 | username=admin&password=1234 |
| response_code optional | string | 응답 코드 | 200 |
5.6.1.20.2 - 1.1
scpcli 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
LB 헬스 체크를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB 헬스 체크 ID | e3cd678b11784734bc366148aa37580e |
| description optional | string | 설명 | this is an lb server group |
| health_check_count optional | integer | 탐지 횟수 | 3 |
| health_check_interval optional | integer | 헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. | 5 |
| health_check_port optional | integer | 헬스 체크 포트 | 80 |
| health_check_timeout optional | integer | 대기 시간 | 5 |
| health_check_url optional | string | URL 모니터 | /test |
| http_method optional | **** | LB 헬스 체크 HTTP 방식 | GET |
| protocol optional | **** | 프로토콜 | TCP |
| request_data optional | string | 요청 문자열 | username=admin&password=1234 |
| response_code optional | string | 응답 코드 | 200 |
5.6.1.21 - SetLbListener
5.6.1.21.1 - 1.2
scpcli 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
리스너 목록을 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | Listener 아이디 | - |
| condition_type optional | **** | The condition type of the listener. | - |
| description optional | string | 설명 | - |
| insert_client_ip optional | boolean | Whether the client IP should be inserted. | - |
| persistence optional | string | 지속성 유형 | - |
| response_timeout optional | integer | 응답 시간 초과 | - |
| server_group_id optional | string | LB 서버 그룹 아이디 | - |
| session_duration_time optional | integer | The session duration time. | - |
| sni_certificate optional | array | The sni certificate of the listener. | '{"domain_name": "", "sni_cert_id": ""}' |
| support_http2 optional | boolean | Whether the HTTP 2.0 is supported | - |
| url_handler optional | array | URL 처리 | - |
| 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 | 프로토콜 | - |
| 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 | - |
5.6.1.21.2 - 1.1
scpcli 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
리스너 목록을 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | Listener 아이디 | - |
| condition_type optional | **** | The condition type of the listener. | - |
| description optional | string | 설명 | - |
| insert_client_ip optional | boolean | Whether the client IP should be inserted. | - |
| persistence optional | string | 지속성 유형 | - |
| response_timeout optional | integer | 응답 시간 초과 | - |
| server_group_id optional | string | LB 서버 그룹 아이디 | - |
| session_duration_time optional | integer | The session duration time. | - |
| sni_certificate optional | array | The sni certificate of the listener. | '{"domain_name": "", "sni_cert_id": ""}' |
| support_http2 optional | boolean | Whether the HTTP 2.0 is supported | - |
| url_handler optional | array | URL 처리 | - |
| 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 | 프로토콜 | - |
| 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 | - |
5.6.1.22 - SetLBServerGroup
5.6.1.22.1 - 1.2
scpcli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]
Description
LB 서버 그룹을 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| description optional | string | 설명 | this is an lb server group |
| lb_health_check_id optional | string | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method optional | **** | 부하 분산 | ROUND_ROBIN |
5.6.1.22.2 - 1.1
scpcli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]
Description
LB 서버 그룹을 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| description optional | string | 설명 | this is an lb server group |
| lb_health_check_id optional | string | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method optional | **** | 부하 분산 | ROUND_ROBIN |
5.6.1.23 - SetLbServerGroupMember
5.6.1.23.1 - 1.2
scpcli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]
Description
Member를 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | Lb Server Group ID | - |
| member_port optional | integer | Member 포트 | 80 |
| member_state optional | **** | Member State of Member | - |
| member_weight optional | integer | Weight of Member | 100 |
5.6.1.23.2 - 1.1
scpcli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]
Description
Member를 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | Lb Server Group ID | - |
| member_port optional | integer | Member 포트 | 80 |
| member_state optional | **** | Member State of Member | - |
| member_weight optional | integer | Weight of Member | 100 |
5.6.1.24 - SetLoadbalancer
5.6.1.24.1 - 1.1
scpcli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>
Description
LoadBalancer를 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | 자원 ID | - |
| description required | string | 설명 | - |
5.6.1.25 - ShowLBHealthCheck
5.6.1.25.1 - 1.2
scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>
Description
LB 헬스 체크를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB 헬스 체크 ID | e3cd678b11784734bc366148aa37580e |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | this is an lb server group |
| health_check_count | 탐지 횟수 | 3 |
| health_check_interval | 헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. | 5 |
| health_check_port | 헬스 체크 포트 | 80 |
| health_check_timeout | 대기 시간 | 5 |
| health_check_type | LB 헬스 체크 유형 | DEFAULT |
| health_check_url | URL 모니터 | /test |
| http_method | LB 헬스 체크 HTTP 방식 | GET |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 헬스 체크명 | Test-LbMonitor-01 |
| protocol | 프로토콜 | TCP |
| request_data | 요청 문자열 | username=admin&password=1234 |
| response_code | 응답 코드 | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
5.6.1.25.2 - 1.1
scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>
Description
LB 헬스 체크를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_health_check_id required | string | LB 헬스 체크 ID | e3cd678b11784734bc366148aa37580e |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | this is an lb server group |
| health_check_count | 탐지 횟수 | 3 |
| health_check_interval | 헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. | 5 |
| health_check_port | 헬스 체크 포트 | 80 |
| health_check_timeout | 대기 시간 | 5 |
| health_check_type | LB 헬스 체크 유형 | DEFAULT |
| health_check_url | URL 모니터 | /test |
| http_method | LB 헬스 체크 HTTP 방식 | GET |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 헬스 체크명 | Test-LbMonitor-01 |
| protocol | 프로토콜 | TCP |
| request_data | 요청 문자열 | username=admin&password=1234 |
| response_code | 응답 코드 | 200 |
| state | LB Health Check state | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
5.6.1.26 - ShowLbListener
5.6.1.26.1 - 1.2
scpcli loadbalancer lb-listener show
--listener_id <value>
Description
Listener를 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | Listener 아이디 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| condition_type | The condition type of the listener. | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| https_redirection | The https redirection of the listener. | |
| insert_client_ip | Whether the client IP should be inserted. | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Listener 명 | |
| persistence | 지속성 유형 | |
| protocol | 프로토콜 | |
| response_timeout | 응답 시간 초과 | |
| routing_action | The routing action of the listener. | |
| server_group_id | LB 서버 그룹 아이디 | |
| server_group_name | LB 서버 그룹 명 | |
| service_port | 서비스 포트 | |
| session_duration_time | The session duration time. | |
| sni_certificate | The sni certificate of the listener. | |
| ssl_certificate | SSL 인증서 | |
| state | Listener 상태 | |
| support_http2 | Whether the HTTP 2.0 is supported | |
| url_handler | URL 처리 | |
| 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. |
5.6.1.26.2 - 1.1
scpcli loadbalancer lb-listener show
--listener_id <value>
Description
Listener를 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| listener_id required | string | Listener 아이디 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| condition_type | The condition type of the listener. | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| https_redirection | The https redirection of the listener. | |
| insert_client_ip | Whether the client IP should be inserted. | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Listener 명 | |
| persistence | 지속성 유형 | |
| protocol | 프로토콜 | |
| response_timeout | 응답 시간 초과 | |
| routing_action | The routing action of the listener. | |
| server_group_id | LB 서버 그룹 아이디 | |
| server_group_name | LB 서버 그룹 명 | |
| service_port | 서비스 포트 | |
| session_duration_time | The session duration time. | |
| sni_certificate | The sni certificate of the listener. | |
| ssl_certificate | SSL 인증서 | |
| state | Listener 상태 | |
| support_http2 | Whether the HTTP 2.0 is supported | |
| url_handler | URL 처리 | |
| 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. |
5.6.1.27 - ShowLBServerGroup
5.6.1.27.1 - 1.2
scpcli loadbalancer lb-server-group read
--lb_server_group_id <value>
Description
LB 서버 그룹을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | this is an lb server group |
| lb_health_check_id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method | 부하 분산 | ROUND_ROBIN |
| lb_name | Load Balancer 명 | Test-LB-01 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 서버 그룹 명 | ServerGroup01 |
| protocol | 프로토콜 | TCP |
| state | LB 서버 그룹 상태 | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
5.6.1.27.2 - 1.1
scpcli loadbalancer lb-server-group read
--lb_server_group_id <value>
Description
LB 서버 그룹을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_server_group_id required | string | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
Responses
| Name | Description | Example |
|---|---|---|
| id | LB 서버 그룹 ID | 3d8d8754d0d54683a29f3dcc3dd95d5b |
| account_id | Account ID | e3cd678b11784734bc366148aa37580e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | this is an lb server group |
| lb_health_check_id | LB 헬스 체크 ID | 46c681018e33453085ca7c8db54e0076 |
| lb_method | 부하 분산 | ROUND_ROBIN |
| lb_name | Load Balancer 명 | Test-LB-01 |
| loadbalancer_id | Load Balancer ID | 82efa35c88834bc083020443e57faa10 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | LB 서버 그룹 명 | ServerGroup01 |
| protocol | 프로토콜 | TCP |
| state | LB 서버 그룹 상태 | ACTIVE |
| subnet_id | Service Subnet ID | 60fba45cb6c811efba41ba92e4fe7200 |
| vpc_id | VPC ID | 8acceeb6920c4fc494490d864f67f0b5 |
5.6.1.28 - ShowLbServerGroupMember
5.6.1.28.1 - 1.2
scpcli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>
Description
Member를 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | Lb Server Group ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| member |
5.6.1.28.2 - 1.1
scpcli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>
Description
Member를 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| member_id required | string | ID of Member | - |
| lb_server_group_id required | string | Lb Server Group ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| member |
5.6.1.29 - ShowLoadbalancer
5.6.1.29.1 - 1.2
scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>
Description
LoadBalancer를 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | 자원 ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | |
| account_id | LoadBalancer account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| firewall_id | 방화벽 ID | |
| health_check_ip | Health check IP | |
| layer_type | 계층 타입 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 이름 | |
| public_nat_enabled | Public NAT Enabled Status | |
| service_ip | LoadBalancer 서비스 IP | |
| source_nat_ip | Source NAT IP | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.6.1.29.2 - 1.1
scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>
Description
LoadBalancer를 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| loadbalancer_id required | string | 자원 ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 자원 ID | |
| account_id | LoadBalancer account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| firewall_id | 방화벽 ID | |
| health_check_ip | Health check IP | |
| layer_type | 계층 타입 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 이름 | |
| public_nat_enabled | Public NAT Enabled Status | |
| service_ip | LoadBalancer 서비스 IP | |
| source_nat_ip | Source NAT IP | |
| state | The state of the load balancer. | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.6.1.30 - ShowLoadbalancerCertificate
5.6.1.30.1 - 1.2
scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>
Description
인증서를 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_certificate_id required | string | 인증서 아이디 | - |
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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | ||
| not_after_dt | ||
| not_before_dt | ||
| organization | The organization of the certificate | |
| private_key | 인증서 개인키 | |
| state |
5.6.1.30.2 - 1.1
scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>
Description
인증서를 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| lb_certificate_id required | string | 인증서 아이디 | - |
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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | ||
| not_after_dt | ||
| not_before_dt | ||
| organization | The organization of the certificate | |
| private_key | 인증서 개인키 | |
| state |
5.6.1.31 - ShowLoadbalancerPublicNatIp
5.6.1.31.1 - 1.2
scpcli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>
Description
Show Load Balancer Public NAT IP
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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 |
5.6.1.31.2 - 1.1
scpcli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>
Description
Show Load Balancer Public NAT IP
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260331 |
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 |
5.7 - Security Group
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Security Group 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
5.7.1 - CLIs
5.7.1.1 - Create Security Group
5.7.1.1.1 - 1.0
scpcli security-group security-group create
--name <value>
[--description <value>]
[--loggable <value>]
[--tags <value>]
Description
Security Group을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Security Group 이름 | - |
| description optional | string | Security Group 설명 | - |
| loggable optional | boolean | Security Group 로깅 여부 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group ID | |
| account_id | Security Group Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group 설명 | |
| loggable | Security Group 로깅 여부 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Security Group 이름 | |
| rule_count | Security Group Rule 수 | |
| state | Security Group 상태 |
5.7.1.2 - Create Security Group Rule
5.7.1.2.1 - 1.0
scpcli 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
Security Group rule을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 설명 | - |
| ethertype optional | string | Security Group Rule Ethertype (IPV4, IPV6) | - |
| port_range_max optional | integer | Security Group Rule 포트 범위 최대값 | - |
| port_range_min optional | integer | Security Group Rule 포트 범위 최소값 | - |
| protocol optional | string | Security Group Rule 프로토콜 | - |
| remote_group_id optional | string | Security Group Rule 원격 그룹 ID | - |
| remote_ip_prefix optional | string | Security Group Rule IP 주소 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group Rule ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Rule 설명 | |
| direction | Security Group Rule 방향 (Ingress, Egress) | |
| ethertype | Security Group Rule Ethertype (IPV4, IPV6) | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| port_range_max | Security Group Rule 포트 범위 최대값 | |
| port_range_min | Security Group Rule 포트 범위 최소값 | |
| protocol | Security Group Rule 프로토콜 | |
| remote_group_id | Security Group Rule 원격 그룹 ID | |
| remote_group_name | Security Group Rule 원격 그룹 이름 | |
| remote_ip_prefix | Security Group Rule IP 주소 | |
| security_group_id | Security Group ID |
5.7.1.3 - Delete Security Group
5.7.1.3.1 - 1.0
scpcli security-group security-group delete
--security_group_id <value>
Description
Security Group을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_id required | string | Security Group ID | - |
5.7.1.4 - Delete Security Group Rule
5.7.1.4.1 - 1.0
scpcli security-group security-group-rule delete
--security_group_rule_id <value>
Description
Security Group rule을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_rule_id required | string | Security Group Rule ID | - |
5.7.1.5 - List Security Group Rules
5.7.1.5.1 - 1.0
scpcli 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
Security Group rule 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 IP 주소 | - |
| remote_group_id optional | string | Security Group Rule 원격 그룹 ID | - |
| description optional | string | Security Group Rule 설명 | - |
| direction optional | string | Security Group Rule 방향 (Ingress, Egress) | - |
| service optional | string | Security Group Rule 서비스 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group Rule ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Rule 설명 | |
| direction | Security Group Rule 방향 (Ingress, Egress) | |
| ethertype | Security Group Rule Ethertype (IPV4, IPV6) | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| port_range_max | Security Group Rule 포트 범위 최대값 | |
| port_range_min | Security Group Rule 포트 범위 최소값 | |
| protocol | Security Group Rule 프로토콜 | |
| remote_group_id | Security Group Rule 원격 그룹 ID | |
| remote_group_name | Security Group Rule 원격 그룹 이름 | |
| remote_ip_prefix | Security Group Rule IP 주소 | |
| security_group_id | Security Group ID |
5.7.1.6 - List Security Groups
5.7.1.6.1 - 1.0
scpcli security-group security-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
Description
Security Group 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group ID | |
| account_id | Security Group Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group 설명 | |
| loggable | Security Group 로깅 여부 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Security Group 이름 | |
| rule_count | Security Group Rule 수 | |
| state | Security Group 상태 |
5.7.1.7 - Set Security Group
5.7.1.7.1 - 1.0
scpcli security-group security-group set
--security_group_id <value>
[--description <value>]
[--loggable <value>]
Description
Security Group을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_id required | string | Security Group ID | - |
| description optional | string | Security Group 설명 | - |
| loggable optional | boolean | Security Group 로깅 여부 | - |
5.7.1.8 - Show Security Group
5.7.1.8.1 - 1.0
scpcli security-group security-group show
--security_group_id <value>
Description
Security Group 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group 설명 | |
| loggable | Security Group 로깅 여부 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Security Group 이름 | |
| rule_count | Security Group Rule 수 | |
| state | Security Group 상태 |
5.7.1.9 - Show Security Group Rule
5.7.1.9.1 - 1.0
scpcli security-group security-group-rule show
--security_group_rule_id <value>
[--fields <value>]
Description
Security Group rule을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| security_group_rule_id required | string | Security Group Rule ID | - |
| fields optional | array | 필드명 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Security Group Rule ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Security Group Rule 설명 | |
| direction | Security Group Rule 방향 (Ingress, Egress) | |
| ethertype | Security Group Rule Ethertype (IPV4, IPV6) | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| port_range_max | Security Group Rule 포트 범위 최대값 | |
| port_range_min | Security Group Rule 포트 범위 최소값 | |
| protocol | Security Group Rule 프로토콜 | |
| remote_group_id | Security Group Rule 원격 그룹 ID | |
| remote_group_name | Security Group Rule 원격 그룹 이름 | |
| remote_ip_prefix | Security Group Rule IP 주소 | |
| security_group_id | Security Group ID |
5.8 - VPC
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 VPC 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
5.8.1 - CLIs
5.8.1.1 - Approval VPC Peering
5.8.1.1.1 - 1.1
scpcli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>
Description
VPC Peering 승인
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
| type required | string | 승인 유형 | - |
5.8.1.2 - Approve PrivateLink Endpoint
5.8.1.2.1 - 1.1
scpcli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>
Description
Approve PrivateLink Endpoint
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | - |
| type required | string | PrivateLink Endpoint Action Type | - |
5.8.1.3 - Connect PrivateLink Endpoint
5.8.1.3.1 - 1.1
scpcli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>
Description
Connect PrivateLink Endpoint
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | - |
| type required | string | PrivateLink Endpoint Action Type | - |
5.8.1.4 - Create Internet Gateway
5.8.1.4.1 - 1.1
scpcli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Internet Gateway를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| type required | string | Internet Gateway 유형 | - |
| description optional | string | 설명 | - |
| firewall_enabled optional | boolean | 방화벽 사용 | - |
| firewall_loggable optional | boolean | 방화벽 로깅 가능 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| firewall_id | Firewall ID | |
| loggable | NAT 로그 저장 여부 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway 명 | |
| state | 상태 | |
| type | Internet Gateway 유형 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.4.2 - 1.0
scpcli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Internet Gateway를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| type required | string | Internet Gateway 유형 | - |
| description optional | string | 설명 | - |
| firewall_enabled optional | boolean | 방화벽 사용 | - |
| firewall_loggable optional | boolean | 방화벽 로깅 가능 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| firewall_id | Firewall ID | |
| loggable | NAT 로그 저장 여부 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway 명 | |
| state | 상태 | |
| type | Internet Gateway 유형 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.5 - Create NAT Gateway
5.8.1.5.1 - 1.1
scpcli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]
Description
NAT Gateway를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet CIDR | - |
| publicip_id required | string | PublicIP ID | - |
| description optional | string | NAT Gateway 상세설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway 명 | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway 명 | |
| nat_gateway_ip_address | NAT Gateway IP 주소 | |
| publicip_id | PublicIP ID | |
| state | NAT Gateway 상태 | |
| subnet_cidr | Subnet Cidr | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.5.2 - 1.0
scpcli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]
Description
NAT Gateway를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet CIDR | - |
| publicip_id required | string | PublicIP ID | - |
| description optional | string | NAT Gateway 상세설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway 명 | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway 명 | |
| nat_gateway_ip_address | NAT Gateway IP 주소 | |
| publicip_id | PublicIP ID | |
| state | NAT Gateway 상태 | |
| subnet_cidr | Subnet Cidr | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.6 - Create Port
5.8.1.6.1 - 1.1
scpcli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]
Description
Port를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet ID | - |
| name required | string | Port 명 | - |
| description optional | string | 설명 | - |
| fixed_ip_address optional | string | 고정된 IP | - |
| security_groups optional | array | Security Group 목록 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| port |
5.8.1.6.2 - 1.0
scpcli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]
Description
Port를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet ID | - |
| name required | string | Port 명 | - |
| description optional | string | 설명 | - |
| fixed_ip_address optional | string | 고정된 IP | - |
| security_groups optional | array | Security Group 목록 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| port |
5.8.1.7 - Create Private NAT
5.8.1.7.1 - 1.1
scpcli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Private NAT 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Private NAT 명 | - |
| direct_connect_id required | string | Direct Connect ID | - |
| cidr required | string | Private NAT IP 대역 | - |
| description optional | string | 설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | |
| account_id | Account ID | |
| cidr | Private NAT IP 대역 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| direct_connect_id | Direct Connect ID | |
| direct_connect_name | Direct Connect명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT 명 | |
| state | Private NAT 상태 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.7.2 - 1.0
scpcli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Private NAT 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Private NAT 명 | - |
| direct_connect_id required | string | Direct Connect ID | - |
| cidr required | string | Private NAT IP 대역 | - |
| description optional | string | 설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | |
| account_id | Account ID | |
| cidr | Private NAT IP 대역 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| direct_connect_id | Direct Connect ID | |
| direct_connect_name | Direct Connect명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT 명 | |
| state | Private NAT 상태 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.8 - Create Private NAT IP
5.8.1.8.1 - 1.1
scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>
Description
Private NAT IP 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | - |
| ip_address required | string | Private NAT IP 주소 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP 연결된 자원 ID | |
| attached_resource_name | Private NAT IP 연결된 자원명 | |
| attached_resource_type | Private NAT IP 연결된 자원 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP 상태 |
5.8.1.8.2 - 1.0
scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>
Description
Private NAT IP 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | - |
| ip_address required | string | Private NAT IP 주소 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP 연결된 자원 ID | |
| attached_resource_name | Private NAT IP 연결된 자원명 | |
| attached_resource_type | Private NAT IP 연결된 자원 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP 상태 |
5.8.1.9 - Create PrivateLink Endpoint
5.8.1.9.1 - 1.1
scpcli 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
PrivateLink Endpoint 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet ID | - |
| name required | string | PrivateLink Endpoint 명 | - |
| endpoint_ip_address required | string | Endpoint IP 주소 | - |
| description optional | string | 설명 | - |
| privatelink_service_id optional | string | PrivateLink Service ID | - |
| security_group_ids optional | array | Security Group 목록 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | |
| account_id | Account ID | |
| approval_type | PrivateLink Service 승인 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| endpoint_ip_address | Endpoint IP 주소 | |
| endpoint_ip_port_id | Endpoint IP Port ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint 명 | |
| privatelink_service_id | PrivateLink Service ID | |
| security_group_ids | Security Group 목록 | |
| state | PrivateLink Endpoint 상태 | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.8.1.10 - Create PrivateLink Service
5.8.1.10.1 - 1.1
scpcli 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
PrivateLink Service 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet ID | - |
| service_ip_address required | string | Service IP 주소 | - |
| name required | string | PrivateLink Service 명 | - |
| connected_resource_type required | string | 연결된 자원 Type | - |
| approval_type required | string | PrivateLink Service 승인 타입 | - |
| connected_resource_id optional | string | 연결된 자원 ID | - |
| connected_resource_ip_address optional | string | 연결된 자원 IP 주소 | - |
| description optional | string | 설명 | - |
| high_speed_transfer optional | boolean | 고속 데이터 전송 사용 | - |
| security_group_ids optional | array | Security Group 목록 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | |
| account_id | Account ID | |
| approval_type | PrivateLink Service 승인 타입 | |
| connected_resource_id | 연결된 자원 ID | |
| connected_resource_ip_address | 연결된 자원 IP 주소 | |
| connected_resource_name | 연결된 자원명 | |
| connected_resource_type | 연결된 자원 Type | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| high_speed_transfer | 고속 데이터 전송 사용 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service 명 | |
| security_group_ids | Security Group 목록 | |
| service_ip_address | Service IP 주소 | |
| service_ip_port_id | Service IP Port ID | |
| state | PrivateLink Service 상태 | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.8.1.11 - Create PublicIP
5.8.1.11.1 - 1.1
scpcli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]
Description
PublicIP를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type required | string | PublicIP 타입 | - |
| description optional | string | PublicIP 상세 설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | |
| account_id | Account ID | |
| attached_resource_id | PublicIP 연결된 자원 ID | |
| attached_resource_name | PublicIP 연결된 자원명 | |
| attached_resource_type | PublicIP 연결된 자원 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP 상세 설명 | |
| ip_address | IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP 상태 | |
| type | PublicIP 타입 |
5.8.1.11.2 - 1.0
scpcli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]
Description
PublicIP를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type required | string | PublicIP 타입 | - |
| description optional | string | PublicIP 상세 설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | |
| account_id | Account ID | |
| attached_resource_id | PublicIP 연결된 자원 ID | |
| attached_resource_name | PublicIP 연결된 자원명 | |
| attached_resource_type | PublicIP 연결된 자원 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP 상세 설명 | |
| ip_address | IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP 상태 | |
| type | PublicIP 타입 |
5.8.1.12 - Create Subnet
5.8.1.12.1 - 1.1
scpcli 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
Subnet을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Subnet 유형 | - |
| name required | string | Subnet 명 | subnetName |
| cidr required | string | Subnet Cidr | 192.167.1.0/24 |
| allocation_pools optional | array | IP 할당 범위 | [ |
| description optional | string | 설명 | Subnet Description |
| dns_nameservers optional | array | DNS Name Server | [ |
| host_routes optional | array | 호스트 경로 | [ |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | IP 할당 범위 | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Subnet Description |
| dns_nameservers | DNS Name Server | |
| gateway_ip_address | Gateway IP | 192.167.1.1 |
| host_routes | 호스트 경로 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet 명 | subnetName |
| state | 상태 | |
| type | Subnet 유형 | |
| vpc_id | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC 명 | vpcName |
5.8.1.12.2 - 1.0
scpcli 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
Subnet을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Subnet 유형 | - |
| name required | string | Subnet 명 | subnetName |
| cidr required | string | Subnet Cidr | 192.167.1.0/24 |
| allocation_pools optional | array | IP 할당 범위 | [ |
| description optional | string | 설명 | Subnet Description |
| dns_nameservers optional | array | DNS Name Server | [ |
| host_routes optional | array | 호스트 경로 | [ |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | IP 할당 범위 | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Subnet Description |
| dns_nameservers | DNS Name Server | |
| gateway_ip_address | Gateway IP | 192.167.1.1 |
| host_routes | 호스트 경로 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet 명 | subnetName |
| state | 상태 | |
| type | Subnet 유형 | |
| vpc_id | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC 명 | vpcName |
5.8.1.13 - Create Transit Gateway
5.8.1.13.1 - 1.1
scpcli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]
Description
Transit Gateway 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Transit Gateway 명 | - |
| description optional | string | 설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | |
| account_id | Account ID | |
| bandwidth | Transit Gateway 포트 용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway 상세 설명 | |
| firewall_ids | Firewall ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway 명 | |
| state | 상태 | |
| uplink_enabled | Uplink 사용 |
5.8.1.13.2 - 1.0
scpcli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]
Description
Transit Gateway 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Transit Gateway 명 | - |
| description optional | string | 설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | |
| account_id | Account ID | |
| bandwidth | Transit Gateway 포트 용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway 상세 설명 | |
| firewall_ids | Firewall ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway 명 | |
| state | 상태 | |
| uplink_enabled | Uplink 사용 |
5.8.1.14 - Create Transit Gateway Rule
5.8.1.14.1 - 1.1
scpcli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Transit Gateway 규칙 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
| tgw_connection_vpc_id required | string | Transit Gateway에 연결된 VPC ID. | - |
| destination_type required | string | 목적지 타입 | - |
| destination_cidr required | string | 목적지 CIDR | - |
| description optional | string | 설명 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| destination_cidr | 목적지 CIDR | |
| destination_resource_id | 목적지 자원 ID | |
| destination_resource_name | 목적지 자원명 | |
| destination_type | 목적지 타입 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_resource_id | 출발지 자원 ID | |
| source_resource_name | 출발지 자원명 | |
| source_type | 출발지 타입 | |
| state | 상태 | |
| tgw_connection_vpc_id | Transit Gateway에 연결된 VPC ID. | |
| tgw_connection_vpc_name | Transit Gateway에 연결된 VPC명. |
5.8.1.14.2 - 1.0
scpcli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Transit Gateway 규칙 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
| tgw_connection_vpc_id required | string | Transit Gateway에 연결된 VPC ID. | - |
| destination_type required | string | 목적지 타입 | - |
| destination_cidr required | string | 목적지 CIDR | - |
| description optional | string | 설명 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| destination_cidr | 목적지 CIDR | |
| destination_resource_id | 목적지 자원 ID | |
| destination_resource_name | 목적지 자원명 | |
| destination_type | 목적지 타입 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_resource_id | 출발지 자원 ID | |
| source_resource_name | 출발지 자원명 | |
| source_type | 출발지 타입 | |
| state | 상태 | |
| tgw_connection_vpc_id | Transit Gateway에 연결된 VPC ID. | |
| tgw_connection_vpc_name | Transit Gateway에 연결된 VPC명. |
5.8.1.15 - Create Transit Gateway VPC Connection
5.8.1.15.1 - 1.1
scpcli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>
Description
Transit Gateway VPC 연결 생성.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
| vpc_id required | string | VPC ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC 연결 ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | 상태 | |
| transit_gateway_id | Transit Gateway ID | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.15.2 - 1.0
scpcli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>
Description
Transit Gateway VPC 연결 생성.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
| vpc_id required | string | VPC ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC 연결 ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | 상태 | |
| transit_gateway_id | Transit Gateway ID | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.16 - Create VPC
5.8.1.16.1 - 1.1
scpcli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
VPC를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | VPC 명 | vpcName |
| cidr required | string | VPC Cidr | 192.167.0.0/18 |
| description optional | string | 설명 | VPC Description |
| tags optional | array | 태그 목록 | '{"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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | vpcDescription |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC 명 | vpcName |
| state | 상태 |
5.8.1.16.2 - 1.0
scpcli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
VPC를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | VPC 명 | vpcName |
| cidr required | string | VPC Cidr | 192.167.0.0/18 |
| description optional | string | 설명 | VPC Description |
| tags optional | array | 태그 목록 | '{"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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | vpcDescription |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC 명 | vpcName |
| state | 상태 |
5.8.1.17 - Create VPC Endpoint
5.8.1.17.1 - 1.1
scpcli 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
VPC Endpoint 를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| subnet_id required | string | Subnet ID | - |
| resource_type required | string | VPC Endpoint 자원 타입 | - |
| resource_key required | string | VPC Endpoint Resource Key | - |
| resource_info required | string | VPC Endpoint Resource Key 정보 | - |
| name required | string | VPC Endpoint 명 | - |
| endpoint_ip_address required | string | VPC Endpoint IP 주소 | - |
| description optional | string | 설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| endpoint_ip_address | VPC Endpoint IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint 명 | |
| resource_info | VPC Endpoint Resource Key 정보 | |
| resource_key | VPC Endpoint Resource Key | |
| resource_type | VPC Endpoint 자원 타입 | |
| state | VPC Endpoint 상태 | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.17.2 - 1.0
scpcli 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
VPC Endpoint 를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| subnet_id required | string | Subnet ID | - |
| resource_type required | string | VPC Endpoint 자원 타입 | - |
| resource_key required | string | VPC Endpoint Resource Key | - |
| resource_info required | string | VPC Endpoint Resource Key 정보 | - |
| name required | string | VPC Endpoint 명 | - |
| endpoint_ip_address required | string | VPC Endpoint IP 주소 | - |
| description optional | string | 설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| endpoint_ip_address | VPC Endpoint IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint 명 | |
| resource_info | VPC Endpoint Resource Key 정보 | |
| resource_key | VPC Endpoint Resource Key | |
| resource_type | VPC Endpoint 자원 타입 | |
| state | VPC Endpoint 상태 | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.18 - Create VPC Peering
5.8.1.18.1 - 1.1
scpcli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]
Description
VPC Peering 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| requester_vpc_id required | string | 요청 VPC ID | - |
| name required | string | VPC Peering 명 | - |
| approver_vpc_id required | string | 승인 VPC ID | - |
| approver_vpc_account_id required | string | 승인 VPC 과제 ID | - |
| description optional | string | 설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | |
| account_type | 과제 유형 | |
| approver_vpc_account_id | 승인 VPC 과제 ID | |
| approver_vpc_id | 승인 VPC ID | |
| approver_vpc_name | 승인 VPC 명 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | 요청 VPC 과제 ID | |
| description | VPC Peering 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering 명 | |
| requester_vpc_account_id | 요청 VPC 과제 ID | |
| requester_vpc_id | 요청 VPC ID | |
| requester_vpc_name | 요청 VPC 명 | |
| state | 상태 |
5.8.1.18.2 - 1.0
scpcli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]
Description
VPC Peering 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| requester_vpc_id required | string | 요청 VPC ID | - |
| name required | string | VPC Peering 명 | - |
| approver_vpc_id required | string | 승인 VPC ID | - |
| approver_vpc_account_id required | string | 승인 VPC 과제 ID | - |
| description optional | string | 설명 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | |
| account_type | 과제 유형 | |
| approver_vpc_account_id | 승인 VPC 과제 ID | |
| approver_vpc_id | 승인 VPC ID | |
| approver_vpc_name | 승인 VPC 명 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | 요청 VPC 과제 ID | |
| description | VPC Peering 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering 명 | |
| requester_vpc_account_id | 요청 VPC 과제 ID | |
| requester_vpc_id | 요청 VPC ID | |
| requester_vpc_name | 요청 VPC 명 | |
| state | 상태 |
5.8.1.19 - Create Vpc Peering Rule
5.8.1.19.1 - 1.1
scpcli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]
Description
VPC Peering 규칙 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
| destination_vpc_type required | string | 목적지 VPC 유형 | - |
| destination_cidr required | string | 목적지 CIDR | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering 규칙 ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | 목적지 CIDR | |
| destination_vpc_id | 목적지 VPC ID | |
| destination_vpc_name | 목적지 VPC 명 | |
| destination_vpc_type | 목적지 VPC 유형 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | 출발지 VPC ID | |
| source_vpc_name | 출발지 VPC 명 | |
| source_vpc_type | 출발지 VPC 유형 | |
| state | 상태 | |
| vpc_peering_id | VPC Peering ID |
5.8.1.19.2 - 1.0
scpcli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]
Description
VPC Peering 규칙 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
| destination_vpc_type required | string | 목적지 VPC 유형 | - |
| destination_cidr required | string | 목적지 CIDR | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering 규칙 ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | 목적지 CIDR | |
| destination_vpc_id | 목적지 VPC ID | |
| destination_vpc_name | 목적지 VPC 명 | |
| destination_vpc_type | 목적지 VPC 유형 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | 출발지 VPC ID | |
| source_vpc_name | 출발지 VPC 명 | |
| source_vpc_type | 출발지 VPC 유형 | |
| state | 상태 | |
| vpc_peering_id | VPC Peering ID |
5.8.1.20 - Delete Internet Gateway
5.8.1.20.1 - 1.1
scpcli vpc internet-gateway delete
--internet_gateway_id <value>
Description
Internet Gateway를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | - |
5.8.1.20.2 - 1.0
scpcli vpc internet-gateway delete
--internet_gateway_id <value>
Description
Internet Gateway를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | - |
5.8.1.21 - Delete NAT Gateway
5.8.1.21.1 - 1.1
scpcli vpc nat-gateway delete
--nat_gateway_id <value>
Description
NAT Gateway를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway 명 | - |
5.8.1.21.2 - 1.0
scpcli vpc nat-gateway delete
--nat_gateway_id <value>
Description
NAT Gateway를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway 명 | - |
5.8.1.22 - Delete Port
5.8.1.22.1 - 1.1
scpcli vpc port delete
--port_id <value>
Description
Port를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | - |
5.8.1.22.2 - 1.0
scpcli vpc port delete
--port_id <value>
Description
Port를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | - |
5.8.1.23 - Delete Private NAT
5.8.1.23.1 - 1.1
scpcli vpc private-nat delete
--private_nat_id <value>
Description
Private NAT 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | - |
5.8.1.23.2 - 1.0
scpcli vpc private-nat delete
--private_nat_id <value>
Description
Private NAT 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | - |
5.8.1.24 - Delete Private NAT IP
5.8.1.24.1 - 1.1
scpcli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Private NAT IP 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_ip_id required | string | Private NAT IP ID | - |
| private_nat_id required | string | Private NAT ID | - |
5.8.1.24.2 - 1.0
scpcli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Private NAT IP 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | - |
5.8.1.25 - Delete PrivateLink Endpoint
5.8.1.25.1 - 1.1
scpcli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>
Description
PrivateLink Endpoint 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | - |
5.8.1.26 - Delete PrivateLink Service
5.8.1.26.1 - 1.1
scpcli vpc privatelink-service delete
--privatelink_service_id <value>
Description
PrivateLink Service 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | - |
5.8.1.27 - Delete PublicIP
5.8.1.27.1 - 1.1
scpcli vpc public-ip delete
--publicip_id <value>
Description
PublicIP를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | - |
5.8.1.27.2 - 1.0
scpcli vpc public-ip delete
--publicip_id <value>
Description
PublicIP를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | - |
5.8.1.28 - Delete Subnet
5.8.1.28.1 - 1.1
scpcli vpc subnet delete
--subnet_id <value>
Description
Subnet을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
5.8.1.28.2 - 1.0
scpcli vpc subnet delete
--subnet_id <value>
Description
Subnet을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
5.8.1.29 - Delete Transit Gateway
5.8.1.29.1 - 1.1
scpcli vpc transit-gateway delete
--transit_gateway_id <value>
Description
Transit Gateway 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
5.8.1.29.2 - 1.0
scpcli vpc transit-gateway delete
--transit_gateway_id <value>
Description
Transit Gateway 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
5.8.1.30 - Delete Transit Gateway Rule
5.8.1.30.1 - 1.1
scpcli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Transit Gateway 규칙 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| transit_gateway_id required | string | Transit Gateway ID | - |
5.8.1.30.2 - 1.0
scpcli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Transit Gateway 규칙 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| transit_gateway_id required | string | Transit Gateway ID | - |
5.8.1.31 - Delete Transit Gateway VPC Connection
5.8.1.31.1 - 1.1
scpcli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>
Description
Transit Gateway VPC 연결 삭제.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_connection_id required | string | Transit Gateway VPC 연결 ID | - |
| transit_gateway_id required | string | Transit Gateway ID | - |
5.8.1.31.2 - 1.0
scpcli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>
Description
Transit Gateway VPC 연결 삭제.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_connection_id required | string | Transit Gateway VPC 연결 ID | - |
| transit_gateway_id required | string | Transit Gateway ID | - |
5.8.1.32 - Delete VPC
5.8.1.32.1 - 1.1
scpcli vpc vpc delete
--vpc_id <value>
Description
VPC를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
5.8.1.32.2 - 1.0
scpcli vpc vpc delete
--vpc_id <value>
Description
VPC를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
5.8.1.33 - Delete VPC Endpoint
5.8.1.33.1 - 1.1
scpcli vpc vpc-endpoint delete
--vpc_endpoint_id <value>
Description
VPC Endpoint 를 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | - |
5.8.1.33.2 - 1.0
scpcli vpc vpc-endpoint delete
--vpc_endpoint_id <value>
Description
VPC Endpoint 를 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | - |
5.8.1.34 - Delete VPC Peering
5.8.1.34.1 - 1.1
scpcli vpc vpc-peering delete
--vpc_peering_id <value>
Description
VPC Peering 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
5.8.1.34.2 - 1.0
scpcli vpc vpc-peering delete
--vpc_peering_id <value>
Description
VPC Peering 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
5.8.1.35 - Delete VPC Peering Rule
5.8.1.35.1 - 1.1
scpcli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>
Description
VPC Peering 규칙 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| vpc_peering_id required | string | VPC Peering ID | - |
5.8.1.35.2 - 1.0
scpcli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>
Description
VPC Peering 규칙 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| vpc_peering_id required | string | VPC Peering ID | - |
5.8.1.36 - List Connected PrivateLink Endpoints
5.8.1.36.1 - 1.1
scpcli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
연결된 PrivateLink Endpoint 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | - |
| 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 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| privatelink_service_id | PrivateLink Service ID | |
| state | PrivateLink Endpoint 상태 |
5.8.1.37 - List Internet Gateways
5.8.1.37.1 - 1.1
scpcli 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
Internet Gateway 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Internet Gateway ID | - |
| name optional | string | Internet Gateway 명 | - |
| type optional | **** | Internet Gateway 유형 | - |
| state optional | string | 상태 | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| firewall_id | Firewall ID | |
| loggable | NAT 로그 저장 여부 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway 명 | |
| state | 상태 | |
| type | Internet Gateway 유형 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.37.2 - 1.0
scpcli 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
Internet Gateway 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Internet Gateway ID | - |
| name optional | string | Internet Gateway 명 | - |
| type optional | **** | Internet Gateway 유형 | - |
| state optional | string | 상태 | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| firewall_id | Firewall ID | |
| loggable | NAT 로그 저장 여부 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway 명 | |
| state | 상태 | |
| type | Internet Gateway 유형 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.38 - List NAT Gateways
5.8.1.38.1 - 1.1
scpcli 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
NAT Gateway 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| name optional | string | NAT Gateway 명 | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
| subnet_id optional | string | Subnet ID | - |
| subnet_name optional | string | Subnet 명 | - |
| nat_gateway_ip_address optional | string | NAT Gateway IP 주소 | - |
| state optional | **** | NAT Gateway 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway 명 | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway 명 | |
| nat_gateway_ip_address | NAT Gateway IP 주소 | |
| publicip_id | PublicIP ID | |
| state | NAT Gateway 상태 | |
| subnet_cidr | Subnet Cidr | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.38.2 - 1.0
scpcli 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
NAT Gateway 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| name optional | string | NAT Gateway 명 | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
| subnet_id optional | string | Subnet ID | - |
| subnet_name optional | string | Subnet 명 | - |
| nat_gateway_ip_address optional | string | NAT Gateway IP 주소 | - |
| state optional | **** | NAT Gateway 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway 명 | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway 명 | |
| nat_gateway_ip_address | NAT Gateway IP 주소 | |
| publicip_id | PublicIP ID | |
| state | NAT Gateway 상태 | |
| subnet_cidr | Subnet Cidr | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.39 - List Ports
5.8.1.39.1 - 1.1
scpcli 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>]
Description
Port 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | Port 제한 | - |
| marker optional | string | Port 마커 | - |
| sort optional | string | Port 정렬 | - |
| name optional | string | Port 명 | - |
| subnet_id optional | string | Subnet ID | - |
| subnet_name optional | string | Subnet 명 | - |
| id optional | string | Port ID | - |
| attached_resource_id optional | string | 연결된 자원 ID | - |
| fixed_ip_address optional | string | 고정된 IP | - |
| mac_address optional | string | MAC 주소 | - |
| state optional | string | 상태 | - |
| security_groups optional | string | Security Group 목록 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | |
| account_id | Account ID | |
| attached_resource_id | 연결된 자원 ID | |
| attached_resource_type | 연결된 자원 유형 | |
| created_at | 생성일시 | |
| description | 설명 | |
| fixed_ip_address | 고정된 IP | |
| mac_address | MAC 주소 | |
| modified_at | 수정일시 | |
| name | Port 명 | |
| state | 상태 | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.39.2 - 1.0
scpcli 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>]
Description
Port 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | Port 제한 | - |
| marker optional | string | Port 마커 | - |
| sort optional | string | Port 정렬 | - |
| name optional | string | Port 명 | - |
| subnet_id optional | string | Subnet ID | - |
| subnet_name optional | string | Subnet 명 | - |
| id optional | string | Port ID | - |
| attached_resource_id optional | string | 연결된 자원 ID | - |
| fixed_ip_address optional | string | 고정된 IP | - |
| mac_address optional | string | MAC 주소 | - |
| state optional | string | 상태 | - |
| security_groups optional | string | Security Group 목록 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | |
| account_id | Account ID | |
| attached_resource_id | 연결된 자원 ID | |
| attached_resource_type | 연결된 자원 유형 | |
| created_at | 생성일시 | |
| description | 설명 | |
| fixed_ip_address | 고정된 IP | |
| mac_address | MAC 주소 | |
| modified_at | 수정일시 | |
| name | Port 명 | |
| state | 상태 | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.40 - List Private NAT
5.8.1.40.1 - 1.1
scpcli 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
Private NAT 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Private NAT 명 | - |
| cidr optional | string | Private NAT IP 대역 | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
| direct_connect_id optional | string | Direct Connect ID | - |
| direct_connect_name optional | string | Direct Connect명 | - |
| state optional | **** | Private NAT 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | |
| account_id | Account ID | |
| cidr | Private NAT IP 대역 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| direct_connect_id | Direct Connect ID | |
| direct_connect_name | Direct Connect명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT 명 | |
| state | Private NAT 상태 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.40.2 - 1.0
scpcli 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
Private NAT 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 명 | - |
| cidr optional | string | Private NAT IP 대역 | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
| direct_connect_id optional | string | Direct Connect ID | - |
| direct_connect_name optional | string | Direct Connect명 | - |
| state optional | **** | Private NAT 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | |
| account_id | Account ID | |
| cidr | Private NAT IP 대역 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| direct_connect_id | Direct Connect ID | |
| direct_connect_name | Direct Connect명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT 명 | |
| state | Private NAT 상태 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.41 - List Private NAT IP
5.8.1.41.1 - 1.1
scpcli 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
Private NAT IP 목록
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | Private NAT IP 주소 | - |
| state optional | **** | Private NAT IP 상태 | - |
| attached_resource_type optional | **** | Private NAT IP 연결된 자원 타입 | - |
| attached_resource_id optional | string | Private NAT IP 연결된 자원 ID | - |
| attached_resource_name optional | string | Private NAT IP 연결된 자원명 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP 연결된 자원 ID | |
| attached_resource_name | Private NAT IP 연결된 자원명 | |
| attached_resource_type | Private NAT IP 연결된 자원 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP 상태 |
5.8.1.41.2 - 1.0
scpcli 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
Private NAT IP 목록
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | Private NAT IP 주소 | - |
| state optional | **** | Private NAT IP 상태 | - |
| attached_resource_type optional | **** | Private NAT IP 연결된 자원 타입 | - |
| attached_resource_id optional | string | Private NAT IP 연결된 자원 ID | - |
| attached_resource_name optional | string | Private NAT IP 연결된 자원명 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP 연결된 자원 ID | |
| attached_resource_name | Private NAT IP 연결된 자원명 | |
| attached_resource_type | Private NAT IP 연결된 자원 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP 상태 |
5.8.1.42 - List PrivateLink Endpoint
5.8.1.42.1 - 1.1
scpcli 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
PrivateLink Endpoint 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | PrivateLink Endpoint ID | - |
| name optional | string | PrivateLink Endpoint 명 | - |
| vpc_id optional | string | VPC ID | - |
| subnet_id optional | string | Subnet ID | - |
| privatelink_service_id optional | string | PrivateLink Service ID | - |
| endpoint_ip_address optional | string | Endpoint IP 주소 | - |
| state optional | **** | PrivateLink Endpoint 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | |
| account_id | Account ID | |
| approval_type | PrivateLink Service 승인 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| endpoint_ip_address | Endpoint IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint 명 | |
| privatelink_service_id | PrivateLink Service ID | |
| state | PrivateLink Endpoint 상태 | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.8.1.43 - List PrivateLink Service
5.8.1.43.1 - 1.1
scpcli 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
PrivateLink Service 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | PrivateLink Service ID | - |
| name optional | string | PrivateLink Service 명 | - |
| vpc_id optional | string | VPC ID | - |
| subnet_id optional | string | Subnet ID | - |
| service_ip_address optional | string | Service IP 주소 | - |
| connected_resource_id optional | string | 연결된 자원 ID | - |
| connected_resource_type optional | string | 연결된 자원 Type | - |
| connected_resource_name optional | string | 연결된 자원명 | - |
| connected_resource_ip_address optional | string | 연결된 자원 IP 주소 | - |
| state optional | **** | PrivateLink Service 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | |
| account_id | Account ID | |
| approval_type | PrivateLink Service 승인 타입 | |
| connected_resource_id | 연결된 자원 ID | |
| connected_resource_ip_address | 연결된 자원 IP 주소 | |
| connected_resource_name | 연결된 자원명 | |
| connected_resource_type | 연결된 자원 Type | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service 명 | |
| service_ip_address | Service IP 주소 | |
| state | PrivateLink Service 상태 | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.8.1.44 - List PublicIPs
5.8.1.44.1 - 1.1
scpcli 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
PublicIP 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | IP 주소 | - |
| state optional | string | PublicIP 상태 | - |
| attached_resource_type optional | string | PublicIP 연결된 자원 타입 | - |
| attached_resource_id optional | string | PublicIP 연결된 자원 ID | - |
| attached_resource_name optional | string | PublicIP 연결된 자원명 | - |
| vpc_id optional | string | VPC ID | - |
| type optional | **** | PublicIP 타입 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | |
| account_id | Account ID | |
| attached_resource_id | PublicIP 연결된 자원 ID | |
| attached_resource_name | PublicIP 연결된 자원명 | |
| attached_resource_type | PublicIP 연결된 자원 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP 상세 설명 | |
| ip_address | IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP 상태 | |
| type | PublicIP 타입 |
5.8.1.44.2 - 1.0
scpcli 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
PublicIP 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | IP 주소 | - |
| state optional | string | PublicIP 상태 | - |
| attached_resource_type optional | string | PublicIP 연결된 자원 타입 | - |
| attached_resource_id optional | string | PublicIP 연결된 자원 ID | - |
| attached_resource_name optional | string | PublicIP 연결된 자원명 | - |
| vpc_id optional | string | VPC ID | - |
| type optional | **** | PublicIP 타입 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | |
| account_id | Account ID | |
| attached_resource_id | PublicIP 연결된 자원 ID | |
| attached_resource_name | PublicIP 연결된 자원명 | |
| attached_resource_type | PublicIP 연결된 자원 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP 상세 설명 | |
| ip_address | IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP 상태 | |
| type | PublicIP 타입 |
5.8.1.45 - List Subnets
5.8.1.45.1 - 1.1
scpcli 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
Subnet 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| name optional | string | Subnet 명 | subnetName |
| type optional | **** | Subnet 유형 | - |
| state optional | **** | 상태 | - |
| vpc_id optional | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC 명 | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| gateway_ip_address | Gateway IP | 192.167.1.1 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet 명 | subnetName |
| state | 상태 | |
| type | Subnet 유형 | |
| vpc_id | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC 명 | vpcName |
5.8.1.45.2 - 1.0
scpcli 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
Subnet 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| name optional | string | Subnet 명 | subnetName |
| type optional | **** | Subnet 유형 | - |
| state optional | **** | 상태 | - |
| vpc_id optional | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC 명 | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| gateway_ip_address | Gateway IP | 192.167.1.1 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet 명 | subnetName |
| state | 상태 | |
| type | Subnet 유형 | |
| vpc_id | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC 명 | vpcName |
5.8.1.46 - List Transit Gateway Rules
5.8.1.46.1 - 1.1
scpcli 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
Transit Gateway 규칙 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | - |
| tgw_connection_vpc_id optional | string | Transit Gateway에 연결된 VPC ID. | - |
| tgw_connection_vpc_name optional | string | Transit Gateway에 연결된 VPC명. | - |
| source_type optional | **** | 출발지 타입 | - |
| destination_type optional | **** | 목적지 타입 | - |
| destination_cidr optional | string | 목적지 CIDR | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| destination_cidr | 목적지 CIDR | |
| destination_resource_id | 목적지 자원 ID | |
| destination_resource_name | 목적지 자원명 | |
| destination_type | 목적지 타입 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_resource_id | 출발지 자원 ID | |
| source_resource_name | 출발지 자원명 | |
| source_type | 출발지 타입 | |
| state | 상태 | |
| tgw_connection_vpc_id | Transit Gateway에 연결된 VPC ID. | |
| tgw_connection_vpc_name | Transit Gateway에 연결된 VPC명. |
5.8.1.46.2 - 1.0
scpcli 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
Transit Gateway 규칙 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | - |
| tgw_connection_vpc_id optional | string | Transit Gateway에 연결된 VPC ID. | - |
| tgw_connection_vpc_name optional | string | Transit Gateway에 연결된 VPC명. | - |
| source_type optional | **** | 출발지 타입 | - |
| destination_type optional | **** | 목적지 타입 | - |
| destination_cidr optional | string | 목적지 CIDR | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| destination_cidr | 목적지 CIDR | |
| destination_resource_id | 목적지 자원 ID | |
| destination_resource_name | 목적지 자원명 | |
| destination_type | 목적지 타입 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_resource_id | 출발지 자원 ID | |
| source_resource_name | 출발지 자원명 | |
| source_type | 출발지 타입 | |
| state | 상태 | |
| tgw_connection_vpc_id | Transit Gateway에 연결된 VPC ID. | |
| tgw_connection_vpc_name | Transit Gateway에 연결된 VPC명. |
5.8.1.47 - List Transit Gateway VPC Connections
5.8.1.47.1 - 1.1
scpcli 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
Transit Gateway VPC 연결 목록 조회.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway VPC 연결 ID | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC 연결 ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | 상태 | |
| transit_gateway_id | Transit Gateway ID | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.47.2 - 1.0
scpcli 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
Transit Gateway VPC 연결 목록 조회.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway VPC 연결 ID | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC 연결 ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | 상태 | |
| transit_gateway_id | Transit Gateway ID | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.48 - List Transit Gateways
5.8.1.48.1 - 1.1
scpcli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
Description
Transit Gateway 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Transit Gateway ID | - |
| name optional | string | Transit Gateway 명 | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | |
| account_id | Account ID | |
| bandwidth | Transit Gateway 포트 용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway 상세 설명 | |
| firewall_ids | Firewall ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway 명 | |
| state | 상태 | |
| uplink_enabled | Uplink 사용 |
5.8.1.48.2 - 1.0
scpcli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
Description
Transit Gateway 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | - |
| name optional | string | Transit Gateway 명 | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | |
| account_id | Account ID | |
| bandwidth | Transit Gateway 포트 용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway 상세 설명 | |
| firewall_ids | Firewall ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway 명 | |
| state | 상태 | |
| uplink_enabled | Uplink 사용 |
5.8.1.49 - List VPC Endpoint
5.8.1.49.1 - 1.1
scpcli 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
VPC Endpoint 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Endpoint ID | - |
| name optional | string | VPC Endpoint 명 | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
| subnet_id optional | string | Subnet ID | - |
| resource_key optional | string | VPC Endpoint Resource Key | - |
| resource_type optional | **** | VPC Endpoint 자원 타입 | - |
| endpoint_ip_address optional | string | VPC Endpoint IP 주소 | - |
| state optional | **** | VPC Endpoint 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| endpoint_ip_address | VPC Endpoint IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint 명 | |
| resource_info | VPC Endpoint Resource Key 정보 | |
| resource_key | VPC Endpoint Resource Key | |
| resource_type | VPC Endpoint 자원 타입 | |
| state | VPC Endpoint 상태 | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.49.2 - 1.0
scpcli 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
VPC Endpoint 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Endpoint ID | - |
| name optional | string | VPC Endpoint 명 | - |
| vpc_id optional | string | VPC ID | - |
| vpc_name optional | string | VPC 명 | - |
| subnet_id optional | string | Subnet ID | - |
| resource_key optional | string | VPC Endpoint Resource Key | - |
| resource_type optional | **** | VPC Endpoint 자원 타입 | - |
| endpoint_ip_address optional | string | VPC Endpoint IP 주소 | - |
| state optional | **** | VPC Endpoint 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| endpoint_ip_address | VPC Endpoint IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint 명 | |
| resource_info | VPC Endpoint Resource Key 정보 | |
| resource_key | VPC Endpoint Resource Key | |
| resource_type | VPC Endpoint 자원 타입 | |
| state | VPC Endpoint 상태 | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.50 - List VPC Endpoint Connectable Resources
5.8.1.50.1 - 1.1
scpcli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]
Description
List VpcEndpoint connectable resources
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | VPC Endpoint 자원 타입 | - |
| vpc_id optional | string | VPC ID(resource_type이 DNS인 경우, 필수 입력값입니다) | - |
Responses
| Name | Description | Example |
|---|---|---|
| resource_info | VPC Endpoint Resource Key 정보 | |
| resource_key | VPC Endpoint Resource Key | |
| resource_type | VPC Endpoint 자원 타입 |
5.8.1.50.2 - 1.0
scpcli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]
Description
List VpcEndpoint connectable resources
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | VPC Endpoint 자원 타입 | - |
| vpc_id optional | string | VPC ID(resource_type이 DNS인 경우, 필수 입력값입니다) | - |
Responses
| Name | Description | Example |
|---|---|---|
| resource_info | VPC Endpoint Resource Key 정보 | |
| resource_key | VPC Endpoint Resource Key | |
| resource_type | VPC Endpoint 자원 타입 |
5.8.1.51 - List VPC Peering
5.8.1.51.1 - 1.1
scpcli 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
VPC Peering 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | VPC Peering ID | - |
| name optional | string | VPC Peering 명 | - |
| requester_vpc_id optional | string | 요청 VPC ID | - |
| requester_vpc_name optional | string | 요청 VPC 명 | - |
| approver_vpc_id optional | string | 승인 VPC ID | - |
| approver_vpc_name optional | string | 승인 VPC 명 | - |
| account_type optional | **** | 과제 유형 | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | |
| account_type | 과제 유형 | |
| approver_vpc_account_id | 승인 VPC 과제 ID | |
| approver_vpc_id | 승인 VPC ID | |
| approver_vpc_name | 승인 VPC 명 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | 요청 VPC 과제 ID | |
| description | VPC Peering 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering 명 | |
| requester_vpc_account_id | 요청 VPC 과제 ID | |
| requester_vpc_id | 요청 VPC ID | |
| requester_vpc_name | 요청 VPC 명 | |
| state | 상태 |
5.8.1.51.2 - 1.0
scpcli 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
VPC Peering 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | - |
| name optional | string | VPC Peering 명 | - |
| requester_vpc_id optional | string | 요청 VPC ID | - |
| requester_vpc_name optional | string | 요청 VPC 명 | - |
| approver_vpc_id optional | string | 승인 VPC ID | - |
| approver_vpc_name optional | string | 승인 VPC 명 | - |
| account_type optional | **** | 과제 유형 | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | |
| account_type | 과제 유형 | |
| approver_vpc_account_id | 승인 VPC 과제 ID | |
| approver_vpc_id | 승인 VPC ID | |
| approver_vpc_name | 승인 VPC 명 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | 요청 VPC 과제 ID | |
| description | VPC Peering 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering 명 | |
| requester_vpc_account_id | 요청 VPC 과제 ID | |
| requester_vpc_id | 요청 VPC ID | |
| requester_vpc_name | 요청 VPC 명 | |
| state | 상태 |
5.8.1.52 - List VPC Peering Rules
5.8.1.52.1 - 1.1
scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
VPC Peering 규칙 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering 규칙 ID | - |
| name optional | string | VPC Peering 명 | - |
| source_vpc_id optional | string | 출발지 VPC ID | - |
| source_vpc_type optional | **** | 출발지 VPC 유형 | - |
| destination_vpc_id optional | string | 목적지 VPC ID | - |
| destination_vpc_type optional | **** | 목적지 VPC 유형 | - |
| destination_cidr optional | string | 목적지 CIDR | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering 규칙 ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | 목적지 CIDR | |
| destination_vpc_id | 목적지 VPC ID | |
| destination_vpc_name | 목적지 VPC 명 | |
| destination_vpc_type | 목적지 VPC 유형 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | 출발지 VPC ID | |
| source_vpc_name | 출발지 VPC 명 | |
| source_vpc_type | 출발지 VPC 유형 | |
| state | 상태 | |
| vpc_peering_id | VPC Peering ID |
5.8.1.52.2 - 1.0
scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
VPC Peering 규칙 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering 규칙 ID | - |
| name optional | string | VPC Peering 명 | - |
| source_vpc_id optional | string | 출발지 VPC ID | - |
| source_vpc_type optional | **** | 출발지 VPC 유형 | - |
| destination_vpc_id optional | string | 목적지 VPC ID | - |
| destination_vpc_type optional | **** | 목적지 VPC 유형 | - |
| destination_cidr optional | string | 목적지 CIDR | - |
| state optional | **** | 상태 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering 규칙 ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | 목적지 CIDR | |
| destination_vpc_id | 목적지 VPC ID | |
| destination_vpc_name | 목적지 VPC 명 | |
| destination_vpc_type | 목적지 VPC 유형 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | 출발지 VPC ID | |
| source_vpc_name | 출발지 VPC 명 | |
| source_vpc_type | 출발지 VPC 유형 | |
| state | 상태 | |
| vpc_peering_id | VPC Peering ID |
5.8.1.53 - List VPCs
5.8.1.53.1 - 1.1
scpcli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]
Description
VPC 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| name optional | string | VPC 명 | vpcName |
| state optional | **** | 상태 | - |
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | vpcDescription |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC 명 | vpcName |
| state | 상태 |
5.8.1.53.2 - 1.0
scpcli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]
Description
VPC 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| name optional | string | VPC 명 | vpcName |
| state optional | **** | 상태 | - |
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | vpcDescription |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC 명 | vpcName |
| state | 상태 |
5.8.1.54 - Request PrivateLink Endpoint
5.8.1.54.1 - 1.1
scpcli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>
Description
Request PrivateLink Endpoint
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | - |
| type required | string | PrivateLink Endpoint Action Type | - |
5.8.1.55 - Set Internet Gateway
5.8.1.55.1 - 1.1
scpcli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]
Description
Internet Gateway를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | - |
| description optional | string | 설명 | - |
| loggable optional | boolean | NAT 로그 저장 여부 | - |
5.8.1.55.2 - 1.0
scpcli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]
Description
Internet Gateway를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | - |
| description optional | string | 설명 | - |
| loggable optional | boolean | NAT 로그 저장 여부 | - |
5.8.1.56 - Set NAT Gateway
5.8.1.56.1 - 1.1
scpcli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]
Description
NAT Gateway를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway 명 | - |
| description optional | string | NAT Gateway 상세설명 | - |
5.8.1.56.2 - 1.0
scpcli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]
Description
NAT Gateway를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway 명 | - |
| description optional | string | NAT Gateway 상세설명 | - |
5.8.1.57 - Set Port
5.8.1.57.1 - 1.1
scpcli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]
Description
Port를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | - |
| description optional | string | 설명 | - |
| security_groups optional | array | Security Group 목록 | - |
5.8.1.57.2 - 1.0
scpcli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]
Description
Port를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | - |
| description optional | string | 설명 | - |
| security_groups optional | array | Security Group 목록 | - |
5.8.1.58 - Set Private NAT
5.8.1.58.1 - 1.1
scpcli vpc private-nat set
--private_nat_id <value>
[--description <value>]
Description
Private NAT 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | - |
| description optional | string | 설명 | - |
5.8.1.58.2 - 1.0
scpcli vpc private-nat set
--private_nat_id <value>
[--description <value>]
Description
Private NAT 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | - |
| description optional | string | 설명 | - |
5.8.1.59 - Set PrivateLink Endpoint
5.8.1.59.1 - 1.1
scpcli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]
Description
PrivateLink Endpoint 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | - |
| description optional | string | 설명 | - |
5.8.1.60 - Set PrivateLink Service
5.8.1.60.1 - 1.1
scpcli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]
Description
PrivateLink Service 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | - |
| description optional | string | 설명 | - |
5.8.1.61 - Set PublicIP
5.8.1.61.1 - 1.1
scpcli vpc public-ip set
--publicip_id <value>
--description <value>
Description
PublicIP를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | - |
| description required | string | PublicIP 상세 설명 | - |
5.8.1.61.2 - 1.0
scpcli vpc public-ip set
--publicip_id <value>
--description <value>
Description
PublicIP를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | - |
| description required | string | PublicIP 상세 설명 | - |
5.8.1.62 - Set Subnet
5.8.1.62.1 - 1.1
scpcli vpc subnet set
--subnet_id <value>
--description <value>
Description
Subnet을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| description required | string | 설명 | Subnet Description |
5.8.1.62.2 - 1.0
scpcli vpc subnet set
--subnet_id <value>
--description <value>
Description
Subnet을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| description required | string | 설명 | Subnet Description |
5.8.1.63 - Set Transit Gateway
5.8.1.63.1 - 1.1
scpcli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]
Description
Transit Gateway 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
| description optional | string | 설명 | - |
5.8.1.63.2 - 1.0
scpcli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]
Description
Transit Gateway 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
| description optional | string | 설명 | - |
5.8.1.64 - Set VPC
5.8.1.64.1 - 1.1
scpcli vpc vpc set
--vpc_id <value>
[--description <value>]
Description
VPC를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| description optional | string | 설명 | vpcDescription |
5.8.1.64.2 - 1.0
scpcli vpc vpc set
--vpc_id <value>
[--description <value>]
Description
VPC를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC ID | - |
| description optional | string | 설명 | vpcDescription |
5.8.1.65 - Set VPC Endpoint
5.8.1.65.1 - 1.1
scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]
Description
VPC Endpoint 를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | - |
| description optional | string | 설명 | - |
5.8.1.65.2 - 1.0
scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]
Description
VPC Endpoint 를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | - |
| description optional | string | 설명 | - |
5.8.1.66 - Set VPC Peering
5.8.1.66.1 - 1.1
scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]
Description
VPC Peering 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
| description optional | string | 설명 | - |
5.8.1.66.2 - 1.0
scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]
Description
VPC Peering 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
| description optional | string | 설명 | - |
5.8.1.67 - Show Internet Gateway
5.8.1.67.1 - 1.1
scpcli vpc internet-gateway show
--internet_gateway_id <value>
Description
Internet Gateway를 상세조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| firewall_id | Firewall ID | |
| loggable | NAT 로그 저장 여부 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway 명 | |
| state | 상태 | |
| type | Internet Gateway 유형 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.67.2 - 1.0
scpcli vpc internet-gateway show
--internet_gateway_id <value>
Description
Internet Gateway를 상세조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| firewall_id | Firewall ID | |
| loggable | NAT 로그 저장 여부 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway 명 | |
| state | 상태 | |
| type | Internet Gateway 유형 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.68 - Show NAT Gateway
5.8.1.68.1 - 1.1
scpcli vpc nat-gateway show
--nat_gateway_id <value>
Description
NAT Gateway를 상세조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway 명 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway 명 | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway 명 | |
| nat_gateway_ip_address | NAT Gateway IP 주소 | |
| publicip_id | PublicIP ID | |
| state | NAT Gateway 상태 | |
| subnet_cidr | Subnet Cidr | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.68.2 - 1.0
scpcli vpc nat-gateway show
--nat_gateway_id <value>
Description
NAT Gateway를 상세조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway 명 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway 명 | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway 명 | |
| nat_gateway_ip_address | NAT Gateway IP 주소 | |
| publicip_id | PublicIP ID | |
| state | NAT Gateway 상태 | |
| subnet_cidr | Subnet Cidr | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.69 - Show Port
5.8.1.69.1 - 1.1
scpcli vpc port show
--port_id <value>
Description
Port를 상세조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| port |
5.8.1.69.2 - 1.0
scpcli vpc port show
--port_id <value>
Description
Port를 상세조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| port |
5.8.1.70 - Show Private NAT
5.8.1.70.1 - 1.1
scpcli vpc private-nat show
--private_nat_id <value>
Description
Private NAT 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | |
| account_id | Account ID | |
| cidr | Private NAT IP 대역 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| direct_connect_id | Direct Connect ID | |
| direct_connect_name | Direct Connect명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT 명 | |
| state | Private NAT 상태 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.70.2 - 1.0
scpcli vpc private-nat show
--private_nat_id <value>
Description
Private NAT 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | |
| account_id | Account ID | |
| cidr | Private NAT IP 대역 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| direct_connect_id | Direct Connect ID | |
| direct_connect_name | Direct Connect명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT 명 | |
| state | Private NAT 상태 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.71 - Show PrivateLink Endpoint
5.8.1.71.1 - 1.1
scpcli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>
Description
PrivateLink Endpoint 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | |
| account_id | Account ID | |
| approval_type | PrivateLink Service 승인 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| endpoint_ip_address | Endpoint IP 주소 | |
| endpoint_ip_port_id | Endpoint IP Port ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint 명 | |
| privatelink_service_id | PrivateLink Service ID | |
| security_group_ids | Security Group 목록 | |
| state | PrivateLink Endpoint 상태 | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.8.1.72 - Show PrivateLink Service
5.8.1.72.1 - 1.1
scpcli vpc privatelink-service show
--privatelink_service_id <value>
Description
PrivateLink Service 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | |
| account_id | Account ID | |
| approval_type | PrivateLink Service 승인 타입 | |
| connected_resource_id | 연결된 자원 ID | |
| connected_resource_ip_address | 연결된 자원 IP 주소 | |
| connected_resource_name | 연결된 자원명 | |
| connected_resource_type | 연결된 자원 Type | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| high_speed_transfer | 고속 데이터 전송 사용 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service 명 | |
| security_group_ids | Security Group 목록 | |
| service_ip_address | Service IP 주소 | |
| service_ip_port_id | Service IP Port ID | |
| state | PrivateLink Service 상태 | |
| subnet_id | Subnet ID | |
| vpc_id | VPC ID |
5.8.1.73 - Show PublicIP
5.8.1.73.1 - 1.1
scpcli vpc public-ip show
--publicip_id <value>
Description
PublicIP를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | |
| account_id | Account ID | |
| attached_resource_id | PublicIP 연결된 자원 ID | |
| attached_resource_name | PublicIP 연결된 자원명 | |
| attached_resource_type | PublicIP 연결된 자원 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP 상세 설명 | |
| ip_address | IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP 상태 | |
| type | PublicIP 타입 |
5.8.1.73.2 - 1.0
scpcli vpc public-ip show
--publicip_id <value>
Description
PublicIP를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | |
| account_id | Account ID | |
| attached_resource_id | PublicIP 연결된 자원 ID | |
| attached_resource_name | PublicIP 연결된 자원명 | |
| attached_resource_type | PublicIP 연결된 자원 타입 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP 상세 설명 | |
| ip_address | IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP 상태 | |
| type | PublicIP 타입 |
5.8.1.74 - Show Subnet
5.8.1.74.1 - 1.1
scpcli vpc subnet show
--subnet_id <value>
Description
Subnet을 상세조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
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 | IP 할당 범위 | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Subnet Description |
| dns_nameservers | DNS Name Server | |
| gateway_ip_address | Gateway IP | 192.167.1.1 |
| host_routes | 호스트 경로 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet 명 | subnetName |
| state | 상태 | |
| type | Subnet 유형 | |
| vpc_id | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC 명 | vpcName |
5.8.1.74.2 - 1.0
scpcli vpc subnet show
--subnet_id <value>
Description
Subnet을 상세조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | IP 할당 범위 | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Subnet Description |
| dns_nameservers | DNS Name Server | |
| gateway_ip_address | Gateway IP | 192.167.1.1 |
| host_routes | 호스트 경로 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet 명 | subnetName |
| state | 상태 | |
| type | Subnet 유형 | |
| vpc_id | VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC 명 | vpcName |
5.8.1.75 - Show Transit Gateway
5.8.1.75.1 - 1.1
scpcli vpc transit-gateway show
--transit_gateway_id <value>
Description
Transit Gateway 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | |
| account_id | Account ID | |
| bandwidth | Transit Gateway 포트 용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway 상세 설명 | |
| firewall_ids | Firewall ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway 명 | |
| state | 상태 | |
| uplink_enabled | Uplink 사용 |
5.8.1.75.2 - 1.0
scpcli vpc transit-gateway show
--transit_gateway_id <value>
Description
Transit Gateway 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | |
| account_id | Account ID | |
| bandwidth | Transit Gateway 포트 용량 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway 상세 설명 | |
| firewall_ids | Firewall ID | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway 명 | |
| state | 상태 | |
| uplink_enabled | Uplink 사용 |
5.8.1.76 - Show VPC
5.8.1.76.1 - 1.1
scpcli vpc vpc show
--vpc_id <value>
Description
VPC를 상세조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | vpcDescription |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC 명 | vpcName |
| state | 상태 |
5.8.1.76.2 - 1.0
scpcli vpc vpc show
--vpc_id <value>
Description
VPC를 상세조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | vpcDescription |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC 명 | vpcName |
| state | 상태 |
5.8.1.77 - Show VPC Endpoint
5.8.1.77.1 - 1.1
scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>
Description
VPC Endpoint 를 상세조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| endpoint_ip_address | VPC Endpoint IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint 명 | |
| resource_info | VPC Endpoint Resource Key 정보 | |
| resource_key | VPC Endpoint Resource Key | |
| resource_type | VPC Endpoint 자원 타입 | |
| state | VPC Endpoint 상태 | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.77.2 - 1.0
scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>
Description
VPC Endpoint 를 상세조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | |
| endpoint_ip_address | VPC Endpoint IP 주소 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint 명 | |
| resource_info | VPC Endpoint Resource Key 정보 | |
| resource_key | VPC Endpoint Resource Key | |
| resource_type | VPC Endpoint 자원 타입 | |
| state | VPC Endpoint 상태 | |
| subnet_id | Subnet ID | |
| subnet_name | Subnet 명 | |
| vpc_id | VPC ID | |
| vpc_name | VPC 명 |
5.8.1.78 - Show VPC Peering
5.8.1.78.1 - 1.1
scpcli vpc vpc-peering show
--vpc_peering_id <value>
Description
VPC Peering 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | |
| account_type | 과제 유형 | |
| approver_vpc_account_id | 승인 VPC 과제 ID | |
| approver_vpc_id | 승인 VPC ID | |
| approver_vpc_name | 승인 VPC 명 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | 요청 VPC 과제 ID | |
| description | VPC Peering 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering 명 | |
| requester_vpc_account_id | 요청 VPC 과제 ID | |
| requester_vpc_id | 요청 VPC ID | |
| requester_vpc_name | 요청 VPC 명 | |
| state | 상태 |
5.8.1.78.2 - 1.0
scpcli vpc vpc-peering show
--vpc_peering_id <value>
Description
VPC Peering 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | |
| account_type | 과제 유형 | |
| approver_vpc_account_id | 승인 VPC 과제 ID | |
| approver_vpc_id | 승인 VPC ID | |
| approver_vpc_name | 승인 VPC 명 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | 요청 VPC 과제 ID | |
| description | VPC Peering 상세설명 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering 명 | |
| requester_vpc_account_id | 요청 VPC 과제 ID | |
| requester_vpc_id | 요청 VPC ID | |
| requester_vpc_name | 요청 VPC 명 | |
| state | 상태 |
5.9 - VPN
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 VPN 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
5.9.1 - CLIs
5.9.1.1 - Create VPN Gateway
5.9.1.1.1 - 1.1
scpcli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]
Description
VPN gateway 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 타입 | PUBLIC |
| ip_id required | string | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_address required | string | VPN Gateway IP 주소 | 123.0.0.1 |
| description optional | string | 설명 | Example Description for VPN Gateway |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP 타입 | PUBLIC |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | 상태 | ACTIVE |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
5.9.1.1.2 - 1.0
scpcli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]
Description
VPN gateway 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 타입 | PUBLIC |
| ip_id required | string | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_address required | string | VPN Gateway IP 주소 | 123.0.0.1 |
| description optional | string | 설명 | Example Description for VPN Gateway |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP 타입 | PUBLIC |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | 상태 | ACTIVE |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
5.9.1.2 - Create VPN Tunnel
5.9.1.2.1 - 1.1
scpcli 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
VPN tunnel 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 목록 | null-md5 |
| phase2_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group 목록 | 30 |
| perfect_forward_secrecy required | string | VPN Tunnel IPSec Perfect Forward Secrecy(PFS) | ENABLE |
| pre_shared_key required | string | VPN Tunnel ISAKMP 인증 : Pre-shared Key | PreSharedKey1 |
| phase1_life_time required | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| phase1_encryptions required | array | VPN Tunnel ISAKMP Proposal 목록 | des-md5 |
| phase1_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group 목록 | 30 |
| peer_gateway_ip required | string | VPN Tunnel Peer Gateway IP 주소 | 123.0.0.2 |
| ike_version required | integer | VPN Tunnel IKE 버전 | 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 이름 | ExampleVpnTunnel1 |
| description optional | string | 설명 | Example Description for VPN Tunnel |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Tunnel |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel 이름 | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | 상태 | ACTIVE |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
5.9.1.2.2 - 1.0
scpcli 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
VPN tunnel 생성
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 목록 | null-md5 |
| phase2_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group 목록 | 30 |
| perfect_forward_secrecy required | string | VPN Tunnel IPSec Perfect Forward Secrecy(PFS) | ENABLE |
| pre_shared_key required | string | VPN Tunnel ISAKMP 인증 : Pre-shared Key | PreSharedKey1 |
| phase1_life_time required | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| phase1_encryptions required | array | VPN Tunnel ISAKMP Proposal 목록 | des-md5 |
| phase1_diffie_hellman_groups required | array | VPN Tunnel ISAKMP Diffie-Hellman Group 목록 | 30 |
| peer_gateway_ip required | string | VPN Tunnel Peer Gateway IP 주소 | 123.0.0.2 |
| ike_version required | integer | VPN Tunnel IKE 버전 | 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 이름 | ExampleVpnTunnel1 |
| description optional | string | 설명 | Example Description for VPN Tunnel |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Tunnel |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel 이름 | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | 상태 | ACTIVE |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
5.9.1.3 - Delete VPN Gateway
5.9.1.3.1 - 1.1
scpcli vpn vpn-gateway delete
--vpn_gateway_id <value>
Description
VPN gateway 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
5.9.1.3.2 - 1.0
scpcli vpn vpn-gateway delete
--vpn_gateway_id <value>
Description
VPN gateway 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
5.9.1.4 - Delete VPN Tunnel
5.9.1.4.1 - 1.1
scpcli vpn vpn-tunnel delete
--vpn_tunnel_id <value>
Description
VPN tunnel 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
5.9.1.4.2 - 1.0
scpcli vpn vpn-tunnel delete
--vpn_tunnel_id <value>
Description
VPN tunnel 삭제
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
5.9.1.5 - List VPN Gateways
5.9.1.5.1 - 1.1
scpcli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
VPN gateway 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 주소 | 123.0.0.1 |
| vpc_id optional | string | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name optional | string | VPC 명 | ExampleVPC1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP 타입 | PUBLIC |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | 상태 | ACTIVE |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
5.9.1.5.2 - 1.0
scpcli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
VPN gateway 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 주소 | 123.0.0.1 |
| vpc_id optional | string | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name optional | string | VPC 명 | ExampleVPC1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP 타입 | PUBLIC |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | 상태 | ACTIVE |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
5.9.1.6 - List VPN Tunnels
5.9.1.6.1 - 1.1
scpcli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]
Description
VPN tunnel 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 이름 | 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Tunnel |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel 이름 | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | 상태 | ACTIVE |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
5.9.1.6.2 - 1.0
scpcli 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
VPN tunnel 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 이름 | 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 주소 | 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Tunnel |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel 이름 | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | 상태 | ACTIVE |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
5.9.1.7 - Set VPN Gateway
5.9.1.7.1 - 1.1
scpcli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]
Description
VPN gateway 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| description optional | string | 설명 | Example Description for VPN Gateway |
5.9.1.7.2 - 1.0
scpcli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]
Description
VPN gateway 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_gateway_id required | string | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| description optional | string | 설명 | Example Description for VPN Gateway |
5.9.1.8 - Set VPN Tunnel
5.9.1.8.1 - 1.1
scpcli 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
VPN tunnel 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
| description optional | string | 설명 | 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 버전 | 2 |
| peer_gateway_ip optional | string | VPN Tunnel Peer Gateway IP 주소 | 123.0.0.2 |
| phase1_diffie_hellman_groups optional | array | VPN Tunnel ISAKMP Diffie-Hellman Group 목록 | 30 |
| phase1_encryptions optional | array | VPN Tunnel ISAKMP Proposal 목록 | des-md5 |
| phase1_life_time optional | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| pre_shared_key optional | string | VPN Tunnel ISAKMP 인증 : 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 목록 | 30 |
| phase2_encryptions optional | array | VPN Tunnel ISAKMP Proposal 목록 | 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 |
5.9.1.8.2 - 1.0
scpcli 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
VPN tunnel 수정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpn_tunnel_id required | string | VPN Tunnel ID | 2ade2919287040bc92e557fbbe6709c1 |
| description optional | string | 설명 | 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 버전 | 2 |
| peer_gateway_ip optional | string | VPN Tunnel Peer Gateway IP 주소 | 123.0.0.2 |
| phase1_diffie_hellman_groups optional | array | VPN Tunnel ISAKMP Diffie-Hellman Group 목록 | 30 |
| phase1_encryptions optional | array | VPN Tunnel ISAKMP Proposal 목록 | des-md5 |
| phase1_life_time optional | integer | VPN Tunnel ISAKMP Lifetime (sec) | 86400 |
| pre_shared_key optional | string | VPN Tunnel ISAKMP 인증 : 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 목록 | 30 |
| phase2_encryptions optional | array | VPN Tunnel ISAKMP Proposal 목록 | 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 |
5.9.1.9 - Show VPN Gateway
5.9.1.9.1 - 1.1
scpcli vpn vpn-gateway show
--vpn_gateway_id <value>
Description
VPN gateway 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP 타입 | PUBLIC |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | 상태 | ACTIVE |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
5.9.1.9.2 - 1.0
scpcli vpn vpn-gateway show
--vpn_gateway_id <value>
Description
VPN gateway 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Gateway |
| ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| ip_id | VPN Gateway IP ID | fcde872f75c145a0893d656cc698f13e |
| ip_type | VPN Gateway IP 타입 | PUBLIC |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Gateway Name | ExampleVpnGW1 |
| state | 상태 | ACTIVE |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
5.9.1.10 - Show VPN Tunnel
5.9.1.10.1 - 1.1
scpcli vpn vpn-tunnel show
--vpn_tunnel_id <value>
Description
VPN tunnel 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Tunnel |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel 이름 | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | 상태 | ACTIVE |
| status | VPN Tunnel 상태 | UP |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
5.9.1.10.2 - 1.0
scpcli vpn vpn-tunnel show
--vpn_tunnel_id <value>
Description
VPN tunnel 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 설명 | Example Description for VPN Tunnel |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPN Tunnel 이름 | ExampleVpnTunnel1 |
| phase1 | VPN Tunnel Phase1 | |
| phase2 | VPN Tunnel Phase2 | |
| state | 상태 | ACTIVE |
| status | VPN Tunnel 상태 | UP |
| vpc_id | VPC ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| vpc_name | VPC 명 | ExampleVPC1 |
| vpn_gateway_id | VPN Gateway ID | b156740b6335468d8354eb9ef8eddf5a |
| vpn_gateway_ip_address | VPN Gateway IP 주소 | 123.0.0.1 |
| vpn_gateway_name | VPN Gateway Name | ExampleVpnGW1 |
6 - Database
6.1 - CacheStore(DBaaS)
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 CacheStore(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
6.1.1 - CLIs
6.1.1.1 - Create Cluster
6.1.1.1.1 - 1.0
scpcli cachestore cluster create
--database_user_password <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--replica_count <value>]
[--tags <value>]
[--database_port <value>]
[--sentinel_port <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | '{"block_storage_groups": [{"role_type": "", "size_gb": "", "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' | |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| replica_count optional | integer | Replica count | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| database_port optional | integer | Database service port | - |
| sentinel_port optional | integer | Sentinel port | - |
| retention_period_day optional | string | Backup retention period (day) | 7 |
| starting_time_hour optional | string | Backup starting time (hour) | 2 |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.2 - Create Restore Cluster
6.1.1.2.1 - 1.0
scpcli cachestore restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.3 - List Backup Histories
6.1.1.3.1 - 1.0
scpcli cachestore backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_at | Backup end time | |
| backup_history_number | Backup id | |
| backup_size_gb | Backup amount(GB) | |
| backup_start_at | Backup start time | |
| backup_state | Backup state | |
| backup_state_detail | Backup detail state | |
| software_version | Software version |
6.1.1.4 - List Clusters
6.1.1.4.1 - 1.0
scpcli cachestore cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Cluster name | - |
| service_state optional | string | Service state | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
6.1.1.5 - List Commands
6.1.1.5.1 - 1.0
scpcli cachestore command list
--cluster_id <value>
Description
List Commands.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ||
| applied_value | ||
| description | ||
| modifiable | ||
| name |
6.1.1.6 - List Engine Version Properties
6.1.1.6.1 - 1.0
scpcli cachestore engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
6.1.1.7 - List Engine Versions
6.1.1.7.1 - 1.0
scpcli cachestore engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
6.1.1.8 - List Parameter Groups
6.1.1.8.1 - 1.0
scpcli cachestore parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| major_version optional | string | Software major version | - |
| product_image_type optional | string | Product image type | - |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type |
6.1.1.9 - List Parameter Values
6.1.1.9.1 - 1.0
scpcli cachestore parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| allows_value | Parameter allows value | |
| applied_value | Parameter applied value | |
| apply_type | Parameter apply type | |
| data_type | Parameter data type | |
| default_value | Parameter default value | |
| description | Parameter description | |
| is_modifiable | Parameter is_modifiable | |
| name | Parameter name | |
| software_type | Parameter software type |
6.1.1.10 - List Parameters
6.1.1.10.1 - 1.0
scpcli cachestore parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_parameter_group_id required | string | Parameter group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type |
6.1.1.11 - List Server Types
6.1.1.11.1 - 1.0
scpcli cachestore engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
6.1.1.12 - Remove Backup Histories
6.1.1.12.1 - 1.0
scpcli cachestore backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
6.1.1.13 - Restart Cluster
6.1.1.13.1 - 1.0
scpcli cachestore cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.14 - Set Backup
6.1.1.14.1 - 1.0
scpcli cachestore backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
Description
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.15 - Set Block Storage Size
6.1.1.15.1 - 1.0
scpcli cachestore block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.16 - Set Maintenance
6.1.1.16.1 - 1.0
scpcli cachestore maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.17 - Set Parameter Values
6.1.1.17.1 - 1.0
scpcli cachestore parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
6.1.1.18 - Set Security Group Rules
6.1.1.18.1 - 1.0
scpcli cachestore security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.19 - Set Server Type
6.1.1.19.1 - 1.0
scpcli cachestore server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.20 - Show Cluster
6.1.1.20.1 - 1.0
scpcli cachestore cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_option | Backup setting option | |
| database_port | ||
| sentinel_port |
6.1.1.21 - Show Request
6.1.1.21.1 - 1.0
scpcli cachestore request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
6.1.1.22 - Start Cluster
6.1.1.22.1 - 1.0
scpcli cachestore cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.23 - Stop Cluster
6.1.1.23.1 - 1.0
scpcli cachestore cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.24 - Switchover Cluster
6.1.1.24.1 - 1.0
scpcli cachestore cluster switchover
--cluster_id <value>
--switch_host_name <value>
Description
Switchover Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| switch_host_name required | string | Switch over target | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.25 - Synchronize Cluster State
6.1.1.25.1 - 1.0
scpcli cachestore cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.26 - Synchronize Commands
6.1.1.26.1 - 1.0
scpcli cachestore command sync
--cluster_id <value>
Description
Synchronize Commands.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.27 - Synchronize Parameter Values
6.1.1.27.1 - 1.0
scpcli cachestore parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.1.1.28 - Terminate Cluster
6.1.1.28.1 - 1.0
scpcli cachestore cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.1.1.29 - Unset Backup
6.1.1.29.1 - 1.0
scpcli cachestore backup unset
--cluster_id <value>
Description
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.1.1.30 - Unset Maintenance
6.1.1.30.1 - 1.0
scpcli cachestore maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
6.1.1.31 - Update Commands
6.1.1.31.1 - 1.0
scpcli cachestore command set
--cluster_id <value>
--commands <value>
Description
Update Commands.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| commands required | array | Apply command information | '{"id": "", "name": "", "new_value": ""}' |
6.2 - EPAS(DBaaS)
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 EPAS(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
6.2.1 - CLIs
6.2.1.1 - Add Block Storages
6.2.1.1.1 - 1.0
scpcli epas block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| size_gb required | integer | Size in GB | 104 |
| role_type required | string | Role type | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.2 - Create Cluster
6.2.1.2.1 - 1.0
scpcli epas cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_encoding <value>]
[--database_locale <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| vip_public_ip_id optional | string | (VIP) Public IP ID | - |
| virtual_ip_address optional | string | Virtual IP address | - |
| audit_enabled optional | boolean | Audit usage state | - |
| database_encoding optional | string | Database encoding | - |
| database_locale optional | string | Database locale information | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| retention_period_day optional | string | Backup retention period (day) | 7 |
| starting_time_hour optional | string | Backup starting time (hour) | 2 |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.3 - Create Replica
6.2.1.3.1 - 1.0
scpcli epas replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.4 - Create Restore Cluster
6.2.1.4.1 - 1.0
scpcli epas restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.5 - Delete Archive Log
6.2.1.5.1 - 1.0
scpcli epas archive log delete
--cluster_id <value>
[--type <value>]
Description
Delete Archive Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | string | Archive log type | ALL |
6.2.1.6 - Export Log
6.2.1.6.1 - 1.0
scpcli epas log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.7 - List Backup Histories
6.2.1.7.1 - 1.0
scpcli epas backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_at | Backup end time | |
| backup_history_number | Backup id | |
| backup_size_gb | Backup amount(GB) | |
| backup_start_at | Backup start time | |
| backup_state | Backup state | |
| backup_state_detail | Backup detail state | |
| software_version | Software version |
6.2.1.8 - List Clusters
6.2.1.8.1 - 1.0
scpcli epas cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Cluster name | - |
| service_state optional | string | Service state | - |
| database_name optional | string | Database Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| database_name | Database Name | |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
6.2.1.9 - List Engine Version Properties
6.2.1.9.1 - 1.0
scpcli epas engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
6.2.1.10 - List Engine Versions
6.2.1.10.1 - 1.0
scpcli epas engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
6.2.1.11 - List Log Export Configs
6.2.1.11.1 - 1.0
scpcli epas log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | **** | Log type | alert |
Responses
| Name | Description | Example |
|---|---|---|
| bucket_name | Bucket name | examplebucket |
| delete_on_export | Delete on export | True |
| is_bucket_deleted | Bucket deleted | False |
| is_registered | Log type registration state | True |
| log_label | Log label | DB Alert Log |
| log_type | Log type | alert |
| schedule_day_of_month | Schedule day of month | 28 |
| schedule_day_of_week | Schedule day of week | MON |
| schedule_frequency_type | Schedule frequency type | DAY |
| schedule_hour | Schedule hour | 12 |
6.2.1.12 - List Parameter Groups
6.2.1.12.1 - 1.0
scpcli epas parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| major_version optional | string | Software major version | - |
| product_image_type optional | string | Product image type | - |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type |
6.2.1.13 - List Parameter Values
6.2.1.13.1 - 1.0
scpcli epas parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| allows_value | Parameter allows value | |
| applied_value | Parameter applied value | |
| apply_type | Parameter apply type | |
| data_type | Parameter data type | |
| default_value | Parameter default value | |
| description | Parameter description | |
| is_modifiable | Parameter is_modifiable | |
| name | Parameter name | |
| software_type | Parameter software type |
6.2.1.14 - List Parameters
6.2.1.14.1 - 1.0
scpcli epas parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_parameter_group_id required | string | Parameter group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type |
6.2.1.15 - List Replicas
6.2.1.15.1 - 1.0
scpcli epas replica list
--cluster_id <value>
Description
List Replicas.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
6.2.1.16 - List Server Types
6.2.1.16.1 - 1.0
scpcli epas engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
6.2.1.17 - Patch Minor Version
6.2.1.17.1 - 1.0
scpcli epas minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
6.2.1.18 - Promote Replica Cluster
6.2.1.18.1 - 1.0
scpcli epas replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.19 - Register Log Export Config
6.2.1.19.1 - 1.0
scpcli epas log export config register
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--log_type <value>
--delete_on_export <value>
--bucket_name <value>
--access_key <value>
Description
Register Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| secret_key required | string | Secret key | secretkey |
| schedule_hour required | string | Schedule hour | 12 |
| schedule_frequency_type required | string | Schedule frequency type | DAY |
| schedule_day_of_week required | **** | Schedule day of week | MON |
| schedule_day_of_month required | string | Schedule day of month | 28 |
| log_type required | string | Log type | alert |
| delete_on_export required | boolean | Delete on export | True |
| bucket_name required | string | Bucket name | examplebucket |
| access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.20 - Remove Backup Histories
6.2.1.20.1 - 1.0
scpcli epas backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
6.2.1.21 - Reset Replica
6.2.1.21.1 - 1.0
scpcli epas replica reset
--replica_cluster_id <value>
Description
Reset Replica.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.22 - Restart Cluster
6.2.1.22.1 - 1.0
scpcli epas cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.23 - Set Archive Config
6.2.1.23.1 - 1.0
scpcli epas archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
6.2.1.24 - Set Audit Log
6.2.1.24.1 - 1.0
scpcli epas audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| use_audit_log required | boolean | use_audit_log | - |
6.2.1.25 - Set Backup
6.2.1.25.1 - 1.0
scpcli epas backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| archive_frequency_minute required | string | Backup starting time (minute) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.26 - Set Block Storage Size
6.2.1.26.1 - 1.0
scpcli epas block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.27 - Set Log Export Config
6.2.1.27.1 - 1.0
scpcli epas log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>
Description
Set Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| secret_key required | string | Secret key | secretkey |
| schedule_hour required | string | Schedule hour | 12 |
| schedule_frequency_type required | string | Schedule frequency type | DAY |
| schedule_day_of_week required | **** | Schedule day of week | MON |
| schedule_day_of_month required | string | Schedule day of month | 28 |
| delete_on_export required | boolean | Delete on export | True |
| access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
6.2.1.28 - Set Maintenance
6.2.1.28.1 - 1.0
scpcli epas maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.29 - Set Parameter Values
6.2.1.29.1 - 1.0
scpcli epas parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
6.2.1.30 - Set Security Group Rules
6.2.1.30.1 - 1.0
scpcli epas security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.31 - Set Server Type
6.2.1.31.1 - 1.0
scpcli epas server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.32 - Show Archive Config
6.2.1.32.1 - 1.0
scpcli epas archive config show
--cluster_id <value>
Description
Show Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
6.2.1.33 - Show Cluster
6.2.1.33.1 - 1.0
scpcli epas cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
6.2.1.34 - Show Request
6.2.1.34.1 - 1.0
scpcli epas request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
6.2.1.35 - Start Cluster
6.2.1.35.1 - 1.0
scpcli epas cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.36 - Stop Cluster
6.2.1.36.1 - 1.0
scpcli epas cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.37 - Switchover Cluster
6.2.1.37.1 - 1.0
scpcli epas cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.38 - Synchronize Archive Config
6.2.1.38.1 - 1.0
scpcli epas archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.39 - Synchronize Cluster State
6.2.1.39.1 - 1.0
scpcli epas cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.40 - Synchronize Parameter Values
6.2.1.40.1 - 1.0
scpcli epas parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.41 - Synchronize Replica State
6.2.1.41.1 - 1.0
scpcli epas replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.2.1.42 - Terminate Cluster
6.2.1.42.1 - 1.0
scpcli epas cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.2.1.43 - Unregister Log Export Config
6.2.1.43.1 - 1.0
scpcli epas log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
6.2.1.44 - Unset Backup
6.2.1.44.1 - 1.0
scpcli epas backup unset
--cluster_id <value>
Description
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.2.1.45 - Unset Maintenance
6.2.1.45.1 - 1.0
scpcli epas maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
6.3 - MariaDB(DBaaS)
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 MariaDB(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
6.3.1 - CLIs
6.3.1.1 - Add Block Storages
6.3.1.1.1 - 1.0
scpcli mariadb block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| size_gb required | integer | Size in GB | 104 |
| role_type required | string | Role type | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.2 - Create Cluster
6.3.1.2.1 - 1.0
scpcli mariadb cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_character_set <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| vip_public_ip_id optional | string | (VIP) Public IP ID | - |
| virtual_ip_address optional | string | Virtual IP address | - |
| audit_enabled optional | boolean | Audit usage state | - |
| database_character_set optional | string | Database encoding | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| retention_period_day optional | string | Backup retention period (day) | 7 |
| starting_time_hour optional | string | Backup starting time (hour) | 2 |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.3 - Create Replica
6.3.1.3.1 - 1.0
scpcli mariadb replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.4 - Create Restore Cluster
6.3.1.4.1 - 1.0
scpcli mariadb restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.5 - Export Log
6.3.1.5.1 - 1.0
scpcli mariadb log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.6 - List Backup Histories
6.3.1.6.1 - 1.0
scpcli mariadb backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_at | Backup end time | |
| backup_history_number | Backup id | |
| backup_size_gb | Backup amount(GB) | |
| backup_start_at | Backup start time | |
| backup_state | Backup state | |
| backup_state_detail | Backup detail state | |
| software_version | Software version |
6.3.1.7 - List Clusters
6.3.1.7.1 - 1.0
scpcli mariadb cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Cluster name | - |
| service_state optional | string | Service state | - |
| database_name optional | string | Database Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| database_name | Database Name | |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
6.3.1.8 - List Engine Version Properties
6.3.1.8.1 - 1.0
scpcli mariadb engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
6.3.1.9 - List Engine Versions
6.3.1.9.1 - 1.0
scpcli mariadb engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
6.3.1.10 - List Log Export Configs
6.3.1.10.1 - 1.0
scpcli mariadb log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | **** | Log type | alert |
Responses
| Name | Description | Example |
|---|---|---|
| bucket_name | Bucket name | examplebucket |
| delete_on_export | Delete on export | True |
| is_bucket_deleted | Bucket deleted | False |
| is_registered | Log type registration state | True |
| log_label | Log label | DB Alert Log |
| log_type | Log type | alert |
| schedule_day_of_month | Schedule day of month | 28 |
| schedule_day_of_week | Schedule day of week | MON |
| schedule_frequency_type | Schedule frequency type | DAY |
| schedule_hour | Schedule hour | 12 |
6.3.1.11 - List Parameter Groups
6.3.1.11.1 - 1.0
scpcli mariadb parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| major_version optional | string | Software major version | - |
| product_image_type optional | string | Product image type | - |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type |
6.3.1.12 - List Parameter Values
6.3.1.12.1 - 1.0
scpcli mariadb parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| allows_value | Parameter allows value | |
| applied_value | Parameter applied value | |
| apply_type | Parameter apply type | |
| data_type | Parameter data type | |
| default_value | Parameter default value | |
| description | Parameter description | |
| is_modifiable | Parameter is_modifiable | |
| name | Parameter name | |
| software_type | Parameter software type |
6.3.1.13 - List Parameters
6.3.1.13.1 - 1.0
scpcli mariadb parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_parameter_group_id required | string | Parameter group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type |
6.3.1.14 - List Replicas
6.3.1.14.1 - 1.0
scpcli mariadb replica list
--cluster_id <value>
Description
List Replicas.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
6.3.1.15 - List Server Types
6.3.1.15.1 - 1.0
scpcli mariadb engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
6.3.1.16 - Patch Minor Version
6.3.1.16.1 - 1.0
scpcli mariadb minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
6.3.1.17 - Promote Replica Cluster
6.3.1.17.1 - 1.0
scpcli mariadb replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.18 - Register Log Export Config
6.3.1.18.1 - 1.0
scpcli mariadb log export config register
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--log_type <value>
--delete_on_export <value>
--bucket_name <value>
--access_key <value>
Description
Register Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| secret_key required | string | Secret key | secretkey |
| schedule_hour required | string | Schedule hour | 12 |
| schedule_frequency_type required | string | Schedule frequency type | DAY |
| schedule_day_of_week required | **** | Schedule day of week | MON |
| schedule_day_of_month required | string | Schedule day of month | 28 |
| log_type required | string | Log type | alert |
| delete_on_export required | boolean | Delete on export | True |
| bucket_name required | string | Bucket name | examplebucket |
| access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.19 - Remove Backup Histories
6.3.1.19.1 - 1.0
scpcli mariadb backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
6.3.1.20 - Reset Replica
6.3.1.20.1 - 1.0
scpcli mariadb replica reset
--replica_cluster_id <value>
Description
Reset Replica.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.21 - Restart Cluster
6.3.1.21.1 - 1.0
scpcli mariadb cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.22 - Set Archive Config
6.3.1.22.1 - 1.0
scpcli mariadb archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
6.3.1.23 - Set Audit Log
6.3.1.23.1 - 1.0
scpcli mariadb audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| use_audit_log required | boolean | use_audit_log | - |
6.3.1.24 - Set Backup
6.3.1.24.1 - 1.0
scpcli mariadb backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| archive_frequency_minute required | string | Backup starting time (minute) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.25 - Set Block Storage Size
6.3.1.25.1 - 1.0
scpcli mariadb block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.26 - Set Log Export Config
6.3.1.26.1 - 1.0
scpcli mariadb log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>
Description
Set Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| secret_key required | string | Secret key | secretkey |
| schedule_hour required | string | Schedule hour | 12 |
| schedule_frequency_type required | string | Schedule frequency type | DAY |
| schedule_day_of_week required | **** | Schedule day of week | MON |
| schedule_day_of_month required | string | Schedule day of month | 28 |
| delete_on_export required | boolean | Delete on export | True |
| access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
6.3.1.27 - Set Maintenance
6.3.1.27.1 - 1.0
scpcli mariadb maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.28 - Set Parameter Values
6.3.1.28.1 - 1.0
scpcli mariadb parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
6.3.1.29 - Set Security Group Rules
6.3.1.29.1 - 1.0
scpcli mariadb security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.30 - Set Server Type
6.3.1.30.1 - 1.0
scpcli mariadb server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.31 - Show Archive Config
6.3.1.31.1 - 1.0
scpcli mariadb archive config show
--cluster_id <value>
Description
Show Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
6.3.1.32 - Show Cluster
6.3.1.32.1 - 1.0
scpcli mariadb cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| audit_enabled | Audit usage state | |
| backup_option | Backup setting option | |
| database_character_set | Database encoding | |
| database_name | Database Name | |
| database_port | Database service port | |
| database_user_name | Database User Name | |
| origin_region | Origin Region |
6.3.1.33 - Show Request
6.3.1.33.1 - 1.0
scpcli mariadb request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
6.3.1.34 - Start Cluster
6.3.1.34.1 - 1.0
scpcli mariadb cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.35 - Stop Cluster
6.3.1.35.1 - 1.0
scpcli mariadb cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.36 - Switchover Cluster
6.3.1.36.1 - 1.0
scpcli mariadb cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.37 - Synchronize Archive Config
6.3.1.37.1 - 1.0
scpcli mariadb archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.38 - Synchronize Cluster State
6.3.1.38.1 - 1.0
scpcli mariadb cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.39 - Synchronize Parameter Values
6.3.1.39.1 - 1.0
scpcli mariadb parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.40 - Synchronize Replica State
6.3.1.40.1 - 1.0
scpcli mariadb replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.3.1.41 - Terminate Cluster
6.3.1.41.1 - 1.0
scpcli mariadb cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.3.1.42 - Unregister Log Export Config
6.3.1.42.1 - 1.0
scpcli mariadb log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
6.3.1.43 - Unset Backup
6.3.1.43.1 - 1.0
scpcli mariadb backup unset
--cluster_id <value>
Description
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.3.1.44 - Unset Maintenance
6.3.1.44.1 - 1.0
scpcli mariadb maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
6.4 - Microsoft SQL Server(DBaaS)
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Microsoft SQL Server(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|
6.4.1 - CLIs
6.4.1.1 - Add Block Storages
6.4.1.1.1 - 1.0
scpcli sqlserver block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| size_gb required | integer | Size in GB | 104 |
| role_type required | string | Role type | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.2 - Add Secondary
6.4.1.2.1 - 1.0
scpcli sqlserver secondary add
--cluster_id <value>
--name <value>
--license <value>
[--service_ip_address <value>]
Description
Add Secondary.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| name required | string | Secondary Name | - |
| license required | string | license | - |
| service_ip_address optional | string | User subnet IP address | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.3 - Add/Remove Databases
6.4.1.3.1 - 1.0
scpcli sqlserver database set
--cluster_id <value>
[--add_databases <value>]
[--del_databases <value>]
Description
Add/Remove Databases.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| add_databases optional | array | Databases | '{"database_name": "", "drive_letter": "E"}' |
| del_databases optional | array | Databases | '{"database_name": "", "drive_letter": "E"}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.4 - Create Cluster
6.4.1.4.1 - 1.0
scpcli sqlserver cluster create
--archive_frequency_minute <value>
--license <value>
--databases <value>
--database_user_password <value>
--database_user_name <value>
--database_service_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_collation <value>]
[--database_name <value>]
[--database_port <value>]
[--full_backup_day_of_week <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| archive_frequency_minute required | string | Backup starting time (minute) | - |
| license required | string | license | - |
| databases required | array | Databases | '{"database_name": "", "drive_letter": "E"}' |
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_service_name required | string | Database Service Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| vip_public_ip_id optional | string | (VIP) Public IP ID | - |
| virtual_ip_address optional | string | Virtual IP address | - |
| audit_enabled optional | boolean | Audit usage state | - |
| database_collation optional | string | - | |
| database_name optional | **** | - | |
| database_port optional | integer | Database service port | - |
| full_backup_day_of_week optional | string | Full backup day of week | - |
| retention_period_day optional | string | Backup retention period (day) | 7 |
| starting_time_hour optional | string | Backup starting time (hour) | 2 |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.5 - Create Restore Cluster
6.4.1.5.1 - 1.0
scpcli sqlserver restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.6 - Export Log
6.4.1.6.1 - 1.0
scpcli sqlserver log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.7 - List Backup Histories
6.4.1.7.1 - 1.0
scpcli sqlserver backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_at | Backup end time | |
| backup_history_number | Backup id | |
| backup_size_gb | Backup amount(GB) | |
| backup_start_at | Backup start time | |
| backup_state | Backup state | |
| backup_state_detail | Backup detail state | |
| software_version | Software version |
6.4.1.8 - List Clusters
6.4.1.8.1 - 1.0
scpcli sqlserver cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Cluster name | - |
| service_state optional | string | Service state | - |
| database_name optional | string | Database Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| database_name | Database Name | |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
6.4.1.9 - List Engine Version Properties
6.4.1.9.1 - 1.0
scpcli sqlserver engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
6.4.1.10 - List Engine Versions
6.4.1.10.1 - 1.0
scpcli sqlserver engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
6.4.1.11 - List Log Export Configs
6.4.1.11.1 - 1.0
scpcli sqlserver log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | **** | Log type | alert |
Responses
| Name | Description | Example |
|---|---|---|
| bucket_name | Bucket name | examplebucket |
| delete_on_export | Delete on export | True |
| is_bucket_deleted | Bucket deleted | False |
| is_registered | Log type registration state | True |
| log_label | Log label | DB Alert Log |
| log_type | Log type | alert |
| schedule_day_of_month | Schedule day of month | 28 |
| schedule_day_of_week | Schedule day of week | MON |
| schedule_frequency_type | Schedule frequency type | DAY |
| schedule_hour | Schedule hour | 12 |
6.4.1.12 - List Parameter Groups
6.4.1.12.1 - 1.0
scpcli sqlserver parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| major_version optional | string | Software major version | - |
| product_image_type optional | string | Product image type | - |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type |
6.4.1.13 - List Parameter Values
6.4.1.13.1 - 1.0
scpcli sqlserver parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| allows_value | Parameter allows value | |
| applied_value | Parameter applied value | |
| apply_type | Parameter apply type | |
| data_type | Parameter data type | |
| default_value | Parameter default value | |
| description | Parameter description | |
| is_modifiable | Parameter is_modifiable | |
| name | Parameter name | |
| software_type | Parameter software type |
6.4.1.14 - List Parameters
6.4.1.14.1 - 1.0
scpcli sqlserver parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_parameter_group_id required | string | Parameter group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type |
6.4.1.15 - List Server Types
6.4.1.15.1 - 1.0
scpcli sqlserver engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
6.4.1.16 - Patch Minor Version
6.4.1.16.1 - 1.0
scpcli sqlserver minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
6.4.1.17 - Register Log Export Config
6.4.1.17.1 - 1.0
scpcli sqlserver log export config register
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--log_type <value>
--delete_on_export <value>
--bucket_name <value>
--access_key <value>
Description
Register Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| secret_key required | string | Secret key | secretkey |
| schedule_hour required | string | Schedule hour | 12 |
| schedule_frequency_type required | string | Schedule frequency type | DAY |
| schedule_day_of_week required | **** | Schedule day of week | MON |
| schedule_day_of_month required | string | Schedule day of month | 28 |
| log_type required | string | Log type | alert |
| delete_on_export required | boolean | Delete on export | True |
| bucket_name required | string | Bucket name | examplebucket |
| access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.18 - Remove Backup Histories
6.4.1.18.1 - 1.0
scpcli sqlserver backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| backup_history_number required | array | Backup id | - |
6.4.1.19 - Restart Cluster
6.4.1.19.1 - 1.0
scpcli sqlserver cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.20 - Set Audit Log
6.4.1.20.1 - 1.0
scpcli sqlserver audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| use_audit_log required | boolean | use_audit_log | - |
6.4.1.21 - Set Backup
6.4.1.21.1 - 1.0
scpcli sqlserver backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
[--full_backup_day_of_week <value>]
Description
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| archive_frequency_minute required | string | Backup starting time (minute) | - |
| full_backup_day_of_week optional | string | Full backup day of week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.22 - Set Block Storage Size
6.4.1.22.1 - 1.0
scpcli sqlserver block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.23 - Set Log Export Config
6.4.1.23.1 - 1.0
scpcli sqlserver log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>
Description
Set Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| secret_key required | string | Secret key | secretkey |
| schedule_hour required | string | Schedule hour | 12 |
| schedule_frequency_type required | string | Schedule frequency type | DAY |
| schedule_day_of_week required | **** | Schedule day of week | MON |
| schedule_day_of_month required | string | Schedule day of month | 28 |
| delete_on_export required | boolean | Delete on export | True |
| access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
6.4.1.24 - Set Maintenance
6.4.1.24.1 - 1.0
scpcli sqlserver maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.25 - Set Parameter Values
6.4.1.25.1 - 1.0
scpcli sqlserver parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
6.4.1.26 - Set Security Group Rules
6.4.1.26.1 - 1.0
scpcli sqlserver security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.27 - Set Server Type
6.4.1.27.1 - 1.0
scpcli sqlserver server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.28 - Show Cluster
6.4.1.28.1 - 1.0
scpcli sqlserver cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| audit_enabled | Audit usage state | |
| backup_option | Backup setting option | |
| database_collation | ||
| database_port | Database service port | |
| database_service_name | Database Service Name | |
| database_user_name | Database User Name | |
| databases | Databases |
6.4.1.29 - Show Request
6.4.1.29.1 - 1.0
scpcli sqlserver request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
6.4.1.30 - Start Cluster
6.4.1.30.1 - 1.0
scpcli sqlserver cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.31 - Stop Cluster
6.4.1.31.1 - 1.0
scpcli sqlserver cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.32 - Switchover Cluster
6.4.1.32.1 - 1.0
scpcli sqlserver cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.33 - Synchronize Cluster State
6.4.1.33.1 - 1.0
scpcli sqlserver cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.34 - Synchronize Parameter Values
6.4.1.34.1 - 1.0
scpcli sqlserver parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.4.1.35 - Terminate Cluster
6.4.1.35.1 - 1.0
scpcli sqlserver cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
6.4.1.36 - Unregister Log Export Config
6.4.1.36.1 - 1.0
scpcli sqlserver log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
6.4.1.37 - Unset Backup
6.4.1.37.1 - 1.0
scpcli sqlserver backup unset
--cluster_id <value>
Description
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
6.4.1.38 - Unset Maintenance
6.4.1.38.1 - 1.0
scpcli sqlserver maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
6.5 - MySQL(DBaaS)
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 MySQL(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
6.5.1 - CLIs
6.5.1.1 - Add Block Storages
6.5.1.1.1 - 1.0
scpcli mysql block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| size_gb required | integer | Size in GB | 104 |
| role_type required | string | Role type | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.2 - Create Cluster
6.5.1.2.1 - 1.0
scpcli mysql cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_case_sensitive <value>]
[--database_character_set <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| vip_public_ip_id optional | string | (VIP) Public IP ID | - |
| virtual_ip_address optional | string | Virtual IP address | - |
| audit_enabled optional | **** | - | |
| database_case_sensitive optional | boolean | Database case sensitivity | - |
| database_character_set optional | string | Database encoding | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| retention_period_day optional | string | Backup retention period (day) | 7 |
| starting_time_hour optional | string | Backup starting time (hour) | 2 |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.3 - Create Replica
6.5.1.3.1 - 1.0
scpcli mysql replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.4 - Create Restore Cluster
6.5.1.4.1 - 1.0
scpcli mysql restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.5 - Export Log
6.5.1.5.1 - 1.0
scpcli mysql log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.6 - List Backup Histories
6.5.1.6.1 - 1.0
scpcli mysql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_at | Backup end time | |
| backup_history_number | Backup id | |
| backup_size_gb | Backup amount(GB) | |
| backup_start_at | Backup start time | |
| backup_state | Backup state | |
| backup_state_detail | Backup detail state | |
| software_version | Software version |
6.5.1.7 - List Clusters
6.5.1.7.1 - 1.0
scpcli mysql cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Cluster name | - |
| service_state optional | string | Service state | - |
| database_name optional | string | Database Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| database_name | Database Name | |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
6.5.1.8 - List Engine Version Properties
6.5.1.8.1 - 1.0
scpcli mysql engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
6.5.1.9 - List Engine Versions
6.5.1.9.1 - 1.0
scpcli mysql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
6.5.1.10 - List Log Export Configs
6.5.1.10.1 - 1.0
scpcli mysql log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | **** | Log type | alert |
Responses
| Name | Description | Example |
|---|---|---|
| bucket_name | Bucket name | examplebucket |
| delete_on_export | Delete on export | True |
| is_bucket_deleted | Bucket deleted | False |
| is_registered | Log type registration state | True |
| log_label | Log label | DB Alert Log |
| log_type | Log type | alert |
| schedule_day_of_month | Schedule day of month | 28 |
| schedule_day_of_week | Schedule day of week | MON |
| schedule_frequency_type | Schedule frequency type | DAY |
| schedule_hour | Schedule hour | 12 |
6.5.1.11 - List Parameter Groups
6.5.1.11.1 - 1.0
scpcli mysql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| major_version optional | string | Software major version | - |
| product_image_type optional | string | Product image type | - |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type |
6.5.1.12 - List Parameter Values
6.5.1.12.1 - 1.0
scpcli mysql parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| allows_value | Parameter allows value | |
| applied_value | Parameter applied value | |
| apply_type | Parameter apply type | |
| data_type | Parameter data type | |
| default_value | Parameter default value | |
| description | Parameter description | |
| is_modifiable | Parameter is_modifiable | |
| name | Parameter name | |
| software_type | Parameter software type |
6.5.1.13 - List Parameters
6.5.1.13.1 - 1.0
scpcli mysql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_parameter_group_id required | string | Parameter group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type |
6.5.1.14 - List Replicas
6.5.1.14.1 - 1.0
scpcli mysql replica list
--cluster_id <value>
Description
List Replicas.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
6.5.1.15 - List Server Types
6.5.1.15.1 - 1.0
scpcli mysql engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
6.5.1.16 - Patch Minor Version
6.5.1.16.1 - 1.0
scpcli mysql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
6.5.1.17 - Promote Replica Cluster
6.5.1.17.1 - 1.0
scpcli mysql replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.18 - Register Log Export Config
6.5.1.18.1 - 1.0
scpcli mysql log export config register
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--log_type <value>
--delete_on_export <value>
--bucket_name <value>
--access_key <value>
Description
Register Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| secret_key required | string | Secret key | secretkey |
| schedule_hour required | string | Schedule hour | 12 |
| schedule_frequency_type required | string | Schedule frequency type | DAY |
| schedule_day_of_week required | **** | Schedule day of week | MON |
| schedule_day_of_month required | string | Schedule day of month | 28 |
| log_type required | string | Log type | alert |
| delete_on_export required | boolean | Delete on export | True |
| bucket_name required | string | Bucket name | examplebucket |
| access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.19 - Remove Backup Histories
6.5.1.19.1 - 1.0
scpcli mysql backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
6.5.1.20 - Reset Replica
6.5.1.20.1 - 1.0
scpcli mysql replica reset
--replica_cluster_id <value>
Description
Reset Replica.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.21 - Restart Cluster
6.5.1.21.1 - 1.0
scpcli mysql cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.22 - Set Archive Config
6.5.1.22.1 - 1.0
scpcli mysql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
6.5.1.23 - Set Backup
6.5.1.23.1 - 1.0
scpcli mysql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| archive_frequency_minute required | string | Backup starting time (minute) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.24 - Set Block Storage Size
6.5.1.24.1 - 1.0
scpcli mysql block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.25 - Set Log Export Config
6.5.1.25.1 - 1.0
scpcli mysql log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>
Description
Set Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| secret_key required | string | Secret key | secretkey |
| schedule_hour required | string | Schedule hour | 12 |
| schedule_frequency_type required | string | Schedule frequency type | DAY |
| schedule_day_of_week required | **** | Schedule day of week | MON |
| schedule_day_of_month required | string | Schedule day of month | 28 |
| delete_on_export required | boolean | Delete on export | True |
| access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
6.5.1.26 - Set Maintenance
6.5.1.26.1 - 1.0
scpcli mysql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.27 - Set Parameter Values
6.5.1.27.1 - 1.0
scpcli mysql parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
6.5.1.28 - Set Security Group Rules
6.5.1.28.1 - 1.0
scpcli mysql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.29 - Set Server Type
6.5.1.29.1 - 1.0
scpcli mysql server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.30 - Show Archive Config
6.5.1.30.1 - 1.0
scpcli mysql archive config show
--cluster_id <value>
Description
Show Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
6.5.1.31 - Show Cluster
6.5.1.31.1 - 1.0
scpcli mysql cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_option | Backup setting option | |
| database_character_set | Database encoding | |
| database_name | Database Name | |
| database_port | Database service port | |
| database_user_name | Database User Name | |
| origin_region | Origin Region |
6.5.1.32 - Show Request
6.5.1.32.1 - 1.0
scpcli mysql request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
6.5.1.33 - Start Cluster
6.5.1.33.1 - 1.0
scpcli mysql cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.34 - Stop Cluster
6.5.1.34.1 - 1.0
scpcli mysql cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.35 - Switchover Cluster
6.5.1.35.1 - 1.0
scpcli mysql cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.36 - Synchronize Archive Config
6.5.1.36.1 - 1.0
scpcli mysql archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.37 - Synchronize Cluster State
6.5.1.37.1 - 1.0
scpcli mysql cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.38 - Synchronize Parameter Values
6.5.1.38.1 - 1.0
scpcli mysql parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.39 - Synchronize Replica State
6.5.1.39.1 - 1.0
scpcli mysql replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.5.1.40 - Terminate Cluster
6.5.1.40.1 - 1.0
scpcli mysql cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.5.1.41 - Unregister Log Export Config
6.5.1.41.1 - 1.0
scpcli mysql log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
6.5.1.42 - Unset Backup
6.5.1.42.1 - 1.0
scpcli mysql backup unset
--cluster_id <value>
Description
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.5.1.43 - Unset Maintenance
6.5.1.43.1 - 1.0
scpcli mysql maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
6.6 - PostgreSQL(DBaaS)
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 PostgreSQL(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
6.6.1 - CLIs
6.6.1.1 - Add Block Storages
6.6.1.1.1 - 1.0
scpcli postgresql block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| size_gb required | integer | Size in GB | 104 |
| role_type required | string | Role type | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.2 - Create Cluster
6.6.1.2.1 - 1.0
scpcli postgresql cluster create
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--ha_enabled <value>]
[--nat_enabled <value>]
[--origin_cluster_id <value>]
[--tags <value>]
[--vip_public_ip_id <value>]
[--virtual_ip_address <value>]
[--audit_enabled <value>]
[--database_encoding <value>]
[--database_locale <value>]
[--database_port <value>]
[--archive_frequency_minute <value>]
[--retention_period_day <value>]
[--starting_time_hour <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| ha_enabled optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| origin_cluster_id optional | string | Origin cluster ID | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| vip_public_ip_id optional | string | (VIP) Public IP ID | - |
| virtual_ip_address optional | string | Virtual IP address | - |
| audit_enabled optional | boolean | Audit usage state | - |
| database_encoding optional | string | Database encoding | - |
| database_locale optional | string | Database locale information | - |
| database_port optional | integer | Database service port | - |
| archive_frequency_minute optional | string | Backup starting time (minute) | - |
| retention_period_day optional | string | Backup retention period (day) | 7 |
| starting_time_hour optional | string | Backup starting time (hour) | 2 |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.3 - Create Other region Replica
6.6.1.3.1 - 1.0
scpcli postgresql replica dr create
--cluster_id <value>
--subnet_id <value>
--replicas <value>
--replica_count <value>
--region <value>
--nat_enabled <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Other region Replica.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| subnet_id required | string | Subnet ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| region required | string | Replica region | - |
| nat_enabled required | boolean | NAT availability | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.4 - Create Replica
6.6.1.4.1 - 1.0
scpcli postgresql replica create
--cluster_id <value>
--replicas <value>
--replica_count <value>
--allowable_ip_addresses <value>
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Replica.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| replicas required | array | Replicas list | '{"instance_groups": [{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}], "name": ""}' |
| replica_count required | integer | Replica count | - |
| allowable_ip_addresses required | array | Allowed IP addresses list | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.5 - Create Restore Cluster
6.6.1.5.1 - 1.0
scpcli postgresql restore create
--cluster_id <value>
--server_type_name <value>
--name <value>
--instance_name_prefix <value>
[--allowable_ip_addresses <value>]
[--backup_history_number <value>]
[--backup_recovery_time <value>]
[--block_storage_groups <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| server_type_name required | string | Server type name | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| backup_history_number optional | string | Backup id | - |
| backup_recovery_time optional | string | Backup Recovery Time | - |
| block_storage_groups optional | array | Block storage groups list | '{"role_type": "", "size_gb": 104, "volume_type": "SSD"}' |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.6 - Delete Archive Log
6.6.1.6.1 - 1.0
scpcli postgresql archive log delete
--cluster_id <value>
[--type <value>]
Description
Delete Archive Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | string | Archive log type | ALL |
6.6.1.7 - Export Log
6.6.1.7.1 - 1.0
scpcli postgresql log export
--log_type <value>
--cluster_id <value>
Description
Export Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.8 - List Backup Histories
6.6.1.8.1 - 1.0
scpcli postgresql backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_at | Backup end time | |
| backup_history_number | Backup id | |
| backup_size_gb | Backup amount(GB) | |
| backup_start_at | Backup start time | |
| backup_state | Backup state | |
| backup_state_detail | Backup detail state | |
| software_version | Software version |
6.6.1.9 - List Clusters
6.6.1.9.1 - 1.0
scpcli postgresql cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
[--database_name <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Cluster name | - |
| service_state optional | string | Service state | - |
| database_name optional | string | Database Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| database_name | Database Name | |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
6.6.1.10 - List Engine Version Properties
6.6.1.10.1 - 1.0
scpcli postgresql engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
6.6.1.11 - List Engine Versions
6.6.1.11.1 - 1.0
scpcli postgresql engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
6.6.1.12 - List Log Export Configs
6.6.1.12.1 - 1.0
scpcli postgresql log export configs list
--cluster_id <value>
[--type <value>]
Description
List Log Export Configs.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| type optional | **** | Log type | alert |
Responses
| Name | Description | Example |
|---|---|---|
| bucket_name | Bucket name | examplebucket |
| delete_on_export | Delete on export | True |
| is_bucket_deleted | Bucket deleted | False |
| is_registered | Log type registration state | True |
| log_label | Log label | DB Alert Log |
| log_type | Log type | alert |
| schedule_day_of_month | Schedule day of month | 28 |
| schedule_day_of_week | Schedule day of week | MON |
| schedule_frequency_type | Schedule frequency type | DAY |
| schedule_hour | Schedule hour | 12 |
6.6.1.13 - List Parameter Groups
6.6.1.13.1 - 1.0
scpcli postgresql parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| major_version optional | string | Software major version | - |
| product_image_type optional | string | Product image type | - |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type |
6.6.1.14 - List Parameter Values
6.6.1.14.1 - 1.0
scpcli postgresql parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| allows_value | Parameter allows value | |
| applied_value | Parameter applied value | |
| apply_type | Parameter apply type | |
| data_type | Parameter data type | |
| default_value | Parameter default value | |
| description | Parameter description | |
| is_modifiable | Parameter is_modifiable | |
| name | Parameter name | |
| software_type | Parameter software type |
6.6.1.15 - List Parameters
6.6.1.15.1 - 1.0
scpcli postgresql parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_parameter_group_id required | string | Parameter group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type |
6.6.1.16 - List Replicas
6.6.1.16.1 - 1.0
scpcli postgresql replica list
--cluster_id <value>
Description
List Replicas.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | Server name | |
| region | Replica region | |
| replica_state | Replica state | |
| replica_state_detail | Replica detail state | |
| synced_at | Replica check time |
6.6.1.17 - List Server Types
6.6.1.17.1 - 1.0
scpcli postgresql engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
6.6.1.18 - Patch Minor Version
6.6.1.18.1 - 1.0
scpcli postgresql minor version patch
--cluster_id <value>
--software_version <value>
--backup_before_upgrade <value>
Description
Patch Minor Version.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| software_version required | string | software_version | - |
| backup_before_upgrade required | boolean | backup_before_upgrade | - |
6.6.1.19 - Promote Replica Cluster
6.6.1.19.1 - 1.0
scpcli postgresql replica cluster promote
--cluster_id <value>
Description
Promote Replica Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.20 - Register Log Export Config
6.6.1.20.1 - 1.0
scpcli postgresql log export config register
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--log_type <value>
--delete_on_export <value>
--bucket_name <value>
--access_key <value>
Description
Register Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| secret_key required | string | Secret key | secretkey |
| schedule_hour required | string | Schedule hour | 12 |
| schedule_frequency_type required | string | Schedule frequency type | DAY |
| schedule_day_of_week required | **** | Schedule day of week | MON |
| schedule_day_of_month required | string | Schedule day of month | 28 |
| log_type required | string | Log type | alert |
| delete_on_export required | boolean | Delete on export | True |
| bucket_name required | string | Bucket name | examplebucket |
| access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.21 - Remove Backup Histories
6.6.1.21.1 - 1.0
scpcli postgresql backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
6.6.1.22 - Reset Replica
6.6.1.22.1 - 1.0
scpcli postgresql replica reset
--replica_cluster_id <value>
Description
Reset Replica.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| replica_cluster_id required | string | Replica cluster id | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.23 - Restart Cluster
6.6.1.23.1 - 1.0
scpcli postgresql cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.24 - Set Archive Config
6.6.1.24.1 - 1.0
scpcli postgresql archive config set
--cluster_id <value>
--archive_enabled <value>
[--retention_period_day <value>]
Description
Set Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| archive_enabled required | boolean | Archive enabled | True |
| retention_period_day optional | integer | Backup retention period (day) | - |
6.6.1.25 - Set Audit Log
6.6.1.25.1 - 1.0
scpcli postgresql audit log set
--cluster_id <value>
--use_audit_log <value>
Description
Set Audit Log.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| use_audit_log required | boolean | use_audit_log | - |
6.6.1.26 - Set Backup
6.6.1.26.1 - 1.0
scpcli postgresql backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
--archive_frequency_minute <value>
Description
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| archive_frequency_minute required | string | Backup starting time (minute) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.27 - Set Block Storage Size
6.6.1.27.1 - 1.0
scpcli postgresql block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.28 - Set Log Export Config
6.6.1.28.1 - 1.0
scpcli postgresql log export config set
--log_type <value>
--cluster_id <value>
--secret_key <value>
--schedule_hour <value>
--schedule_frequency_type <value>
--schedule_day_of_week <value>
--schedule_day_of_month <value>
--delete_on_export <value>
--access_key <value>
Description
Set Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
| secret_key required | string | Secret key | secretkey |
| schedule_hour required | string | Schedule hour | 12 |
| schedule_frequency_type required | string | Schedule frequency type | DAY |
| schedule_day_of_week required | **** | Schedule day of week | MON |
| schedule_day_of_month required | string | Schedule day of month | 28 |
| delete_on_export required | boolean | Delete on export | True |
| access_key required | string | Access key | 13952a8851244213f2de8d95069bf161 |
6.6.1.29 - Set Maintenance
6.6.1.29.1 - 1.0
scpcli postgresql maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.30 - Set Parameter Values
6.6.1.30.1 - 1.0
scpcli postgresql parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
6.6.1.31 - Set Security Group Rules
6.6.1.31.1 - 1.0
scpcli postgresql security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.32 - Set Server Type
6.6.1.32.1 - 1.0
scpcli postgresql server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.33 - Show Archive Config
6.6.1.33.1 - 1.0
scpcli postgresql archive config show
--cluster_id <value>
Description
Show Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| archive_enabled | Archive enabled | True |
| retention_period_day | Backup retention period (day) |
6.6.1.34 - Show Cluster
6.6.1.34.1 - 1.0
scpcli postgresql cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
6.6.1.35 - Show Request
6.6.1.35.1 - 1.0
scpcli postgresql request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
6.6.1.36 - Start Cluster
6.6.1.36.1 - 1.0
scpcli postgresql cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.37 - Stop Cluster
6.6.1.37.1 - 1.0
scpcli postgresql cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.38 - Switchover Cluster
6.6.1.38.1 - 1.0
scpcli postgresql cluster switchover
--cluster_id <value>
Description
Switchover Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.39 - Synchronize Archive Config
6.6.1.39.1 - 1.0
scpcli postgresql archive config sync
--cluster_id <value>
Description
Synchronize Archive Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.40 - Synchronize Cluster State
6.6.1.40.1 - 1.0
scpcli postgresql cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.41 - Synchronize Parameter Values
6.6.1.41.1 - 1.0
scpcli postgresql parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.42 - Synchronize Replica State
6.6.1.42.1 - 1.0
scpcli postgresql replica state sync
--origin_cluster_id <value>
Description
Synchronize Replica State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| origin_cluster_id required | string | Origin cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
6.6.1.43 - Terminate Cluster
6.6.1.43.1 - 1.0
scpcli postgresql cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.6.1.44 - Unregister Log Export Config
6.6.1.44.1 - 1.0
scpcli postgresql log export config unregister
--log_type <value>
--cluster_id <value>
Description
Unregister Log Export Config.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_type required | **** | Log type | alert |
| cluster_id required | string | Cluster ID | 109a585ae67b4e8482fdafc8a4a5be74 |
6.6.1.45 - Unset Backup
6.6.1.45.1 - 1.0
scpcli postgresql backup unset
--cluster_id <value>
Description
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
6.6.1.46 - Unset Maintenance
6.6.1.46.1 - 1.0
scpcli postgresql maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | DB cluster id | - |
7 - Data Analytics
7.1 - Data Flow
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Data Flow 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|
7.1.1 - CLIs
7.1.1.1 - CheckClusterResourceSizeForDataFlowServiceCreate
7.1.1.1.1 - 1.1
scpcli data-flow check cluster resource size for data flow service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Creation.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
7.1.1.1.2 - 1.0
scpcli data-flow check cluster resource size for data flow service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Creation.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
7.1.1.2 - CheckClusterResourceSizeForDataFlowServiceUpdate
7.1.1.2.1 - 1.1
scpcli data-flow check cluster resource size for data flow service update
--data_flow_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Update.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
7.1.1.2.2 - 1.0
scpcli data-flow check cluster resource size for data flow service update
--data_flow_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Flow Service Update.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
7.1.1.3 - CheckDataFlowNameDuplication
7.1.1.3.1 - 1.1
scpcli data-flow check data flow name duplication
--data_flow_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_name required | string | Data flow name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | Data flow check result |
7.1.1.3.2 - 1.0
scpcli data-flow check data flow name duplication
--data_flow_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_name required | string | Data flow name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | Data flow check result |
7.1.1.4 - CheckDataFlowServiceNameDuplication
7.1.1.4.1 - 1.1
scpcli data-flow check data flow service name duplication
--data_flow_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Service Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_name required | string | Data flow service name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | Data flow service check result |
7.1.1.4.2 - 1.0
scpcli data-flow check data flow service name duplication
--data_flow_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Check Duplication Data Flow Service Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_name required | string | Data flow service name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | Data flow service check result |
7.1.1.5 - CreateDataFlow
7.1.1.5.1 - 1.1
scpcli data-flow create data flow
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_flow_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create data flow
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| ingress_controller_name required | string | ingress_controller_name | - |
| image_id required | string | image_id | - |
| host_alias_list required | array | host_alias_list | {'hostnames': [''], 'ip': ''} |
| domain required | string | domain | - |
| data_flow_name required | string | data_flow_name | - |
| cluster_id required | string | cluster_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| dsc_domain optional | string | dsc_domain | - |
| instance_id optional | string | instance_id | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.1.1.5.2 - 1.0
scpcli data-flow create data flow
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_flow_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create data flow
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| ingress_controller_name required | string | ingress_controller_name | - |
| image_id required | string | image_id | - |
| host_alias_list required | array | host_alias_list | {'hostnames': [''], 'ip': ''} |
| domain required | string | domain | - |
| data_flow_name required | string | data_flow_name | - |
| cluster_id required | string | cluster_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| dsc_domain optional | string | dsc_domain | - |
| instance_id optional | string | instance_id | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.1.1.6 - CreateDataFlowService
7.1.1.6.1 - 1.1
scpcli data-flow create data flow service
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_flow_service_name <value>
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Create dataflow service console
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| host_alias required | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| domain required | string | description | - |
| data_flow_service_name required | string | data_flow_service_name | - |
| data_flow_id required | string | data_flow_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.1.1.6.2 - 1.0
scpcli data-flow create data flow service
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_flow_service_name <value>
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Create dataflow service console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| service_workload required | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| host_alias required | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| domain required | string | description | - |
| data_flow_service_name required | string | data_flow_service_name | - |
| data_flow_id required | string | data_flow_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.1.1.7 - DeleteDataFlow
7.1.1.7.1 - 1.1
scpcli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.1.1.7.2 - 1.0
scpcli data-flow delete data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.1.1.8 - DeleteDataFlowService
7.1.1.8.1 - 1.1
scpcli data-flow delete data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataflow service console
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.1.1.8.2 - 1.0
scpcli data-flow delete data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataflow service console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.1.1.9 - ListDataFlowImages
7.1.1.9.1 - 1.1
scpcli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Images.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| image_id | Image ID | |
| image_name | Image name | |
| version | Version |
7.1.1.9.2 - 1.0
scpcli data-flow list data flow images
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Images.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| image_id | Image ID | |
| image_name | Image name | |
| version | Version |
7.1.1.10 - ListDataFlows
7.1.1.10.1 - 1.1
scpcli data-flow list data flow
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataflow_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_flow_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow list console v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | created_dt:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| dataflow_version optional | string | version | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| cluster_id optional | string | cluster_id | - |
| data_flow_name optional | string | data_flow_name | - |
| region optional | string | region | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| image_id | image_id | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| namespace_name | namespace_name | |
| state | state | |
| version | version |
7.1.1.10.2 - 1.0
scpcli data-flow list data flow
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataflow_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_flow_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow list console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | created_dt:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| dataflow_version optional | string | version | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| cluster_id optional | string | cluster_id | - |
| data_flow_name optional | string | data_flow_name | - |
| region optional | string | region | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| image_id | image_id | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| namespace_name | namespace_name | |
| state | state | |
| version | version |
7.1.1.11 - ListDataFlowService
7.1.1.11.1 - 1.1
scpcli data-flow list data flow service
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--state <value>]
[--data_flow_service_name <value>]
[--data_flow_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow service list console v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| data_flow_service_name optional | string | data_flow_service_name | - |
| data_flow_name optional | string | data_flow_name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| data_flow_service_id | data_flow_service_id | |
| data_flow_service_name | data_flow_service_name | |
| description | description | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| state | state | |
| version | version |
7.1.1.11.2 - 1.0
scpcli data-flow list data flow service
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--state <value>]
[--data_flow_service_name <value>]
[--data_flow_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataflow service list console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| data_flow_service_name optional | string | data_flow_service_name | - |
| data_flow_name optional | string | data_flow_name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| data_flow_service_id | data_flow_service_id | |
| data_flow_service_name | data_flow_service_name | |
| description | description | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| state | state | |
| version | version |
7.1.1.12 - ShowDataFlow
7.1.1.12.1 - 1.1
scpcli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| count_data_flow_service | count_data_flow_service | |
| created_dt | created_dt | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| description | description | |
| domain | domain | |
| host_alias_list | host_alias | [{‘hostnames’: [’’], ‘ip’: ‘’}] |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
7.1.1.12.2 - 1.0
scpcli data-flow show data flow
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data flow
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| count_data_flow_service | count_data_flow_service | |
| created_dt | created_dt | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| description | description | |
| domain | domain | |
| host_alias_list | host_alias | [{‘hostnames’: [’’], ‘ip’: ‘’}] |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
7.1.1.13 - ShowDataFlowService
7.1.1.13.1 - 1.1
scpcli data-flow show data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
GET dataflow service console v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| data_flow_service_id | data_flow_service_id | |
| data_flow_service_name | data_flow_service_name | |
| description | description | |
| domain | domain | |
| host_alias | host_alias | {’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]} |
| host_file_registry | host_file_registry | |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| service_workload | service_workload | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url_nifi | web_url_nifi | |
| web_url_registry | web_url_registry |
7.1.1.13.2 - 1.0
scpcli data-flow show data flow service
--data_flow_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
GET dataflow service console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_flow_id | data_flow_id | |
| data_flow_name | data_flow_name | |
| data_flow_service_id | data_flow_service_id | |
| data_flow_service_name | data_flow_service_name | |
| description | description | |
| domain | domain | |
| host_alias | host_alias | {’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]} |
| host_file_registry | host_file_registry | |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| service_workload | service_workload | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url_nifi | web_url_nifi | |
| web_url_registry | web_url_registry |
7.1.1.14 - ShowDataFlowServiceSubVersions
7.1.1.14.1 - 1.1
scpcli data-flow show data flow service sub versions
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Service Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Data flow ID | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| data_flow_service_count | DataFlowService count | |
| versions | image versions |
7.1.1.14.2 - 1.0
scpcli data-flow show data flow service sub versions
--data_flow_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Get List of Data Flow Service Versions.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Data flow ID | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| data_flow_service_count | DataFlowService count | |
| versions | image versions |
7.1.1.15 - UpdateDataFlow
7.1.1.15.1 - 1.1
scpcli data-flow update data flow
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update data flow by flow id
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias_list optional | array | host_alias | {'hostnames': [''], 'ip': ''} |
| node_selector optional | string | node_selector | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.1.1.15.2 - 1.0
scpcli data-flow update data flow
--data_flow_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update data flow by flow id
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241s |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias_list optional | array | host_alias | {'hostnames': [''], 'ip': ''} |
| node_selector optional | string | node_selector | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.1.1.16 - UpdateDataFlowService
7.1.1.16.1 - 1.1
scpcli data-flow update data flow service
--data_flow_service_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update dataflow service console
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias optional | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| node_selector optional | string | node_selector | - |
| service_workload optional | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.1.1.16.2 - 1.0
scpcli data-flow update data flow service
--data_flow_service_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update dataflow service console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_flow_service_id required | string | data_flow_service_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias optional | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| node_selector optional | string | node_selector | - |
| service_workload optional | object | service_workload | {'nifi': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'nifi_registry': {'cpu': '2000', 'memory': '1024', 'replica': '1', 'version': '1.27.1'}, 'zookeeper': {'cpu': '2000', 'memory': '1024', 'replica': '3', 'version': '3.9.2'}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.2 - Data Ops
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Data Ops 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|
7.2.1 - CLIs
7.2.1.1 - CheckClusterResourceSizeForDataOpsServiceCreate
7.2.1.1.1 - 1.1
scpcli data-ops check cluster resource size for data ops service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Ops Service Creation.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
7.2.1.1.2 - 1.0
scpcli data-ops check cluster resource size for data ops service create
--cluster_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Ops Service Creation.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
7.2.1.2 - CheckClusterResourceSizeForDataOpsServiceUpdate
7.2.1.2.1 - 1.1
scpcli data-ops check cluster resource size for data ops service update
--data_ops_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Ops Service Update.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
7.2.1.2.2 - 1.0
scpcli data-ops check cluster resource size for data ops service update
--data_ops_service_id <value>
--service_workload <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
Validate Cluster Resource Size for Data Ops Service Update.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | ||
| err_code | Error code | |
| memory | ||
| result | Cluster resource check result |
7.2.1.3 - CheckDataOpsNameDuplication
7.2.1.3.1 - 1.1
scpcli data-ops check data ops name duplication
--data_ops_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
check duplication controller
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_name required | string | data ops name | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.2.1.3.2 - 1.0
scpcli data-ops check data ops name duplication
--data_ops_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
check duplication controller
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_name required | string | data ops name | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.2.1.4 - CheckDataOpsServiceNameDuplication
7.2.1.4.1 - 1.1
scpcli data-ops check data ops service name duplication
--data_ops_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
check duplication controller
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_name required | string | data ops service name | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.2.1.4.2 - 1.0
scpcli data-ops check data ops service name duplication
--data_ops_service_name <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
check duplication controller
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_name required | string | data ops service name | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.2.1.5 - CreateDataOps
7.2.1.5.1 - 1.1
scpcli data-ops create data ops
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_ops_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create dataops
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| ingress_controller_name required | string | ingress_controller_name | - |
| image_id required | string | image_id | - |
| host_alias_list required | array | host_alias_list | {'hostnames': [''], 'ip': ''} |
| domain required | string | domain | - |
| data_ops_name required | string | data_ops_name | - |
| cluster_id required | string | cluster_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| dsc_domain optional | string | dsc_domain | - |
| instance_id optional | string | instance_id | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.2.1.5.2 - 1.0
scpcli data-ops create data ops
--storage_class_name <value>
--ingress_controller_name <value>
--image_id <value>
--host_alias_list <value>
--domain <value>
--data_ops_name <value>
--cluster_id <value>
[--account <value>]
[--description <value>]
[--dsc_domain <value>]
[--instance_id <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create dataops
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| storage_class_name required | string | storage_class_name | - |
| ingress_controller_name required | string | ingress_controller_name | - |
| image_id required | string | image_id | - |
| host_alias_list required | array | host_alias_list | {'hostnames': [''], 'ip': ''} |
| domain required | string | domain | - |
| data_ops_name required | string | data_ops_name | - |
| cluster_id required | string | cluster_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| dsc_domain optional | string | dsc_domain | - |
| instance_id optional | string | instance_id | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.2.1.6 - CreateDataOpsService
7.2.1.6.1 - 1.1
scpcli data-ops create data ops service
--worker_type <value>
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_ops_service_name <value>
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create dataops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| worker_type required | string | worker_type | - |
| storage_class_name required | string | storage_class_name | - |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| host_alias required | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| domain required | string | description | - |
| data_ops_service_name required | string | data_ops_service_name | - |
| data_ops_id required | string | data_ops_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.2.1.6.2 - 1.0
scpcli data-ops create data ops service
--worker_type <value>
--storage_class_name <value>
--service_workload <value>
--host_alias <value>
--domain <value>
--data_ops_service_name <value>
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--node_selector <value>]
[--tags <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
create dataops service
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| worker_type required | string | worker_type | - |
| storage_class_name required | string | storage_class_name | - |
| service_workload required | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| host_alias required | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| domain required | string | description | - |
| data_ops_service_name required | string | data_ops_service_name | - |
| data_ops_id required | string | data_ops_id | - |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| node_selector optional | string | node_selector | - |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|
7.2.1.7 - DeleteDataOps
7.2.1.7.1 - 1.1
scpcli data-ops delete data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataops v1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.2.1.7.2 - 1.0
scpcli data-ops delete data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete dataops v1
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.2.1.8 - DeleteDataOpsService
7.2.1.8.1 - 1.1
scpcli data-ops delete data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete data ops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.2.1.8.2 - 1.0
scpcli data-ops delete data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
delete data ops service
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.2.1.9 - ListDataOps
7.2.1.9.1 - 1.1
scpcli data-ops list data ops
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataops_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_ops_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
{aianalytics.GetDataOpsListConsole.notes} v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | created_dt:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| dataops_version optional | string | version | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| cluster_id optional | string | cluster_id | - |
| data_ops_name optional | string | data_ops_name | - |
| region optional | string | region | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| image_id | image_id | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| namespace_name | namespace_name | |
| state | state | |
| version | version |
7.2.1.9.2 - 1.0
scpcli data-ops list data ops
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--state <value>]
[--dataops_version <value>]
[--size <value>]
[--page <value>]
[--cluster_id <value>]
[--data_ops_name <value>]
[--region <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
{aianalytics.GetDataOpsListConsole.notes}
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sort optional | string | sort | created_dt:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| dataops_version optional | string | version | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| cluster_id optional | string | cluster_id | - |
| data_ops_name optional | string | data_ops_name | - |
| region optional | string | region | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| image_id | image_id | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| namespace_name | namespace_name | |
| state | state | |
| version | version |
7.2.1.10 - ListDataOpsImageVersions
7.2.1.10.1 - 1.1
scpcli data-ops list data ops image versions
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops image version v1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| image_attr | image_attr | |
| image_id | image_id | |
| image_name | image_name | |
| version | version |
7.2.1.10.2 - 1.0
scpcli data-ops list data ops image versions
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops image version v1
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| image_attr | image_attr | |
| image_id | image_id | |
| image_name | image_name | |
| version | version |
7.2.1.11 - ListDataOpsService
7.2.1.11.1 - 1.1
scpcli data-ops list data ops service
[--created_by <value>]
[--state <value>]
[--sort <value>]
[--size <value>]
[--page <value>]
[--data_ops_service_name <value>]
[--data_ops_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
GetDataOpsServiceListConsole v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| sort optional | string | sort | created_dt:desc |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| data_ops_service_name optional | string | data_ops_service_name | - |
| data_ops_name optional | string | data_ops_name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| data_ops_service_id | data_ops_service_id | |
| data_ops_service_name | data_ops_service_name | |
| description | description | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| state | state | |
| version | version |
7.2.1.11.2 - 1.0
scpcli data-ops list data ops service
[--created_by <value>]
[--state <value>]
[--sort <value>]
[--size <value>]
[--page <value>]
[--data_ops_service_name <value>]
[--data_ops_name <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
GetDataOpsServiceListConsole
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| created_by optional | string | created_by | - |
| state optional | **** | state | - |
| sort optional | string | sort | created_dt:desc |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| data_ops_service_name optional | string | data_ops_service_name | - |
| data_ops_name optional | string | data_ops_name | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| data_ops_service_id | data_ops_service_id | |
| data_ops_service_name | data_ops_service_name | |
| description | description | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| state | state | |
| version | version |
7.2.1.12 - ShowDataOps
7.2.1.12.1 - 1.1
scpcli data-ops show data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops detail v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| description | description | |
| domain | domain | |
| host_alias_list | host_alias | [{‘hostnames’: [’’], ‘ip’: ‘’}] |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
7.2.1.12.2 - 1.0
scpcli data-ops show data ops
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get dataops detail
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| description | description | |
| domain | domain | |
| host_alias_list | host_alias | [{‘hostnames’: [’’], ‘ip’: ‘’}] |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
7.2.1.13 - ShowDataOpsService
7.2.1.13.1 - 1.1
scpcli data-ops show data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data ops service v1.1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| account_id | account_id | |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| data_ops_service_id | data_ops_service_id | |
| data_ops_service_name | data_ops_service_name | |
| description | description | |
| domain | domain | |
| host_alias | host_alias | {’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]} |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| service_workload | service_workload | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
7.2.1.13.2 - 1.0
scpcli data-ops show data ops service
--data_ops_service_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data ops service
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| account | account | {‘account_id’: ‘’, ‘account_password’: ‘’} |
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_dt | created_dt | |
| data_ops_id | data_ops_id | |
| data_ops_name | data_ops_name | |
| data_ops_service_id | data_ops_service_id | |
| data_ops_service_name | data_ops_service_name | |
| description | description | |
| domain | domain | |
| host_alias | host_alias | {’enabled’: ’true’, ‘host_alias_list’: [{‘hostname’: ‘’, ‘ip’: ‘’}]} |
| hosts_file | hosts_file | |
| http_port | http_port | |
| https_port | https_port | |
| image_id | image_id | |
| ingress_class_name | ingress_class_name | |
| instance_id | instance_id | |
| is_active_image | is_active_image | |
| modified_dt | modified_dt | |
| namespace_name | namespace_name | |
| node_selector | node_selector | |
| service_workload | service_workload | |
| state | state | |
| storage_class_name | storage_class_name | |
| version | version | |
| web_url | web_url |
7.2.1.14 - ShowDataOpsServiceSubVersion
7.2.1.14.1 - 1.1
scpcli data-ops show data ops service sub version
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data ops sub version
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| data_ops_service_count | DataOpsService count | |
| versions | image versions |
7.2.1.14.2 - 1.0
scpcli data-ops show data ops service sub version
--data_ops_id <value>
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
get data ops sub version
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
Responses
| Name | Description | Example |
|---|---|---|
| data_ops_service_count | DataOpsService count | |
| versions | image versions |
7.2.1.15 - UpdateDataOps
7.2.1.15.1 - 1.1
scpcli data-ops update data ops
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update dataops v1
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias_list optional | array | host_alias | {'hostnames': [''], 'ip': ''} |
| node_selector optional | string | node_selector | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.2.1.15.2 - 1.0
scpcli data-ops update data ops
--data_ops_id <value>
[--account <value>]
[--description <value>]
[--domain <value>]
[--host_alias_list <value>]
[--node_selector <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update dataops v1
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_id required | string | data ops ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| account optional | object | account | {'account_id': '', 'account_password': ''} |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias_list optional | array | host_alias | {'hostnames': [''], 'ip': ''} |
| node_selector optional | string | node_selector | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.2.1.16 - UpdateDataOpsService
7.2.1.16.1 - 1.1
scpcli data-ops update data ops service
--data_ops_service_id <value>
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--worker_type <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update data ops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias optional | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| node_selector optional | string | node_selector | - |
| service_workload optional | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| worker_type optional | string | worker_type | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.2.1.16.2 - 1.0
scpcli data-ops update data ops service
--data_ops_service_id <value>
[--description <value>]
[--domain <value>]
[--host_alias <value>]
[--node_selector <value>]
[--service_workload <value>]
[--worker_type <value>]
[--accept <value>]
[--content-type <value>]
[--scp-request-path <value>]
Description
update data ops service
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| data_ops_service_id required | string | data ops service ID | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| description optional | string | description | - |
| domain optional | string | domain | - |
| host_alias optional | object | host_alias | {'enabled': 'true', 'host_alias_list': [{'hostname': '', 'ip': ''}]} |
| node_selector optional | string | node_selector | - |
| service_workload optional | object | service_workload | {'scheduler': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'web_server': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}, 'worker': {'cpu': '', 'memory': '', 'replica': '', 'version': ''}} |
| worker_type optional | string | worker_type | - |
| accept optional | string | Accept | - |
| content-type optional | string | Content-Type | - |
| scp-request-path optional | string | Scp-Request-Path | - |
7.3 - Event Streams
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Event Streams 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
7.3.1 - CLIs
7.3.1.1 - Add Instances
7.3.1.1.1 - 1.0
scpcli eventstreams instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]
Description
Add Instances.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| service_ip_addresses required | array | User subnet IP address | - |
| instance_count required | integer | Instance Count | - |
| public_ip_ids optional | array | Public IP ID List | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.2 - Create Cluster
7.3.1.2.1 - 1.0
scpcli eventstreams cluster create
--zookeeper_sasl_password <value>
--zookeeper_sasl_id <value>
--broker_sasl_password <value>
--broker_sasl_id <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--akhq_enabled <value>]
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--nat_enabled <value>]
[--tags <value>]
[--akhq_id <value>]
[--akhq_password <value>]
[--broker_port <value>]
[--zookeeper_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| zookeeper_sasl_password required | string | zookeeper sasl password | - |
| zookeeper_sasl_id required | string | zookeeper sasl id | - |
| broker_sasl_password required | string | broker sasl password | - |
| broker_sasl_id required | string | broker sasl id | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| akhq_enabled optional | boolean | AKHQ availability | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| is_combined optional | boolean | HA availability | - |
| nat_enabled optional | boolean | NAT availability | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| akhq_id optional | string | akhq id | - |
| akhq_password optional | string | akhq password | - |
| broker_port optional | integer | broker port | - |
| zookeeper_port optional | integer | zookeeper port | - |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.3 - List Clusters
7.3.1.3.1 - 1.0
scpcli eventstreams cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Cluster name | - |
| service_state optional | string | Service state | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
7.3.1.4 - List Engine Version Properties
7.3.1.4.1 - 1.0
scpcli eventstreams engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
7.3.1.5 - List Engine Versions
7.3.1.5.1 - 1.0
scpcli eventstreams engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
7.3.1.6 - List Parameter Groups
7.3.1.6.1 - 1.0
scpcli eventstreams parameter group list
[--major_version <value>]
[--product_image_type <value>]
[--sort <value>]
Description
List Parameter Groups.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| major_version optional | string | Software major version | - |
| product_image_type optional | string | Product image type | - |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter group ID | |
| major_version | Software major version | |
| name | Parameter group name | |
| product_image_type | Product image type | |
| product_type | Product type |
7.3.1.7 - List Parameter Values
7.3.1.7.1 - 1.0
scpcli eventstreams parameter value list
--cluster_id <value>
Description
List Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| allows_value | Parameter allows value | |
| applied_value | Parameter applied value | |
| apply_type | Parameter apply type | |
| data_type | Parameter data type | |
| default_value | Parameter default value | |
| description | Parameter description | |
| is_modifiable | Parameter is_modifiable | |
| name | Parameter name | |
| software_type | Parameter software type |
7.3.1.8 - List Parameters
7.3.1.8.1 - 1.0
scpcli eventstreams parameter list
--dbaas_parameter_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
List Parameters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_parameter_group_id required | string | Parameter group ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Parameter id | |
| dbaas_parameter_group_id | Parameter id | |
| default_value | Parameter default value | |
| description | Parameter description | |
| name | Parameter name | |
| software_type | Parameter software type |
7.3.1.9 - List Server Types
7.3.1.9.1 - 1.0
scpcli eventstreams engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
7.3.1.10 - Restart Cluster
7.3.1.10.1 - 1.0
scpcli eventstreams cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.11 - Set Block Storage Size
7.3.1.11.1 - 1.0
scpcli eventstreams block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.12 - Set Maintenance
7.3.1.12.1 - 1.0
scpcli eventstreams maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.13 - Set Parameter Values
7.3.1.13.1 - 1.0
scpcli eventstreams parameter value set
--cluster_id <value>
--parameters <value>
Description
Set Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| parameters required | array | Parameter request list | '{"id": "", "new_value": "", "old_value": ""}' |
7.3.1.14 - Set Security Group Rules
7.3.1.14.1 - 1.0
scpcli eventstreams security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.15 - Set Server Type
7.3.1.15.1 - 1.0
scpcli eventstreams server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.16 - Show Cluster
7.3.1.16.1 - 1.0
scpcli eventstreams cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
7.3.1.17 - Show Request
7.3.1.17.1 - 1.0
scpcli eventstreams request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
7.3.1.18 - Start Cluster
7.3.1.18.1 - 1.0
scpcli eventstreams cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.19 - Stop Cluster
7.3.1.19.1 - 1.0
scpcli eventstreams cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.20 - Synchronize Cluster State
7.3.1.20.1 - 1.0
scpcli eventstreams cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.21 - Synchronize Parameter Values
7.3.1.21.1 - 1.0
scpcli eventstreams parameter value sync
--cluster_id <value>
Description
Synchronize Parameter Values.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.3.1.22 - Terminate Cluster
7.3.1.22.1 - 1.0
scpcli eventstreams cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
7.3.1.23 - Unset Maintenance
7.3.1.23.1 - 1.0
scpcli eventstreams maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
7.4 - Quick Query
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Quick Query 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|
7.4.1 - CLIs
7.4.1.1 - CheckClusterResourceSizeForQuickQuery
7.4.1.1.1 - 1.1
scpcli quick-query check resource validation
--node_pool_validation_request <value>
[--cluster_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--is_engine_type_private <value>]
[--memory <value>]
[--replica <value>]
Description
Check if resource is verified to be modified/created
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| node_pool_validation_request required | array | node_pool_validation_request | '{"auto_scale": "", "desired_node_count": "", "max_node_count": "", "min_node_count": "", "scale_name": ""}' |
| cluster_id optional | string | cluster_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| is_engine_type_private optional | boolean | is_engine_type_private | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | cpu | |
| is_node_pool_auto_scalable | is_node_pool_auto_scalable | |
| memory | memory | |
| replica | replica |
7.4.1.1.2 - 1.0
scpcli quick-query check resource validation
--node_pool_validation_request <value>
[--cluster_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--is_engine_type_private <value>]
[--memory <value>]
[--replica <value>]
Description
Check if resource is verified to be modified/created
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| node_pool_validation_request required | array | node_pool_validation_request | '{"auto_scale": "", "desired_node_count": "", "max_node_count": "", "min_node_count": "", "scale_name": ""}' |
| cluster_id optional | string | cluster_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| is_engine_type_private optional | boolean | is_engine_type_private | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu | cpu | |
| is_node_pool_auto_scalable | is_node_pool_auto_scalable | |
| memory | memory | |
| replica | replica |
7.4.1.2 - CheckDuplicationQuickQueryName
7.4.1.2.1 - 1.1
scpcli quick-query check quick query duplication
--quick_query_name <value>
Description
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_name required | string | quick query name | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | check result |
7.4.1.2.2 - 1.0
scpcli quick-query check quick query duplication
--quick_query_name <value>
Description
Check Duplication Quick Query Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_name required | string | quick query name | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | check result |
7.4.1.3 - CreateQuickQuery
7.4.1.3.1 - 1.1
scpcli quick-query create quick query
--quickquery_version <value>
--quick_query_name <value>
--max_query <value>
--is_engine_type_private <value>
--image_id <value>
--dsc_domain <value>
--domain <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--cloud_logging_enabled <value>
--node_pool_create_requests <value>
[--tags <value>]
[--cifs_volume_id <value>]
[--lb_id <value>]
[--public_acl_ip_address <value>]
[--description <value>]
[--dsc_console_ip <value>]
[--host_alias_list <value>]
[--instance_id <value>]
[--product_group_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--memory <value>]
[--replica <value>]
Description
Create Quick Query.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quickquery_version required | string | version | - |
| quick_query_name required | string | quick_query_name | - |
| max_query required | string | max_query | - |
| is_engine_type_private required | boolean | is_engine_type_private | - |
| image_id required | string | image_id | - |
| dsc_domain required | string | dsc_domain | - |
| domain required | string | domain | - |
| vpc_id required | string | vpc_id | - |
| volume_id required | string | volume_id | - |
| subnet_id required | string | subnet_id | - |
| security_group_id_list required | array | security_group_id_list | - |
| kubernetes_engine_name required | string | kubernetes_engine_name | - |
| k8s_version required | string | k8s_version | - |
| cloud_logging_enabled required | boolean | cloud_logging_enabled | - |
| node_pool_create_requests required | array | node_pool_create_requests | '{"auto_recovery": false, "auto_scale": false, "desired_node_count": "", "image_os": "", "image_os_version": "", "k8s_version": "", "keypair_name": "", "max_node_count": "", "min_node_count": "", "name": "", "scale_name": "", "volume_size": "", "volume_type_name": ""}' |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| cifs_volume_id optional | string | cifs_volume_id | - |
| lb_id optional | string | lb_id | - |
| public_acl_ip_address optional | string | public_acl_ip_address | - |
| description optional | string | description | - |
| dsc_console_ip optional | string | dsc_console_ip | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
| instance_id optional | string | instance_id | - |
| product_group_id optional | string | product_group_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
Responses
| Name | Description | Example |
|---|---|---|
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
| request_id | Request ID | 10a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 10a599e031e749b7b260868f441e862b |
7.4.1.3.2 - 1.0
scpcli quick-query create quick query
--quickquery_version <value>
--quick_query_name <value>
--max_query <value>
--is_engine_type_private <value>
--image_id <value>
--dsc_domain <value>
--domain <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--cloud_logging_enabled <value>
--node_pool_create_requests <value>
[--tags <value>]
[--cifs_volume_id <value>]
[--lb_id <value>]
[--public_acl_ip_address <value>]
[--description <value>]
[--dsc_console_ip <value>]
[--host_alias_list <value>]
[--instance_id <value>]
[--product_group_id <value>]
[--auto_scale <value>]
[--cluster_size <value>]
[--cpu <value>]
[--memory <value>]
[--replica <value>]
Description
Create Quick Query.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quickquery_version required | string | version | - |
| quick_query_name required | string | quick_query_name | - |
| max_query required | string | max_query | - |
| is_engine_type_private required | boolean | is_engine_type_private | - |
| image_id required | string | image_id | - |
| dsc_domain required | string | dsc_domain | - |
| domain required | string | domain | - |
| vpc_id required | string | vpc_id | - |
| volume_id required | string | volume_id | - |
| subnet_id required | string | subnet_id | - |
| security_group_id_list required | array | security_group_id_list | - |
| kubernetes_engine_name required | string | kubernetes_engine_name | - |
| k8s_version required | string | k8s_version | - |
| cloud_logging_enabled required | boolean | cloud_logging_enabled | - |
| node_pool_create_requests required | array | node_pool_create_requests | '{"auto_recovery": false, "auto_scale": false, "desired_node_count": "", "image_os": "", "image_os_version": "", "k8s_version": "", "keypair_name": "", "max_node_count": "", "min_node_count": "", "name": "", "scale_name": "", "volume_size": "", "volume_type_name": ""}' |
| tags optional | array | tags | '{"tag_key": "", "tag_value": ""}' |
| cifs_volume_id optional | string | cifs_volume_id | - |
| lb_id optional | string | lb_id | - |
| public_acl_ip_address optional | string | public_acl_ip_address | - |
| description optional | string | description | - |
| dsc_console_ip optional | string | dsc_console_ip | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
| instance_id optional | string | instance_id | - |
| product_group_id optional | string | product_group_id | - |
| auto_scale optional | boolean | auto_scale | - |
| cluster_size optional | string | cluster_size | - |
| cpu optional | string | cpu | - |
| memory optional | string | memory | - |
| replica optional | string | replica | - |
Responses
| Name | Description | Example |
|---|---|---|
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
| request_id | Request ID | 10a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 10a599e031e749b7b260868f441e862b |
7.4.1.4 - DeleteQuickQuery
7.4.1.4.1 - 1.1
scpcli quick-query delete quick query
--quick_query_id <value>
Description
delete quick query
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
7.4.1.4.2 - 1.0
scpcli quick-query delete quick query
--quick_query_id <value>
Description
delete quick query
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
7.4.1.5 - ListQuickQuery
7.4.1.5.1 - 1.1
scpcli quick-query list quick query
--page <value>
--size <value>
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--quick_query_state <value>]
[--quickquery_version <value>]
[--quick_query_name <value>]
Description
get quick query list console
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| page required | integer | page | 0 |
| size required | integer | size | 20 |
| sort optional | string | sort | created_at:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| quick_query_state optional | **** | state | - |
| quickquery_version optional | string | version | - |
| quick_query_name optional | string | quick_query_name | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| quick_query_id | quick_query_id | |
| quick_query_name | quick_query_name | |
| quick_query_state | quick_query_state | |
| quick_query_version | quick_query_version |
7.4.1.5.2 - 1.0
scpcli quick-query list quick query
--page <value>
--size <value>
[--sort <value>]
[--cluster_name <value>]
[--created_by <value>]
[--quick_query_state <value>]
[--quickquery_version <value>]
[--quick_query_name <value>]
Description
get quick query list console
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| page required | integer | page | 0 |
| size required | integer | size | 20 |
| sort optional | string | sort | created_at:desc |
| cluster_name optional | string | cluster_name | - |
| created_by optional | string | created_by | - |
| quick_query_state optional | **** | state | - |
| quickquery_version optional | string | version | - |
| quick_query_name optional | string | quick_query_name | - |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | cluster_id | |
| cluster_name | cluster_name | |
| cluster_permission | cluster_permission | |
| cluster_request_failed | cluster_request_failed | |
| created_by | created_by | |
| created_dt | created_at | |
| modified_by | modified_by | |
| modified_dt | modified_at | |
| quick_query_id | quick_query_id | |
| quick_query_name | quick_query_name | |
| quick_query_state | quick_query_state | |
| quick_query_version | quick_query_version |
7.4.1.6 - ListQuickQueryImages
7.4.1.6.1 - 1.1
scpcli quick-query list quick query images
Description
get quick query image versions
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|---|---|
| image_attr | image_attr | |
| image_id | image_id | |
| image_name | image_name | |
| version | version |
7.4.1.6.2 - 1.0
scpcli quick-query list quick query images
Description
get quick query image versions
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Responses
| Name | Description | Example |
|---|---|---|
| image_attr | image_attr | |
| image_id | image_id | |
| image_name | image_name | |
| version | version |
7.4.1.7 - ShowQuickQuery
7.4.1.7.1 - 1.1
scpcli quick-query show quick query
--quick_query_id <value>
Description
Get Quick Query details.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
Responses
| Name | Description | Example |
|---|---|---|
| age | age | |
| cluster_id | cluster id | |
| container_version | Container Version | |
| created_at | created at | |
| external_ip_address | External IP Address | |
| gpu_name | GPU Name | |
| ip | IP | |
| kernel_version | Kernel Version | |
| kubernetes_version | Kubernetes Version | |
| name | name | |
| node_capacities | Node Capacities | |
| node_status | node status | |
| number_of_allocated_pods | Number of allocated pods | |
| number_of_gpu | Number of GPU | |
| os_image | OS Image | |
| uid | uid |
7.4.1.7.2 - 1.0
scpcli quick-query show quick query
--quick_query_id <value>
Description
Get Quick Query details.
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
Responses
| Name | Description | Example |
|---|---|---|
| age | age | |
| cluster_id | cluster id | |
| container_version | Container Version | |
| created_at | created at | |
| external_ip_address | External IP Address | |
| gpu_name | GPU Name | |
| ip | IP | |
| kernel_version | Kernel Version | |
| kubernetes_version | Kubernetes Version | |
| name | name | |
| node_capacities | Node Capacities | |
| node_status | node status | |
| number_of_allocated_pods | Number of allocated pods | |
| number_of_gpu | Number of GPU | |
| os_image | OS Image | |
| uid | uid |
7.4.1.8 - UpdateQuickQueryDescription
7.4.1.8.1 - 1.1
scpcli quick-query update quick query description
--quick_query_id <value>
--description <value>
Description
update quick query description
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| description required | string | description | - |
7.4.1.8.2 - 1.0
scpcli quick-query update quick query description
--quick_query_id <value>
--description <value>
Description
update quick query description
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| description required | string | description | - |
7.4.1.9 - UpdateQuickQueryDomain
7.4.1.9.1 - 1.1
scpcli quick-query update quick query domain
--quick_query_id <value>
--domain <value>
Description
update quick query domain
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| domain required | string | domain | - |
7.4.1.9.2 - 1.0
scpcli quick-query update quick query domain
--quick_query_id <value>
--domain <value>
Description
update quick query domain
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| domain required | string | domain | - |
7.4.1.10 - UpdateQuickQueryDscDomain
7.4.1.10.1 - 1.1
scpcli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>
Description
update quick query dsc domain
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| dsc_domain required | string | dsc_domain | - |
7.4.1.10.2 - 1.0
scpcli quick-query update quick query dsc domain
--quick_query_id <value>
--dsc_domain <value>
Description
update quick query dsc domain
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| dsc_domain required | string | dsc_domain | - |
7.4.1.11 - UpdateQuickQueryEngine
7.4.1.11.1 - 1.1
scpcli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]
Description
update quick query engine
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| replica required | string | replica | - |
| memory required | string | memory | - |
| cpu required | string | cpu | - |
| cluster_size optional | string | cluster_size | - |
7.4.1.11.2 - 1.0
scpcli quick-query update quick query engine
--quick_query_id <value>
--replica <value>
--memory <value>
--cpu <value>
[--cluster_size <value>]
Description
update quick query engine
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| replica required | string | replica | - |
| memory required | string | memory | - |
| cpu required | string | cpu | - |
| cluster_size optional | string | cluster_size | - |
7.4.1.12 - UpdateQuickQueryHostAlias
7.4.1.12.1 - 1.1
scpcli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]
Description
update quick query host alias
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
7.4.1.12.2 - 1.0
scpcli quick-query update quick query host alias
--quick_query_id <value>
[--host_alias_list <value>]
Description
update quick query host alias
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| quick_query_id required | string | quick_query_id | - |
| host_alias_list optional | array | host_alias_list | '{"hostnames": "", "ip": ""}' |
7.5 - Search Engine
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Search Engine 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
7.5.1 - CLIs
7.5.1.1 - Add Block Storages
7.5.1.1.1 - 1.0
scpcli searchengine block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| size_gb required | integer | Size in GB | 104 |
| role_type required | string | Role type | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.2 - Add Instances
7.5.1.2.1 - 1.0
scpcli searchengine instance add
--cluster_id <value>
--service_ip_addresses <value>
--instance_count <value>
[--public_ip_ids <value>]
Description
Add Instances.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| service_ip_addresses required | array | User subnet IP address | - |
| instance_count required | integer | Instance Count | - |
| public_ip_ids optional | array | Public IP ID List | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.3 - Create Cluster
7.5.1.3.1 - 1.0
scpcli searchengine cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--is_combined <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_port <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| is_combined optional | boolean | Master Data server separation state | - |
| license optional | string | license | - |
| nat_enabled optional | boolean | NAT availability | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| database_port optional | integer | Database service port | - |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.4 - Create Restore Cluster
7.5.1.4.1 - 1.0
scpcli searchengine restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "role_type": "ACTIVE"}' |
| backup_history_number required | string | Backup id | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| license optional | string | license | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.5 - List Backup Histories
7.5.1.5.1 - 1.0
scpcli searchengine backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_at | Backup end time | |
| backup_history_number | Backup id | |
| backup_size_gb | Backup amount(GB) | |
| backup_start_at | Backup start time | |
| backup_state | Backup state | |
| backup_state_detail | Backup detail state | |
| software_version | Software version |
7.5.1.6 - List Clusters
7.5.1.6.1 - 1.0
scpcli searchengine cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Cluster name | - |
| service_state optional | string | Service state | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| ha_enabled | HA availability | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| role_type | Role type | |
| service_state | Service state |
7.5.1.7 - List Engine Version Properties
7.5.1.7.1 - 1.0
scpcli searchengine engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
7.5.1.8 - List Engine Versions
7.5.1.8.1 - 1.0
scpcli searchengine engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
7.5.1.9 - List Server Types
7.5.1.9.1 - 1.0
scpcli searchengine engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
7.5.1.10 - Remove Backup Histories
7.5.1.10.1 - 1.0
scpcli searchengine backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
7.5.1.11 - Restart Cluster
7.5.1.11.1 - 1.0
scpcli searchengine cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.12 - Set Backup
7.5.1.12.1 - 1.0
scpcli searchengine backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
Description
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.13 - Set Block Storage Size
7.5.1.13.1 - 1.0
scpcli searchengine block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.14 - Set Maintenance
7.5.1.14.1 - 1.0
scpcli searchengine maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.15 - Set Security Group Rules
7.5.1.15.1 - 1.0
scpcli searchengine security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.16 - Set Server Type
7.5.1.16.1 - 1.0
scpcli searchengine server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.17 - Show Cluster
7.5.1.17.1 - 1.0
scpcli searchengine cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
7.5.1.18 - Show Request
7.5.1.18.1 - 1.0
scpcli searchengine request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
7.5.1.19 - Start Cluster
7.5.1.19.1 - 1.0
scpcli searchengine cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.20 - Stop Cluster
7.5.1.20.1 - 1.0
scpcli searchengine cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.21 - Synchronize Cluster State
7.5.1.21.1 - 1.0
scpcli searchengine cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.5.1.22 - Terminate Cluster
7.5.1.22.1 - 1.0
scpcli searchengine cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
7.5.1.23 - Unset Backup
7.5.1.23.1 - 1.0
scpcli searchengine backup unset
--cluster_id <value>
Description
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
7.5.1.24 - Unset Maintenance
7.5.1.24.1 - 1.0
scpcli searchengine maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
7.6 - Vertica(DBaaS)
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Vertica(DBaaS) 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
7.6.1 - CLIs
7.6.1.1 - Add Block Storages
7.6.1.1.1 - 1.0
scpcli vertica block storage add
--instance_group_id <value>
--size_gb <value>
--role_type <value>
[--volume_type <value>]
Description
Add Block Storages.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| size_gb required | integer | Size in GB | 104 |
| role_type required | string | Role type | - |
| volume_type optional | string | Volume type | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.2 - Create Cluster
7.6.1.2.1 - 1.0
scpcli vertica cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_locale <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| database_user_password required | string | Database user password | - |
| database_user_name required | string | Database User Name | - |
| database_name required | string | Database Name | - |
| timezone required | string | Timezone | - |
| subnet_id required | string | Subnet ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "ACTIVE", "service_ip_address": ""}], "role_type": "ACTIVE", "server_type_name": ""}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| license optional | string | license | - |
| nat_enabled optional | boolean | NAT availability | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| database_locale optional | string | Database locale information | - |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.3 - Create Restore Cluster
7.6.1.3.1 - 1.0
scpcli vertica restore create
--cluster_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--backup_history_number <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--tags <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Restore Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "", "size_gb": 104, "volume_type": "SSD"}], "role_type": "ACTIVE", "server_type_name": ""}' |
| backup_history_number required | string | Backup id | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| license optional | string | license | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| period_hour optional | string | Period in hours | - |
| starting_day_of_week optional | string | Starting day of week | - |
| starting_time optional | string | Starting time | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.4 - List Backup Histories
7.6.1.4.1 - 1.0
scpcli vertica backup history list
--cluster_id <value>
[--limit <value>]
[--page <value>]
Description
List Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| limit optional | integer | Number of backup lists | - |
| page optional | integer | Backup list page | - |
Responses
| Name | Description | Example |
|---|---|---|
| backup_end_at | Backup end time | |
| backup_history_number | Backup id | |
| backup_size_gb | Backup amount(GB) | |
| backup_start_at | Backup start time | |
| backup_state | Backup state | |
| backup_state_detail | Backup detail state | |
| software_version | Software version |
7.6.1.5 - List Clusters
7.6.1.5.1 - 1.0
scpcli vertica cluster list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--service_state <value>]
Description
List Clusters.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Cluster name | - |
| service_state optional | string | Service state | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| console_included | Management Console included state | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| database_name | Database Name | |
| instance_count | Instance Count | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| role_type | Role type | |
| service_state | Service state |
7.6.1.6 - List Engine Version Properties
7.6.1.6.1 - 1.0
scpcli vertica engine version property list
--dbaas_engine_version_id <value>
Description
List Engine Version Properties.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dbaas_engine_version_id required | string | DBaaS engine version ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| name | DBaas engine property name | |
| value | DBaas engine property value |
7.6.1.7 - List Engine Versions
7.6.1.7.1 - 1.0
scpcli vertica engine version list
[--id <value>]
[--product_image_type <value>]
[--eos_included <value>]
Description
List Engine Versions.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id optional | string | DBaaS engine version ID | - |
| product_image_type optional | **** | Product image type | - |
| eos_included optional | boolean | EoS included | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| end_of_service | End of Service | |
| major_version | Software major version | |
| name | DBaaS engine version name | |
| os_type | OS type | |
| os_version | OS version | |
| product_image_type | Product type | |
| software_version | Software version |
7.6.1.8 - List Server Types
7.6.1.8.1 - 1.0
scpcli vertica engine server type list
[--name <value>]
[--product_image_type <value>]
Description
List Server Types.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Server type name | - |
| product_image_type optional | string | Product image type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cpu_core | Server type cpu core | |
| description | Server type description | |
| memory_gb | Server type memory | |
| name | Server type name | |
| product_image_type | Product image type | |
| product_type | Product type | |
| purpose | Server type purpose | |
| type | Server type class |
7.6.1.9 - Remove Backup Histories
7.6.1.9.1 - 1.0
scpcli vertica backup history remove
--cluster_id <value>
--backup_history_number <value>
Description
Remove Backup Histories.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| backup_history_number required | array | Backup id | - |
7.6.1.10 - Restart Cluster
7.6.1.10.1 - 1.0
scpcli vertica cluster restart
--cluster_id <value>
Description
Restart Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.11 - Set Backup
7.6.1.11.1 - 1.0
scpcli vertica backup set
--cluster_id <value>
--starting_time_hour <value>
--retention_period_day <value>
Description
Set Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.12 - Set Block Storage Size
7.6.1.12.1 - 1.0
scpcli vertica block storage size set
--block_storage_group_id <value>
--size_gb <value>
Description
Set Block Storage Size.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| block_storage_group_id required | string | Block storage group ID | afc33891202643ba8ba1a5298a1affff |
| size_gb required | integer | Size in GB | 16 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.13 - Set Maintenance
7.6.1.13.1 - 1.0
scpcli vertica maintenance set
--cluster_id <value>
--term_hour <value>
--start_time <value>
--start_minute <value>
--start_day_of_week <value>
Description
Set Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| term_hour required | string | term_hour | - |
| start_time required | string | start_time | - |
| start_minute required | string | start_minute | - |
| start_day_of_week required | string | start_day_of_week | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.14 - Set Security Group Rules
7.6.1.14.1 - 1.0
scpcli vertica security group rule set
--cluster_id <value>
[--add_ip_addresses <value>]
[--del_ip_addresses <value>]
Description
Set Security Group Rules.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
| add_ip_addresses optional | array | Allowed IP addresses list | - |
| del_ip_addresses optional | array | Allowed IP addresses list | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.15 - Set Server Type
7.6.1.15.1 - 1.0
scpcli vertica server type set
--instance_group_id <value>
--server_type_name <value>
Description
Set Server Type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_group_id required | string | Instance group ID | - |
| server_type_name required | string | Server type name | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.16 - Show Cluster
7.6.1.16.1 - 1.0
scpcli vertica cluster show
--cluster_id <value>
Description
Show Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| block_storage_groups | Block storage groups list | |
| instances | Instances list | |
| role_type | Role type | |
| server_type_name | Server type name |
7.6.1.17 - Show Request
7.6.1.17.1 - 1.0
scpcli vertica request show
--request_id <value>
Description
Show Request.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| state | Request state |
7.6.1.18 - Start Cluster
7.6.1.18.1 - 1.0
scpcli vertica cluster start
--cluster_id <value>
Description
Start Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.19 - Stop Cluster
7.6.1.19.1 - 1.0
scpcli vertica cluster stop
--cluster_id <value>
Description
Stop Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.20 - Synchronize Cluster State
7.6.1.20.1 - 1.0
scpcli vertica cluster state sync
--cluster_id <value>
Description
Synchronize Cluster State.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
7.6.1.21 - Terminate Cluster
7.6.1.21.1 - 1.0
scpcli vertica cluster delete
--cluster_id <value>
Description
Terminate Cluster.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
7.6.1.22 - Unset Backup
7.6.1.22.1 - 1.0
scpcli vertica backup unset
--cluster_id <value>
Description
Unset Backup.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
7.6.1.23 - Unset Maintenance
7.6.1.23.1 - 1.0
scpcli vertica maintenance unset
--cluster_id <value>
Description
Unset Maintenance.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
8 - Application Service
8.1 - API Gateway
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 API Gateway 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | DEPRECATED | 20260430 |
| 1.2 | CURRENT | - |
8.1.1 - CLIs
8.1.1.1 - Approve PrivateLink Endpoint
8.1.1.1.1 - 1.2
scpcli application-apigateway privatelink endpoint approve
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>
Description
PrivateLink 엔드포인트를 승인한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| type required | string | PrivateLink 엔드포인트 액션 유형 | CANCEL |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.2 - Connect PrivateLink Endpoint
8.1.1.2.1 - 1.2
scpcli application-apigateway privatelink endpoint connect
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>
Description
PrivateLink 엔드포인트를 연결한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| type required | string | PrivateLink 엔드포인트 액션 유형 | CANCEL |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.3 - Create AccessControl
8.1.1.3.1 - 1.2
scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]
Description
접근제어를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| name required | string | 접근제어명 | DenyTest |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
| allowed_ip_addr required | array | 허용 IP 주소 | 127.0.0.1/24,192.168.127.12 |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | 접근제어 ID | 27bb070b564349f8a31cc60734cc36a5 |
| allowed_ip_addr | 허용 IP 주소 | [‘127.0.0.1/24,192.168.127.12’] |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| created_at | 생성 일시 | 2024-05-19T00:23:17Z |
| description | 설명 | |
| name | 접근제어명 | DenyTest |
8.1.1.3.2 - 1.1
scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]
Description
접근제어를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| name required | string | 접근제어명 | DenyTest |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
| allowed_ip_addr required | array | 허용 IP 주소 | 127.0.0.1/24,192.168.127.12 |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | 접근제어 ID | 27bb070b564349f8a31cc60734cc36a5 |
| allowed_ip_addr | 허용 IP 주소 | [‘127.0.0.1/24,192.168.127.12’] |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| created_at | 생성 일시 | 2024-05-19T00:23:17Z |
| description | 설명 | |
| name | 접근제어명 | DenyTest |
8.1.1.3.3 - 1.0
scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]
Description
접근제어를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| name required | string | 접근제어명 | DenyTest |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
| allowed_ip_addr required | array | 허용 IP 주소 | 127.0.0.1/24,192.168.127.12 |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | 접근제어 ID | 27bb070b564349f8a31cc60734cc36a5 |
| allowed_ip_addr | 허용 IP 주소 | [‘127.0.0.1/24,192.168.127.12’] |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| created_at | 생성 일시 | 2024-05-19T00:23:17Z |
| description | 설명 | |
| name | 접근제어명 | DenyTest |
8.1.1.4 - Create Api
8.1.1.4.1 - 1.2
scpcli application-apigateway api create
--name <value>
[--description <value>]
[--endpoint_type <value>]
[--id <value>]
[--tags <value>]
Description
API를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 이름 | test-api |
| description optional | string | 설명 | description |
| endpoint_type optional | string | 엔드포인트 유형 | - |
| id optional | string | Api ID | - |
| tags optional | array | 태그 목록 | '{"key": "key", "value": "value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | Description |
| name | 이름 | test-api |
8.1.1.4.2 - 1.1
scpcli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]
Description
API를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 이름 | test-api |
| description optional | string | 설명 | description |
| id optional | string | Api ID | - |
| tags optional | array | 태그 목록 | '{"key": "key", "value": "value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | Description |
| name | 이름 | test-api |
8.1.1.4.3 - 1.0
scpcli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]
Description
API를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 이름 | test-api |
| description optional | string | 설명 | description |
| id optional | string | Api ID | - |
| tags optional | array | 태그 목록 | '{"key": "key", "value": "value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | Description |
| name | 이름 | test-api |
8.1.1.5 - Create Api Deployment
8.1.1.5.1 - 1.2
scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]
Description
API를 배포한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| stage_type required | string | 스테이지 유형 | new |
| description optional | string | 설명 | description |
| stage_name optional | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
8.1.1.5.2 - 1.1
scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]
Description
API를 배포한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| stage_type required | string | 스테이지 유형 | new |
| description optional | string | 설명 | description |
| stage_name optional | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
8.1.1.5.3 - 1.0
scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]
Description
API를 배포한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| stage_type required | string | 스테이지 유형 | new |
| description optional | string | 설명 | description |
| stage_name optional | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
8.1.1.6 - Create Api Key
8.1.1.6.1 - 1.2
scpcli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]
Description
API Key를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| name required | string | 이름 | api-key-name |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | API Key ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | |
| description | 설명 | description |
| key | Key | key |
| name | 이름 | api-key-name |
8.1.1.6.2 - 1.1
scpcli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]
Description
API Key를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| name required | string | 이름 | api-key-name |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | API Key ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | |
| description | 설명 | description |
| key | Key | key |
| name | 이름 | api-key-name |
8.1.1.7 - Create Auth
8.1.1.7.1 - 1.2
scpcli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>
Description
인증을 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| name required | string | 인증명 | Token01 |
| expiration_period required | integer | 만료 기간 | 90 |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
Responses
| Name | Description | Example |
|---|---|---|
| access_token | 액세스 토큰 | *********************************************************** |
8.1.1.7.2 - 1.1
scpcli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>
Description
인증을 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| name required | string | 인증명 | Token01 |
| expiration_period required | integer | 만료 기간 | 90 |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
Responses
| Name | Description | Example |
|---|---|---|
| access_token | 액세스 토큰 | *********************************************************** |
8.1.1.7.3 - 1.0
scpcli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>
Description
인증을 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| name required | string | 인증명 | Token01 |
| expiration_period required | integer | 만료 기간 | 90 |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
Responses
| Name | Description | Example |
|---|---|---|
| access_token | 액세스 토큰 | *********************************************************** |
8.1.1.8 - Create Method
8.1.1.8.1 - 1.2
scpcli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]
Description
메서드를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| method_type required | string | 메서드 유형 | GET |
| integration_type required | string | 메서드 통합 유형 | HTTP |
| api_key_required optional | boolean | API Key 사용여부 | False |
| endpoint_url optional | string | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id optional | string | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| privatelink_endpoint_id optional | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| query_strings optional | object | 메서드 쿼리 문자열 | {'param1': 'value1', 'param2': 'value2'} |
| request_headers optional | object | 메서드 요청 헤더 | {'test1' : True} |
Responses
| Name | Description | Example |
|---|---|---|
| api_key_required | API Key 사용여부 | False |
| endpoint_url | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| function_name | Cloud Function Name | test-function |
| integration_type | 메서드 통합 유형 | HTTP |
| method_type | 메서드 유형 | GET |
| privatelink_endpoint_id | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| query_strings | 메서드 쿼리 문자열 | {‘param1’: ‘value1’, ‘param2’: ‘value2’} |
| request_headers | 메서드 요청 헤더 | {’test1’ : True} |
| request_path | 메서드 요청 경로 | {users} |
| srn | SRN | srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test |
8.1.1.8.2 - 1.1
scpcli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]
Description
메서드를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| method_type required | string | 메서드 유형 | GET |
| integration_type required | string | 메서드 통합 유형 | HTTP |
| api_key_required optional | boolean | API Key 사용여부 | False |
| endpoint_url optional | string | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id optional | string | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| privatelink_endpoint_id optional | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| query_strings optional | object | 메서드 쿼리 문자열 | {'param1': 'value1', 'param2': 'value2'} |
| request_headers optional | object | 메서드 요청 헤더 | {'test1' : True} |
Responses
| Name | Description | Example |
|---|---|---|
| api_key_required | API Key 사용여부 | False |
| endpoint_url | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| function_name | Cloud Function Name | test-function |
| integration_type | 메서드 통합 유형 | HTTP |
| method_type | 메서드 유형 | GET |
| query_strings | 메서드 쿼리 문자열 | {‘param1’: ‘value1’, ‘param2’: ‘value2’} |
| request_headers | 메서드 요청 헤더 | {’test1’ : True} |
| request_path | 메서드 요청 경로 | {users} |
| srn | SRN | srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test |
8.1.1.8.3 - 1.0
scpcli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]
Description
메서드를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| method_type required | string | 메서드 유형 | GET |
| integration_type required | string | 메서드 통합 유형 | HTTP |
| api_key_required optional | boolean | API Key 사용여부 | False |
| endpoint_url optional | string | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id optional | string | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| privatelink_endpoint_id optional | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| query_strings optional | object | 메서드 쿼리 문자열 | {'param1': 'value1', 'param2': 'value2'} |
| request_headers optional | object | 메서드 요청 헤더 | {'test1' : True} |
Responses
| Name | Description | Example |
|---|---|---|
| endpoint_url | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| integration_type | 메서드 통합 유형 | HTTP |
| method_type | 메서드 유형 | GET |
| query_strings | 메서드 쿼리 문자열 | {‘param1’: ‘value1’, ‘param2’: ‘value2’} |
| request_headers | 메서드 요청 헤더 | {’test1’ : True} |
| request_path | 메서드 요청 경로 | {users} |
| srn | SRN | srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test |
8.1.1.9 - Create PrivateLink Endpoint
8.1.1.9.1 - 1.2
scpcli application-apigateway privatelink endpoint create
--privatelink_service_id <value>
--name <value>
[--description <value>]
Description
PrivateLink 엔드포인트를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink 서비스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| name required | string | PrivateLink 엔드포인트명 | endpoint |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| description | 설명 | description |
| name | PrivateLink 엔드포인트명 | endpoint |
| privatelink_service_id | PrivateLink 서비스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| status | PrivateLink 엔드포인트 상태 | CANCELED |
8.1.1.10 - Create Resource
8.1.1.10.1 - 1.2
scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>
Description
리소스를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| path_part required | string | 경로명 | test |
Responses
| Name | Description | Example |
|---|---|---|
| id | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| parent_id | 부모 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| path | 경로 |
8.1.1.10.2 - 1.1
scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>
Description
리소스를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| path_part required | string | 경로명 | test |
Responses
| Name | Description | Example |
|---|---|---|
| id | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| parent_id | 부모 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| path | 경로 |
8.1.1.10.3 - 1.0
scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>
Description
리소스를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| path_part required | string | 경로명 | test |
Responses
| Name | Description | Example |
|---|---|---|
| id | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| parent_id | 부모 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| path | 경로 |
8.1.1.11 - Create Stage
8.1.1.11.1 - 1.2
scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]
Description
스테이지를 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 이름 | test-stage |
| deployment_id required | string | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| active_deployment | 활성화 배포 | 2024-05-17T00:23:17Z |
| allow_credentials | 허용 인증 | True |
| allow_headers | 허용 헤더 | [‘Content-Type’, ‘Authorization’] |
| allow_methods | 허용 메서드 | [‘GET’, ‘POST’, ‘PUT’, ‘PATCH’] |
| allow_origins | 허용 원본 | [’*’] |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_key_required | API Key 사용여부 | False |
| cors_enabled | CORS 사용여부 | False |
| created_at | 생성 일시 | |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
| expose_headers | 노출 헤더 | [’test1’, ’test2’] |
| invoke_url | 호출 URL | http://test.com/stg |
| jwt_enabled | JWT 사용여부 | False |
| max_age | 최대 캐시 기간 | 3600 |
| name | 스테이지명 | test-stage |
| usage_plan_api_keys | API Key | [] |
| usage_plan_id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| usage_plan_limit | 사용량 정책 할당량 | 10 |
| usage_plan_name | 이름 | usage-plan-name |
| usage_plan_rate | 사용량 정책 주기 | day |
8.1.1.11.2 - 1.1
scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]
Description
스테이지를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 이름 | test-stage |
| deployment_id required | string | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| active_deployment | 활성화 배포 | 2024-05-17T00:23:17Z |
| allow_credentials | 허용 인증 | True |
| allow_headers | 허용 헤더 | [‘Content-Type’, ‘Authorization’] |
| allow_methods | 허용 메서드 | [‘GET’, ‘POST’, ‘PUT’, ‘PATCH’] |
| allow_origins | 허용 원본 | [’*’] |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_key_required | API Key 사용여부 | False |
| cors_enabled | CORS 사용여부 | False |
| created_at | 생성 일시 | |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
| expose_headers | 노출 헤더 | [’test1’, ’test2’] |
| invoke_url | 호출 URL | http://test.com/stg |
| jwt_enabled | JWT 사용여부 | False |
| max_age | 최대 캐시 기간 | 3600 |
| name | 스테이지명 | test-stage |
| usage_plan_api_keys | API Key | [] |
| usage_plan_id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| usage_plan_limit | 사용량 정책 할당량 | 10 |
| usage_plan_name | 이름 | usage-plan-name |
| usage_plan_rate | 사용량 정책 주기 | day |
8.1.1.11.3 - 1.0
scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]
Description
스테이지를 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 이름 | test-stage |
| deployment_id required | string | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| active_deployment | 활성화 배포 | 2024-05-17T00:23:17Z |
| allow_credentials | 허용 인증 | True |
| allow_headers | 허용 헤더 | [‘Content-Type’, ‘Authorization’] |
| allow_methods | 허용 메서드 | [‘GET’, ‘POST’, ‘PUT’, ‘PATCH’] |
| allow_origins | 허용 원본 | [’*’] |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| cors_enabled | CORS 사용여부 | False |
| created_at | 생성 일시 | |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| expose_headers | 노출 헤더 | [’test1’, ’test2’] |
| invoke_url | 호출 URL | http://test.com/stg |
| ip_restriction_enabled | IP 접근제어 사용여부 | False |
| jwt_enabled | JWT 사용여부 | False |
| max_age | 최대 캐시 기간 | 3600 |
| name | 스테이지명 | test-stage |
8.1.1.12 - Create Usage Plans
8.1.1.12.1 - 1.2
scpcli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]
Description
사용량 정책을 생성한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| rate required | string | 사용량 정책 주기 | day |
| name required | string | 이름 | usage-plan-name |
| limit required | integer | 사용량 정책 할당량 | 10 |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_keys | API Key | [] |
| created_at | 생성 일시 | |
| created_by_id | 생성자 | 27bb070b564349f8a31cc60734cc36a5 |
| created_by_name | 생성자 | username |
| description | 설명 | description |
| limit | 사용량 정책 할당량 | 10 |
| modified_at | 수정시간 | |
| modified_by_id | 수정자 | 27bb070b564349f8a31cc60734cc36a5 |
| modified_by_name | 수정자 | username |
| name | 이름 | usage-plan-name |
| rate | 사용량 정책 주기 | day |
8.1.1.12.2 - 1.1
scpcli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]
Description
사용량 정책을 생성한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| rate required | string | 사용량 정책 주기 | day |
| name required | string | 이름 | usage-plan-name |
| limit required | integer | 사용량 정책 할당량 | 10 |
| description optional | string | 설명 | description |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_keys | API Key | [] |
| created_at | 생성 일시 | |
| created_by_id | 생성자 | 27bb070b564349f8a31cc60734cc36a5 |
| created_by_name | 생성자 | username |
| description | 설명 | description |
| limit | 사용량 정책 할당량 | 10 |
| modified_at | 수정시간 | |
| modified_by_id | 수정자 | 27bb070b564349f8a31cc60734cc36a5 |
| modified_by_name | 수정자 | username |
| name | 이름 | usage-plan-name |
| rate | 사용량 정책 주기 | day |
8.1.1.13 - Delete Access Control
8.1.1.13.1 - 1.2
scpcli application-apigateway access control delete
--access_control_id <value>
--api_id <value>
Description
접근제어를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_control_id required | string | 접근제어 ID | - |
| api_id required | string | Api ID | - |
8.1.1.13.2 - 1.1
scpcli application-apigateway access control delete
--access_control_id <value>
--api_id <value>
Description
접근제어를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_control_id required | string | 접근제어 ID | - |
| api_id required | string | Api ID | - |
8.1.1.13.3 - 1.0
scpcli application-apigateway access control delete
--access_control_id <value>
--api_id <value>
Description
접근제어를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_control_id required | string | 접근제어 ID | - |
| api_id required | string | Api ID | - |
8.1.1.14 - Delete an API Key
8.1.1.14.1 - 1.2
scpcli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
Description
API Key를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_key_id required | string | API Key ID | 27bb070b564349f8a31cc60734cc36a5 |
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.14.2 - 1.1
scpcli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
Description
API Key를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_key_id required | string | API Key ID | 27bb070b564349f8a31cc60734cc36a5 |
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.15 - Delete Api
8.1.1.15.1 - 1.2
scpcli application-apigateway api delete
--api_id <value>
Description
API를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
8.1.1.15.2 - 1.1
scpcli application-apigateway api delete
--api_id <value>
Description
API를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
8.1.1.15.3 - 1.0
scpcli application-apigateway api delete
--api_id <value>
Description
API를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
8.1.1.16 - Delete Auth
8.1.1.16.1 - 1.2
scpcli application-apigateway auth delete
--auth_id <value>
--api_id <value>
Description
인증을 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auth_id required | string | 인증 ID | - |
| api_id required | string | Api ID | - |
8.1.1.16.2 - 1.1
scpcli application-apigateway auth delete
--auth_id <value>
--api_id <value>
Description
인증을 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auth_id required | string | 인증 ID | - |
| api_id required | string | Api ID | - |
8.1.1.16.3 - 1.0
scpcli application-apigateway auth delete
--auth_id <value>
--api_id <value>
Description
인증을 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auth_id required | string | 인증 ID | - |
| api_id required | string | Api ID | - |
8.1.1.17 - Delete Method
8.1.1.17.1 - 1.2
scpcli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>
Description
메서드를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| method_type required | **** | 메서드 유형 | GET |
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.17.2 - 1.1
scpcli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>
Description
메서드를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| method_type required | **** | 메서드 유형 | GET |
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.17.3 - 1.0
scpcli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>
Description
메서드를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| method_type required | **** | 메서드 유형 | GET |
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.18 - Delete PrivateLink Endpoint
8.1.1.18.1 - 1.2
scpcli application-apigateway privatelink endpoint delete
--privatelink_endpoint_id <value>
Description
PrivateLink 엔드포인트를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.19 - Delete Resource
8.1.1.19.1 - 1.2
scpcli application-apigateway resource delete
--resource_id <value>
--api_id <value>
Description
리소스를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.19.2 - 1.1
scpcli application-apigateway resource delete
--resource_id <value>
--api_id <value>
Description
리소스를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.19.3 - 1.0
scpcli application-apigateway resource delete
--resource_id <value>
--api_id <value>
Description
리소스를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.20 - Delete Stage
8.1.1.20.1 - 1.2
scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>
Description
스테이지를 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
8.1.1.20.2 - 1.1
scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>
Description
스테이지를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
8.1.1.20.3 - 1.0
scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>
Description
스테이지를 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
8.1.1.21 - Delete Usage Plan
8.1.1.21.1 - 1.2
scpcli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>
Description
사용량 정책을 삭제한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.21.2 - 1.1
scpcli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>
Description
사용량 정책을 삭제한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.22 - List AccessControls
8.1.1.22.1 - 1.2
scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
접근제어 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 접근제어 ID | 27bb070b564349f8a31cc60734cc36a5 |
| allowed_ip_addr | 허용 IP 주소 | [‘127.0.0.1/24,192.168.127.12’] |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| created_at | 생성 일시 | 2024-05-19T00:23:17Z |
| description | 설명 | |
| name | 접근제어명 | DenyTest |
8.1.1.22.2 - 1.1
scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
접근제어 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 접근제어 ID | 27bb070b564349f8a31cc60734cc36a5 |
| allowed_ip_addr | 허용 IP 주소 | [‘127.0.0.1/24,192.168.127.12’] |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| created_at | 생성 일시 | 2024-05-19T00:23:17Z |
| description | 설명 | |
| name | 접근제어명 | DenyTest |
8.1.1.22.3 - 1.0
scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
접근제어 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 접근제어 ID | 27bb070b564349f8a31cc60734cc36a5 |
| allowed_ip_addr | 허용 IP 주소 | [‘127.0.0.1/24,192.168.127.12’] |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| created_at | 생성 일시 | 2024-05-19T00:23:17Z |
| description | 설명 | |
| name | 접근제어명 | DenyTest |
8.1.1.23 - List Api Deployments
8.1.1.23.1 - 1.2
scpcli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]
Description
API 배포 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| deployment_id optional | string | 이름 | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name optional | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| deployment_date | 배포 일시 | 2024-05-17T00:23:17Z |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
| status | 상태 | Active |
8.1.1.23.2 - 1.1
scpcli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]
Description
API 배포 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| deployment_id optional | string | 이름 | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name optional | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| deployment_date | 배포 일시 | 2024-05-17T00:23:17Z |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
| status | 상태 | Active |
8.1.1.23.3 - 1.0
scpcli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]
Description
API 배포 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| deployment_id optional | string | 이름 | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name optional | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| deployment_date | 배포 일시 | 2024-05-17T00:23:17Z |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
| status | 상태 | Active |
8.1.1.24 - List Api Keys
8.1.1.24.1 - 1.2
scpcli application-apigateway api key list
--usage_plan_id <value>
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
API Key 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 이름 | api-key-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | API Key ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | |
| description | 설명 | description |
| key | Key | key |
| name | 이름 | api-key-name |
8.1.1.24.2 - 1.1
scpcli application-apigateway api key list
--usage_plan_id <value>
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
API Key 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 이름 | api-key-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | API Key ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | |
| description | 설명 | description |
| key | Key | key |
| name | 이름 | api-key-name |
8.1.1.25 - List Apis
8.1.1.25.1 - 1.2
scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
API 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 이름 | test-api |
Responses
| Name | Description | Example |
|---|---|---|
| id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| account_id | 계정 ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| description | 설명 | Description |
| dns_record_status | DNS 레코드 상태 | Active |
| name | 이름 | test-api |
| status | API 상태 | Active |
8.1.1.25.2 - 1.1
scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
API 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
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 | 이름 | test-api |
Responses
| Name | Description | Example |
|---|---|---|
| id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| account_id | 계정 ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| description | 설명 | Description |
| dns_record_status | DNS 레코드 상태 | Active |
| name | 이름 | test-api |
| status | API 상태 | Active |
8.1.1.25.3 - 1.0
scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
API 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 이름 | test-api |
Responses
| Name | Description | Example |
|---|---|---|
| id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| account_id | 계정 ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| description | 설명 | Description |
| dns_record_status | DNS 레코드 상태 | Active |
| name | 이름 | test-api |
| status | API 상태 | Active |
8.1.1.26 - List Auths
8.1.1.26.1 - 1.2
scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
인증 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인증 ID | 27bb070b564349f8a31cc60734cc36a5 |
| auth_method | 인증 수단 | JWT(JSON WEB Token) |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| expired_at | 만료 예정 일시 | 2024-05-17T00:23:17Z |
| name | 인증명 | Token01 |
8.1.1.26.2 - 1.1
scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
인증 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인증 ID | 27bb070b564349f8a31cc60734cc36a5 |
| auth_method | 인증 수단 | JWT(JSON WEB Token) |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| expired_at | 만료 예정 일시 | 2024-05-17T00:23:17Z |
| name | 인증명 | Token01 |
8.1.1.26.3 - 1.0
scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
인증 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인증 ID | 27bb070b564349f8a31cc60734cc36a5 |
| auth_method | 인증 수단 | JWT(JSON WEB Token) |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| expired_at | 만료 예정 일시 | 2024-05-17T00:23:17Z |
| name | 인증명 | Token01 |
8.1.1.27 - List Connected PrivateLink Endpoints
8.1.1.27.1 - 1.2
scpcli application-apigateway api connected endpoint list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
연결요청된 PrivateLink 엔드포인트를 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| status | PrivateLink 엔드포인트 상태 | Active |
8.1.1.28 - List Methods
8.1.1.28.1 - 1.2
scpcli application-apigateway method list
--resource_id <value>
--api_id <value>
Description
메서드 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| api_key_required | API Key 사용여부 | False |
| endpoint_url | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| function_name | Cloud Function Name | test-function |
| integration_type | 메서드 통합 유형 | HTTP |
| method_type | 메서드 유형 | GET |
| privatelink_endpoint_id | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| query_strings | 메서드 쿼리 문자열 | {‘param1’: ‘value1’, ‘param2’: ‘value2’} |
| request_headers | 메서드 요청 헤더 | {’test1’ : True} |
| request_path | 메서드 요청 경로 | {users} |
| srn | SRN | srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test |
8.1.1.28.2 - 1.1
scpcli application-apigateway method list
--resource_id <value>
--api_id <value>
Description
메서드 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| api_key_required | API Key 사용여부 | False |
| endpoint_url | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| function_name | Cloud Function Name | test-function |
| integration_type | 메서드 통합 유형 | HTTP |
| method_type | 메서드 유형 | GET |
| query_strings | 메서드 쿼리 문자열 | {‘param1’: ‘value1’, ‘param2’: ‘value2’} |
| request_headers | 메서드 요청 헤더 | {’test1’ : True} |
| request_path | 메서드 요청 경로 | {users} |
| srn | SRN | srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test |
8.1.1.28.3 - 1.0
scpcli application-apigateway method list
--resource_id <value>
--api_id <value>
Description
메서드 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| endpoint_url | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| integration_type | 메서드 통합 유형 | HTTP |
| method_type | 메서드 유형 | GET |
| query_strings | 메서드 쿼리 문자열 | {‘param1’: ‘value1’, ‘param2’: ‘value2’} |
| request_headers | 메서드 요청 헤더 | {’test1’ : True} |
| request_path | 메서드 요청 경로 | {users} |
| srn | SRN | srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test |
8.1.1.29 - List PrivateLink Endpoints
8.1.1.29.1 - 1.2
scpcli application-apigateway privatelink endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
PrivateLink 엔드포인트 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | PrivateLink 엔드포인트명 | endpoint |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| name | PrivateLink 엔드포인트명 | endpoint |
| privatelink_service_id | PrivateLink 서비스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| status | PrivateLink 엔드포인트 상태 | CANCELED |
8.1.1.30 - List Reports
8.1.1.30.1 - 1.2
scpcli application-apigateway report list
--api_id <value>
--end_date <value>
--start_date <value>
--stage_name <value>
Description
Report 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| end_date required | string | 종료일자 | 2025-07-30 |
| start_date required | string | 시작일자 | 2025-07-01 |
| stage_name required | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| call_count | 호출 수 | 10 |
| date | 날짜 | |
| error_4xx_count | 4xx 에러 수 | 10 |
| error_5xx_count | 5xx 에러 수 | 10 |
| integration_latency | 통합 지연시간 | 10 |
| latency | 지연시간 | 10 |
8.1.1.30.2 - 1.1
scpcli application-apigateway report list
--api_id <value>
--end_date <value>
--start_date <value>
--stage_name <value>
Description
Report 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| end_date required | string | 종료일자 | 2025-07-30 |
| start_date required | string | 시작일자 | 2025-07-01 |
| stage_name required | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| call_count | 호출 수 | 10 |
| date | 날짜 | |
| error_4xx_count | 4xx 에러 수 | 10 |
| error_5xx_count | 5xx 에러 수 | 10 |
| integration_latency | 통합 지연시간 | 10 |
| latency | 지연시간 | 10 |
8.1.1.31 - List Resources
8.1.1.31.1 - 1.2
scpcli application-apigateway resource list
--api_id <value>
Description
리소스 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| methods | ||
| parent_id | 부모 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| path | 경로 | /test/test1 |
| path_part | 경로명 | test |
8.1.1.31.2 - 1.1
scpcli application-apigateway resource list
--api_id <value>
Description
리소스 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| methods | ||
| parent_id | 부모 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| path | 경로 | /test/test1 |
| path_part | 경로명 | test |
8.1.1.31.3 - 1.0
scpcli application-apigateway resource list
--api_id <value>
Description
리소스 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| methods | ||
| parent_id | 부모 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| path | 경로 | /test/test1 |
| path_part | 경로명 | test |
8.1.1.32 - List Stages
8.1.1.32.1 - 1.2
scpcli application-apigateway stage list
--api_id <value>
Description
스테이지 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| active_deployment | 활성화 배포 | 2024-05-17T00:23:17Z |
| allow_credentials | 허용 인증 | True |
| allow_headers | 허용 헤더 | [‘Content-Type’, ‘Authorization’] |
| allow_methods | 허용 메서드 | [‘GET’, ‘POST’, ‘PUT’, ‘PATCH’] |
| allow_origins | 허용 원본 | [’*’] |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_key_required | API Key 사용여부 | False |
| api_summary | API 요약 | [{‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/’}, {‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/test’}] |
| cors_enabled | CORS 사용여부 | False |
| created_at | 생성 일시 | |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
| expose_headers | 노출 헤더 | [’test1’, ’test2’] |
| invoke_url | 호출 URL | http://test.com/stg |
| jwt_enabled | JWT 사용여부 | False |
| max_age | 최대 캐시 기간 | 3600 |
| name | 스테이지명 | test-stage |
| usage_plan_api_keys | API Key | [] |
| usage_plan_id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| usage_plan_limit | 사용량 정책 할당량 | 10 |
| usage_plan_name | 이름 | usage-plan-name |
| usage_plan_rate | 사용량 정책 주기 | day |
8.1.1.32.2 - 1.1
scpcli application-apigateway stage list
--api_id <value>
Description
스테이지 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| active_deployment | 활성화 배포 | 2024-05-17T00:23:17Z |
| allow_credentials | 허용 인증 | True |
| allow_headers | 허용 헤더 | [‘Content-Type’, ‘Authorization’] |
| allow_methods | 허용 메서드 | [‘GET’, ‘POST’, ‘PUT’, ‘PATCH’] |
| allow_origins | 허용 원본 | [’*’] |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_key_required | API Key 사용여부 | False |
| api_summary | API 요약 | [{‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/’}, {‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/test’}] |
| cors_enabled | CORS 사용여부 | False |
| created_at | 생성 일시 | |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
| expose_headers | 노출 헤더 | [’test1’, ’test2’] |
| invoke_url | 호출 URL | http://test.com/stg |
| jwt_enabled | JWT 사용여부 | False |
| max_age | 최대 캐시 기간 | 3600 |
| name | 스테이지명 | test-stage |
| usage_plan_api_keys | API Key | [] |
| usage_plan_id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| usage_plan_limit | 사용량 정책 할당량 | 10 |
| usage_plan_name | 이름 | usage-plan-name |
| usage_plan_rate | 사용량 정책 주기 | day |
8.1.1.32.3 - 1.0
scpcli application-apigateway stage list
--api_id <value>
Description
스테이지 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| active_deployment | 활성화 배포 | 2024-05-17T00:23:17Z |
| allow_credentials | 허용 인증 | True |
| allow_headers | 허용 헤더 | [‘Content-Type’, ‘Authorization’] |
| allow_methods | 허용 메서드 | [‘GET’, ‘POST’, ‘PUT’, ‘PATCH’] |
| allow_origins | 허용 원본 | [’*’] |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_summary | API 요약 | [{‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/’}, {‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/test’}] |
| cors_enabled | CORS 사용여부 | False |
| created_at | 생성 일시 | |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| expose_headers | 노출 헤더 | [’test1’, ’test2’] |
| invoke_url | 호출 URL | http://test.com/stg |
| ip_restriction_enabled | IP 접근제어 사용여부 | False |
| jwt_enabled | JWT 사용여부 | False |
| max_age | 최대 캐시 기간 | 3600 |
| name | 스테이지명 | test-stage |
8.1.1.33 - List Usage Plans
8.1.1.33.1 - 1.2
scpcli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
사용량 정책 목록을 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 이름 | usage-plan-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| connected_api_keys | 연결된 API Key 목록 | [‘key1’, ‘key2’] |
| created_at | 생성 일시 | |
| description | 설명 | description |
| limit | 사용량 정책 할당량 | 10 |
| name | 이름 | usage-plan-name |
| rate | 사용량 정책 주기 | day |
8.1.1.33.2 - 1.1
scpcli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
사용량 정책 목록을 조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 이름 | usage-plan-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| connected_api_keys | 연결된 API Key 목록 | [‘key1’, ‘key2’] |
| created_at | 생성 일시 | |
| description | 설명 | description |
| limit | 사용량 정책 할당량 | 10 |
| name | 이름 | usage-plan-name |
| rate | 사용량 정책 주기 | day |
8.1.1.34 - Request PrivateLink Endpoint
8.1.1.34.1 - 1.2
scpcli application-apigateway privatelink endpoint request
--privatelink_endpoint_id <value>
--type <value>
Description
PrivateLink 엔드포인트를 요청한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| type required | string | PrivateLink 엔드포인트 액션 유형 | CANCEL |
8.1.1.35 - Set Access Control
8.1.1.35.1 - 1.2
scpcli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]
Description
접근제어를 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_control_id required | string | 접근제어 ID | - |
| api_id required | string | Api ID | - |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
| allowed_ip_addr required | array | 허용 IP 주소 | 127.0.0.1/24,192.168.127.12 |
| description optional | string | 설명 | description |
8.1.1.35.2 - 1.1
scpcli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]
Description
접근제어를 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_control_id required | string | 접근제어 ID | - |
| api_id required | string | Api ID | - |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
| allowed_ip_addr required | array | 허용 IP 주소 | 127.0.0.1/24,192.168.127.12 |
| description optional | string | 설명 | description |
8.1.1.35.3 - 1.0
scpcli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]
Description
접근제어를 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_control_id required | string | 접근제어 ID | - |
| api_id required | string | Api ID | - |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
| allowed_ip_addr required | array | 허용 IP 주소 | 127.0.0.1/24,192.168.127.12 |
| description optional | string | 설명 | description |
8.1.1.36 - Set Api Description
8.1.1.36.1 - 1.2
scpcli application-apigateway api description set
--api_id <value>
[--description <value>]
Description
API 설명을 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| description optional | string | 설명 | description |
8.1.1.36.2 - 1.1
scpcli application-apigateway api description set
--api_id <value>
[--description <value>]
Description
API 설명을 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| description optional | string | 설명 | description |
8.1.1.36.3 - 1.0
scpcli application-apigateway api description set
--api_id <value>
[--description <value>]
Description
API 설명을 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| description optional | string | 설명 | description |
8.1.1.37 - Set API Key Description
8.1.1.37.1 - 1.2
scpcli application-apigateway api key set
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
[--description <value>]
Description
API Key 설명을 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_key_id required | string | API Key ID | 27bb070b564349f8a31cc60734cc36a5 |
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| description optional | string | 설명 | description |
8.1.1.37.2 - 1.1
scpcli application-apigateway api key set
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
[--description <value>]
Description
API Key 설명을 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_key_id required | string | API Key ID | 27bb070b564349f8a31cc60734cc36a5 |
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| description optional | string | 설명 | description |
8.1.1.38 - Set Auth
8.1.1.38.1 - 1.2
scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>
Description
인증을 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auth_id required | string | 인증 ID | - |
| api_id required | string | Api ID | - |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
8.1.1.38.2 - 1.1
scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>
Description
인증을 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auth_id required | string | 인증 ID | - |
| api_id required | string | Api ID | - |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
8.1.1.38.3 - 1.0
scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>
Description
인증을 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auth_id required | string | 인증 ID | - |
| api_id required | string | Api ID | - |
| connected_stages required | array | 연결된 스테이지 | dev,stg |
8.1.1.39 - Set Method
8.1.1.39.1 - 1.2
scpcli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>
--integration_type <value>
--api_key_required <value>
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]
Description
메서드를 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| method_type required | **** | 메서드 유형 | GET |
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| request_headers required | dict | 메서드 요청 헤더 | {'test1' : True} |
| query_strings required | dict | 메서드 쿼리 문자열 | {'param1': 'value1', 'param2': 'value2'} |
| integration_type required | string | 메서드 통합 유형 | HTTP |
| api_key_required required | boolean | API Key 사용여부 | False |
| endpoint_url optional | string | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id optional | string | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| privatelink_endpoint_id optional | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.39.2 - 1.1
scpcli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>
--integration_type <value>
--api_key_required <value>
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]
Description
메서드를 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| method_type required | **** | 메서드 유형 | GET |
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| request_headers required | dict | 메서드 요청 헤더 | {'test1' : True} |
| query_strings required | dict | 메서드 쿼리 문자열 | {'param1': 'value1', 'param2': 'value2'} |
| integration_type required | string | 메서드 통합 유형 | HTTP |
| api_key_required required | boolean | API Key 사용여부 | False |
| endpoint_url optional | string | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id optional | string | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| privatelink_endpoint_id optional | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.39.3 - 1.0
scpcli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>
Description
메서드를 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| method_type required | **** | 메서드 유형 | GET |
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| request_headers required | dict | 메서드 요청 헤더 | {'test1' : True} |
| query_strings required | dict | 메서드 쿼리 문자열 | {'param1': 'value1', 'param2': 'value2'} |
8.1.1.40 - Set PrivateLink Endpoint
8.1.1.40.1 - 1.2
scpcli application-apigateway privatelink endpoint set
--privatelink_endpoint_id <value>
[--description <value>]
Description
PrivateLink 엔드포인트를 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description optional | string | 설명 | description |
8.1.1.41 - Set Stage Active Deployment
8.1.1.41.1 - 1.2
scpcli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>
Description
스테이지 활성화 배포를 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
| deployment_id required | string | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.41.2 - 1.1
scpcli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>
Description
스테이지 활성화 배포를 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
| deployment_id required | string | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.41.3 - 1.0
scpcli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>
Description
스테이지 활성화 배포를 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
| deployment_id required | string | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.42 - Set Stage Configuration
8.1.1.42.1 - 1.2
scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]
Description
스테이지 설정을 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
| jwt_enabled required | boolean | JWT 사용여부 | False |
| cors_enabled required | boolean | CORS 사용여부 | False |
| allow_credentials optional | boolean | 허용 인증 | True |
| allow_headers optional | array | 허용 헤더 | Content-Type |
| allow_methods optional | array | 허용 메서드 | '{}' |
| allow_origins optional | array | 허용 원본 | * |
| connected_api_keys optional | array | 연결된 API Key 목록 | key1 |
| description optional | string | 설명 | description |
| expose_headers optional | array | 노출 헤더 | test1 |
| max_age optional | integer | 최대 캐시 기간 | 3600 |
| usage_plan_id optional | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.42.2 - 1.1
scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]
Description
스테이지 설정을 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
| jwt_enabled required | boolean | JWT 사용여부 | False |
| cors_enabled required | boolean | CORS 사용여부 | False |
| allow_credentials optional | boolean | 허용 인증 | True |
| allow_headers optional | array | 허용 헤더 | Content-Type |
| allow_methods optional | array | 허용 메서드 | '{}' |
| allow_origins optional | array | 허용 원본 | * |
| connected_api_keys optional | array | 연결된 API Key 목록 | key1 |
| description optional | string | 설명 | description |
| expose_headers optional | array | 노출 헤더 | test1 |
| max_age optional | integer | 최대 캐시 기간 | 3600 |
| usage_plan_id optional | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
8.1.1.42.3 - 1.0
scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--ip_restriction_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--expose_headers <value>]
[--max_age <value>]
Description
스테이지 설정을 수정한다(ip_restriction_enabled 수정은 더 이상 지원되지 않음)
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
| jwt_enabled required | boolean | JWT 사용여부 | False |
| ip_restriction_enabled required | boolean | IP 접근제어 사용여부 | False |
| cors_enabled required | boolean | CORS 사용여부 | False |
| allow_credentials optional | boolean | 허용 인증 | True |
| allow_headers optional | array | 허용 헤더 | Content-Type |
| allow_methods optional | array | 허용 메서드 | '{}' |
| allow_origins optional | array | 허용 원본 | * |
| expose_headers optional | array | 노출 헤더 | test1 |
| max_age optional | integer | 최대 캐시 기간 | 3600 |
8.1.1.43 - Set Usage Plan Description
8.1.1.43.1 - 1.2
scpcli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]
Description
사용량 정책 설명을 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| description optional | string | 설명 | description |
8.1.1.43.2 - 1.1
scpcli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]
Description
사용량 정책 설명을 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| description optional | string | 설명 | description |
8.1.1.44 - Set Usage Plan Quota
8.1.1.44.1 - 1.2
scpcli application-apigateway usage plan set quota
--usage_plan_id <value>
--api_id <value>
--rate <value>
--limit <value>
Description
사용량 정책 할당량을 수정한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| rate required | string | 사용량 정책 주기 | day |
| limit required | integer | 사용량 정책 할당량 | 10 |
8.1.1.44.2 - 1.1
scpcli application-apigateway usage plan set quota
--usage_plan_id <value>
--api_id <value>
--rate <value>
--limit <value>
Description
사용량 정책 할당량을 수정한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| rate required | string | 사용량 정책 주기 | day |
| limit required | integer | 사용량 정책 할당량 | 10 |
8.1.1.45 - Show Access Control
8.1.1.45.1 - 1.2
scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>
Description
접근제어를 상세조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_control_id required | string | 접근제어 ID | - |
| api_id required | string | Api ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 접근제어 ID | 27bb070b564349f8a31cc60734cc36a5 |
| allowed_ip_addr | 허용 IP 주소 | [‘127.0.0.1/24,192.168.127.12’] |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| created_at | 생성 일시 | 2024-05-19T00:23:17Z |
| description | 설명 | |
| name | 접근제어명 | DenyTest |
8.1.1.45.2 - 1.1
scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>
Description
접근제어를 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_control_id required | string | 접근제어 ID | - |
| api_id required | string | Api ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 접근제어 ID | 27bb070b564349f8a31cc60734cc36a5 |
| allowed_ip_addr | 허용 IP 주소 | [‘127.0.0.1/24,192.168.127.12’] |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| created_at | 생성 일시 | 2024-05-19T00:23:17Z |
| description | 설명 | |
| name | 접근제어명 | DenyTest |
8.1.1.45.3 - 1.0
scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>
Description
접근제어를 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_control_id required | string | 접근제어 ID | - |
| api_id required | string | Api ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 접근제어 ID | 27bb070b564349f8a31cc60734cc36a5 |
| allowed_ip_addr | 허용 IP 주소 | [‘127.0.0.1/24,192.168.127.12’] |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| created_at | 생성 일시 | 2024-05-19T00:23:17Z |
| description | 설명 | |
| name | 접근제어명 | DenyTest |
8.1.1.46 - Show Api
8.1.1.46.1 - 1.2
scpcli application-apigateway api show
--api_id <value>
Description
API를 상세조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| account_id | 계정 ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| description | 설명 | Description |
| dns_record_status | DNS 레코드 상태 | Active |
| name | 이름 | test-api |
| status | API 상태 | Active |
8.1.1.46.2 - 1.1
scpcli application-apigateway api show
--api_id <value>
Description
API를 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| account_id | 계정 ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| description | 설명 | Description |
| dns_record_status | DNS 레코드 상태 | Active |
| name | 이름 | test-api |
| status | API 상태 | Active |
8.1.1.46.3 - 1.0
scpcli application-apigateway api show
--api_id <value>
Description
API를 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| account_id | 계정 ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| description | 설명 | Description |
| dns_record_status | DNS 레코드 상태 | Active |
| name | 이름 | test-api |
| status | API 상태 | Active |
8.1.1.47 - Show Auth
8.1.1.47.1 - 1.2
scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>
Description
인증을 상세조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auth_id required | string | 인증 ID | - |
| api_id required | string | Api ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인증 ID | 27bb070b564349f8a31cc60734cc36a5 |
| auth_method | 인증 수단 | JWT(JSON WEB Token) |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| expired_at | 만료 예정 일시 | 2024-05-17T00:23:17Z |
| name | 인증명 | Token01 |
8.1.1.47.2 - 1.1
scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>
Description
인증을 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auth_id required | string | 인증 ID | - |
| api_id required | string | Api ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인증 ID | 27bb070b564349f8a31cc60734cc36a5 |
| auth_method | 인증 수단 | JWT(JSON WEB Token) |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| expired_at | 만료 예정 일시 | 2024-05-17T00:23:17Z |
| name | 인증명 | Token01 |
8.1.1.47.3 - 1.0
scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>
Description
인증을 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| auth_id required | string | 인증 ID | - |
| api_id required | string | Api ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인증 ID | 27bb070b564349f8a31cc60734cc36a5 |
| auth_method | 인증 수단 | JWT(JSON WEB Token) |
| connected_stages | 연결된 스테이지 | [‘dev,stg’] |
| expired_at | 만료 예정 일시 | 2024-05-17T00:23:17Z |
| name | 인증명 | Token01 |
8.1.1.48 - Show Method
8.1.1.48.1 - 1.2
scpcli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>
Description
메서드를 상세조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| method_type required | **** | 메서드 유형 | GET |
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| api_key_required | API Key 사용여부 | False |
| endpoint_url | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| function_name | Cloud Function Name | test-function |
| integration_type | 메서드 통합 유형 | HTTP |
| method_type | 메서드 유형 | GET |
| privatelink_endpoint_id | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| query_strings | 메서드 쿼리 문자열 | {‘param1’: ‘value1’, ‘param2’: ‘value2’} |
| request_headers | 메서드 요청 헤더 | {’test1’ : True} |
| request_path | 메서드 요청 경로 | {users} |
| srn | SRN | srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test |
8.1.1.48.2 - 1.1
scpcli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>
Description
메서드를 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| method_type required | **** | 메서드 유형 | GET |
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| api_key_required | API Key 사용여부 | False |
| endpoint_url | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| function_name | Cloud Function Name | test-function |
| integration_type | 메서드 통합 유형 | HTTP |
| method_type | 메서드 유형 | GET |
| query_strings | 메서드 쿼리 문자열 | {‘param1’: ‘value1’, ‘param2’: ‘value2’} |
| request_headers | 메서드 요청 헤더 | {’test1’ : True} |
| request_path | 메서드 요청 경로 | {users} |
| srn | SRN | srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test |
8.1.1.48.3 - 1.0
scpcli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>
Description
메서드를 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| method_type required | **** | 메서드 유형 | GET |
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| endpoint_url | 메서드 엔드포인트 URL | https://127.0.0.1:8000 |
| function_id | Cloud Function ID | 27bb070b564349f8a31cc60734cc36a5 |
| integration_type | 메서드 통합 유형 | HTTP |
| method_type | 메서드 유형 | GET |
| query_strings | 메서드 쿼리 문자열 | {‘param1’: ‘value1’, ‘param2’: ‘value2’} |
| request_headers | 메서드 요청 헤더 | {’test1’ : True} |
| request_path | 메서드 요청 경로 | {users} |
| srn | SRN | srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test |
8.1.1.49 - Show PrivateLink Endpoint
8.1.1.49.1 - 1.2
scpcli application-apigateway privatelink endpoint show
--privatelink_endpoint_id <value>
Description
PrivateLink 엔드포인트를 조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink 엔드포인트 ID | 27bb070b564349f8a31cc60734cc36a5 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| description | 설명 | description |
| name | PrivateLink 엔드포인트명 | endpoint |
| privatelink_service_id | PrivateLink 서비스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| status | PrivateLink 엔드포인트 상태 | CANCELED |
8.1.1.50 - Show Resource
8.1.1.50.1 - 1.2
scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>
Description
리소스를 상세조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| methods | ||
| parent_id | 부모 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| path | 경로 | /test/test1 |
| path_part | 경로명 | test |
8.1.1.50.2 - 1.1
scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>
Description
리소스를 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| methods | ||
| parent_id | 부모 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| path | 경로 | /test/test1 |
| path_part | 경로명 | test |
8.1.1.50.3 - 1.0
scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>
Description
리소스를 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_id required | string | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| methods | ||
| parent_id | 부모 리소스 ID | 27bb070b564349f8a31cc60734cc36a5 |
| path | 경로 | /test/test1 |
| path_part | 경로명 | test |
8.1.1.51 - Show Stage
8.1.1.51.1 - 1.2
scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>
Description
스테이지를 상세조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| active_deployment | 활성화 배포 | 2024-05-17T00:23:17Z |
| allow_credentials | 허용 인증 | True |
| allow_headers | 허용 헤더 | [‘Content-Type’, ‘Authorization’] |
| allow_methods | 허용 메서드 | [‘GET’, ‘POST’, ‘PUT’, ‘PATCH’] |
| allow_origins | 허용 원본 | [’*’] |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_key_required | API Key 사용여부 | False |
| cors_enabled | CORS 사용여부 | False |
| created_at | 생성 일시 | |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
| expose_headers | 노출 헤더 | [’test1’, ’test2’] |
| invoke_url | 호출 URL | http://test.com/stg |
| jwt_enabled | JWT 사용여부 | False |
| max_age | 최대 캐시 기간 | 3600 |
| name | 스테이지명 | test-stage |
| usage_plan_api_keys | API Key | [] |
| usage_plan_id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| usage_plan_limit | 사용량 정책 할당량 | 10 |
| usage_plan_name | 이름 | usage-plan-name |
| usage_plan_rate | 사용량 정책 주기 | day |
8.1.1.51.2 - 1.1
scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>
Description
스테이지를 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| active_deployment | 활성화 배포 | 2024-05-17T00:23:17Z |
| allow_credentials | 허용 인증 | True |
| allow_headers | 허용 헤더 | [‘Content-Type’, ‘Authorization’] |
| allow_methods | 허용 메서드 | [‘GET’, ‘POST’, ‘PUT’, ‘PATCH’] |
| allow_origins | 허용 원본 | [’*’] |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_key_required | API Key 사용여부 | False |
| cors_enabled | CORS 사용여부 | False |
| created_at | 생성 일시 | |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| description | 설명 | description |
| expose_headers | 노출 헤더 | [’test1’, ’test2’] |
| invoke_url | 호출 URL | http://test.com/stg |
| jwt_enabled | JWT 사용여부 | False |
| max_age | 최대 캐시 기간 | 3600 |
| name | 스테이지명 | test-stage |
| usage_plan_api_keys | API Key | [] |
| usage_plan_id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| usage_plan_limit | 사용량 정책 할당량 | 10 |
| usage_plan_name | 이름 | usage-plan-name |
| usage_plan_rate | 사용량 정책 주기 | day |
8.1.1.51.3 - 1.0
scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>
Description
스테이지를 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | 스테이지명 | test-stage |
Responses
| Name | Description | Example |
|---|---|---|
| active_deployment | 활성화 배포 | 2024-05-17T00:23:17Z |
| allow_credentials | 허용 인증 | True |
| allow_headers | 허용 헤더 | [‘Content-Type’, ‘Authorization’] |
| allow_methods | 허용 메서드 | [‘GET’, ‘POST’, ‘PUT’, ‘PATCH’] |
| allow_origins | 허용 원본 | [’*’] |
| api_id | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| cors_enabled | CORS 사용여부 | False |
| created_at | 생성 일시 | |
| deployment_id | 배포 ID | 27bb070b564349f8a31cc60734cc36a5 |
| expose_headers | 노출 헤더 | [’test1’, ’test2’] |
| invoke_url | 호출 URL | http://test.com/stg |
| ip_restriction_enabled | IP 접근제어 사용여부 | False |
| jwt_enabled | JWT 사용여부 | False |
| max_age | 최대 캐시 기간 | 3600 |
| name | 스테이지명 | test-stage |
8.1.1.52 - Show Usage Plan
8.1.1.52.1 - 1.2
scpcli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>
Description
사용량 정책을 상세조회한다
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_keys | API Key | [] |
| created_at | 생성 일시 | |
| created_by_id | 생성자 | 27bb070b564349f8a31cc60734cc36a5 |
| created_by_name | 생성자 | username |
| description | 설명 | description |
| limit | 사용량 정책 할당량 | 10 |
| modified_at | 수정시간 | |
| modified_by_id | 수정자 | 27bb070b564349f8a31cc60734cc36a5 |
| modified_by_name | 수정자 | username |
| name | 이름 | usage-plan-name |
| rate | 사용량 정책 주기 | day |
8.1.1.52.2 - 1.1
scpcli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>
Description
사용량 정책을 상세조회한다
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| usage_plan_id required | string | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용량 정책 ID | 27bb070b564349f8a31cc60734cc36a5 |
| api_keys | API Key | [] |
| created_at | 생성 일시 | |
| created_by_id | 생성자 | 27bb070b564349f8a31cc60734cc36a5 |
| created_by_name | 생성자 | username |
| description | 설명 | description |
| limit | 사용량 정책 할당량 | 10 |
| modified_at | 수정시간 | |
| modified_by_id | 수정자 | 27bb070b564349f8a31cc60734cc36a5 |
| modified_by_name | 수정자 | username |
| name | 이름 | usage-plan-name |
| rate | 사용량 정책 주기 | day |
8.2 - Queue Service
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Queue Service 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
8.2.1 - CLIs
8.2.1.1 - Check Queue Name Duplication
8.2.1.1.1 - 1.0
scpcli queueservice check queue name duplication
--name <value>
Description
Queue명 중복 체크
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Queue명 | test-queue.fifo |
Responses
| Name | Description | Example |
|---|---|---|
| result | 결과 | True |
8.2.1.2 - Create Queue
8.2.1.2.1 - 1.0
scpcli queueservice queue create
--id <value>
--name <value>
--message_size <value>
--message_retention_period_unit <value>
--message_retention_period <value>
[--data_key_reuse_period <value>]
[--data_key_reuse_period_unit <value>]
[--description <value>]
[--tags <value>]
Description
Queue 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | KMS ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| name required | string | KMS명 | test-kms |
| message_size required | integer | 메시지 크기 | 256 |
| message_retention_period_unit required | string | 기간 단위 | minute |
| message_retention_period required | integer | 메시지 보존 기간 | 40 |
| data_key_reuse_period optional | integer | 데이터 키 재사용 기간 | 40 |
| data_key_reuse_period_unit optional | **** | 기간 단위 | minute |
| description optional | string | 설명 | Queue description |
| tags optional | array | 태그 목록 | '{"key": "key1", "value": "value1"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| messages | 설명 | Create Queue |
| state | Queue 상태 | ACTIVE |
8.2.1.3 - Delete Acl
8.2.1.3.1 - 1.0
scpcli queueservice queue delete acl
--queue_id <value>
--ip_address <value>
Description
접근 허용 IP 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| ip_address required | array | 접근 허용 IP 목록 | 0.0.0.0 |
8.2.1.4 - Delete Queue
8.2.1.4.1 - 1.0
scpcli queueservice queue delete
--queue_id <value>
Description
Queue 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
8.2.1.5 - List Queue
8.2.1.5.1 - 1.0
scpcli queueservice queue list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
Queue 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Queue명 | test-queue.fifo |
Responses
| Name | Description | Example |
|---|---|---|
| id | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| account_id | Account ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| encryption | 암호화 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Queue명 | test-queue.fifo |
| number_wait_messages | 대기 메시지 수 | 10 |
| state | Queue 상태 | ACTIVE |
| type | Queue 유형 | FIFO |
8.2.1.6 - Set Acl
8.2.1.6.1 - 1.0
scpcli queueservice queue set acl
--queue_id <value>
--ip_address <value>
Description
접근 허용 IP 추가
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| ip_address required | array | 접근 허용 IP 목록 | 0.0.0.0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
8.2.1.7 - Show Queue
8.2.1.7.1 - 1.0
scpcli queueservice queue show
--queue_id <value>
Description
Queue 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
Responses
| Name | Description | Example |
|---|---|---|
| ip_address | IP 주소 | 192.168.0.0 |
8.2.1.8 - Update Queue Config
8.2.1.8.1 - 1.0
scpcli queueservice queue set config
--queue_id <value>
--name <value>
--id <value>
--message_size <value>
--message_retention_period_unit <value>
--message_retention_period <value>
[--data_key_reuse_period <value>]
[--data_key_reuse_period_unit <value>]
Description
Queue 구성 설정 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| name required | string | KMS명 | test-kms |
| id required | string | KMS ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| message_size required | integer | 메시지 크기 | 256 |
| message_retention_period_unit required | string | 기간 단위 | minute |
| message_retention_period required | integer | 메시지 보존 기간 | 40 |
| data_key_reuse_period optional | integer | 데이터 키 재사용 기간 | 40 |
| data_key_reuse_period_unit optional | **** | 기간 단위 | minute |
8.2.1.9 - Update Queue Description
8.2.1.9.1 - 1.0
scpcli queueservice queue set description
--queue_id <value>
--description <value>
Description
Queue 설명 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queue_id required | string | Queue ID | 8c9f6c1c928a45b4bbd1e4da5531d656 |
| description required | string | 설명 | Queue description |
9 - Security
9.1 - Certificate Manager
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Certificate Manager 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | SUPPORTED | 20260531 |
| 1.1 | CURRENT | - |
9.1.1 - CLIs
9.1.1.1 - Check duplicate name
9.1.1.1.1 - 1.1
scpcli certificatemanager certificate check
--name <value>
Description
인증서 이름 중복 여부
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 인증서 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False 체크 | True |
9.1.1.1.2 - 1.0
scpcli certificatemanager certificate check
--name <value>
Description
인증서 이름 중복 여부
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 인증서 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False 체크 | True |
9.1.1.2 - Create a certificate
9.1.1.2.1 - 1.1
scpcli certificatemanager certificate create
--timezone <value>
--region <value>
--private_key <value>
--name <value>
--cert_body <value>
[--cert_chain <value>]
[--recipients <value>]
[--tags <value>]
Description
인증서 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| timezone required | string | 타임존 | Asia/Seoul |
| region required | string | 리즌 이름 | west1 |
| private_key required | string | 개인키 | <encoded private key data> |
| name required | string | 인증서 이름 | test-certificate |
| cert_body required | string | 인증서 body | <encoded certificate body data> |
| cert_chain optional | string | 인증서 체인 | <encoded certificate chain data> |
| recipients optional | array | 만료된 인증서 수신인 | '{"region": "", "user_id": "", "user_name": ""}' |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | b82909b3576449fda984fb25c3123542da |
| cert_body | 인증서 body | |
| cert_chain | 인증서 체인 | |
| cert_kind | 인증서 타입 | PRD |
| cert_type | 인증서 타입 | pem |
| cert_version | 인증서 버전 | 2 |
| cn | 인증서 CN 정보 | test.go.kr |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| key_bit_size | 키 bit 크기 | 2048 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 인증서 이름 | test-certificate |
| not_after_dt | 인증서 만료일 | 2026-02-07T18:07:59 |
| not_before_dt | 인증서 시작일 | 2025-02-08T18:07:00 |
| organization | 인증서 O(조직) 정보 | samsungSDS |
| private_key | 개인키 | |
| recipients | 만료된 인증서 수신인 | [{‘region’: ‘’, ‘user_id’: ‘sdaFDQSDADZ2488e195c0e97d9b9eb’, ‘user_name’: ‘kildong.hong’}] |
| state | 인증서 상태 | VALID |
| tags | 태그 리스트 | |
| user_name | 사용자 이름 | kildong@samsung.com |
9.1.1.2.2 - 1.0
scpcli certificatemanager certificate create
--timezone <value>
--region <value>
--private_key <value>
--name <value>
--cert_body <value>
[--cert_chain <value>]
[--recipients <value>]
[--tags <value>]
Description
인증서 생성
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| timezone required | string | 타임존 | Asia/Seoul |
| region required | string | 리즌 이름 | west1 |
| private_key required | string | 개인키 | <encoded private key data> |
| name required | string | 인증서 이름 | test-certificate |
| cert_body required | string | 인증서 body | <encoded certificate body data> |
| cert_chain optional | string | 인증서 체인 | <encoded certificate chain data> |
| recipients optional | array | 만료된 인증서 수신인 | '{"region": "", "user_id": "", "user_name": ""}' |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | b82909b3576449fda984fb25c3123542da |
| cert_body | 인증서 body | |
| cert_chain | 인증서 체인 | |
| cert_kind | 인증서 타입 | PRD |
| cert_type | 인증서 타입 | pem |
| cert_version | 인증서 버전 | 2 |
| cn | 인증서 CN 정보 | test.go.kr |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| key_bit_size | 키 bit 크기 | 2048 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 인증서 이름 | test-certificate |
| not_after_dt | 인증서 만료일 | 2026-02-07T18:07:59 |
| not_before_dt | 인증서 시작일 | 2025-02-08T18:07:00 |
| organization | 인증서 O(조직) 정보 | samsungSDS |
| private_key | 개인키 | |
| recipients | 만료된 인증서 수신인 | [{‘region’: ‘’, ‘user_id’: ‘sdaFDQSDADZ2488e195c0e97d9b9eb’, ‘user_name’: ‘kildong.hong’}] |
| state | 인증서 상태 | VALID |
| tags | 태그 리스트 | |
| user_name | 사용자 이름 | kildong@samsung.com |
9.1.1.3 - Delete a certificate
9.1.1.3.1 - 1.1
scpcli certificatemanager certificate delete
--certificate_id <value>
Description
인증서 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| certificate_id required | string | 인증서 id | - |
9.1.1.3.2 - 1.0
scpcli certificatemanager certificate delete
--certificate_id <value>
Description
인증서 삭제
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| certificate_id required | string | 인증서 id | - |
9.1.1.4 - Detail a certificate
9.1.1.4.1 - 1.1
scpcli certificatemanager certificate detail
--certificate_id <value>
Description
인증서 상세정보
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| certificate_id required | string | 인증서 id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | b82909b3576449fda984fb25c3123542da |
| cert_body | 인증서 body | |
| cert_chain | 인증서 체인 | |
| cert_kind | 인증서 타입 | DEV |
| cert_type | 인증서 타입 | pem |
| cert_version | 인증서 버전 | 2 |
| cn | 인증서 CN 정보 | test.go.kr |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| key_bit_size | 키 bit 크기 | 2048 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 인증서 이름 | test-certificate |
| not_after_dt | 인증서 만료일 | 2026-02-07T18:07:59 |
| not_before_dt | 인증서 시작일 | 2025-02-08T18:07:00 |
| organization | 인증서 O(조직) 정보 | samsungSDS |
| private_key | 개인키 | |
| state | 인증서 상태 | VALID |
| user_name | 사용자 이름 | 2048 |
9.1.1.4.2 - 1.0
scpcli certificatemanager certificate detail
--certificate_id <value>
Description
인증서 상세정보
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| certificate_id required | string | 인증서 id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | b82909b3576449fda984fb25c3123542da |
| cert_body | 인증서 body | |
| cert_chain | 인증서 체인 | |
| cert_kind | 인증서 타입 | DEV |
| cert_type | 인증서 타입 | pem |
| cert_version | 인증서 버전 | 2 |
| cn | 인증서 CN 정보 | test.go.kr |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| key_bit_size | 키 bit 크기 | 2048 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 인증서 이름 | test-certificate |
| not_after_dt | 인증서 만료일 | 2026-02-07T18:07:59 |
| not_before_dt | 인증서 시작일 | 2025-02-08T18:07:00 |
| organization | 인증서 O(조직) 정보 | samsungSDS |
| private_key | 개인키 | |
| state | 인증서 상태 | VALID |
| user_name | 사용자 이름 | 2048 |
9.1.1.5 - List certificates
9.1.1.5.1 - 1.1
scpcli certificatemanager certificate list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ismine <value>]
[--name <value>]
[--cn <value>]
[--state <value>]
Description
인증서 리스트
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ismine optional | boolean | 사용자가 등록한 인증서인지 확인 여부 | - |
| name optional | string | 인증서 이름 | test-certificate |
| cn optional | string | 인증서 CN 정보 | test.go.kr |
| state optional | array | 인증서 상태 | V |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인증서 id | |
| cert_kind | 인증서 타입 | PRD |
| cn | 인증서 CN 정보 | test.go.kr |
| name | 인증서 이름 | test-certificate |
| not_after_dt | 인증서 만료일 | 2026-02-07T18:07:59 |
| not_before_dt | 인증서 시작일 | 2025-02-08T18:07:00 |
| state | 인증서 상태 | VALID |
9.1.1.5.2 - 1.0
scpcli certificatemanager certificate list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ismine <value>]
[--name <value>]
[--cn <value>]
[--state <value>]
Description
인증서 리스트
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 |
| ismine optional | boolean | 사용자가 등록한 인증서인지 확인 여부 | - |
| name optional | string | 인증서 이름 | test-certificate |
| cn optional | string | 인증서 CN 정보 | test.go.kr |
| state optional | array | 인증서 상태 | V |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인증서 id | |
| cert_kind | 인증서 타입 | PRD |
| cn | 인증서 CN 정보 | test.go.kr |
| name | 인증서 이름 | test-certificate |
| not_after_dt | 인증서 만료일 | 2026-02-07T18:07:59 |
| not_before_dt | 인증서 시작일 | 2025-02-08T18:07:00 |
| state | 인증서 상태 | VALID |
9.1.1.6 - Self-sign a certificate
9.1.1.6.1 - 1.1
scpcli certificatemanager certificate selfSign
--timezone <value>
--region <value>
--organization <value>
--not_before_dt <value>
--not_after_dt <value>
--name <value>
--cn <value>
[--recipients <value>]
[--tags <value>]
Description
인증서 자체 서명
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| timezone required | string | 타임존 | Asia/Seoul |
| region required | string | 리즌 이름 | west1 |
| organization required | string | 인증서 O(조직) 정보 | samsungSDS |
| not_before_dt required | string | 인증서 시작일 | 20250101 |
| not_after_dt required | string | 인증서 만료일 | 20251212 |
| name required | string | 인증서 이름 | test-certificate |
| cn required | string | 인증서 CN 정보 | test.go.kr |
| recipients optional | array | 만료된 인증서 수신인 | '{"region": "", "user_id": "", "user_name": ""}' |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | b82909b3576449fda984fb25c3123542da |
| cert_body | 인증서 body | |
| cert_chain | 인증서 체인 | |
| cert_kind | 인증서 타입 | DEV |
| cert_type | 인증서 타입 | pem |
| cert_version | 인증서 버전 | 2 |
| cn | 인증서 CN 정보 | test.go.kr |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| key_bit_size | 키 bit 크기 | 2048 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 인증서 이름 | test-certificate |
| not_after_dt | 인증서 만료일 | 2026-02-07T18:07:59 |
| not_before_dt | 인증서 시작일 | 2025-02-08T18:07:00 |
| organization | 인증서 O(조직) 정보 | samsungSDS |
| private_key | 개인키 | |
| state | 인증서 상태 | VALID |
| user_name | 사용자 이름 | 2048 |
9.1.1.6.2 - 1.0
scpcli certificatemanager certificate selfSign
--timezone <value>
--region <value>
--organization <value>
--not_before_dt <value>
--not_after_dt <value>
--name <value>
--cn <value>
[--recipients <value>]
[--tags <value>]
Description
인증서 자체 서명
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| timezone required | string | 타임존 | Asia/Seoul |
| region required | string | 리즌 이름 | west1 |
| organization required | string | 인증서 O(조직) 정보 | samsungSDS |
| not_before_dt required | string | 인증서 시작일 | 20250101 |
| not_after_dt required | string | 인증서 만료일 | 20251212 |
| name required | string | 인증서 이름 | test-certificate |
| cn required | string | 인증서 CN 정보 | test.go.kr |
| recipients optional | array | 만료된 인증서 수신인 | '{"region": "", "user_id": "", "user_name": ""}' |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | b82909b3576449fda984fb25c3123542da |
| cert_body | 인증서 body | |
| cert_chain | 인증서 체인 | |
| cert_kind | 인증서 타입 | DEV |
| cert_type | 인증서 타입 | pem |
| cert_version | 인증서 버전 | 2 |
| cn | 인증서 CN 정보 | test.go.kr |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| key_bit_size | 키 bit 크기 | 2048 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 인증서 이름 | test-certificate |
| not_after_dt | 인증서 만료일 | 2026-02-07T18:07:59 |
| not_before_dt | 인증서 시작일 | 2025-02-08T18:07:00 |
| organization | 인증서 O(조직) 정보 | samsungSDS |
| private_key | 개인키 | |
| state | 인증서 상태 | VALID |
| user_name | 사용자 이름 | 2048 |
9.1.1.7 - Validate a certificate
9.1.1.7.1 - 1.1
scpcli certificatemanager certificate validate
--private_key <value>
--cert_body <value>
[--cert_chain <value>]
Description
인증서 검증
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_key required | string | 개인키 | <encoded private key data> |
| cert_body required | string | 인증서 body | <encoded certificate body data> |
| cert_chain optional | string | 인증서 체인 | <encoded certificate chain data> |
Responses
| Name | Description | Example |
|---|---|---|
| validate_check |
9.1.1.7.2 - 1.0
scpcli certificatemanager certificate validate
--private_key <value>
--is_need_cert_chain <value>
--cert_body <value>
[--cert_chain <value>]
Description
인증서 검증
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_key required | string | 개인키 | <encoded private key data> |
| is_need_cert_chain required | boolean | 인증서 체인 필요 여부 | True |
| cert_body required | string | 인증서 body | <encoded certificate body data> |
| cert_chain optional | string | 인증서 체인 | <encoded certificate chain data> |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False 체크 | True |
9.2 - Config Inspection
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Config Inspection에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | SUPPORTED | 20260531 |
| 1.1 | CURRENT | - |
9.2.1 - CLIs
9.2.1.1 - Create Config Inspection
9.2.1.1.1 - 1.1
scpcli configinspection ci create
--use_diagnosis_check_type_ssi <value>
--use_diagnosis_check_type_bp <value>
--frequency_value <value>
--frequency_type <value>
--diagnosis_start_time_pattern <value>
--auth_key_id <value>
--plan_type <value>
--diagnosis_type <value>
--diagnosis_name <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--diagnosis_account_id <value>
--csp_type <value>
--account_id <value>
[--tags <value>]
[--auth_key_created_at <value>]
[--auth_key_expired_at <value>]
Description
진단 상품 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| use_diagnosis_check_type_ssi required | string | 체크리스트 SSI 사용 여부 | y |
| use_diagnosis_check_type_bp required | string | 체크리스트 Best Practice 사용 여부 | y |
| frequency_value required | string | Schedule value (01~31, MONDAY~SUNDAY, everyDay) | 1 |
| frequency_type required | string | Schedule type( monthly, weekly, daily) | MONTH |
| diagnosis_start_time_pattern required | string | Start time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes ) | 08:00 |
| auth_key_id required | string | 인증키 ID | 9b72a9856e494e67afc69atd3631fe38 |
| plan_type required | string | 요금제 | STANDARD |
| diagnosis_type required | string | 진단 유형 | Console |
| diagnosis_name required | string | 진단명 | Sample Diagnosis Name |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | 진단 체크리스트 | BP |
| diagnosis_account_id required | string | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| csp_type required | string | 클라우드 서비스 제공자의 유형 | SCP |
| account_id required | string | 진단 계정 | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| auth_key_created_at optional | string | 인증 키 생성 날짜 | 2022-01-01 12:00:00 |
| auth_key_expired_at optional | string | 인증 키 만료 날짜 | 2023-01-01 12:00:00 |
Responses
| Name | Description | Example |
|---|---|---|
| diagnosis_id | 진단 ID | Sample Diagnosis Name |
| result | True, False 체크 | True |
9.2.1.1.2 - 1.0
scpcli configinspection ci create
--use_diagnosis_check_type_ssi <value>
--use_diagnosis_check_type_bp <value>
--frequency_value <value>
--frequency_type <value>
--diagnosis_start_time_pattern <value>
--auth_key_id <value>
--plan_type <value>
--diagnosis_type <value>
--diagnosis_name <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--diagnosis_account_id <value>
--csp_type <value>
--account_id <value>
[--tags <value>]
[--auth_key_created_at <value>]
[--auth_key_expired_at <value>]
Description
진단 상품 생성
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| use_diagnosis_check_type_ssi required | string | 체크리스트 SSI 사용 여부 | y |
| use_diagnosis_check_type_bp required | string | 체크리스트 Best Practice 사용 여부 | y |
| frequency_value required | string | Schedule value (01~31, MONDAY~SUNDAY, everyDay) | 1 |
| frequency_type required | string | Schedule type( monthly, weekly, daily) | MONTH |
| diagnosis_start_time_pattern required | string | Start time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes ) | 08:00 |
| auth_key_id required | string | 인증키 ID | 9b72a9856e494e67afc69atd3631fe38 |
| plan_type required | string | 요금제 | STANDARD |
| diagnosis_type required | string | 진단 유형 | Console |
| diagnosis_name required | string | 진단명 | Sample Diagnosis Name |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | 진단 체크리스트 | BP |
| diagnosis_account_id required | string | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| csp_type required | string | 클라우드 서비스 제공자의 유형 | SCP |
| account_id required | string | 진단 계정 | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| auth_key_created_at optional | string | 인증 키 생성 날짜 | 2022-01-01 12:00:00 |
| auth_key_expired_at optional | string | 인증 키 만료 날짜 | 2023-01-01 12:00:00 |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False 체크 | True |
9.2.1.2 - Delete Config Inspection
9.2.1.2.1 - 1.1
scpcli configinspection ci delete
--diagnosis_id <value>
Description
config inspection 목록 가져오기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | 진단 ID | Sample Diagnosis Name |
9.2.1.2.2 - 1.0
scpcli configinspection ci delete
--diagnosis_id <value>
Description
config inspection 목록 가져오기
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | 진단 ID | Sample Diagnosis Name |
9.2.1.3 - Diagnosis Request
9.2.1.3.1 - 1.1
scpcli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>
Description
진단 요청
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tenant_id required | string | Tenant ID | 1234567890 |
| secret_key required | string | Secret Key | SAMPLE KEY |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | 진단 체크리스트 | BP |
| access_key required | string | Access Key | SAMPLE KEY |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False 체크 | True |
9.2.1.3.2 - 1.0
scpcli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>
Description
진단 요청
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tenant_id required | string | Tenant ID | 1234567890 |
| secret_key required | string | Secret Key | SAMPLE KEY |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | 진단 체크리스트 | BP |
| access_key required | string | Access Key | SAMPLE KEY |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False 체크 | True |
9.2.1.4 - Get Diagnosis Object Detail
9.2.1.4.1 - 1.1
scpcli configinspection ci detail
--diagnosis_id <value>
Description
진단 결과 세부 정보 가져오기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | 진단 ID | Sample Diagnosis Name |
Responses
| Name | Description | Example |
|---|---|---|
| auth_key_created_at | 인증 키 생성 날짜 | 2022-01-01T12:00:00Z |
| auth_key_expired_at | 인증 키 만료 날짜 | 2022-01-01T12:00:00Z |
| auth_key_id | 인증키 ID | 9b72a9856e494e67afc69atd3631fe38 |
| auth_key_state | 인증키 상태 | ACTIVATED |
| user_id | 사용자 ID | 4f5d60e9e08b48d0a0881e21ab14e266 |
9.2.1.4.2 - 1.0
scpcli configinspection ci detail
--diagnosis_id <value>
Description
진단 결과 세부 정보 가져오기
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | 진단 ID | Sample Diagnosis Name |
Responses
| Name | Description | Example |
|---|---|---|
| auth_key_created_at | 인증 키 생성 날짜 | 2022-01-01T12:00:00Z |
| auth_key_expired_at | 인증 키 만료 날짜 | 2022-01-01T12:00:00Z |
| auth_key_id | 인증키 ID | 9b72a9856e494e67afc69atd3631fe38 |
| auth_key_state | 인증키 상태 | ACTIVATED |
| user_id | 사용자 ID | 4f5d60e9e08b48d0a0881e21ab14e266 |
9.2.1.5 - Get Diagnosis Result Detail
9.2.1.5.1 - 1.1
scpcli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
Description
진단 결과 세부 정보 가져오기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_request_sequence required | string | 진단 요청 Sequence | SCPCIS-E75FD21CA524441C9C1B1B381D5974F7 |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| action_guide | 조치 가이드 | 원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다. |
| changed | 관리결과 변경 여부 | True |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_criteria | 진단 기준 | 【 Security Group 규칙 】 |
| ① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다. | ||
| diagnosis_item | 진단 항목 | 2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다. |
| diagnosis_layer | 영역 | 2.NETWORK |
| diagnosis_method | 진단 방법 | Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다. |
| diagnosis_result | 확인결과 상태 | 03 |
| result_contents | 상세 결과 | 상세 내역 |
| sub_category | Sub Category | NURIBP_SCP_02.NW_004 |
9.2.1.5.2 - 1.0
scpcli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
Description
진단 결과 세부 정보 가져오기
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_request_sequence required | string | 진단 요청 Sequence | SCPCIS-E75FD21CA524441C9C1B1B381D5974F7 |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| action_guide | 조치 가이드 | 원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다. |
| changed | 관리결과 변경 여부 | True |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_criteria | 진단 기준 | 【 Security Group 규칙 】 |
| ① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다. | ||
| diagnosis_item | 진단 항목 | 2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다. |
| diagnosis_layer | 영역 | 2.NETWORK |
| diagnosis_method | 진단 방법 | Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다. |
| diagnosis_result | 확인결과 상태 | 03 |
| result_contents | 상세 결과 | 상세 내역 |
| sub_category | Sub Category | NURIBP_SCP_02.NW_004 |
9.2.1.6 - List Config Inspection
9.2.1.6.1 - 1.1
scpcli configinspection ci list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ismine <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--csp_type <value>]
[--diagnosis_account_id <value>]
[--recent_diagnosis_state <value>]
[--start_date <value>]
[--end_date <value>]
Description
config inspection 목록 가져오기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
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 |
| ismine optional | boolean | 나의 Config Inspection | False |
| diagnosis_id optional | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | 진단명 | My Diagnosis |
| csp_type optional | string | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id optional | string | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| recent_diagnosis_state optional | array | 최근 진단 상태 | C |
| start_date optional | string | 시작일 | 2022-01-01 12:00:00 |
| end_date optional | string | 종료일 | 2022-01-02 12:00:00 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2022-01-01T12:00:00Z |
| csp_type | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_id | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | 진단명 | Sample Diagnosis Name |
| diagnosis_type | 진단 유형 | Console |
| error_state | 최근 진단 오류 타입 | CONNECTION_FAIL |
| plan_type | 요금제 | STANDARD |
| recent_diagnosis_at | 최근 진단 일시 | 2022-01-01T12:00:00Z |
| recent_diagnosis_state | 최근 진단 상태 | Completed |
9.2.1.6.2 - 1.0
scpcli configinspection ci list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ismine <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--csp_type <value>]
[--diagnosis_account_id <value>]
[--recent_diagnosis_state <value>]
[--start_date <value>]
[--end_date <value>]
Description
config inspection 목록 가져오기
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
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 |
| ismine optional | boolean | 나의 Config Inspection | False |
| diagnosis_id optional | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | 진단명 | My Diagnosis |
| csp_type optional | string | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id optional | string | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| recent_diagnosis_state optional | array | 최근 진단 상태 | C |
| start_date optional | string | 시작일 | 2022-01-01 12:00:00 |
| end_date optional | string | 종료일 | 2022-01-02 12:00:00 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2022-01-01T12:00:00Z |
| csp_type | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_id | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | 진단명 | Sample Diagnosis Name |
| diagnosis_type | 진단 유형 | Console |
| error_state | 최근 진단 오류 타입 | CONNECTION_FAIL |
| plan_type | 요금제 | STANDARD |
| recent_diagnosis_at | 최근 진단 일시 | 2022-01-01T12:00:00Z |
| recent_diagnosis_state | 최근 진단 상태 | Completed |
9.2.1.7 - List Diagnosis Result
9.2.1.7.1 - 1.1
scpcli configinspection ci result list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--start_date <value>]
[--end_date <value>]
[--csp_type <value>]
[--diagnosis_state <value>]
[--user_id <value>]
Description
진단 결과 목록 가져오기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
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 |
| account_id optional | string | 진단 계정 | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_id optional | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | 진단명 | Sample Diagnosis Name |
| start_date optional | string | 시작일 | 2022-01-01 |
| end_date optional | string | 종료일 | 2022-12-31 |
| csp_type optional | string | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_state optional | string | 진단 상태 | Completed |
| user_id optional | string | 사용자 ID | 76b563a009584b1380715c00703a02ff |
Responses
| Name | Description | Example |
|---|---|---|
| count_check | check 개수 | 10 |
| count_error | error 개수 | 0 |
| count_fail | fail 개수 | 3 |
| count_na | na 개수 | 2 |
| count_pass | pass 개수 | 5 |
| csp_type | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_id | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | 진단명 | Sample Diagnosis Name |
| diagnosis_request_sequence | 진단 요청 Sequence | 1234567890 |
| diagnosis_result | 진단 결과 | SUCCESS |
| diagnosis_total_count | 총 개수 | 10 |
| proceed_date | 진단 일자 | 2022-01-01T12:00:00Z |
| total | 전체 개수 | 10 |
9.2.1.7.2 - 1.0
scpcli configinspection ci result list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--start_date <value>]
[--end_date <value>]
[--csp_type <value>]
[--diagnosis_state <value>]
[--user_id <value>]
Description
진단 결과 목록 가져오기
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
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 |
| account_id optional | string | 진단 계정 | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_id optional | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | 진단명 | Sample Diagnosis Name |
| start_date optional | string | 시작일 | 2022-01-01 |
| end_date optional | string | 종료일 | 2022-12-31 |
| csp_type optional | string | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_state optional | string | 진단 상태 | Completed |
| user_id optional | string | 사용자 ID | 76b563a009584b1380715c00703a02ff |
Responses
| Name | Description | Example |
|---|---|---|
| count_check | check 개수 | 10 |
| count_error | error 개수 | 0 |
| count_fail | fail 개수 | 3 |
| count_na | na 개수 | 2 |
| count_pass | pass 개수 | 5 |
| csp_type | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_id | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | 진단명 | Sample Diagnosis Name |
| diagnosis_request_sequence | 진단 요청 Sequence | 1234567890 |
| diagnosis_result | 진단 결과 | SUCCESS |
| diagnosis_total_count | 총 개수 | 10 |
| proceed_date | 진단 일자 | 2022-01-01T12:00:00Z |
| total | 전체 개수 | 10 |
9.3 - Key Management Service
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Key Management Service(KMS)에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
9.3.1 - CLIs
9.3.1.1 - Change Rotate Info
9.3.1.1.1 - 1.1
scpcli kms kms change rotate info
--key_id <value>
--rotate_cycle <value>
--auto_rotate <value>
Description
키 회전정보를 변경한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| rotate_cycle required | integer | 회전 주기 | 7 |
| auto_rotate required | string | 자동회전 Y 또는 N | Y |
9.3.1.1.2 - 1.0
scpcli kms kms change rotate info
--key_id <value>
--rotate_cycle <value>
--auto_rotate <value>
Description
키 회전정보를 변경한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| rotate_cycle required | integer | 회전 주기 | 7 |
| auto_rotate required | string | 자동회전 Y 또는 N | Y |
9.3.1.2 - Change State Of Key
9.3.1.2.1 - 1.1
scpcli kms kms change state
--key_id <value>
--state <value>
Description
키 상태를 변경한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| state required | string | State of key(Active, Stop) | Active |
9.3.1.2.2 - 1.0
scpcli kms kms change state
--key_id <value>
--state <value>
Description
키 상태를 변경한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| state required | string | State of key(Active, Stop) | Active |
9.3.1.3 - Check Duplicate Name
9.3.1.3.1 - 1.1
scpcli kms kms check duplicate name
--name <value>
Description
키 이름 중복을 체크한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 키 이름 | testkey |
Responses
| Name | Description | Example |
|---|---|---|
| isDuplicateName | True |
9.3.1.3.2 - 1.0
scpcli kms kms check duplicate name
--name <value>
Description
키 이름 중복을 체크한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 키 이름 | testkey |
Responses
| Name | Description | Example |
|---|---|---|
| isDuplicateName | True |
9.3.1.4 - Create Datakey
9.3.1.4.1 - 1.1
scpcli kms kms datakey
--key_id <value>
--key_type <value>
Description
새 데이터키를 생성하고, 키(용도:암호화/복호화)로 암호화된 값을 생성합니다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| key_type required | string | Key type( plaintext or wrapped ) | plaintext |
Responses
| Name | Description | Example |
|---|---|---|
| ciphertext | 암호화된 데이터 키 | vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
| key_version | KMS 키 버전 | 1 |
| plaintext | 데이터키 (base64로 인코딩된) | oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA= |
9.3.1.4.2 - 1.0
scpcli kms kms datakey
--key_id <value>
--key_type <value>
Description
새 데이터키를 생성하고, 키(용도:암호화/복호화)로 암호화된 값을 생성합니다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| key_type required | string | Key type( plaintext or wrapped ) | plaintext |
Responses
| Name | Description | Example |
|---|---|---|
| ciphertext | 암호화된 데이터 키 | vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
| key_version | KMS 키 버전 | 1 |
| plaintext | 데이터키 (base64로 인코딩된) | oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA= |
9.3.1.5 - Create Key
9.3.1.5.1 - 1.1
scpcli kms kms create
--rotate_cycle <value>
--purpose <value>
--name <value>
--description <value>
--auto_rotate <value>
[--key_type <value>]
[--tags <value>]
Description
키를 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| rotate_cycle required | integer | 회전 주기 | 7 |
| purpose required | string | 키 용도 | rsa-2048 |
| name required | string | 키 이름 | testkey |
| description required | string | 키 설명 | description1 |
| auto_rotate required | string | 자동회전 Y 또는 N | Y |
| key_type optional | string | 기본 또는 고급 | advanced |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| auto_rotate | 자동회전 Y 또는 N | Y |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_version | KMS키 현재 버전 | 7 |
| delete_at | Date of deletion | 20251008 |
| delete_target_yn | 키 삭제예정 여부 | Y |
| description | 키 설명 | description1 |
| key_type | 기본 또는 고급 | advanced |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | testkey |
| next_rotate_at | 다음 회전일 | 20241008 |
| order_ref | 오더 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| purpose | 키 용도 | rsa-2048 |
| region | 리즌 이름 | kr-west1 |
| rotate_cycle | 회전 주기 | 7 |
| secret_ref | 시크릿 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| use_count | KMS키 사용횟수 | 1004 |
9.3.1.5.2 - 1.0
scpcli kms kms create
--rotate_cycle <value>
--purpose <value>
--name <value>
--description <value>
--auto_rotate <value>
[--key_type <value>]
[--tags <value>]
Description
키를 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| rotate_cycle required | integer | 회전 주기 | 7 |
| purpose required | string | 키 용도 | rsa-2048 |
| name required | string | 키 이름 | testkey |
| description required | string | 키 설명 | description1 |
| auto_rotate required | string | 자동회전 Y 또는 N | Y |
| key_type optional | string | 기본 또는 고급 | advanced |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| auto_rotate | 자동회전 Y 또는 N | Y |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_version | KMS키 현재 버전 | 7 |
| delete_at | Date of deletion | 20251008 |
| delete_target_yn | 키 삭제예정 여부 | Y |
| description | 키 설명 | description1 |
| key_type | 기본 또는 고급 | advanced |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | testkey |
| next_rotate_at | 다음 회전일 | 20241008 |
| order_ref | 오더 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| purpose | 키 용도 | rsa-2048 |
| region | 리즌 이름 | kr-west1 |
| rotate_cycle | 회전 주기 | 7 |
| secret_ref | 시크릿 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| use_count | KMS키 사용횟수 | 1004 |
9.3.1.6 - Decrypt Data
9.3.1.6.1 - 1.1
scpcli kms kms decrypt
--key_id <value>
--ciphertext <value>
Description
키(용도:암호화/복호화)를 사용하여 제공된 암호문을 해독합니다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| ciphertext required | string | KMS에 의해 암호화된 데이터 | vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
Responses
| Name | Description | Example |
|---|---|---|
| plaintext | 데이터키 (base64로 인코딩된 ) | dGhlIHF1aWNrIGJyb3duIGZveAo= |
9.3.1.6.2 - 1.0
scpcli kms kms decrypt
--key_id <value>
--ciphertext <value>
Description
키(용도:암호화/복호화)를 사용하여 제공된 암호문을 해독합니다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| ciphertext required | string | KMS에 의해 암호화된 데이터 | vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
Responses
| Name | Description | Example |
|---|---|---|
| plaintext | 데이터키 (base64로 인코딩된 ) | dGhlIHF1aWNrIGJyb3duIGZveAo= |
9.3.1.7 - Delete Key
9.3.1.7.1 - 1.1
scpcli kms kms delete
--key_id <value>
[--is_directly <value>]
Description
키를 지금 또는 나중에 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| is_directly optional | boolean | 즉시삭제 여부 | True |
9.3.1.7.2 - 1.0
scpcli kms kms delete
--key_id <value>
[--is_directly <value>]
Description
키를 지금 또는 나중에 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| is_directly optional | boolean | 즉시삭제 여부 | True |
9.3.1.8 - Encrypt Data
9.3.1.8.1 - 1.1
scpcli kms kms encrypt
--key_id <value>
--plaintext <value>
Description
제공된 일반 텍스트(base64 인코딩)를 키(용도:암호화/복호화)를 사용하여 암호화합니다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| plaintext required | string | Data(base64 encoded) to encrypt | dGhlIHF1aWNrIGJyb3duIGZveAo= |
Responses
| Name | Description | Example |
|---|---|---|
| ciphertext | KMS에 의해 암호화된 데이터 | vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
| key_version | KMS 키 버전 | 1 |
9.3.1.8.2 - 1.0
scpcli kms kms encrypt
--key_id <value>
--plaintext <value>
Description
제공된 일반 텍스트(base64 인코딩)를 키(용도:암호화/복호화)를 사용하여 암호화합니다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| plaintext required | string | Data(base64 encoded) to encrypt | dGhlIHF1aWNrIGJyb3duIGZveAo= |
Responses
| Name | Description | Example |
|---|---|---|
| ciphertext | KMS에 의해 암호화된 데이터 | vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
| key_version | KMS 키 버전 | 1 |
9.3.1.9 - List Keys
9.3.1.9.1 - 1.1
scpcli kms kms list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
키 리스트 조회하기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 키 이름 | testkey |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| auto_rotate | 자동회전 Y 또는 N | Y |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_version | KMS키 현재 버전 | 7 |
| delete_at | Date of deletion | 20251008 |
| delete_target_yn | 키 삭제예정 여부 | Y |
| description | 키 설명 | description1 |
| key_type | 기본 또는 고급 | advanced |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | testkey |
| next_rotate_at | 다음 회전일 | 20241008 |
| order_ref | 오더 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| purpose | 키 용도 | rsa-2048 |
| region | 리즌 이름 | kr-west1 |
| rotate_cycle | 회전 주기 | 7 |
| secret_ref | 시크릿 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| use_count | KMS키 사용횟수 | 1004 |
9.3.1.9.2 - 1.0
scpcli kms kms list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
키 리스트 조회하기
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 키 이름 | testkey |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| auto_rotate | 자동회전 Y 또는 N | Y |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_version | KMS키 현재 버전 | 7 |
| delete_at | Date of deletion | 20251008 |
| delete_target_yn | 키 삭제예정 여부 | Y |
| description | 키 설명 | description1 |
| key_type | 기본 또는 고급 | advanced |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | testkey |
| next_rotate_at | 다음 회전일 | 20241008 |
| order_ref | 오더 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| purpose | 키 용도 | rsa-2048 |
| region | 리즌 이름 | kr-west1 |
| rotate_cycle | 회전 주기 | 7 |
| secret_ref | 시크릿 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| use_count | KMS키 사용횟수 | 1004 |
9.3.1.10 - List Users
9.3.1.10.1 - 1.1
scpcli kms kms list users
--key_id <value>
Description
키를 사용한 사람 목록을 보여준다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| user_id | 사용자 id | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_name | 사용자 이름 | kimsamsung |
9.3.1.10.2 - 1.0
scpcli kms kms list users
--key_id <value>
Description
키를 사용한 사람 목록을 보여준다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| user_id | 사용자 id | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_name | 사용자 이름 | kimsamsung |
9.3.1.11 - Make hmac
9.3.1.11.1 - 1.1
scpcli kms kms generate hmac
--key_id <value>
--input <value>
Description
HMAC 키를 사용해 생성합니다.( 용도: 생성/확인 )
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| input required | string | Data(base64 encoded) for verification | dGVzdCBpbnB1dA== |
Responses
| Name | Description | Example |
|---|---|---|
| hmac | HMAC 데이터 | vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ= |
9.3.1.11.2 - 1.0
scpcli kms kms generate hmac
--key_id <value>
--input <value>
Description
HMAC 키를 사용해 생성합니다.( 용도: 생성/확인 )
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| input required | string | Data(base64 encoded) for verification | dGVzdCBpbnB1dA== |
Responses
| Name | Description | Example |
|---|---|---|
| hmac | HMAC 데이터 | vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ= |
9.3.1.12 - Rewrap Data
9.3.1.12.1 - 1.1
scpcli kms kms rewrap
--key_id <value>
--ciphertext <value>
Description
최신 버전의 키(용도:암호화/복호화)를 사용하여 제공된 암호문을 다시 래핑합니다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| ciphertext required | string | KMS에 의해 암호화된 데이터 | vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
Responses
| Name | Description | Example |
|---|---|---|
| ciphertext | KMS에 의해 암호화된 재래핑할 데이터 | vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
| key_version | KMS 키 버전 | 1 |
9.3.1.12.2 - 1.0
scpcli kms kms rewrap
--key_id <value>
--ciphertext <value>
Description
최신 버전의 키(용도:암호화/복호화)를 사용하여 제공된 암호문을 다시 래핑합니다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| ciphertext required | string | KMS에 의해 암호화된 데이터 | vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
Responses
| Name | Description | Example |
|---|---|---|
| ciphertext | KMS에 의해 암호화된 재래핑할 데이터 | vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
| key_version | KMS 키 버전 | 1 |
9.3.1.13 - Rotate Key
9.3.1.13.1 - 1.1
scpcli kms kms rotate
--key_id <value>
Description
키를 회전한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| auto_rotate | 자동회전 Y 또는 N | Y |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_version | KMS키 현재 버전 | 7 |
| delete_at | Date of deletion | 20251008 |
| delete_target_yn | 키 삭제예정 여부 | Y |
| description | 키 설명 | description1 |
| key_type | 기본 또는 고급 | advanced |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | testkey |
| next_rotate_at | 다음 회전일 | 20241008 |
| order_ref | 오더 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| purpose | 키 용도 | rsa-2048 |
| region | 리즌 이름 | kr-west1 |
| rotate_cycle | 회전 주기 | 7 |
| secret_ref | 시크릿 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| use_count | KMS키 사용횟수 | 1004 |
9.3.1.13.2 - 1.0
scpcli kms kms rotate
--key_id <value>
Description
키를 회전한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| auto_rotate | 자동회전 Y 또는 N | Y |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_version | KMS키 현재 버전 | 7 |
| delete_at | Date of deletion | 20251008 |
| delete_target_yn | 키 삭제예정 여부 | Y |
| description | 키 설명 | description1 |
| key_type | 기본 또는 고급 | advanced |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | testkey |
| next_rotate_at | 다음 회전일 | 20241008 |
| order_ref | 오더 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| purpose | 키 용도 | rsa-2048 |
| region | 리즌 이름 | kr-west1 |
| rotate_cycle | 회전 주기 | 7 |
| secret_ref | 시크릿 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| use_count | KMS키 사용횟수 | 1004 |
9.3.1.14 - Show Key
9.3.1.14.1 - 1.1
scpcli kms kms show
--key_id <value>
Description
키 정보를 보여준다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| auto_rotate | 자동회전 Y 또는 N | Y |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_version | KMS키 현재 버전 | 7 |
| delete_at | Date of deletion | 20251008 |
| delete_target_yn | 키 삭제예정 여부 | Y |
| description | 키 설명 | description1 |
| key_type | 기본 또는 고급 | advanced |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | testkey |
| next_rotate_at | 다음 회전일 | 20241008 |
| order_ref | 오더 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| purpose | 키 용도 | rsa-2048 |
| region | 리즌 이름 | kr-west1 |
| rotate_cycle | 회전 주기 | 7 |
| secret_ref | 시크릿 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| use_count | KMS키 사용횟수 | 1004 |
9.3.1.14.2 - 1.0
scpcli kms kms show
--key_id <value>
Description
키 정보를 보여준다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| auto_rotate | 자동회전 Y 또는 N | Y |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| current_version | KMS키 현재 버전 | 7 |
| delete_at | Date of deletion | 20251008 |
| delete_target_yn | 키 삭제예정 여부 | Y |
| description | 키 설명 | description1 |
| key_type | 기본 또는 고급 | advanced |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | testkey |
| next_rotate_at | 다음 회전일 | 20241008 |
| order_ref | 오더 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| purpose | 키 용도 | rsa-2048 |
| region | 리즌 이름 | kr-west1 |
| rotate_cycle | 회전 주기 | 7 |
| secret_ref | 시크릿 참조 | 0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| use_count | KMS키 사용횟수 | 1004 |
9.3.1.15 - Sign Data
9.3.1.15.1 - 1.1
scpcli kms kms sign
--key_id <value>
--input <value>
Description
키(용도:서명/검증)를 사용하여 주어진 데이터의 암호화 서명을 반환합니다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| input required | string | Data(base64 encoded) for Signature | dGVzdCBpbnB1dA== |
Responses
| Name | Description | Example |
|---|---|---|
| key_version | KMS 키 버전 | 1 |
| signature | 확인을 위한 시그니쳐 | vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg= |
9.3.1.15.2 - 1.0
scpcli kms kms sign
--key_id <value>
--input <value>
Description
키(용도:서명/검증)를 사용하여 주어진 데이터의 암호화 서명을 반환합니다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| input required | string | Data(base64 encoded) for Signature | dGVzdCBpbnB1dA== |
Responses
| Name | Description | Example |
|---|---|---|
| key_version | KMS 키 버전 | 1 |
| signature | 확인을 위한 시그니쳐 | vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg= |
9.3.1.16 - Update Description
9.3.1.16.1 - 1.1
scpcli kms kms update description
--key_id <value>
--description <value>
Description
설명을 업데이트한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| description required | string | 키 설명 | - |
9.3.1.16.2 - 1.0
scpcli kms kms update description
--key_id <value>
--description <value>
Description
설명을 업데이트한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| description required | string | 키 설명 | - |
9.3.1.17 - Verify Data
9.3.1.17.1 - 1.1
scpcli kms kms verify
--key_id <value>
--signature <value>
--input <value>
Description
제공된 서명이 서명 데이터 중 하나에서 지정된 데이터에 대해 유효한지 여부를 키(용도:서명/검증)를 사용해 반환합니다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| signature required | string | 확인을 위한 시그니쳐 | vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg= |
| input required | string | Data(base64 encoded) for verification | dGVzdCBpbnB1dA== |
Responses
| Name | Description | Example |
|---|---|---|
| valid | 확인결과 | True |
9.3.1.17.2 - 1.0
scpcli kms kms verify
--key_id <value>
--signature <value>
--input <value>
Description
제공된 서명이 서명 데이터 중 하나에서 지정된 데이터에 대해 유효한지 여부를 키(용도:서명/검증)를 사용해 반환합니다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| signature required | string | 확인을 위한 시그니쳐 | vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg= |
| input required | string | Data(base64 encoded) for verification | dGVzdCBpbnB1dA== |
Responses
| Name | Description | Example |
|---|---|---|
| valid | 확인결과 | True |
9.3.1.18 - Verify hmac with input
9.3.1.18.1 - 1.1
scpcli kms kms verify hmac
--key_id <value>
--input <value>
--hmac <value>
Description
INPUT이 유효한지 아닌지 키를 사용해 확인합니다(용도: 생성/확인)
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| input required | string | Data(base64 encoded) for verification | dGVzdCBpbnB1dA== |
| hmac required | string | 확인을 위한 시그니쳐 | vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg= |
Responses
| Name | Description | Example |
|---|---|---|
| valid | 확인결과 | True |
9.3.1.18.2 - 1.0
scpcli kms kms verify hmac
--key_id <value>
--input <value>
--hmac <value>
Description
INPUT이 유효한지 아닌지 키를 사용해 확인합니다(용도: 생성/확인)
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | KMS 키 자원 아이디 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| input required | string | Data(base64 encoded) for verification | dGVzdCBpbnB1dA== |
| hmac required | string | 확인을 위한 시그니쳐 | vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg= |
Responses
| Name | Description | Example |
|---|---|---|
| valid | 확인결과 | True |
9.4 - Secret Vault
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Secret Vault에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
9.4.1 - CLIs
9.4.1.1 - Create Secret Vault
9.4.1.1.1 - 1.0
scpcli secretvault sv create
--vault_token_ttl_ndays <value>
--temporary_key_ttl_nhours <value>
--name <value>
--acl_cidr <value>
--access_key_id <value>
[--description <value>]
[--tags <value>]
Description
시크릿볼트 생성.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vault_token_ttl_ndays required | integer | 볼트 토큰 유효시간 | 720 |
| temporary_key_ttl_nhours required | integer | 임시키 유효 시간 | 3 |
| name required | string | 시크릿볼트 아이디 | name |
| acl_cidr required | string | 접근제한을 위한 CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| access_key_id required | string | Access key ID | b754b12b39da4ce29a40c5e324650bd0 |
| description optional | string | Description | description |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| access_key_id | Access key ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| access_key_type | access key 유형 | Temporary |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | 접근제한을 위한 CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description | description |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | vaultkey |
| temporary_key_ttl_nhours | 임시키 유효 시간 | 36 |
| user_name | 사용자명 | username |
| vault_token_expired_at | 볼트 토큰 만료일 | 2025-02-25 03:07:17.000 |
| vault_token_id | 볼트토큰 아이디 | aace85da-965e-d95a-b4ed-8d32b5d6079 |
| vault_token_secret_value | 볼트토큰 시크릿 | 6171392c-5fd9-43db-9e15-e14af0068f96 |
| vault_token_ttl_ndays | 볼트 토큰 유효시간 | 10 |
| vaultkey_state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| vaultkey_type | 볼트키 타입 | SCP Open API Key |
| waiting_time_ndays | 삭제까지 남은 일수 | 10 |
9.4.1.2 - Delete Secret Vault
9.4.1.2.1 - 1.0
scpcli secretvault sv delete
--secret_vault_id <value>
--waiting_time_ndays <value>
Description
시크릿볼트 상태는 To be terminated 가 아닙니다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_vault_id required | string | 시크릿볼트 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| waiting_time_ndays required | integer | 삭제까지 남은 일수 | 7 |
9.4.1.3 - List Secret Vaults
9.4.1.3.1 - 1.0
scpcli secretvault sv list
Description
시크릿볼트 리스트 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| access_key_id | Access key ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| access_key_type | access key 유형 | Temporary |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | 접근제한을 위한 CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description | description |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | vaultkey |
| temporary_key_ttl_nhours | 임시키 유효 시간 | 36 |
| user_name | 사용자명 | username |
| vault_token_expired_at | 볼트 토큰 만료일 | 2025-02-25 03:07:17.000 |
| vault_token_id | 볼트토큰 아이디 | [AES] SZtB6RasvLypCv4soJlQO3ZmYpUPjFblz7pstjBeTQJXcz/d5KB9TUR3gMY08mga4fxWaF6IfUzTMBh6j/CAaw== |
| vault_token_secret_value | 볼트토큰 시크릿 | [AES] 91/kdnK4NDfs2HGWgNH/EYNnqD7OcM1unXWs0ZAuaFttIqgP8xMUx0dOaRfD6kOD7uuujFxF2nzx35D9Gz9nwQ== |
| vault_token_ttl_ndays | 볼트 토큰 유효시간 | 10 |
| vaultkey_state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| vaultkey_type | 볼트키 타입 | SCP Open API Key |
| waiting_time_ndays | 삭제까지 남은 일수 | 10 |
9.4.1.4 - Show Secret Vault
9.4.1.4.1 - 1.0
scpcli secretvault sv show
--secret_vault_id <value>
Description
시크릿볼트 조회.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_vault_id required | string | 시크릿볼트 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| access_key | 삼성 클라우드 플랫폼 포털에서 발급받은 Access Key | [‘0e3*****************************’] |
| access_key_id | Access key ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| access_key_type | access key 유형 | [‘Temporary’, ‘Permanent’] |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | 접근제한을 위한 CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | 키 설명 | description |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | [‘vaultkey’] |
| temp_key_expired_at | 임시키 만료일 | 2025-02-25 03:07:17.000 |
| temporary_key_ttl_nhours | 임시키 유효 시간 | [‘36’] |
| vault_token_expired_at | 볼트 토큰 만료일 | 2025-02-25 03:07:17.000 |
| vault_token_id | 볼트토큰 아이디 | aace85da-965e-d95a-b4ed-8d32b5d6079 |
| vault_token_secret_value | 볼트토큰 시크릿 | 6171392c-5fd9-43db-9e15-e14af0068f96 |
| vault_token_ttl_ndays | 볼트 토큰 유효시간 | [‘10’] |
| vaultkey_state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| vaultkey_type | 볼트키 타입 | [‘SCP Open API Key’] |
| waiting_time_ndays | 삭제까지 남은 일수 | 10 |
9.5 - Secrets Manager
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Secrets Manager에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
9.5.1 - CLIs
9.5.1.1 - Create Secret
9.5.1.1.1 - 1.0
scpcli secretsmanager secret create
--secret_value <value>
--name <value>
--kms_id <value>
--acl_cidr <value>
[--description <value>]
[--tags <value>]
Description
Secret 을 생성합니다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_value required | string | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {"key1":"value1","key2":"value2"} |
| name required | string | Secret 이름 | name |
| kms_id required | string | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr required | string | Secret 접근허용 CIDR 리스트 | 192.168.1.1/24, 10.0.0.1/16 |
| description optional | string | Secret 설명 | description |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Secret 접근허용 CIDR 리스트 | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Secret 설명 | description |
| kms_id | Key Management Service 상품에서 생성한 자원 ID | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | KMS 키 이름 | kmsname |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | my-secret-name |
| recent_searched_at | 최근 검색일 | 2025-02-25 03:07:17.000 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Secret 타입 | General |
9.5.1.2 - Delete Secret
9.5.1.2.1 - 1.0
scpcli secretsmanager secret delete
--secret_id <value>
--waiting_time_ndays <value>
Description
Secret을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| waiting_time_ndays required | integer | 삭제까지 남은 일수 | 7 |
9.5.1.3 - Generate Random Password
9.5.1.3.1 - 1.0
scpcli secretsmanager generate random password
[--exclude_characters <value>]
[--exclude_lowercase <value>]
[--exclude_numbers <value>]
[--exclude_punctuation <value>]
[--exclude_uppercase <value>]
[--include_space <value>]
[--password_length <value>]
[--require_each_included_type <value>]
Description
임의 비밀번호 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| exclude_characters optional | string | 비밀번호 생성 시 제외할 문자들 | abcdefg |
| exclude_lowercase optional | boolean | 소문자 제외 옵션 | false |
| exclude_numbers optional | boolean | 숫자 제외 옵션 | false |
| exclude_punctuation optional | boolean | 특수문자 제외 옵션 | false |
| exclude_uppercase optional | boolean | 대문자 제외 옵션 | false |
| include_space optional | boolean | 공백 포함 옵션 | false |
| password_length optional | integer | 생성할 비밀번호의 길이 | 32 |
| require_each_included_type optional | boolean | 포함된 모든 문자 유형 필수 요구 | true |
Responses
| Name | Description | Example |
|---|---|---|
| random_password | 임의 비밀번호 생성 | random-value |
9.5.1.4 - List Secrets
9.5.1.4.1 - 1.0
scpcli secretsmanager secret list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
Description
Secret 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Secret 이름 | name |
| state optional | array | Secret 상태 | A |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Secret 접근허용 CIDR 리스트 | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Secret 설명 | description |
| kms_id | Key Management Service 상품에서 생성한 자원 ID | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | KMS 키 이름 | kmsname |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | my-secret-name |
| recent_searched_at | 최근 검색일 | 2025-02-25 03:07:17.000 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Secret 타입 | General |
9.5.1.5 - List Versions of Secret
9.5.1.5.1 - 1.0
scpcli secretsmanager secret list version
--secret_id <value>
Description
Secrets 버전 리스트
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
Responses
| Name | Description | Example |
|---|---|---|
| version_list |
9.5.1.6 - Restore Secret
9.5.1.6.1 - 1.0
scpcli secretsmanager secret restore
--secret_id <value>
Description
Secret 삭제 절차를 취소한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
9.5.1.7 - Set CIDR of Secret
9.5.1.7.1 - 1.0
scpcli secretsmanager secret set cidr
--secret_id <value>
--acl_cidr <value>
Description
Secret의 Value 조회 접근제어를 위한 IP CIDR 값을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr required | string | Secret 접근허용 CIDR 리스트 | 192.168.1.1/24, 10.0.0.1/16 |
9.5.1.8 - Set Description of Secret
9.5.1.8.1 - 1.0
scpcli secretsmanager secret set description
--secret_id <value>
--description <value>
Description
Secret의 설명값을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| description required | string | Secret 설명 | description |
9.5.1.9 - Set KMS ID of Secret
9.5.1.9.1 - 1.0
scpcli secretsmanager secret set kmsid
--secret_id <value>
--kms_id <value>
Description
Secret Value 암호화에 사용한 KMS ID 를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| kms_id required | string | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
9.5.1.10 - Set Label of Version
9.5.1.10.1 - 1.0
scpcli secretsmanager secret update label
--secret_id <value>
--label <value>
[--move_to_version_id <value>]
[--remove_from_version_id <value>]
Description
Version 에 라벨을 추가/이동/삭제합니다. move_to_version_id 값만 사용하는 경우 라벨이 추가되고, remove_from_version_id 값만 사용하는경우 라벨이 제거됩니다. 둘다 사용하는경우, remove_from_version_id 의 라벨값이 move_to_version_id로 이동합니다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| label required | string | Secret 버전 라벨. 중복 불가. | My Custom Label |
| move_to_version_id optional | string | Secret 버전 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| remove_from_version_id optional | string | Secret 버전 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
9.5.1.11 - Show Secret Detail
9.5.1.11.1 - 1.0
scpcli secretsmanager secret show
--secret_id <value>
Description
Secret 상세정보 보기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 계정 id | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Secret 접근허용 CIDR 리스트 | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Secret 설명 | description |
| kms_id | Key Management Service 상품에서 생성한 자원 ID | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | KMS 키 이름 | kmsname |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 키 이름 | my-secret-name |
| recent_searched_at | 최근 검색일 | 2025-02-25 03:07:17.000 |
| state | 키 상태(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Secret 타입 | General |
9.5.1.12 - Show Secret Value
9.5.1.12.1 - 1.0
scpcli secretsmanager secret show value
--secret_id <value>
[--label <value>]
[--version_id <value>]
Description
Secret value 보기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| label optional | string | Secret 버전 라벨. 중복 불가. | CURRENT |
| version_id optional | string | Secret 버전 아이디 | e7b638507d9f4feeb6032a22b7640bf7 |
Responses
| Name | Description | Example |
|---|---|---|
| secret_value | Secret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다. | {“key1”:“value1”,“key2”:“value2”} |
9.5.1.13 - Update Secret Value
9.5.1.13.1 - 1.0
scpcli secretsmanager secret update value
--secret_id <value>
--secret_value <value>
Description
Secret value 업데이트
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret 아이디 | 3265ab469f0d406d83073da3e11e7a6c |
| secret_value required | string | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {"key1":"value1","key2":"value2"} |
10 - Management
10.1 - Cloud Control
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 CloudControl 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
10.1.1 - CLIs
10.1.1.1 - AddBaselineAssignment
10.1.1.1.1 - 1.0
scpcli cloudcontrol baseline assignment add
--assignment_id <value>
--resource_type <value>
--landing_zone_id <value>
[--agree_yn <value>]
[--parent_unit_id <value>]
[--sso_user_name <value>]
[--sso_user_real_name <value>]
Description
add a new baseline assignment
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| assignment_id required | string | 루트/조직 단위/계정 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| resource_type required | string | OU/ACCOUNT | OU |
| landing_zone_id required | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn optional | **** | 약관 동의 여부 | Y |
| parent_unit_id optional | string | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| sso_user_name optional | string | ID Center 사용자명 | testuser |
| sso_user_real_name optional | string | ID Center 사용자 실명 | test user |
Responses
| Name | Description | Example |
|---|---|---|
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
| resource_id | 루트/조직 단위/계정 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| resource_type | OU/ACCOUNT | OU |
10.1.1.2 - CreateAccountFactoryAccount
10.1.1.2.1 - 1.0
scpcli cloudcontrol account create from factory
--parent_unit_id <value>
--name <value>
--landing_zone_id <value>
[--email <value>]
[--sso_user_email <value>]
[--sso_user_name <value>]
[--sso_user_real_name <value>]
Description
create an account using account factory.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_unit_id required | string | 상위 조직 단위 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| name required | string | 계정명 | foo-account |
| landing_zone_id required | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| email optional | string | 계정 이메일 | myaccount@example.com |
| sso_user_email optional | string | ID Center 사용자 이메일 | user_email@example.com |
| sso_user_name optional | string | ID Center 사용자 이름 | John Doe |
| sso_user_real_name optional | string | ID Center 사용자 실명 | John Doe |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | 조직 계정 ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
10.1.1.3 - CreateLandingZone
10.1.1.3.1 - 1.0
scpcli cloudcontrol landing zone create
--sso_type <value>
--log_archive_login_id <value>
--log_archive_account_name <value>
--basic_ou_name <value>
--audit_login_id <value>
--audit_account_name <value>
--agree_yn <value>
--additional_ou_name <value>
Description
Create a landing zone
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sso_type required | string | Account 액세스 구성 | ID_CENTER |
| log_archive_login_id required | string | 로그인 ID | log-archive@samsung.com |
| log_archive_account_name required | string | 로그 아카이브 계정명 | LOG_ARCHIVE |
| basic_ou_name required | string | 기본 조직 단위명 | Security |
| audit_login_id required | string | 로그인 ID | audit@samsung.com |
| audit_account_name required | string | 감사 계정명 | AUDIT |
| agree_yn required | string | 약관 동의 여부 | Y |
| additional_ou_name required | string | 추가 조직 단위명 | Sandbox |
Responses
| Name | Description | Example |
|---|---|---|
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
| landing_zone_id | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
10.1.1.4 - DeleteLandingZone
10.1.1.4.1 - 1.0
scpcli cloudcontrol landing zone delete
--landing_zone_id <value>
Description
Delete a landing zone
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id required | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
10.1.1.5 - DisableGuardrailBindings
10.1.1.5.1 - 1.0
scpcli cloudcontrol guardrail disable
--unit_ids <value>
--guardrail_ids <value>
[--landing_zone_id <value>]
Description
disable guardrail bindings
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_ids required | array | 타겟 정보 | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| guardrail_ids required | array | 가드레일 목록 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
10.1.1.6 - EnableGuardrailBindings
10.1.1.6.1 - 1.0
scpcli cloudcontrol guardrail enable
--unit_ids <value>
--guardrail_ids <value>
[--landing_zone_id <value>]
Description
enable guardrail bindings
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_ids required | array | 타겟 정보 | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| guardrail_ids required | array | 가드레일 목록 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | error code | CloudControl.AlreadyEnabledGuardrails |
| failed_caused | 실패 원인 | guardrail already enabled |
| guardrail_id | 가드레일 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| unit_id | 타겟 ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
10.1.1.7 - ListBaselineAssignments
10.1.1.7.1 - 1.0
scpcli cloudcontrol baseline assignment list
[--landing_zone_id <value>]
[--resource_type <value>]
[--assignment_id <value>]
[--status <value>]
Description
get baseline assignment list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| resource_type optional | **** | OU/ACCOUNT | OU |
| assignment_id optional | string | 루트/조직 단위/계정 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| status optional | **** | 상태 | REGISTRATION_FAILED |
Responses
| Name | Description | Example |
|---|---|---|
| id | 루트/조직 단위/계정 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| account_assigned_count | 등록된 계정 수 | 3 |
| account_count | 전체 계정 수 | 4 |
| ou_assigned_count | 등록된 조직 단위 수 | 5 |
| ou_count | 전체 조직 단위 수 | 10 |
| preventive_guardrail_activated_count | 활성화된 예방 가드레일 수 | 8 |
| sso_user_name | ID Center 사용자명 | testuser |
| status | 상태 | REGISTERED |
| type | OU/ACCOUNT | OU |
10.1.1.8 - ListGuardrails
10.1.1.8.1 - 1.0
scpcli cloudcontrol guardrail list
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--exclude_unit_id <value>]
[--guidance <value>]
[--service_name <value>]
[--status <value>]
Description
get guardrails list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 가드레일명 | foo-guardrail |
| exclude_unit_id optional | string | 연결된(제외) 유닛 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| guidance optional | string | 정책 가이드 | MANDATORY |
| service_name optional | string | Organization | iam |
| status optional | string | 적용 상태 | ENABLED |
Responses
| Name | Description | Example |
|---|---|---|
| id | 가드레일 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| binding_ous | ||
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| description | 가드레일 설명 | This is an example guardrail. |
| guidance | 정책 가이드 | MANDATORY |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| name | 가드레일명 | foo-guardrail |
| service_name | Organization | iam |
| srn | 가드레일 SRN | srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 |
| status | 적용 상태 | |
| type | 가드레일 유형 | PREVENTIVE |
10.1.1.9 - ListGuardrailsForTarget
10.1.1.9.1 - 1.0
scpcli cloudcontrol target guardrail list
--target_id <value>
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
list guardrails for target
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_id required | string | 타겟 ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 가드레일명 | guardrail-example |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| guidance | 정책 가이드 | MANDATORY |
| link_types | 연결 유형 | {‘directed’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’}], ‘inherited’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’}]} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| name | 가드레일명 | foo-guardrail |
| service_name | Organization | iam |
| type | 가드레일 유형 | PREVENTIVE |
10.1.1.10 - ListTargetsForGuardrail
10.1.1.10.1 - 1.0
scpcli cloudcontrol guardrail target list
--target_type <value>
--guardrail_id <value>
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
list targets for guardrail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_type required | **** | 타겟유형 | ACCOUNT |
| guardrail_id required | string | 가드레일 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 타겟명 | ou-test |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 계정 ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| 계정 이메일 | score@samsung.com | |
| name | 계정명 | score-account |
| parent_unit_id | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | ROOT 또는 부모 조직 단위명 | parent-unit-name |
10.1.1.11 - ShowGuardrail
10.1.1.11.1 - 1.0
scpcli cloudcontrol guardrail show
--guardrail_id <value>
[--landing_zone_id <value>]
Description
show a specific guardrail.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| guardrail_id required | string | 가드레일 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 가드레일 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| binding_ous | ||
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| description | 가드레일 설명 | This is an example guardrail. |
| guidance | 정책 가이드 | MANDATORY |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| name | 가드레일명 | foo-guardrail |
| service_name | Organization | iam |
| srn | 가드레일 SRN | srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 |
| status | 적용 상태 | |
| type | 가드레일 유형 | PREVENTIVE |
10.1.1.12 - ShowLandingZone
10.1.1.12.1 - 1.0
scpcli cloudcontrol landing zone show
--landing_zone_id <value>
Description
Show a landing zone
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id required | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn | 약관 동의 여부 | Y |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| identity_center_id | Identity Center ID | 0xnw6g1xh2q5 |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | 리전 | kr-west1 |
| service_name | 서비스명 | Cloud Control |
| srn | 랜딩 존 SRN | srn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b |
| sso_type | Account 액세스 구성 | ID_CENTER |
| status | 상태 | ACTIVE |
| version_id | 랜딩 존 버전 | 1.0 |
10.1.1.13 - UpdateBaselineAssignment
10.1.1.13.1 - 1.0
scpcli cloudcontrol baseline assignment update
--assignment_id <value>
--landing_zone_id <value>
[--agree_yn <value>]
Description
update a specific baseline assignment.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| assignment_id required | string | 루트/조직 단위/계정 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| landing_zone_id required | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn optional | **** | 약관 동의 여부 | Y |
10.2.1 - CLIs
10.2.1.1 - CreateEventPolicy
10.2.1.1.1 - 1.0
scpcli cloudmonitoring event eventpolicy create
--value <value>
--comparisonoperator <value>
--minvalue <value>
--mincomparisonoperator <value>
--maxvalue <value>
--maxcomparisonoperator <value>
--thresholdtype <value>
--eventpolicystatisticstype <value>
--eventpolicystatisticsperiod <value>
--metrickey <value>
--islogmetric <value>
--ftcount <value>
--eventlevel <value>
--disableyn <value>
--productresourceid <value>
[--notificationrecipients <value>]
[--eventmessageprefix <value>]
[--eventoccurtimezone <value>]
[--metricname <value>]
[--objectdisplayname <value>]
[--objectname <value>]
[--objecttype <value>]
[--podobjectdisplayname <value>]
[--podobjectname <value>]
[--metricfunction <value>]
--x-resourcetype <value>
Description
Create Event Policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| value required | number | 값 | 10 |
| comparisonoperator required | string | 비교 연산자 | LT |
| minvalue required | number | 최소 값 | 80 |
| mincomparisonoperator required | string | 최소 비교 연산자 | GT |
| maxvalue required | number | 최대 값 | 90 |
| maxcomparisonoperator required | string | 최대 비교 연산자 | LT |
| thresholdtype required | string | 임계치 유형 - 임계치를 범위로 지정할 경우에는 “RANGE_VALUE"를, 임계치를 단일값으로 지정할 경우에는 “SINGLE_VALUE” 지정해야 합니다. | RANGE_VALUE |
| eventpolicystatisticstype required | string | 이벤트 정책 통계 유형 | MAX |
| eventpolicystatisticsperiod required | integer | 이벤트 정책 통계 기간 - 단위: 분 | 10 |
| metrickey required | string | 메트릭 키 | system.diskio.read.bytes |
| islogmetric required | string | 로그 메트릭 여부 | N |
| ftcount required | integer | 결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값 | 3 |
| eventlevel required | string | 이벤트 레벨 | WARNING |
| disableyn required | string | swagger.event.eventPolicyResponse.disableYn.value | N |
| productresourceid required | string | Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources]. | INSTANCE-c4Hsd27ttDaLw533X4B6Sp |
| notificationrecipients optional | array | 이벤트 알림 수신인 정보 - 알림 대상자 정보는 10개까지 지정할 수 있습니다. | '{"notificationMethods": [{"eventLevel": "FATAL", "notificationMethod": "", "sendMethod": ["MAIL"]}], "recipientKey": "1347", "recipientType": "USER"}' |
| eventmessageprefix optional | string | 이벤트 메시지 접두사 | SCP |
| eventoccurtimezone optional | string | swagger.event.eventPolicyResponse.eventOccurTimeZone.value | GMT+9 |
| metricname optional | string | - | |
| objectdisplayname optional | string | 오브젝트 이름 | dm0 |
| objectname optional | string | 오브젝트 이름 | dm0 |
| objecttype optional | string | 개별항목 유형 | SCP |
| podobjectdisplayname optional | string | swagger.event.eventPolicyResponse.podObjectDisplayName.value | dm0 |
| podobjectname optional | string | swagger.event.eventPolicyResponse.podObjectName.value | dm0 |
| metricfunction optional | string | 메트릭 함수 - 유효한 값: [delta] - 이벤트 발생 여부를 판단하기 위해 성능항목의 현재 값을 사용할지, 이전 값과 현재 값의 차이를 사용할지를 지정합니다. - 이전 값과 현재 값의 차이를 사용하고자 할 경우에만 delta로 지정합니다. | delta |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| eventPolicyStatisticsPeriod | 이벤트 정책 통계 기간 - 단위: 분 | 10 |
| eventPolicyStatisticsType | 이벤트 정책 통계 유형 | MAX |
10.2.1.2 - DeleteEventPolicy
10.2.1.2.1 - 1.0
scpcli cloudmonitoring event eventpolicy delete
--eventpolicyid <value>
--x-resourcetype <value>
Description
Delete Event policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventpolicyid required | integer | Event policy ID to delete - Event Policy ID can be viewed using @[ListEventPolicies]. | 7226 |
| x-resourcetype required | string | Resource Type | - |
10.2.1.3 - ListAccountEvents
10.2.1.3.1 - 1.0
scpcli cloudmonitoring event accountevent list
--queryenddt <value>
--querystartdt <value>
--eventstate <value>
[--page <value>]
[--size <value>]
[--sort <value>]
Description
Search Account Event List
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queryenddt required | string | Query End Date | 2021-10-23T23:59:59.000Z |
| querystartdt required | string | Query Start Date | 2021-10-23T18:00:00.000Z |
| eventstate required | string | Event State | ALL |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| durationSecond | 이벤트 지속 시간 - 단위: 초 | 100 |
| endDt | 종료일시 | 2021-10-23T23:59:59Z |
| eventId | 이벤트 아이디 | |
| eventLevel | 이벤트 레벨 | FATAL |
| eventMessage | 이벤트 메시지 | |
| eventPolicyId | 이벤트 정책 아이디 | 7240 |
| eventState | Event State | ACTIVE |
| metricKey | 메트릭 키 | system.cpu.system.norm.pct |
| metricName | 메트릭 이름 | system.cpu.system.norm.pct |
| objectDisplayName | 오브젝트 이름 | CPU0 |
| objectName | 오브젝트 이름 | CPU0 |
| objectType | 개별항목 유형 | cluster |
| objectTypeName | 개별항목 유형 이름 | cluster |
| productResourceId | 상품 리소스 아이디 | INSTANCE-c4Hsd27ttDaLw533X4B6Sp |
| productTargetType | 메트릭 대상 유형 | system.core.id 별 |
| productTargetTypeEn | 메트릭 대상 유형 | By system.core.id |
| productTypeName | 상품 유형 이름 | Virtual Server |
| startDt | 시작일시 | 2021-10-23T18:00:00Z |
10.2.1.4 - ListAccountMember
10.2.1.4.1 - 1.0
scpcli cloudmonitoring product accountmember list
[--page <value>]
[--size <value>]
[--sort <value>]
Description
Search members included in an Account.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| companyName | swagger.product.ProjectMemberDto.companyName.value | 삼성SDS |
| createdBy | swagger.product.ProjectMemberDto.createdBy.value | 469 |
| createdByEmail | swagger.product.ProjectMemberDto.createdByEmail.value | soonshin.lee@cloud.com |
| createdByName | swagger.product.ProjectMemberDto.createdByName.value | 이순신 |
| createdDt | swagger.product.ProjectMemberDto.userTimezone.value | 2021-08-06T10:23:41.547Z |
| swagger.product.ProjectMemberDto.userEmail.value | kdhong@cloud.com | |
| lastAccessDt | swagger.product.ProjectMemberDto.lastAccessDt.value | 2022-11-06T10:23:41.547Z |
| modifiedBy | swagger.product.ProjectMemberDto.modifiedBy.value | 469 |
| modifiedByEmail | swagger.product.ProjectMemberDto.modifiedByEmail.value | soonshin.lee@cloud.com |
| modifiedByName | swagger.product.ProjectMemberDto.modifiedByName.value | 이순신 |
| modifiedDt | swagger.product.ProjectMemberDto.modifiedDt.value | 2021-08-06T10:23:41.547Z |
| organizationId | swagger.product.ProjectMemberDto.organizationId.value | |
| positionName | swagger.product.ProjectMemberDto.positionName.value | 프로 |
| userGroupCount | swagger.product.ProjectMemberDto.userGroupCount.value | 10 |
| userId | swagger.product.ProjectMemberDto.userId.value | 1984 |
| userName | swagger.product.ProjectMemberDto.userName.value | 홍길동 |
10.2.1.5 - ListAccountResources
10.2.1.5.1 - 1.0
scpcli cloudmonitoring product accountresource list
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>
Description
Search Resource included in an Account.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| accountId | 프로젝트 아이디 | UqXgOSnoqOfKB0_LKO6xId |
| endDt | 상품 삭제 일시 | 9999-12-31T23:59:59.999Z |
| lastEventLevel | 최종 이벤트 레벨 | WARNING |
| poolName | 풀 이름 | POOL-A8-C1DpGqRdQMlfNXdJxLb |
| productIpAddress | 상품 IP주소 | 192.168.245.161 |
| productName | 상품 이름 | VM-Server-01 |
| productResourceId | 상품 리소스 아이디 | INSTANCE-c4Hsd27ttDaLw533X4B6Sp |
| productState | 상품 상태 - 유효한 값 : Running, Down | Running |
| productTypeCode | 상품 유형코드 | VM |
| productTypeName | 상품 유형이름 | Virtual Server |
| startDt | 상품 생성 일시 | 2021-10-23T08:30:00Z |
10.2.1.6 - ListAddressBookMembers
10.2.1.6.1 - 1.0
scpcli cloudmonitoring product addressbookmember list
--addrbookid <value>
[--page <value>]
[--size <value>]
[--sort <value>]
Description
Search address book members
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| addrbookid required | integer | Address book ID - Address book IDs can be obtained from @[ListAddressBooks]. | - |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| userEmail | 사용자 이메일 | kdhong@cloud.com |
| userId | 사용자 리소스 아이디 | 1346 |
| userLanguage | 사용자 언어 | ko |
| userMobileTelNo | 사용자 휴대전화번호 | 010-0000-0000 |
| userName | 사용자 이름 | 홍길동 |
| userTimezone | 사용자 타임존 | Asia/Seoul |
10.2.1.7 - ListAddressBooks
10.2.1.7.1 - 1.0
scpcli cloudmonitoring product addressbook list
[--page <value>]
[--size <value>]
[--sort <value>]
Description
Search a list of address books created by user.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| addrBookName | 주소록 이름 | contact name |
| addrbookId | 주소록 아이디 | 74 |
| createdBy | 생성자 아이디 | 1984 |
| createdByName | 생성자 이름 | 김삼성 |
| createdDt | 생성 일시 | 2021-10-23T22:00:00Z |
| memberCount | 멤버 수 | 10 |
10.2.1.8 - ListEventPolicies
10.2.1.8.1 - 1.0
scpcli cloudmonitoring event eventpolicy list
--productresourceid <value>
[--metrickey <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>
Description
Search Event Policies
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| productresourceid required | string | Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources]. | c94607c8-6a15-4e13-84f3-99cb77d478e3 |
| metrickey optional | string | Metric Key - Metric Key can be viewed using @[ListMetrics]. | system.cpu.system.pct |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| checkAsg | ||
| createBy | ||
| createById | ||
| eventLevel | 이벤트 레벨 | WARNING |
| eventMessagePrefix | 이벤트 메시지 접두사 | SCP |
| eventOccurTimeZone | swagger.event.eventPolicyResponse.eventOccurTimeZone.value | GMT+9 |
| eventPolicyId | 이벤트 정책 아이디 | 7226 |
| eventPolicyStatistics | ||
| eventThreshold | ||
| ftCount | 결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값 | 3 |
| isLogMetric | 로그 메트릭 여부 | N |
| metricDescription | 메트릭 설명 | 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%) |
| metricDescriptionEn | 메트릭 설명 | Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%) |
| metricKey | 메트릭 키 | system.cpu.system.pct |
| metricName | 메트릭 이름 | system.cpu.system.pct |
| objectName | 오브젝트 이름 | cpu0 |
| productName | 상품 이름 | VM-002 |
| productResourceId | 상품 리소스 아이디 | INSTANCE-c4Hsd27ttDaLw533X4B6Sp |
| productSq | 상품 시퀀스 | 7321 |
| productTargetType | 메트릭 대상 유형 | system.core.id 별 |
| productTargetTypeEn | 메트릭 대상 유형 | By system.core.id |
| updateBy | ||
| updateById |
10.2.1.9 - ListEventPolicyHistories
10.2.1.9.1 - 1.0
scpcli cloudmonitoring event eventpolicyhistory list
--eventpolicyid <value>
--queryenddt <value>
--querystartdt <value>
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>
Description
Search event policy histories
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventpolicyid required | integer | Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies]. | 7226 |
| queryenddt required | string | Query End Date | 2021-10-23T23:59:59.000Z |
| querystartdt required | string | Query Start Date | 2021-10-23T18:00:00.000Z |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| createBy | ||
| createById | ||
| disableObject | swagger.event.eventPolicyResponse.disableObject.value | N |
| disableYn | swagger.event.eventPolicyResponse.disableObject.value | N |
| eventLevel | 이벤트 레벨 | WARNING |
| eventMessagePrefix | 이벤트 메시지 접두사 | SCP |
| eventOccurTimeZone | swagger.event.eventPolicyResponse.eventOccurTimeZone.value | GMT+9 |
| eventPolicyHistoryId | 이벤트 정책 이력 아이디 | 8759 |
| eventPolicyHistoryType | 이벤트 정책 이력 유형 - C : 등록, U : 수정, D : 삭제 | U |
| eventPolicyId | 이벤트 정책 아이디 | 7240 |
| eventPolicyStatistics | ||
| eventThreshold | ||
| ftCount | 결함허용 개수 | 3 |
| metricDescription | 메트릭 설명 | 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%) |
| metricDescriptionEn | 메트릭 설명 | Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%) |
| metricKey | 메트릭 키 | system.cpu.system.pct |
| metricName | 메트릭 이름 | system.cpu.system.pct |
| metricUnit | 메트릭 단위 | % |
| modifiedBy | ||
| modifiedByName | ||
| modifiedDt | ||
| notificationRecipientHistory | ||
| objectDisplayName | 오브젝트 이름 | cpu0 |
| objectName | 오브젝트 이름 | cpu0 |
| objectType | 개별항목 유형 | cluster |
| productName | 상품 이름 | VM-Server-01 |
| productResourceId | 상품 리소스 아이디 | INSTANCE-c4Hsd27ttDaLw533X4B6Sp |
| productTargetType | 메트릭 대상 유형 | system.core.id 별 |
| productTargetTypeEn | 메트릭 대상 유형 | By system.core.id |
| updateBy | ||
| updateById |
10.2.1.10 - ListEventPolicyNotification
10.2.1.10.1 - 1.0
scpcli cloudmonitoring event eventpolicynotification list
--eventpolicyid <value>
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>
Description
Search Event Policy Notification
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventpolicyid required | integer | Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies]. | 7226 |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| addrbookAdditionalInfo | ||
| notificationMethods | 알림 메소드 정보 | |
| recipientKey | 수신인 키 - 수신인 키는 @[프로젝트 멤버 조회] 또는 @[사용자의 주소록 목록 조회]를 이용하여 조회합니다. | 1984 |
| recipientName | 수신인 이름 | 홍길동 |
| recipientType | 수신인 유형 - USER : 사용자, ADDRBOOK : 주소록 | USER |
| userAdditionalInfo |
10.2.1.11 - ListMetricPefData
10.2.1.11.1 - 1.0
scpcli cloudmonitoring product metricperfdata list
--querystartdt <value>
--queryenddt <value>
--metricdataconditions <value>
[--ignoreinvalid <value>]
--x-resourcetype <value>
Description
Search the performance values of the collected metrics. Up to 10 query conditions can be specified, and the maximum query period is 24 hours.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| querystartdt required | string | 조회 시작 일시 | 2022-08-07T23:50:00.000Z |
| queryenddt required | string | 조회 종료 일시 | 2022-08-07T23:59:00.000Z |
| metricdataconditions required | array | 메트릭 데이터 조건 | '{"metricKey": "system.diskio.read.bytes", "objectType": "replicaset", "productResourceInfos": [{"objectList": ["kube-01", "kube-02"], "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp"}], "statisticsPeriod": 5, "statisticsTypeList": ["SUM", "MIN"]}' |
| ignoreinvalid optional | string | 유효하지 않은 값 제외 여부 | Y |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| metricKey | 메트릭 키 | system.filesystem.used.bytes |
| metricName | 메트릭 이름 | system.filesystem.used.bytes |
| metricType | 메트릭 유형 | NUM |
| metricUnit | 메트릭 단위 | bytes |
| objectDisplayName | 개별항목 출력 이름 | dm-1 |
| objectName | 개별항목 이름 | dm-1 |
| objectType | 개별항목 유형 | replicaset |
| perfData | 성능 데이터 | [{’time’: 1627378200000, ‘value’: ‘0.0766’}] |
| productName | 상품의 이름 | VM-Server-01 |
| productResourceId | 상품 리소스 아이디 | INSTANCE-c4Hsd27ttDaLw533X4B6Sp |
| statisticsPeriod | 통계 집계 주기 (단위: 분) | 5 |
| statisticsType | 통계 유형 | SUM |
10.2.1.12 - ListMetrics
10.2.1.12.1 - 1.0
scpcli cloudmonitoring product metric list
[--producttypecode <value>]
[--objecttype <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
View the list of metrics provided by Monitoring. You can view the full list of metrics or the list of metrics for each service type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| producttypecode optional | string | Product type code - Product type codes can be obtained using @[ListServiceMonitoring]. If not specified, the entire metric list will be retrieved. | VM |
| objecttype optional | string | Object Type - Only available for services that have subtypes, such as when the 'productTypeCode' is 'Kubernetes' or 'Load Balancer'. | node |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| disableObject | swagger.product.MetricInfoDto.disableObject.value | N |
| displayUnit | ||
| fixedUnit | 메트릭 단위 (고정) | sec |
| isLogMetric | 로그 메트릭 여부 | N |
| isObjectExist | 개별항목 성능 존재 여부 | Y |
| metricDescription | 메트릭 설명 | 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%) |
| metricDescriptionEn | 메트릭 설명 | Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%) |
| metricKey | 메트릭 키 | system.filesystem.used.bytes |
| metricName | 메트릭 이름 | FileSystem |
| metricOrder | 메트릭 순서 | 1 |
| metricSetKey | swagger.product.MetricInfoDto.metricSetKey.value | system.filesystem |
| metricSetName | 메트릭 세트 이름 | FileSystem |
| metricType | 메트릭 유형 | NUM |
| metricUnit | 메트릭 단위 | bytes |
| objectKeyName | 오브젝트 키 이름 | system.core.iowait.pct |
| objectType | swagger.product.MetricInfoDto.disableObject.value | N |
| objectTypeNameEng | swagger.product.MetricInfoDto.disableObject.value | N |
| objectTypeNameLoc | swagger.product.MetricInfoDto.disableObject.value | N |
| perfTitle | swagger.product.MetricInfoDto.perfTitle.value | File System |
| productTargetType | 메트릭 대상 유형 | system.core.id 별 |
| productTargetTypeEn | 메트릭 대상 유형 | By system.core.id |
| productTypeCode | 상품 유형 코드 | VM |
| productTypeName | 상품 유형 이름 | Virtual Server |
10.2.1.13 - ListResourceEvents
10.2.1.13.1 - 1.0
scpcli cloudmonitoring event resourceevent list
--queryenddt <value>
--querystartdt <value>
--eventstate <value>
--productresourceid <value>
[--metrickey <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>
Description
Search a list of events that occurred on a product resource.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queryenddt required | string | Query End Date | 2021-10-23T23:59:59.000Z |
| querystartdt required | string | Query Start Date | 2021-10-23T18:00:00.000Z |
| eventstate required | string | Event State | ALL |
| productresourceid required | string | Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources]. | INSTANCE-c4Hsd27ttDaLw533X4B6Sp |
| metrickey optional | string | Metric Key - Metric Key can be viewed using @[ListMetrics]. | system.cpu.system.pct |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| durationSecond | 이벤트 지속 시간 - 단위: 초 | 100 |
| endDt | 종료일시 | 2021-10-23T23:59:59Z |
| eventId | 이벤트 아이디 | |
| eventLevel | 이벤트 레벨 | FATAL |
| eventMessage | 이벤트 메시지 | |
| eventPolicyId | 이벤트 정책 아이디 | 7240 |
| eventState | Event State | ACTIVE |
| metricKey | 메트릭 키 | system.cpu.system.norm.pct |
| metricName | 메트릭 이름 | system.cpu.system.norm.pct |
| objectDisplayName | 오브젝트 이름 | CPU0 |
| objectName | 오브젝트 이름 | CPU0 |
| objectType | 개별항목 유형 | cluster |
| objectTypeName | 개별항목 유형 이름 | cluster |
| productResourceId | 상품 리소스 아이디 | INSTANCE-c4Hsd27ttDaLw533X4B6Sp |
| productTargetType | 메트릭 대상 유형 | system.core.id 별 |
| productTargetTypeEn | 메트릭 대상 유형 | By system.core.id |
| productTypeName | 상품 유형 이름 | Virtual Server |
| startDt | 시작일시 | 2021-10-23T18:00:00Z |
10.2.1.14 - ListService
10.2.1.14.1 - 1.0
scpcli cloudmonitoring product service list
[--productcategorycode <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
Description
Search a list of product types supported by monitoring.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| productcategorycode optional | string | Product type category - If not specified, the entire product type code will be retrieved. | Compute |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| parentProductTypeName | 부모 상품 이름 | Compute |
| productTypeCode | 상품 코드 | VM |
| productTypeName | 상품 이름 | Virtual Server |
| stateMetricKey | 상태 메트릭 키 | vsphere.mxvm.runtime.state |
10.2.1.15 - SetEventPolicy
10.2.1.15.1 - 1.0
scpcli cloudmonitoring event eventpolicy set
--eventpolicyid <value>
--value <value>
--comparisonoperator <value>
--minvalue <value>
--mincomparisonoperator <value>
--maxvalue <value>
--maxcomparisonoperator <value>
--thresholdtype <value>
--eventpolicystatisticstype <value>
--eventpolicystatisticsperiod <value>
--ftcount <value>
--eventlevel <value>
--disableyn <value>
[--notificationrecipients <value>]
[--eventmessageprefix <value>]
[--eventoccurtimezone <value>]
[--objectdisplayname <value>]
[--objectname <value>]
[--objecttype <value>]
[--podobjectdisplayname <value>]
[--podobjectname <value>]
[--metricfunction <value>]
--x-resourcetype <value>
Description
Set Event Policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventpolicyid required | integer | Event policy ID to modify - Event Policy ID can be viewed using @[ListEventPolicies]. | 7226 |
| value required | number | 값 | 10 |
| comparisonoperator required | string | 비교 연산자 | LT |
| minvalue required | number | 최소 값 | 80 |
| mincomparisonoperator required | string | 최소 비교 연산자 | GT |
| maxvalue required | number | 최대 값 | 90 |
| maxcomparisonoperator required | string | 최대 비교 연산자 | LT |
| thresholdtype required | string | 임계치 유형 - 임계치를 범위로 지정할 경우에는 “RANGE_VALUE"를, 임계치를 단일값으로 지정할 경우에는 “SINGLE_VALUE” 지정해야 합니다. | RANGE_VALUE |
| eventpolicystatisticstype required | string | 이벤트 정책 통계 유형 | MAX |
| eventpolicystatisticsperiod required | integer | 이벤트 정책 통계 기간 - 단위: 분 | 10 |
| ftcount required | integer | 결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값 | 3 |
| eventlevel required | string | 이벤트 레벨 | WARNING |
| disableyn required | string | swagger.event.eventPolicyResponse.disableYn.value | N |
| notificationrecipients optional | array | 이벤트 알림 수신인 정보 | '{"notificationMethods": [{"eventLevel": "FATAL", "notificationMethod": "", "sendMethod": ["MAIL"]}], "recipientKey": "1347", "recipientType": "USER"}' |
| eventmessageprefix optional | string | 이벤트 메시지 접두사 | SCP |
| eventoccurtimezone optional | string | swagger.event.eventPolicyResponse.eventOccurTimeZone.value | GMT+9 |
| objectdisplayname optional | string | 오브젝트 이름 | cpu0 |
| objectname optional | string | 오브젝트 이름 | cpu0 |
| objecttype optional | string | 개별항목 유형 | cluster |
| podobjectdisplayname optional | string | swagger.event.eventPolicyResponse.podObjectName.value | cpu0 |
| podobjectname optional | string | swagger.event.eventPolicyResponse.podObjectName.value | cpu0 |
| metricfunction optional | string | 메트릭 함수 - 유효한 값: [delta] - 이벤트 발생 여부를 판단하기 위해 성능항목의 현재 값을 사용할지, 이전 값과 현재 값의 차이를 사용할지를 지정합니다. - 이전 값과 현재 값의 차이를 사용하고자 할 경우에만 delta로 지정합니다. | delta |
| x-resourcetype required | string | Resource Type | - |
10.2.1.16 - ShowEventNotificationStates
10.2.1.16.1 - 1.0
scpcli cloudmonitoring event eventnotificationstate show
--eventid <value>
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>
Description
Search Event Notification States
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventid required | string | Event ID - Event ID can be viewed using @[ListResourceEvents]. | - |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| notificationStates | 이벤트 알림 상태 | |
| user | ||
| userEmail | 사용자 이메일 | kdhong@cloud.com |
| userId | 사용자 아이디 | 1984 |
| userMobileTelNo | 사용자 휴대 전화번호 | 010-000-0000 |
| userNameNotification | 사용자 이름 | 홍길동 |
10.2.1.17 - ShowEventPolicy
10.2.1.17.1 - 1.0
scpcli cloudmonitoring event eventpolicy show
--eventpolicyid <value>
--x-resourcetype <value>
Description
Show Event Policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventpolicyid required | integer | Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies]. | 7226 |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| eventPolicyStatisticsPeriod | 이벤트 정책 통계 기간 - 단위: 분 | 10 |
| eventPolicyStatisticsType | 이벤트 정책 통계 유형 | MAX |
10.2.1.18 - ShowResourceEvent
10.2.1.18.1 - 1.0
scpcli cloudmonitoring event resourceevent show
--eventid <value>
--x-resourcetype <value>
Description
Show Resource Event
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventid required | string | Event ID - Event ID can be viewed using @[ListResourceEvents]. | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| checkAsg | ||
| createBy | ||
| createById | ||
| eventLevel | 이벤트 레벨 | WARNING |
| eventMessagePrefix | 이벤트 메시지 접두사 | SCP |
| eventOccurTimeZone | swagger.event.eventPolicyResponse.eventOccurTimeZone.value | GMT+9 |
| eventPolicyId | 이벤트 정책 아이디 | 7226 |
| eventPolicyStatistics | ||
| eventThreshold | ||
| ftCount | 결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값 | 3 |
| isLogMetric | 로그 메트릭 여부 | N |
| metricDescription | 메트릭 설명 | 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%) |
| metricDescriptionEn | 메트릭 설명 | Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%) |
| metricKey | 메트릭 키 | system.cpu.system.pct |
| metricName | 메트릭 이름 | system.cpu.system.pct |
| objectName | 오브젝트 이름 | cpu0 |
| productName | 상품 이름 | VM-002 |
| productResourceId | 상품 리소스 아이디 | INSTANCE-c4Hsd27ttDaLw533X4B6Sp |
| productSq | 상품 시퀀스 | 7321 |
| productTargetType | 메트릭 대상 유형 | system.core.id 별 |
| productTargetTypeEn | 메트릭 대상 유형 | By system.core.id |
| updateBy | ||
| updateById |
10.3 - IAM
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 IAM 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260223 |
| 1.1 | SUPPORTED | 20260531 |
| 1.2 | CURRENT | - |
10.3.1 - CLIs
10.3.1.1 - Add a permission into the resource based policy
10.3.1.1.1 - 1.2
scpcli iam permission add
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]
Description
Add a permission into the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
Responses
| Name | Description | Example |
|---|---|---|
| Statement | Statement | {‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’} |
10.3.1.1.2 - 1.1
scpcli iam permission add
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]
Description
Add a permission into the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
Responses
| Name | Description | Example |
|---|---|---|
| Statement | Statement | {‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’} |
10.3.1.1.3 - 1.0
scpcli iam permission add
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]
Description
Add a permission into the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
Responses
| Name | Description | Example |
|---|---|---|
| Statement | Statement | {‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’} |
10.3.1.2 - Add a user to a group
10.3.1.2.1 - 1.2
scpcli iam group user add
--group_id <value>
--user_id <value>
Description
Add a user to a group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| user_id required | string | Group Member User ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| user_email | User Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_name | User 성, 이름 | Kim Samsung |
10.3.1.2.2 - 1.1
scpcli iam group user add
--group_id <value>
--user_id <value>
Description
Add a user to a group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| user_id required | string | Group Member User ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| user_email | User Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_name | User 성, 이름 | Kim Samsung |
10.3.1.2.3 - 1.0
scpcli iam group user add
--group_id <value>
--user_id <value>
Description
Add a user to a group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| user_id required | string | Group Member User ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| user_email | User Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_name | User 성, 이름 | Kim Samsung |
10.3.1.3 - Assign policies to the group
10.3.1.3.1 - 1.2
scpcli iam group policy create
--group_id <value>
--policy_ids <value>
Description
Assign policies to the group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| policy_ids required | array | Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.3.2 - 1.1
scpcli iam group policy create
--group_id <value>
--policy_ids <value>
Description
Assign policies to the group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| policy_ids required | array | Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.3.3 - 1.0
scpcli iam group policy create
--group_id <value>
--policy_ids <value>
Description
Assign policies to the group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| policy_ids required | array | Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.4 - Assign policies to user
10.3.1.4.1 - 1.2
scpcli iam user policy create
--user_id <value>
[--policy_ids <value>]
Description
Assign policies to user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | 사용자 ID | - |
| policy_ids optional | array | User Policy Bindings | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.4.2 - 1.1
scpcli iam user policy create
--user_id <value>
[--policy_ids <value>]
Description
Assign policies to user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | 사용자 ID | - |
| policy_ids optional | array | User Policy Bindings | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.4.3 - 1.0
scpcli iam user policy create
--user_id <value>
[--policy_ids <value>]
Description
Assign policies to user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | 사용자 ID | - |
| policy_ids optional | array | User Policy Bindings | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.5 - Attach policies to Role
10.3.1.5.1 - 1.2
scpcli iam role policy binding attach
--role_id <value>
--policy_ids <value>
Description
Attach policies to Role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| policy_ids required | array | Policy ID List | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.5.2 - 1.1
scpcli iam role policy binding attach
--role_id <value>
--policy_ids <value>
Description
Attach policies to Role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| policy_ids required | array | Policy ID List | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.5.3 - 1.0
scpcli iam role policy binding attach
--role_id <value>
--policy_ids <value>
Description
Attach policies to Role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| policy_ids required | array | Policy ID List | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.6 - Create a group
10.3.1.6.1 - 1.2
scpcli iam group create
--name <value>
--description <value>
[--policy_ids <value>]
[--tags <value>]
[--user_ids <value>]
Description
Create a group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group 이름 | TestGroup |
| description required | string | Group 설명 | Descriptions for group |
| policy_ids optional | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
| tags optional | array | Group Tag | {'key': 'company', 'value': 'SDS'} |
| user_ids optional | array | Group Member User ID List | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| description | Group 설명 | Descriptions for group |
| domain_name | 도메인 이름 | scp |
| members | Project Group Member List | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| name | Group 이름 | TestGroup |
| policies | Policy | [] |
| resource_type | 리소스 명 | group |
| roles | Role 정보 | [] |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | 서비스 명 | iam |
| srn | Group SRN | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Type | USER_DEFINED |
10.3.1.6.2 - 1.1
scpcli iam group create
--name <value>
--description <value>
[--policy_ids <value>]
[--tags <value>]
[--user_ids <value>]
Description
Create a group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group 이름 | TestGroup |
| description required | string | Group 설명 | Descriptions for group |
| policy_ids optional | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
| tags optional | array | Group Tag | {'key': 'company', 'value': 'SDS'} |
| user_ids optional | array | Group Member User ID List | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| description | Group 설명 | Descriptions for group |
| domain_name | 도메인 이름 | scp |
| members | Project Group Member List | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| name | Group 이름 | TestGroup |
| policies | Policy | [] |
| resource_type | 리소스 명 | group |
| roles | Role 정보 | [] |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | 서비스 명 | iam |
| srn | Group SRN | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Type | USER_DEFINED |
10.3.1.6.3 - 1.0
scpcli iam group create
--name <value>
--description <value>
[--policy_ids <value>]
[--tags <value>]
[--user_ids <value>]
Description
Create a group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group 이름 | TestGroup |
| description required | string | Group 설명 | Descriptions for group |
| policy_ids optional | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
| tags optional | array | Group Tag | {'key': 'company', 'value': 'SDS'} |
| user_ids optional | array | Group Member User ID List | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| description | Group 설명 | Descriptions for group |
| domain_name | 도메인 이름 | scp |
| members | Project Group Member List | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| name | Group 이름 | TestGroup |
| policies | Policy | [] |
| resource_type | 리소스 명 | group |
| roles | Role 정보 | [] |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | 서비스 명 | iam |
| srn | Group SRN | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Type | USER_DEFINED |
10.3.1.7 - Create a policy
10.3.1.7.1 - 1.2
scpcli iam policy create
--version <value>
--statement <value>
--policy_name <value>
[--default_version_id <value>]
[--description <value>]
[--policy_category <value>]
[--policy_type <value>]
[--service_type <value>]
[--tags <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]
Description
Create a policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_name required | string | Policy Name | PolicyName |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_category optional | string | Policy Category | IDENTITY_BASED |
| policy_type optional | string | Policy Type | USER_DEFINED |
| service_type optional | string | Service Type | scp-iam |
| tags optional | array | Policy Tag | {'key': 'foo', 'value': 'bar'} |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-1 |
10.3.1.7.2 - 1.1
scpcli iam policy create
--version <value>
--statement <value>
--policy_name <value>
[--default_version_id <value>]
[--description <value>]
[--policy_category <value>]
[--policy_type <value>]
[--service_type <value>]
[--tags <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]
Description
Create a policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_name required | string | Policy Name | PolicyName |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_category optional | string | Policy Category | IDENTITY_BASED |
| policy_type optional | string | Policy Type | USER_DEFINED |
| service_type optional | string | Service Type | scp-iam |
| tags optional | array | Policy Tag | {'key': 'foo', 'value': 'bar'} |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-1 |
10.3.1.7.3 - 1.0
scpcli iam policy create
--version <value>
--statement <value>
--policy_name <value>
[--default_version_id <value>]
[--description <value>]
[--policy_category <value>]
[--policy_type <value>]
[--service_type <value>]
[--tags <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]
Description
Create a policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_name required | string | Policy Name | PolicyName |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_category optional | string | Policy Category | IDENTITY_BASED |
| policy_type optional | string | Policy Type | USER_DEFINED |
| service_type optional | string | Service Type | scp-iam |
| tags optional | array | Policy Tag | {'key': 'foo', 'value': 'bar'} |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-1 |
10.3.1.8 - Create a saml provider
10.3.1.8.1 - 1.2
scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]
Description
Create a saml provider
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | 자격증명공급자 이름 | IdpTest |
| federation_type required | string | 자격증명공급자 유형 | SAML |
| description optional | string | 자격증명공급자 설명 | SAML provider Description |
| file optional | string | 메타데이터 파일 | keycloak-idp-saml.xml |
| tags optional | array | 태그 | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 | |
| description | 자격증명공급자 설명 | |
| federation_type | 자격증명공급자 유형 | |
| idp_cert_end | 유효기간 | |
| idp_file_name | 메타데이터 파일 이름 | |
| idp_file_size | 메타데이터 파일 크기 | |
| idp_issuer_url | 발행자 URL | |
| idp_sso_url | SSO 서비스 위치 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 | |
| saml_provider_name | 자격증명공급자 이름 |
10.3.1.8.2 - 1.1
scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]
Description
Create a saml provider
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | 자격증명공급자 이름 | IdpTest |
| federation_type required | string | 자격증명공급자 유형 | SAML |
| description optional | string | 자격증명공급자 설명 | SAML provider Description |
| file optional | string | 메타데이터 파일 | keycloak-idp-saml.xml |
| tags optional | array | 태그 | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 | |
| description | 자격증명공급자 설명 | |
| federation_type | 자격증명공급자 유형 | |
| idp_cert_end | 유효기간 | |
| idp_file_name | 메타데이터 파일 이름 | |
| idp_file_size | 메타데이터 파일 크기 | |
| idp_issuer_url | 발행자 URL | |
| idp_sso_url | SSO 서비스 위치 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 | |
| saml_provider_name | 자격증명공급자 이름 |
10.3.1.8.3 - 1.0
scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]
Description
Create a saml provider
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | 자격증명공급자 이름 | IdpTest |
| federation_type required | string | 자격증명공급자 유형 | SAML |
| description optional | string | 자격증명공급자 설명 | SAML provider Description |
| file optional | string | 메타데이터 파일 | keycloak-idp-saml.xml |
| tags optional | array | 태그 | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 | |
| description | 자격증명공급자 설명 | |
| federation_type | 자격증명공급자 유형 | |
| idp_cert_end | 유효기간 | |
| idp_file_name | 메타데이터 파일 이름 | |
| idp_file_size | 메타데이터 파일 크기 | |
| idp_issuer_url | 발행자 URL | |
| idp_sso_url | SSO 서비스 위치 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 | |
| saml_provider_name | 자격증명공급자 이름 |
10.3.1.9 - Create an access key
10.3.1.9.1 - 1.2
scpcli iam access-key create
--access_key_type <value>
[--account_id <value>]
[--description <value>]
[--duration <value>]
[--parent_access_key_id <value>]
[--passcode <value>]
Description
Create an access key
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_type required | string | Access key type | PERMANENT |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| description optional | string | Description | description |
| duration optional | string | Expiration duration | P1Y2M10DT2H30M15S |
| parent_access_key_id optional | string | Required access key for creating temporary access key | 92d6eid9e9ae4f868s842910k11573a3 |
| passcode optional | string | Required for temporary access key | 000000 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access key type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access key expiration timestamp | 9999-12-31T23:59:59Z |
| is_enabled | 활성화 여부 | true |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent access key ID which is used for temporary access key to create by | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-f7c6-46bc-9faa-d2b9d20e0899 |
10.3.1.9.2 - 1.1
scpcli iam access-key create
--access_key_type <value>
[--account_id <value>]
[--description <value>]
[--duration <value>]
[--parent_access_key_id <value>]
[--passcode <value>]
Description
Create an access key
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_type required | string | Access key type | PERMANENT |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| description optional | string | Description | description |
| duration optional | string | Expiration duration | P1Y2M10DT2H30M15S |
| parent_access_key_id optional | string | Required access key for creating temporary access key | 92d6eid9e9ae4f868s842910k11573a3 |
| passcode optional | string | Required for temporary access key | 000000 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access key type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access key expiration timestamp | 9999-12-31T23:59:59Z |
| is_enabled | 활성화 여부 | true |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent access key ID which is used for temporary access key to create by | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-f7c6-46bc-9faa-d2b9d20e0899 |
10.3.1.9.3 - 1.0
scpcli iam access-key create
--access_key_type <value>
[--account_id <value>]
[--description <value>]
[--duration <value>]
[--parent_access_key_id <value>]
[--passcode <value>]
Description
Create an access key
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_type required | string | Access key type | PERMANENT |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| description optional | string | Description | description |
| duration optional | string | Expiration duration | P1Y2M10DT2H30M15S |
| parent_access_key_id optional | string | Required access key for creating temporary access key | 92d6eid9e9ae4f868s842910k11573a3 |
| passcode optional | string | Required for temporary access key | 000000 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access key type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access key expiration timestamp | 9999-12-31T23:59:59Z |
| is_enabled | 활성화 여부 | true |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent access key ID which is used for temporary access key to create by | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-f7c6-46bc-9faa-d2b9d20e0899 |
10.3.1.10 - Create IAM user
10.3.1.10.1 - 1.2
scpcli iam iam user create
--account_id <value>
--user_name <value>
--temporary_password <value>
--password <value>
[--description <value>]
[--group_ids <value>]
[--policy_ids <value>]
[--tags <value>]
Description
Create IAM user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID | - |
| user_name required | string | 사용자 이름 | - |
| temporary_password required | boolean | temporary | - |
| password required | string | 비밀 번호 | - |
| description optional | string | description | - |
| group_ids optional | array | Group IDs | - |
| policy_ids optional | array | Policy IDs | - |
| tags optional | array | User Tag | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.10.2 - 1.1
scpcli iam iam user create
--account_id <value>
--user_name <value>
--temporary_password <value>
--password <value>
[--description <value>]
[--group_ids <value>]
[--policy_ids <value>]
[--tags <value>]
Description
Create IAM user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID | - |
| user_name required | string | 사용자 이름 | - |
| temporary_password required | boolean | temporary | - |
| password required | string | 비밀 번호 | - |
| description optional | string | description | - |
| group_ids optional | array | Group IDs | - |
| policy_ids optional | array | Policy IDs | - |
| tags optional | array | User Tag | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.10.3 - 1.0
scpcli iam iam user create
--account_id <value>
--user_name <value>
--temporary_password <value>
--password <value>
[--description <value>]
[--group_ids <value>]
[--policy_ids <value>]
[--tags <value>]
Description
Create IAM user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID | - |
| user_name required | string | 사용자 이름 | - |
| temporary_password required | boolean | temporary | - |
| password required | string | 비밀 번호 | - |
| description optional | string | description | - |
| group_ids optional | array | Group IDs | - |
| policy_ids optional | array | Policy IDs | - |
| tags optional | array | User Tag | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.11 - Create role
10.3.1.11.1 - 1.2
scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]
Description
Create role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | 역할에 연결할 정책 ID 목록 | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | 역할명 | - |
| account_id optional | string | 역할이 속한 계정의 ID | - |
| description optional | string | 역할 설명 | - |
| max_session_duration optional | integer | 역할 세션 최대 지속 시간(초) | 3600 |
| principals optional | array | 신뢰 정책 수행 주체 목록 | '{"type": "", "value": ""}' |
| tags optional | array | 역할 태그 | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | 역할이 속한 계정의 ID | |
| assume_role_policy_document | 역할 신뢰 정책 | |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | |
| creator_name | 생성자 성, 이름 | |
| description | 역할 설명 | |
| max_session_duration | 역할 세션 최대 지속 시간(초) | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | |
| modifier_name | 수정자 성, 이름 | |
| name | 역할명 | |
| policies | 역할에 연결된 정책 목록 | |
| type | 역할 유형 |
10.3.1.11.2 - 1.1
scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]
Description
Create role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | 역할에 연결할 정책 ID 목록 | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | 역할명 | - |
| account_id optional | string | 역할이 속한 계정의 ID | - |
| description optional | string | 역할 설명 | - |
| max_session_duration optional | integer | 역할 세션 최대 지속 시간(초) | 3600 |
| principals optional | array | 신뢰 정책 수행 주체 목록 | '{"type": "", "value": ""}' |
| tags optional | array | 역할 태그 | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | 역할이 속한 계정의 ID | |
| assume_role_policy_document | 역할 신뢰 정책 | |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | |
| creator_name | 생성자 성, 이름 | |
| description | 역할 설명 | |
| max_session_duration | 역할 세션 최대 지속 시간(초) | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | |
| modifier_name | 수정자 성, 이름 | |
| name | 역할명 | |
| policies | 역할에 연결된 정책 목록 | |
| type | 역할 유형 |
10.3.1.11.3 - 1.0
scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]
Description
Create role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | 역할에 연결할 정책 ID 목록 | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | 역할명 | - |
| account_id optional | string | 역할이 속한 계정의 ID | - |
| description optional | string | 역할 설명 | - |
| max_session_duration optional | integer | 역할 세션 최대 지속 시간(초) | 3600 |
| principals optional | array | 신뢰 정책 수행 주체 목록 | '{"type": "", "value": ""}' |
| tags optional | array | 역할 태그 | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | 역할이 속한 계정의 ID | |
| assume_role_policy_document | 역할 신뢰 정책 | |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | |
| creator_name | 생성자 성, 이름 | |
| description | 역할 설명 | |
| max_session_duration | 역할 세션 최대 지속 시간(초) | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | |
| modifier_name | 수정자 성, 이름 | |
| name | 역할명 | |
| policies | 역할에 연결된 정책 목록 | |
| type | 역할 유형 |
10.3.1.12 - Delete bulk role
10.3.1.12.1 - 1.2
scpcli iam role bulk delete
[--account_id <value>]
[--role_ids <value>]
[--role_names <value>]
Description
Delete bulk role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id optional | string | 역할이 속한 계정의 ID | - |
| role_ids optional | array | 역할 ID 목록 | - |
| role_names optional | array | 역할명 목록 | - |
10.3.1.12.2 - 1.1
scpcli iam role bulk delete
[--account_id <value>]
[--role_ids <value>]
[--role_names <value>]
Description
Delete bulk role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id optional | string | 역할이 속한 계정의 ID | - |
| role_ids optional | array | 역할 ID 목록 | - |
| role_names optional | array | 역할명 목록 | - |
10.3.1.12.3 - 1.0
scpcli iam role bulk delete
[--account_id <value>]
[--role_ids <value>]
[--role_names <value>]
Description
Delete bulk role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id optional | string | 역할이 속한 계정의 ID | - |
| role_ids optional | array | 역할 ID 목록 | - |
| role_names optional | array | 역할명 목록 | - |
10.3.1.13 - Delete IAM user
10.3.1.13.1 - 1.2
scpcli iam iam user delete
--user_id <value>
--account_id <value>
Description
Delete IAM user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
10.3.1.13.2 - 1.1
scpcli iam iam user delete
--user_id <value>
--account_id <value>
Description
Delete IAM user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
10.3.1.14 - Delete IAM users
10.3.1.14.1 - 1.2
scpcli iam iam user bulk delete
--account_id <value>
[--user_ids <value>]
Description
Delete IAM users
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID | - |
| user_ids optional | array | 사용자 ID 목록 | - |
10.3.1.14.2 - 1.1
scpcli iam iam user bulk delete
--account_id <value>
[--user_ids <value>]
Description
Delete IAM users
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID | - |
| user_ids optional | array | 사용자 ID 목록 | - |
10.3.1.14.3 - 1.0
scpcli iam iam user bulk delete
--account_id <value>
[--user_ids <value>]
Description
Delete IAM users
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID | - |
| user_ids optional | array | 사용자 ID 목록 | - |
10.3.1.15 - Delete role
10.3.1.15.1 - 1.2
scpcli iam role delete
--role_id <value>
Description
Delete role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
10.3.1.15.2 - 1.1
scpcli iam role delete
--role_id <value>
Description
Delete role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
10.3.1.15.3 - 1.0
scpcli iam role delete
--role_id <value>
Description
Delete role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
10.3.1.16 - Delete the policy
10.3.1.16.1 - 1.2
scpcli iam policy delete
--policy_id <value>
Description
Delete the policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
10.3.1.16.2 - 1.1
scpcli iam policy delete
--policy_id <value>
Description
Delete the policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
10.3.1.16.3 - 1.0
scpcli iam policy delete
--policy_id <value>
Description
Delete the policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
10.3.1.17 - Delete the resource based policy
10.3.1.17.1 - 1.2
scpcli iam resource policy delete
--srn <value>
Description
Delete the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
10.3.1.17.2 - 1.1
scpcli iam resource policy delete
--srn <value>
Description
Delete the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
10.3.1.17.3 - 1.0
scpcli iam resource policy delete
--srn <value>
Description
Delete the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
10.3.1.18 - Delete user policy
10.3.1.18.1 - 1.2
scpcli iam user policy delete
--policy_id <value>
--user_id <value>
Description
Delete user policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | - |
| user_id required | string | 사용자 ID | - |
10.3.1.18.2 - 1.1
scpcli iam user policy delete
--policy_id <value>
--user_id <value>
Description
Delete user policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | - |
| user_id required | string | 사용자 ID | - |
10.3.1.18.3 - 1.0
scpcli iam user policy delete
--policy_id <value>
--user_id <value>
Description
Delete user policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | - |
| user_id required | string | 사용자 ID | - |
10.3.1.19 - Detach policies to Role
10.3.1.19.1 - 1.2
scpcli iam role policy binding bulk detach
--role_id <value>
--policy_ids <value>
Description
Detach policies to Role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| policy_ids required | array | Policy ID List | - |
10.3.1.19.2 - 1.1
scpcli iam role policy binding bulk detach
--role_id <value>
--policy_ids <value>
Description
Detach policies to Role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| policy_ids required | array | Policy ID List | - |
10.3.1.19.3 - 1.0
scpcli iam role policy binding bulk detach
--role_id <value>
--policy_ids <value>
Description
Detach policies to Role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| policy_ids required | array | Policy ID List | - |
10.3.1.20 - Detach policy to Role
10.3.1.20.1 - 1.2
scpcli iam role policy binding detach
--policy_id <value>
--role_id <value>
Description
Detach policy to Role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 역할에 연결된 정책 ID | - |
| role_id required | string | 역할 ID | - |
10.3.1.20.2 - 1.1
scpcli iam role policy binding detach
--policy_id <value>
--role_id <value>
Description
Detach policy to Role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 역할에 연결된 정책 ID | - |
| role_id required | string | 역할 ID | - |
10.3.1.20.3 - 1.0
scpcli iam role policy binding detach
--policy_id <value>
--role_id <value>
Description
Detach policy to Role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 역할에 연결된 정책 ID | - |
| role_id required | string | 역할 ID | - |
10.3.1.21 - Get a Group
10.3.1.21.1 - 1.2
scpcli iam group show
--group_id <value>
Description
Get a Group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| description | Group 설명 | Descriptions for group |
| domain_name | 도메인 이름 | scp |
| members | Project Group Member List | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| name | Group 이름 | TestGroup |
| policies | Policy | [] |
| resource_type | 리소스 명 | group |
| roles | Role 정보 | [] |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | 서비스 명 | iam |
| srn | Group SRN | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Type | USER_DEFINED |
10.3.1.21.2 - 1.1
scpcli iam group show
--group_id <value>
Description
Get a Group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| description | Group 설명 | Descriptions for group |
| domain_name | 도메인 이름 | scp |
| members | Project Group Member List | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| name | Group 이름 | TestGroup |
| policies | Policy | [] |
| resource_type | 리소스 명 | group |
| roles | Role 정보 | [] |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | 서비스 명 | iam |
| srn | Group SRN | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Type | USER_DEFINED |
10.3.1.21.3 - 1.0
scpcli iam group show
--group_id <value>
Description
Get a Group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| description | Group 설명 | Descriptions for group |
| domain_name | 도메인 이름 | scp |
| members | Project Group Member List | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| name | Group 이름 | TestGroup |
| policies | Policy | [] |
| resource_type | 리소스 명 | group |
| roles | Role 정보 | [] |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | 서비스 명 | iam |
| srn | Group SRN | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Type | USER_DEFINED |
10.3.1.22 - Get a specific policy binding list
10.3.1.22.1 - 1.2
scpcli iam policy binding list
--policy_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--identity_id <value>]
[--identity_type <value>]
[--name <value>]
Description
Get a specific policy binding list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| identity_id optional | string | Identity ID | f39c460fade34fecb05ede8f904b24b7 |
| identity_type optional | string | Identity Type | GROUP |
| name optional | string | Name | TestGroup |
Responses
| Name | Description | Example |
|---|---|---|
| count | count | 20 |
| groups | Group | [{‘created_at’: ‘2025-03-26T10:18:04Z’, ‘created_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘openapi-ga2-test-group’, ‘domain_name’: ‘scp’, ‘id’: ‘19fca177a57940daa5817960373c6542’, ‘modified_at’: ‘2025-03-26T10:18:04Z’, ‘modified_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘openapi-ga2-testgroup5’, ‘policies’: [], ‘roles’: [], ‘srn’: ‘srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542’, ’type’: ‘USER_DEFINED’}] |
| page | page | 0 |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| roles | Role | [{‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘assume_role_policy_document’: {‘Statement’: [{‘Action’: ‘’, ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘NotAction’: ‘’, ‘Principal’: ‘’, ‘Resource’: ‘’, ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}, ‘created_at’: ‘2024-05-17T00:23:17Z’, ‘created_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘string’, ‘id’: ‘f39c460fade34fecb05ede8f904b24b7’, ‘max_session_duration’: 0, ‘modified_at’: ‘2024-05-17T00:23:17Z’, ‘modified_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘string’, ’type’: ‘DEFAULT’}] |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
| users | User | [{‘access_control’: False, ‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘account_name’: ‘’, ‘allowed_ip_addresses’: ‘’, ‘company_name’: ‘’, ‘created_at’: ‘2024-11-15T06:57:42.000000Z’, ‘created_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘description’: ‘’, ‘domain_name’: ‘scp’, ‘dst_offset’: ‘+09:00’, ’email’: ‘samsung.kim@samsung.com’, ’email_authenticate_code’: ‘8ada8861bad2423295e4bb576bee5886’, ’email_authenticated’: True, ‘first_name’: ‘’, ‘groups’: [], ‘id’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘keycloak_id’: ‘127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507’, ‘keystone_credential’: ‘’, ’last_login_at’: ‘2024-11-25T06:57:42.000000Z’, ’last_name’: ‘’, ’last_password_update_at’: ‘’, ’login_id’: ‘’, ‘modified_at’: ‘2024-11-17T06:57:42.000000Z’, ‘modified_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ’nation_id’: ‘+82’, ‘phone_authenticated’: False, ‘phone_number’: ‘0000000000’, ‘policies’: [], ‘state’: ‘ACTIVE’, ’temporary_password’: False, ’term_region_id’: ‘1’, ’timezone’: ‘Asia/Seoul’, ’type’: ‘IAM’, ’tz_id’: ‘Asia/Seoul’, ‘user_name’: ‘Kim Samsung’, ‘utc_offset’: ‘+09:00’}] |
10.3.1.22.2 - 1.1
scpcli iam policy binding list
--policy_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--identity_id <value>]
[--identity_type <value>]
[--name <value>]
Description
Get a specific policy binding list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| identity_id optional | string | Identity ID | f39c460fade34fecb05ede8f904b24b7 |
| identity_type optional | string | Identity Type | GROUP |
| name optional | string | Name | TestGroup |
Responses
| Name | Description | Example |
|---|---|---|
| count | count | 20 |
| groups | Group | [{‘created_at’: ‘2025-03-26T10:18:04Z’, ‘created_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘openapi-ga2-test-group’, ‘domain_name’: ‘scp’, ‘id’: ‘19fca177a57940daa5817960373c6542’, ‘modified_at’: ‘2025-03-26T10:18:04Z’, ‘modified_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘openapi-ga2-testgroup5’, ‘policies’: [], ‘roles’: [], ‘srn’: ‘srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542’, ’type’: ‘USER_DEFINED’}] |
| page | page | 0 |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| roles | Role | [{‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘assume_role_policy_document’: {‘Statement’: [{‘Action’: ‘’, ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘NotAction’: ‘’, ‘Principal’: ‘’, ‘Resource’: ‘’, ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}, ‘created_at’: ‘2024-05-17T00:23:17Z’, ‘created_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘string’, ‘id’: ‘f39c460fade34fecb05ede8f904b24b7’, ‘max_session_duration’: 0, ‘modified_at’: ‘2024-05-17T00:23:17Z’, ‘modified_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘string’, ’type’: ‘DEFAULT’}] |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
| users | User | [{‘access_control’: False, ‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘account_name’: ‘’, ‘allowed_ip_addresses’: ‘’, ‘company_name’: ‘’, ‘created_at’: ‘2024-11-15T06:57:42.000000Z’, ‘created_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘description’: ‘’, ‘domain_name’: ‘scp’, ‘dst_offset’: ‘+09:00’, ’email’: ‘samsung.kim@samsung.com’, ’email_authenticate_code’: ‘8ada8861bad2423295e4bb576bee5886’, ’email_authenticated’: True, ‘first_name’: ‘’, ‘groups’: [], ‘id’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘keycloak_id’: ‘127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507’, ‘keystone_credential’: ‘’, ’last_login_at’: ‘2024-11-25T06:57:42.000000Z’, ’last_name’: ‘’, ’last_password_update_at’: ‘’, ’login_id’: ‘’, ‘modified_at’: ‘2024-11-17T06:57:42.000000Z’, ‘modified_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ’nation_id’: ‘+82’, ‘phone_authenticated’: False, ‘phone_number’: ‘0000000000’, ‘policies’: [], ‘state’: ‘ACTIVE’, ’temporary_password’: False, ’term_region_id’: ‘1’, ’timezone’: ‘Asia/Seoul’, ’type’: ‘IAM’, ’tz_id’: ‘Asia/Seoul’, ‘user_name’: ‘Kim Samsung’, ‘utc_offset’: ‘+09:00’}] |
10.3.1.22.3 - 1.0
scpcli iam policy binding list
--policy_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--identity_id <value>]
[--identity_type <value>]
[--name <value>]
Description
Get a specific policy binding list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| identity_id optional | string | Identity ID | f39c460fade34fecb05ede8f904b24b7 |
| identity_type optional | string | Identity Type | GROUP |
| name optional | string | Name | TestGroup |
Responses
| Name | Description | Example |
|---|---|---|
| count | count | 20 |
| groups | Group | [{‘created_at’: ‘2025-03-26T10:18:04Z’, ‘created_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘openapi-ga2-test-group’, ‘domain_name’: ‘scp’, ‘id’: ‘19fca177a57940daa5817960373c6542’, ‘modified_at’: ‘2025-03-26T10:18:04Z’, ‘modified_by’: ‘4a816a3f5099442ebb52daefc1f7be32’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘openapi-ga2-testgroup5’, ‘policies’: [], ‘roles’: [], ‘srn’: ‘srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542’, ’type’: ‘USER_DEFINED’}] |
| page | page | 0 |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| roles | Role | [{‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘assume_role_policy_document’: {‘Statement’: [{‘Action’: ‘’, ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘NotAction’: ‘’, ‘Principal’: ‘’, ‘Resource’: ‘’, ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}, ‘created_at’: ‘2024-05-17T00:23:17Z’, ‘created_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘creator_email’: ‘-’, ‘creator_name’: ‘-’, ‘description’: ‘string’, ‘id’: ‘f39c460fade34fecb05ede8f904b24b7’, ‘max_session_duration’: 0, ‘modified_at’: ‘2024-05-17T00:23:17Z’, ‘modified_by’: ’ef50cdc207f05f6fb8f20219f229ed1f’, ‘modifier_email’: ‘-’, ‘modifier_name’: ‘-’, ’name’: ‘string’, ’type’: ‘DEFAULT’}] |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
| users | User | [{‘access_control’: False, ‘account_id’: ‘d7aba97100564b34a0f4f77c4bc7a303’, ‘account_name’: ‘’, ‘allowed_ip_addresses’: ‘’, ‘company_name’: ‘’, ‘created_at’: ‘2024-11-15T06:57:42.000000Z’, ‘created_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘description’: ‘’, ‘domain_name’: ‘scp’, ‘dst_offset’: ‘+09:00’, ’email’: ‘samsung.kim@samsung.com’, ’email_authenticate_code’: ‘8ada8861bad2423295e4bb576bee5886’, ’email_authenticated’: True, ‘first_name’: ‘’, ‘groups’: [], ‘id’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ‘keycloak_id’: ‘127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507’, ‘keystone_credential’: ‘’, ’last_login_at’: ‘2024-11-25T06:57:42.000000Z’, ’last_name’: ‘’, ’last_password_update_at’: ‘’, ’login_id’: ‘’, ‘modified_at’: ‘2024-11-17T06:57:42.000000Z’, ‘modified_by’: ‘90dddfc2b1e04edba54ba2b41539a9ac’, ’nation_id’: ‘+82’, ‘phone_authenticated’: False, ‘phone_number’: ‘0000000000’, ‘policies’: [], ‘state’: ‘ACTIVE’, ’temporary_password’: False, ’term_region_id’: ‘1’, ’timezone’: ‘Asia/Seoul’, ’type’: ‘IAM’, ’tz_id’: ‘Asia/Seoul’, ‘user_name’: ‘Kim Samsung’, ‘utc_offset’: ‘+09:00’}] |
10.3.1.23 - Get an access key
10.3.1.23.1 - 1.2
scpcli iam access-key show
--access_key_id <value>
Description
Get an access key
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access key type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access key expiration timestamp | 9999-12-31T23:59:59Z |
| is_enabled | 활성화 여부 | true |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent access key ID which is used for temporary access key to create by | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-f7c6-46bc-9faa-d2b9d20e0899 |
10.3.1.23.2 - 1.1
scpcli iam access-key show
--access_key_id <value>
Description
Get an access key
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access key type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access key expiration timestamp | 9999-12-31T23:59:59Z |
| is_enabled | 활성화 여부 | true |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent access key ID which is used for temporary access key to create by | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-f7c6-46bc-9faa-d2b9d20e0899 |
10.3.1.23.3 - 1.0
scpcli iam access-key show
--access_key_id <value>
Description
Get an access key
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access key type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access key expiration timestamp | 9999-12-31T23:59:59Z |
| is_enabled | 활성화 여부 | true |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent access key ID which is used for temporary access key to create by | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-f7c6-46bc-9faa-d2b9d20e0899 |
10.3.1.24 - Get endpoint list
10.3.1.24.1 - 1.2
scpcli iam endpoint list
Description
Get endpoint list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Responses
| Name | Description | Example |
|---|---|---|
| region | Region | kr-west1 |
| service_name | Service name | scp-iam |
| service_type | Service type | scp-iam |
| url | URL | https://iam.dev2.samsungsdscloud.com |
10.3.1.24.2 - 1.1
scpcli iam endpoint list
Description
Get endpoint list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Responses
| Name | Description | Example |
|---|---|---|
| region | Region | kr-west1 |
| service_name | Service name | scp-iam |
| service_type | Service type | scp-iam |
| url | URL | https://iam.dev2.samsungsdscloud.com |
10.3.1.24.3 - 1.0
scpcli iam endpoint list
Description
Get endpoint list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Responses
| Name | Description | Example |
|---|---|---|
| region | Region | kr-west1 |
| service_name | Service name | scp-iam |
| service_type | Service type | scp-iam |
| url | URL | https://iam.dev2.samsungsdscloud.com |
10.3.1.25 - Get IAM users
10.3.1.25.1 - 1.2
scpcli iam iam user show
--user_id <value>
--account_id <value>
Description
Get IAM users
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.25.2 - 1.1
scpcli iam iam user show
--user_id <value>
--account_id <value>
Description
Get IAM users
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.25.3 - 1.0
scpcli iam iam user show
--user_id <value>
--account_id <value>
Description
Get IAM users
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.26 - Get policy list
10.3.1.26.1 - 1.2
scpcli iam policy list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
Description
Get policy list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Policy 생성자 성, 이름 | test1 |
| creator_email optional | string | Policy 생성자 Email | test@test.com |
| modifier_name optional | string | Policy 수정자 성, 이름 | test1 |
| modifier_email optional | string | Policy 수정자 Email | test@test.com |
| exclude_group_id optional | string | 제외할 Group ID | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | 제외할 User ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.26.2 - 1.1
scpcli iam policy list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
Description
Get policy list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
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 | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Policy 생성자 성, 이름 | test1 |
| creator_email optional | string | Policy 생성자 Email | test@test.com |
| modifier_name optional | string | Policy 수정자 성, 이름 | test1 |
| modifier_email optional | string | Policy 수정자 Email | test@test.com |
| exclude_group_id optional | string | 제외할 Group ID | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | 제외할 User ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.26.3 - 1.0
scpcli iam policy list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
Description
Get policy list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
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 | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Policy 생성자 성, 이름 | test1 |
| creator_email optional | string | Policy 생성자 Email | test@test.com |
| modifier_name optional | string | Policy 수정자 성, 이름 | test1 |
| modifier_email optional | string | Policy 수정자 Email | test@test.com |
| exclude_group_id optional | string | 제외할 Group ID | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | 제외할 User ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.27 - Get role
10.3.1.27.1 - 1.2
scpcli iam role show
--role_id <value>
Description
Get role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | 역할이 속한 계정의 ID | |
| assume_role_policy_document | 역할 신뢰 정책 | |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | |
| creator_name | 생성자 성, 이름 | |
| description | 역할 설명 | |
| max_session_duration | 역할 세션 최대 지속 시간(초) | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | |
| modifier_name | 수정자 성, 이름 | |
| name | 역할명 | |
| policies | 역할에 연결된 정책 목록 | |
| type | 역할 유형 |
10.3.1.27.2 - 1.1
scpcli iam role show
--role_id <value>
Description
Get role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | 역할이 속한 계정의 ID | |
| assume_role_policy_document | 역할 신뢰 정책 | |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | |
| creator_name | 생성자 성, 이름 | |
| description | 역할 설명 | |
| max_session_duration | 역할 세션 최대 지속 시간(초) | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | |
| modifier_name | 수정자 성, 이름 | |
| name | 역할명 | |
| policies | 역할에 연결된 정책 목록 | |
| type | 역할 유형 |
10.3.1.27.3 - 1.0
scpcli iam role show
--role_id <value>
Description
Get role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | 역할이 속한 계정의 ID | |
| assume_role_policy_document | 역할 신뢰 정책 | |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | |
| creator_name | 생성자 성, 이름 | |
| description | 역할 설명 | |
| max_session_duration | 역할 세션 최대 지속 시간(초) | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | |
| modifier_name | 수정자 성, 이름 | |
| name | 역할명 | |
| policies | 역할에 연결된 정책 목록 | |
| type | 역할 유형 |
10.3.1.28 - Get role list
10.3.1.28.1 - 1.2
scpcli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]
Description
Get role list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 역할명 | - |
| role_type optional | string | 역할 유형 | - |
| account_id optional | string | 역할이 속한 계정의 ID | - |
| exclude_policy_id optional | string | 예외 대상 정책 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | 역할이 속한 계정의 ID | |
| assume_role_policy_document | 역할 신뢰 정책 | |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | |
| creator_name | 생성자 성, 이름 | |
| description | 역할 설명 | |
| max_session_duration | 역할 세션 최대 지속 시간(초) | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | |
| modifier_name | 수정자 성, 이름 | |
| name | 역할명 | |
| policies | 역할에 연결된 정책 목록 | |
| type | 역할 유형 |
10.3.1.28.2 - 1.1
scpcli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]
Description
Get role list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
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 | 역할명 | - |
| role_type optional | string | 역할 유형 | - |
| account_id optional | string | 역할이 속한 계정의 ID | - |
| exclude_policy_id optional | string | 예외 대상 정책 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | 역할이 속한 계정의 ID | |
| assume_role_policy_document | 역할 신뢰 정책 | |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | |
| creator_name | 생성자 성, 이름 | |
| description | 역할 설명 | |
| max_session_duration | 역할 세션 최대 지속 시간(초) | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | |
| modifier_name | 수정자 성, 이름 | |
| name | 역할명 | |
| policies | 역할에 연결된 정책 목록 | |
| type | 역할 유형 |
10.3.1.28.3 - 1.0
scpcli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]
Description
Get role list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
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 | 역할명 | - |
| role_type optional | string | 역할 유형 | - |
| account_id optional | string | 역할이 속한 계정의 ID | - |
| exclude_policy_id optional | string | 예외 대상 정책 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | 역할이 속한 계정의 ID | |
| assume_role_policy_document | 역할 신뢰 정책 | |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | |
| creator_name | 생성자 성, 이름 | |
| description | 역할 설명 | |
| max_session_duration | 역할 세션 최대 지속 시간(초) | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | |
| modifier_name | 수정자 성, 이름 | |
| name | 역할명 | |
| policies | 역할에 연결된 정책 목록 | |
| type | 역할 유형 |
10.3.1.29 - Get Role Policy-Binding list
10.3.1.29.1 - 1.2
scpcli iam role policy binding list
--role_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]
Description
Get Role Policy-Binding list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | 역할에 연결된 정책 ID | - |
| policy_name optional | string | 역할에 연결된 정책 이름 | - |
| policy_type optional | string | 역할에 연결된 정책 유형 목록 | ['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.29.2 - 1.1
scpcli iam role policy binding list
--role_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]
Description
Get Role Policy-Binding list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | 역할에 연결된 정책 ID | - |
| policy_name optional | string | 역할에 연결된 정책 이름 | - |
| policy_type optional | string | 역할에 연결된 정책 유형 목록 | ['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.29.3 - 1.0
scpcli iam role policy binding list
--role_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]
Description
Get Role Policy-Binding list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | 역할에 연결된 정책 ID | - |
| policy_name optional | string | 역할에 연결된 정책 이름 | - |
| policy_type optional | string | 역할에 연결된 정책 유형 목록 | ['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.30 - Get saml provider information
10.3.1.30.1 - 1.2
scpcli iam saml provider show
--saml_provider_id <value>
Description
Get saml provider information
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | 자격증명공급자 ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 | |
| description | 자격증명공급자 설명 | |
| federation_type | 자격증명공급자 유형 | |
| idp_cert_end | 유효기간 | |
| idp_file_data | 메타데이터 내용 | |
| idp_file_name | 메타데이터 파일 이름 | |
| idp_file_size | 메타데이터 파일 크기 | |
| idp_issuer_url | 발행자 URL | |
| idp_sso_url | SSO 서비스 위치 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 | |
| saml_provider_name | 자격증명공급자 이름 |
10.3.1.30.2 - 1.1
scpcli iam saml provider show
--saml_provider_id <value>
Description
Get saml provider information
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | 자격증명공급자 ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 | |
| description | 자격증명공급자 설명 | |
| federation_type | 자격증명공급자 유형 | |
| idp_cert_end | 유효기간 | |
| idp_file_data | 메타데이터 내용 | |
| idp_file_name | 메타데이터 파일 이름 | |
| idp_file_size | 메타데이터 파일 크기 | |
| idp_issuer_url | 발행자 URL | |
| idp_sso_url | SSO 서비스 위치 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 | |
| saml_provider_name | 자격증명공급자 이름 |
10.3.1.30.3 - 1.0
scpcli iam saml provider show
--saml_provider_id <value>
Description
Get saml provider information
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | 자격증명공급자 ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 | |
| description | 자격증명공급자 설명 | |
| federation_type | 자격증명공급자 유형 | |
| idp_cert_end | 유효기간 | |
| idp_file_data | 메타데이터 내용 | |
| idp_file_name | 메타데이터 파일 이름 | |
| idp_file_size | 메타데이터 파일 크기 | |
| idp_issuer_url | 발행자 URL | |
| idp_sso_url | SSO 서비스 위치 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 | |
| saml_provider_name | 자격증명공급자 이름 |
10.3.1.31 - Get service account
10.3.1.31.1 - 1.2
scpcli iam service account show
--service_account_id <value>
Description
Get service account
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_account_id required | string | Service Account ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| password | Service Account’s Password | |
| service | Service Account’s Service |
10.3.1.31.2 - 1.1
scpcli iam service account show
--service_account_id <value>
Description
Get service account
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_account_id required | string | Service Account ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| password | Service Account’s Password | |
| service | Service Account’s Service |
10.3.1.31.3 - 1.0
scpcli iam service account show
--service_account_id <value>
Description
Get service account
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_account_id required | string | Service Account ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| password | Service Account’s Password | |
| service | Service Account’s Service |
10.3.1.32 - Get user policy-binding list
10.3.1.32.1 - 1.2
scpcli iam user policy show
--user_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]
Description
Get user policy-binding list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | 사용자 ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy Id | - |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type List | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.32.2 - 1.1
scpcli iam user policy show
--user_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]
Description
Get user policy-binding list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | 사용자 ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy Id | - |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type List | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.32.3 - 1.0
scpcli iam user policy show
--user_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]
Description
Get user policy-binding list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | 사용자 ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy Id | - |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type List | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.33 - Group Member list
10.3.1.33.1 - 1.2
scpcli iam group user list
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
[--user_email <value>]
[--creator_name <value>]
[--creator_email <value>]
Description
Group Member list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_name optional | string | Group Member 성, 이름 | Kim Samsung |
| user_email optional | string | Group Member Email | samsung.kim@samsung.com |
| creator_name optional | string | Group Member 생성자 성, 이름 | Kim Samsung |
| creator_email optional | string | Group Member 생성자 Email | samsung.kim@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_last_login_at | Group Member last login at | 2024-05-17T00:23:17Z |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| group_names | Group names | [‘TestGroup’, ‘SampleGroup’] |
| user_created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| user_email | User Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_last_login_at | Group Member last login at | 2024-05-17T00:23:17Z |
| user_name | User 성, 이름 | Kim Samsung |
10.3.1.33.2 - 1.1
scpcli iam group user list
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
[--user_email <value>]
[--creator_name <value>]
[--creator_email <value>]
Description
Group Member list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_name optional | string | Group Member 성, 이름 | Kim Samsung |
| user_email optional | string | Group Member Email | samsung.kim@samsung.com |
| creator_name optional | string | Group Member 생성자 성, 이름 | Kim Samsung |
| creator_email optional | string | Group Member 생성자 Email | samsung.kim@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_last_login_at | Group Member last login at | 2024-05-17T00:23:17Z |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| group_names | Group names | [‘TestGroup’, ‘SampleGroup’] |
| user_created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| user_email | User Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_last_login_at | Group Member last login at | 2024-05-17T00:23:17Z |
| user_name | User 성, 이름 | Kim Samsung |
10.3.1.33.3 - 1.0
scpcli iam group user list
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
[--user_email <value>]
[--creator_name <value>]
[--creator_email <value>]
Description
Group Member list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_name optional | string | Group Member 성, 이름 | Kim Samsung |
| user_email optional | string | Group Member Email | samsung.kim@samsung.com |
| creator_name optional | string | Group Member 생성자 성, 이름 | Kim Samsung |
| creator_email optional | string | Group Member 생성자 Email | samsung.kim@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_last_login_at | Group Member last login at | 2024-05-17T00:23:17Z |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| group_names | Group names | [‘TestGroup’, ‘SampleGroup’] |
| user_created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| user_email | User Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_last_login_at | Group Member last login at | 2024-05-17T00:23:17Z |
| user_name | User 성, 이름 | Kim Samsung |
10.3.1.34 - List access keys
10.3.1.34.1 - 1.2
scpcli iam access-key list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--access_key_type <value>]
[--parent_access_key_id <value>]
Description
List access keys
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
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 |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| access_key_type optional | string | Access key type | PERMANENT |
| parent_access_key_id optional | string | Parent access key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access key type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access key expiration timestamp | 9999-12-31T23:59:59Z |
| is_enabled | 활성화 여부 | true |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent access key ID which is used for temporary access key to create by | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-f7c6-46bc-9faa-d2b9d20e0899 |
10.3.1.34.2 - 1.1
scpcli iam access-key list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--access_key_type <value>]
[--parent_access_key_id <value>]
Description
List access keys
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
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 |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| access_key_type optional | string | Access key type | PERMANENT |
| parent_access_key_id optional | string | Parent access key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access key type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access key expiration timestamp | 9999-12-31T23:59:59Z |
| is_enabled | 활성화 여부 | true |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent access key ID which is used for temporary access key to create by | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-f7c6-46bc-9faa-d2b9d20e0899 |
10.3.1.34.3 - 1.0
scpcli iam access-key list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--access_key_type <value>]
[--parent_access_key_id <value>]
Description
List access keys
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
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 |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| access_key_type optional | string | Access key type | PERMANENT |
| parent_access_key_id optional | string | Parent access key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access key type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access key expiration timestamp | 9999-12-31T23:59:59Z |
| is_enabled | 활성화 여부 | true |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent access key ID which is used for temporary access key to create by | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-f7c6-46bc-9faa-d2b9d20e0899 |
10.3.1.35 - List Groups
10.3.1.35.1 - 1.2
scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]
Description
List Groups
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Group 이름 | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group IDs | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member 존재 여부 | false |
| has_role optional | string | Group Role 존재 여부 | false |
| is_completed optional | string | Group 완결 여부 | false |
| creator_name optional | string | Group 생성자 성, 이름 | Kim Samsung |
| creator_email optional | string | Group 생성자 Email | samsung.kim@samsung.com |
| modifier_name optional | string | Group 수정자 성, 이름 | Kim Samsung |
| modifier_email optional | string | Group 수정자 Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | 제외할 사용자 ID | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | 제외할 정책 ID | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| description | Group 설명 | Descriptions for group |
| domain_name | 도메인 이름 | scp |
| members | Project Group Member List | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| name | Group 이름 | TestGroup |
| policies | Policy | [] |
| resource_type | 리소스 명 | group |
| roles | Role 정보 | [] |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | 서비스 명 | iam |
| srn | Group SRN | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Type | USER_DEFINED |
10.3.1.35.2 - 1.1
scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]
Description
List Groups
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
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 | Group 이름 | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group IDs | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member 존재 여부 | false |
| has_role optional | string | Group Role 존재 여부 | false |
| is_completed optional | string | Group 완결 여부 | false |
| creator_name optional | string | Group 생성자 성, 이름 | Kim Samsung |
| creator_email optional | string | Group 생성자 Email | samsung.kim@samsung.com |
| modifier_name optional | string | Group 수정자 성, 이름 | Kim Samsung |
| modifier_email optional | string | Group 수정자 Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | 제외할 사용자 ID | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | 제외할 정책 ID | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| description | Group 설명 | Descriptions for group |
| domain_name | 도메인 이름 | scp |
| members | Project Group Member List | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| name | Group 이름 | TestGroup |
| policies | Policy | [] |
| resource_type | 리소스 명 | group |
| roles | Role 정보 | [] |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | 서비스 명 | iam |
| srn | Group SRN | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Type | USER_DEFINED |
10.3.1.35.3 - 1.0
scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]
Description
List Groups
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
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 | Group 이름 | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group IDs | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member 존재 여부 | false |
| has_role optional | string | Group Role 존재 여부 | false |
| is_completed optional | string | Group 완결 여부 | false |
| creator_name optional | string | Group 생성자 성, 이름 | Kim Samsung |
| creator_email optional | string | Group 생성자 Email | samsung.kim@samsung.com |
| modifier_name optional | string | Group 수정자 성, 이름 | Kim Samsung |
| modifier_email optional | string | Group 수정자 Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | 제외할 사용자 ID | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | 제외할 정책 ID | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | 생성 일시 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| description | Group 설명 | Descriptions for group |
| domain_name | 도메인 이름 | scp |
| members | Project Group Member List | |
| modified_at | 수정 일시 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| name | Group 이름 | TestGroup |
| policies | Policy | [] |
| resource_type | 리소스 명 | group |
| roles | Role 정보 | [] |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | 서비스 명 | iam |
| srn | Group SRN | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Type | USER_DEFINED |
10.3.1.36 - List IAM users
10.3.1.36.1 - 1.2
scpcli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]
Description
List IAM users
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | 사용자 Email | - |
| nation_id optional | string | 국가 ID | - |
| phone_number optional | string | 사용자 휴대 전화 번호 | - |
| user_name optional | string | 사용자 이름 | - |
| exclude_group_id optional | string | 예외 대상 그룹 | - |
| exclude_policy_id optional | string | 예외 대상 정책 | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | 회사 이름 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | email 인증 여부 | |
| first_name | 사용자 이름 | |
| groups | group names | |
| last_login_at | 마지막 로그인 | |
| last_name | 사용자 성 | |
| last_password_update_at | 마지막 비밀번호 수정시간 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | 비밀 번호 재사용 가능 횟수 | |
| phone_authenticated | 휴대폰 인증 여부 | |
| policies | User Policies | [] |
| state | 상태 | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC Offset |
10.3.1.36.2 - 1.1
scpcli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]
Description
List IAM users
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | 사용자 Email | - |
| nation_id optional | string | 국가 ID | - |
| phone_number optional | string | 사용자 휴대 전화 번호 | - |
| user_name optional | string | 사용자 이름 | - |
| exclude_group_id optional | string | 예외 대상 그룹 | - |
| exclude_policy_id optional | string | 예외 대상 정책 | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | 회사 이름 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | email 인증 여부 | |
| first_name | 사용자 이름 | |
| groups | group names | |
| last_login_at | 마지막 로그인 | |
| last_name | 사용자 성 | |
| last_password_update_at | 마지막 비밀번호 수정시간 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | 비밀 번호 재사용 가능 횟수 | |
| phone_authenticated | 휴대폰 인증 여부 | |
| policies | User Policies | [] |
| state | 상태 | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC Offset |
10.3.1.36.3 - 1.0
scpcli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]
Description
List IAM users
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | 사용자 Email | - |
| nation_id optional | string | 국가 ID | - |
| phone_number optional | string | 사용자 휴대 전화 번호 | - |
| user_name optional | string | 사용자 이름 | - |
| exclude_group_id optional | string | 예외 대상 그룹 | - |
| exclude_policy_id optional | string | 예외 대상 정책 | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | 회사 이름 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | email 인증 여부 | |
| first_name | 사용자 이름 | |
| groups | group names | |
| last_login_at | 마지막 로그인 | |
| last_name | 사용자 성 | |
| last_password_update_at | 마지막 비밀번호 수정시간 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | 비밀 번호 재사용 가능 횟수 | |
| phone_authenticated | 휴대폰 인증 여부 | |
| policies | User Policies | [] |
| state | 상태 | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC Offset |
10.3.1.37 - List saml providers
10.3.1.37.1 - 1.2
scpcli iam saml provider list
[--size <value>]
[--page <value>]
[--sort <value>]
[--federation_type <value>]
[--saml_provider_name <value>]
Description
List saml providers
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| federation_type optional | string | 자격증명공급자 유형 | - |
| saml_provider_name optional | string | 자격증명공급자 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 | |
| description | 자격증명공급자 설명 | |
| federation_type | 자격증명공급자 유형 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 | |
| saml_provider_name | 자격증명공급자 이름 |
10.3.1.37.2 - 1.1
scpcli iam saml provider list
[--size <value>]
[--page <value>]
[--sort <value>]
[--federation_type <value>]
[--saml_provider_name <value>]
Description
List saml providers
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| federation_type optional | string | 자격증명공급자 유형 | - |
| saml_provider_name optional | string | 자격증명공급자 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 | |
| description | 자격증명공급자 설명 | |
| federation_type | 자격증명공급자 유형 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 | |
| saml_provider_name | 자격증명공급자 이름 |
10.3.1.37.3 - 1.0
scpcli iam saml provider list
[--size <value>]
[--page <value>]
[--sort <value>]
[--federation_type <value>]
[--saml_provider_name <value>]
Description
List saml providers
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| federation_type optional | string | 자격증명공급자 유형 | - |
| saml_provider_name optional | string | 자격증명공급자 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 | |
| description | 자격증명공급자 설명 | |
| federation_type | 자격증명공급자 유형 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 | |
| saml_provider_name | 자격증명공급자 이름 |
10.3.1.38 - List service accounts
10.3.1.38.1 - 1.2
scpcli iam service account list
[--name <value>]
[--service <value>]
Description
List service accounts
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Service Account Name | - |
| service optional | string | Service Account's Service | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| service | Service Account’s Service |
10.3.1.38.2 - 1.1
scpcli iam service account list
[--name <value>]
[--service <value>]
Description
List service accounts
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Service Account Name | - |
| service optional | string | Service Account's Service | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| service | Service Account’s Service |
10.3.1.38.3 - 1.0
scpcli iam service account list
[--name <value>]
[--service <value>]
Description
List service accounts
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Service Account Name | - |
| service optional | string | Service Account's Service | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| service | Service Account’s Service |
10.3.1.39 - Modify a Group
10.3.1.39.1 - 1.2
scpcli iam group set
--group_id <value>
--name <value>
--description <value>
Description
Modify a Group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| name required | string | Group 이름 | TestGroup |
| description required | string | Group 설명 | Descriptions for group |
10.3.1.39.2 - 1.1
scpcli iam group set
--group_id <value>
--name <value>
--description <value>
Description
Modify a Group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| name required | string | Group 이름 | TestGroup |
| description required | string | Group 설명 | Descriptions for group |
10.3.1.39.3 - 1.0
scpcli iam group set
--group_id <value>
--name <value>
--description <value>
Description
Modify a Group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| name required | string | Group 이름 | TestGroup |
| description required | string | Group 설명 | Descriptions for group |
10.3.1.40 - Query policy list
10.3.1.40.1 - 1.2
scpcli iam policy query
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
[--excluded_policy_ids <value>]
Description
Query policy list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Policy 생성자 성, 이름 | test1 |
| creator_email optional | string | Policy 생성자 Email | test@test.com |
| modifier_name optional | string | Policy 수정자 성, 이름 | test1 |
| modifier_email optional | string | Policy 수정자 Email | test@test.com |
| exclude_group_id optional | string | 제외할 Group ID | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | 제외할 User ID | - |
| excluded_policy_ids optional | array | 제외할 Policy IDs | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.40.2 - 1.1
scpcli iam policy query
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
[--excluded_policy_ids <value>]
Description
Query policy list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
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 | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Policy 생성자 성, 이름 | test1 |
| creator_email optional | string | Policy 생성자 Email | test@test.com |
| modifier_name optional | string | Policy 수정자 성, 이름 | test1 |
| modifier_email optional | string | Policy 수정자 Email | test@test.com |
| exclude_group_id optional | string | 제외할 Group ID | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | 제외할 User ID | - |
| excluded_policy_ids optional | array | 제외할 Policy IDs | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.40.3 - 1.0
scpcli iam policy query
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
[--excluded_policy_ids <value>]
Description
Query policy list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
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 | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Policy 생성자 성, 이름 | test1 |
| creator_email optional | string | Policy 생성자 Email | test@test.com |
| modifier_name optional | string | Policy 수정자 성, 이름 | test1 |
| modifier_email optional | string | Policy 수정자 Email | test@test.com |
| exclude_group_id optional | string | 제외할 Group ID | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | 제외할 User ID | - |
| excluded_policy_ids optional | array | 제외할 Policy IDs | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.41 - Remove a permission into the resource based policy
10.3.1.41.1 - 1.2
scpcli iam permission remove
--sid <value>
--srn <value>
Description
Remove a permission into the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
10.3.1.41.2 - 1.1
scpcli iam permission remove
--sid <value>
--srn <value>
Description
Remove a permission into the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
10.3.1.41.3 - 1.0
scpcli iam permission remove
--sid <value>
--srn <value>
Description
Remove a permission into the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
10.3.1.42 - Remove a User from a Group
10.3.1.42.1 - 1.2
scpcli iam group user remove
--user_id <value>
--group_id <value>
Description
Remove a User from a Group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | ef50cdc207f05f6fb8f20219f229ed1f |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
10.3.1.42.2 - 1.1
scpcli iam group user remove
--user_id <value>
--group_id <value>
Description
Remove a User from a Group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | ef50cdc207f05f6fb8f20219f229ed1f |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
10.3.1.42.3 - 1.0
scpcli iam group user remove
--user_id <value>
--group_id <value>
Description
Remove a User from a Group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | ef50cdc207f05f6fb8f20219f229ed1f |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
10.3.1.43 - Remove policies
10.3.1.43.1 - 1.2
scpcli iam policy bulk delete
[--ids <value>]
Description
Remove policies
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Policy id list | 37f2e31ff86b415698d7e8eeafab445d |
10.3.1.43.2 - 1.1
scpcli iam policy bulk delete
[--ids <value>]
Description
Remove policies
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Policy id list | 37f2e31ff86b415698d7e8eeafab445d |
10.3.1.43.3 - 1.0
scpcli iam policy bulk delete
[--ids <value>]
Description
Remove policies
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Policy id list | 37f2e31ff86b415698d7e8eeafab445d |
10.3.1.44 - Remove policy assignment from group
10.3.1.44.1 - 1.2
scpcli iam group policy delete
--policy_id <value>
--group_id <value>
Description
Remove policy assignment from group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
10.3.1.44.2 - 1.1
scpcli iam group policy delete
--policy_id <value>
--group_id <value>
Description
Remove policy assignment from group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
10.3.1.44.3 - 1.0
scpcli iam group policy delete
--policy_id <value>
--group_id <value>
Description
Remove policy assignment from group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
10.3.1.45 - Remove saml providers
10.3.1.45.1 - 1.2
scpcli iam saml provider bulk delete
[--ids <value>]
Description
Remove saml providers
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Saml provider id list | - |
10.3.1.45.2 - 1.1
scpcli iam saml provider bulk delete
[--ids <value>]
Description
Remove saml providers
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Saml provider id list | - |
10.3.1.45.3 - 1.0
scpcli iam saml provider bulk delete
[--ids <value>]
Description
Remove saml providers
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Saml provider id list | - |
10.3.1.46 - Remove the access key
10.3.1.46.1 - 1.2
scpcli iam access-key delete
--access_key_id <value>
Description
Remove the access key
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access key ID | f39c460fade34fecb05ede8f904b24b7 |
10.3.1.46.2 - 1.1
scpcli iam access-key delete
--access_key_id <value>
Description
Remove the access key
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access key ID | f39c460fade34fecb05ede8f904b24b7 |
10.3.1.46.3 - 1.0
scpcli iam access-key delete
--access_key_id <value>
Description
Remove the access key
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access key ID | f39c460fade34fecb05ede8f904b24b7 |
10.3.1.47 - Remove the access keys
10.3.1.47.1 - 1.2
scpcli iam access-key remove
[--ids <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--with_count <value>]
Description
Remove the access keys
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Access key id list | - |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| with_count optional | string | with count | true |
10.3.1.47.2 - 1.1
scpcli iam access-key remove
[--ids <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--with_count <value>]
Description
Remove the access keys
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Access key id list | - |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| with_count optional | string | with count | true |
10.3.1.47.3 - 1.0
scpcli iam access-key remove
[--ids <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--with_count <value>]
Description
Remove the access keys
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Access key id list | - |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| with_count optional | string | with count | true |
10.3.1.48 - Remove the Group
10.3.1.48.1 - 1.2
scpcli iam group delete
--group_id <value>
Description
Remove the Group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
10.3.1.48.2 - 1.1
scpcli iam group delete
--group_id <value>
Description
Remove the Group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
10.3.1.48.3 - 1.0
scpcli iam group delete
--group_id <value>
Description
Remove the Group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
10.3.1.49 - Send Temporary Access Key OTP
10.3.1.49.1 - 1.2
scpcli iam access-key send otp
[--locale <value>]
[--method <value>]
Description
Send Temporary Access Key OTP
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| locale optional | string | Locale | - |
| method optional | string | OTP method (EMAIL or PHONE) | - |
Responses
| Name | Description | Example |
|---|
10.3.1.49.2 - 1.1
scpcli iam access-key send otp
[--locale <value>]
[--method <value>]
Description
Send Temporary Access Key OTP
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| locale optional | string | Locale | - |
| method optional | string | OTP method (EMAIL or PHONE) | - |
Responses
| Name | Description | Example |
|---|
10.3.1.49.3 - 1.0
scpcli iam access-key send otp
[--locale <value>]
[--method <value>]
Description
Send Temporary Access Key OTP
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| locale optional | string | Locale | - |
| method optional | string | OTP method (EMAIL or PHONE) | - |
Responses
| Name | Description | Example |
|---|
10.3.1.50 - Set a permission into the resource based policy
10.3.1.50.1 - 1.2
scpcli iam permission set
--sid <value>
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]
Description
Set a permission into the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
10.3.1.50.2 - 1.1
scpcli iam permission set
--sid <value>
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]
Description
Set a permission into the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
10.3.1.50.3 - 1.0
scpcli iam permission set
--sid <value>
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]
Description
Set a permission into the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
10.3.1.51 - Set an access key
10.3.1.51.1 - 1.2
scpcli iam access-key set
--access_key_id <value>
[--is_enabled <value>]
Description
Set or update an access key
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access key ID | f39c460fade34fecb05ede8f904b24b7 |
| is_enabled optional | boolean | 활성화 여부 | true |
10.3.1.51.2 - 1.1
scpcli iam access-key set
--access_key_id <value>
[--is_enabled <value>]
Description
Set or update an access key
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access key ID | f39c460fade34fecb05ede8f904b24b7 |
| is_enabled optional | boolean | 활성화 여부 | true |
10.3.1.51.3 - 1.0
scpcli iam access-key set
--access_key_id <value>
[--is_enabled <value>]
Description
Set or update an access key
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access key ID | f39c460fade34fecb05ede8f904b24b7 |
| is_enabled optional | boolean | 활성화 여부 | true |
10.3.1.52 - Set role
10.3.1.52.1 - 1.2
scpcli iam role set
--role_id <value>
[--description <value>]
[--max_session_duration <value>]
Description
Set role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| description optional | string | 역할 설명 | - |
| max_session_duration optional | integer | 역할 세션 최대 지속 시간(초) | 3600 |
10.3.1.52.2 - 1.1
scpcli iam role set
--role_id <value>
[--description <value>]
[--max_session_duration <value>]
Description
Set role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| description optional | string | 역할 설명 | - |
| max_session_duration optional | integer | 역할 세션 최대 지속 시간(초) | 3600 |
10.3.1.52.3 - 1.0
scpcli iam role set
--role_id <value>
[--description <value>]
[--max_session_duration <value>]
Description
Set role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| description optional | string | 역할 설명 | - |
| max_session_duration optional | integer | 역할 세션 최대 지속 시간(초) | 3600 |
10.3.1.53 - Set role trust policy
10.3.1.53.1 - 1.2
scpcli iam role trust policy
--role_id <value>
--version <value>
--statement <value>
Description
Set role trust policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
10.3.1.53.2 - 1.1
scpcli iam role trust policy
--role_id <value>
--version <value>
--statement <value>
Description
Set role trust policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
10.3.1.53.3 - 1.0
scpcli iam role trust policy
--role_id <value>
--version <value>
--statement <value>
Description
Set role trust policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | 역할 ID | - |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
10.3.1.54 - Set the policy
10.3.1.54.1 - 1.2
scpcli iam policy set
--policy_id <value>
--version <value>
--statement <value>
[--default_version_id <value>]
[--description <value>]
[--policy_name <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]
Description
Set the policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| default_version_id optional | string | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_name optional | string | Policy Name | Policy1 |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
10.3.1.54.2 - 1.1
scpcli iam policy set
--policy_id <value>
--version <value>
--statement <value>
[--default_version_id <value>]
[--description <value>]
[--policy_name <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]
Description
Set the policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| default_version_id optional | string | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_name optional | string | Policy Name | Policy1 |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
10.3.1.54.3 - 1.0
scpcli iam policy set
--policy_id <value>
--version <value>
--statement <value>
[--default_version_id <value>]
[--description <value>]
[--policy_name <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]
Description
Set the policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| default_version_id optional | string | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_name optional | string | Policy Name | Policy1 |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
10.3.1.55 - Set the resource based policy
10.3.1.55.1 - 1.2
scpcli iam resource policy set
--srn <value>
--version <value>
--statement <value>
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]
Description
Set the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
10.3.1.55.2 - 1.1
scpcli iam resource policy set
--srn <value>
--version <value>
--statement <value>
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]
Description
Set the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
10.3.1.55.3 - 1.0
scpcli iam resource policy set
--srn <value>
--version <value>
--statement <value>
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]
Description
Set the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
10.3.1.56 - Show group policy
10.3.1.56.1 - 1.2
scpcli iam group policy show
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]
Description
Show group policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy Id | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type List | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.56.2 - 1.1
scpcli iam group policy show
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]
Description
Show group policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy Id | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type List | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.56.3 - 1.0
scpcli iam group policy show
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]
Description
Show group policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy Id | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type List | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Project Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | 생성자 Email | samsung.kim@samsung.com |
| creator_name | 생성자 성, 이름 | Kim Samsung |
| default_version_id | Policy Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | 도메인 이름 | scp |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | 수정자 Email | samsung.kim@samsung.com |
| modifier_name | 수정자 성, 이름 | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | 서비스 Display 명 | Identity Access Management |
| service_type | Service Type | iam |
| srn | 삼성 리소스 자원명 | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
10.3.1.57 - Show the policy
10.3.1.57.1 - 1.2
scpcli iam policy show
--policy_id <value>
Description
Show the policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-1 |
10.3.1.57.2 - 1.1
scpcli iam policy show
--policy_id <value>
Description
Show the policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-1 |
10.3.1.57.3 - 1.0
scpcli iam policy show
--policy_id <value>
Description
Show the policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-1 |
10.3.1.58 - Show the resource based policy
10.3.1.58.1 - 1.2
scpcli iam resource policy show
--srn <value>
Description
Show the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | {‘Statement’: [{‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’} |
10.3.1.58.2 - 1.1
scpcli iam resource policy show
--srn <value>
Description
Show the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | {‘Statement’: [{‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’} |
10.3.1.58.3 - 1.0
scpcli iam resource policy show
--srn <value>
Description
Show the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | 삼성 리소스 자원명 | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | {‘Statement’: [{‘Action’: [‘virtualserver:ShowVirtualServer’], ‘Condition’: {‘StringEquals’: {‘scp:RequestedRegion’: [‘kr-west1’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘*’, ‘Resource’: [‘srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’} |
10.3.1.59 - Update IAM user
10.3.1.59.1 - 1.2
scpcli iam iam user set
--user_id <value>
--account_id <value>
--password_reuse_count <value>
[--description <value>]
Description
Update IAM user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
| password_reuse_count required | integer | 비밀 번호 재사용 가능 횟수 | - |
| description optional | string | description | - |
10.3.1.59.2 - 1.1
scpcli iam iam user set
--user_id <value>
--account_id <value>
--password_reuse_count <value>
[--description <value>]
Description
Update IAM user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
| password_reuse_count required | integer | 비밀 번호 재사용 가능 횟수 | - |
| description optional | string | description | - |
10.3.1.59.3 - 1.0
scpcli iam iam user set
--user_id <value>
--account_id <value>
--password_reuse_count <value>
[--description <value>]
Description
Update IAM user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
| password_reuse_count required | integer | 비밀 번호 재사용 가능 횟수 | - |
| description optional | string | description | - |
10.3.1.60 - Update IAM user password
10.3.1.60.1 - 1.2
scpcli iam iam user password set
--user_id <value>
--account_id <value>
--password <value>
[--temporary_password <value>]
Description
Update IAM user password
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
| password required | string | 비밀 번호 | - |
| temporary_password optional | boolean | temporary | - |
10.3.1.60.2 - 1.1
scpcli iam iam user password set
--user_id <value>
--account_id <value>
--password <value>
[--temporary_password <value>]
Description
Update IAM user password
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
| password required | string | 비밀 번호 | - |
| temporary_password optional | boolean | temporary | - |
10.3.1.60.3 - 1.0
scpcli iam iam user password set
--user_id <value>
--account_id <value>
--password <value>
[--temporary_password <value>]
Description
Update IAM user password
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID | - |
| password required | string | 비밀 번호 | - |
| temporary_password optional | boolean | temporary | - |
10.3.1.61 - Update saml provider information
10.3.1.61.1 - 1.2
scpcli iam saml provider set
--saml_provider_id <value>
[--description <value>]
[--file <value>]
[--saml_provider_name <value>]
[--tags <value>]
Description
Update saml provider information
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | 자격증명공급자 ID | - |
| description optional | string | 자격증명공급자 설명 | SAML provider Description |
| file optional | string | 메타데이터 파일 | keycloak-idp-saml.xml |
| saml_provider_name optional | string | 자격증명공급자 이름 | IdpTest |
| tags optional | array | 태그 | {'key': 'company', 'value': 'SDS'} |
10.3.1.61.2 - 1.1
scpcli iam saml provider set
--saml_provider_id <value>
[--description <value>]
[--file <value>]
[--saml_provider_name <value>]
[--tags <value>]
Description
Update saml provider information
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | 자격증명공급자 ID | - |
| description optional | string | 자격증명공급자 설명 | SAML provider Description |
| file optional | string | 메타데이터 파일 | keycloak-idp-saml.xml |
| saml_provider_name optional | string | 자격증명공급자 이름 | IdpTest |
| tags optional | array | 태그 | {'key': 'company', 'value': 'SDS'} |
10.3.1.61.3 - 1.0
scpcli iam saml provider set
--saml_provider_id <value>
[--description <value>]
[--file <value>]
[--saml_provider_name <value>]
[--tags <value>]
Description
Update saml provider information
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | 자격증명공급자 ID | - |
| description optional | string | 자격증명공급자 설명 | SAML provider Description |
| file optional | string | 메타데이터 파일 | keycloak-idp-saml.xml |
| saml_provider_name optional | string | 자격증명공급자 이름 | IdpTest |
| tags optional | array | 태그 | {'key': 'company', 'value': 'SDS'} |
10.4 - ID Center
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 IAM 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260223 |
| 1.1 | SUPPORTED | 20260531 |
| 1.2 | CURRENT | - |
10.4.1 - CLIs
10.4.1.1 - CreateAccountAssignment
10.4.1.1.1 - 1.2
scpcli iam-identity-center create account assignments
--instance_id <value>
[--accounts <value>]
[--permission_sets <value>]
[--principals <value>]
Description
set a specific account Assignment
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| accounts optional | array | '{"target_account_email": "target_account@example.com", "target_account_id": "3265ab469f0d406d83073da3e11e7a6c", "target_account_name": "target_account@example.com"}' | |
| permission_sets optional | array | '{"custom_policies": [], "inline_policies": [], "managed_policies": [], "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1", "permission_set_name": "Permission Set", "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}", "session_duration": 3600}' | |
| principals optional | array | '{"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2", "principal_type": "USER"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| permission_set_id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_id | 주체 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_type | 주체 유형 | USER |
| target_account_id | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
10.4.1.1.2 - 1.1
scpcli iam-identity-center create account assignments
--instance_id <value>
[--accounts <value>]
[--permission_sets <value>]
[--principals <value>]
Description
set a specific account Assignment
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| accounts optional | array | '{"target_account_email": "target_account@example.com", "target_account_id": "3265ab469f0d406d83073da3e11e7a6c", "target_account_name": "target_account@example.com"}' | |
| permission_sets optional | array | '{"customer_policies": [], "inline_policies": [], "managed_policies": [], "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1", "permission_set_name": "Permission Set", "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}", "session_duration": 3600}' | |
| principals optional | array | '{"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2", "principal_type": "USER"}' |
Responses
| Name | Description | Example |
|---|---|---|
| account_assignment_id | 할당 ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| permission_set_id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_id | 주체 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_type | 주체 유형 | USER |
| role_srn | 권한 세트 설명 | Permissions for administrators |
| target_account_id | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
10.4.1.1.3 - 1.0
scpcli iam-identity-center create account assignments
--instance_id <value>
[--accounts <value>]
[--permission_sets <value>]
[--principals <value>]
Description
set a specific account Assignment
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| accounts optional | array | '{"target_account_email": "target_account@example.com", "target_account_id": "3265ab469f0d406d83073da3e11e7a6c", "target_account_name": "target_account@example.com"}' | |
| permission_sets optional | array | '{"customer_policies": [], "inline_policies": [], "managed_policies": [], "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1", "permission_set_name": "Permission Set", "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}", "session_duration": 3600}' | |
| principals optional | array | '{"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2", "principal_type": "USER"}' |
Responses
| Name | Description | Example |
|---|---|---|
| account_assignment_id | 할당 ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| permission_set_id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_id | 주체 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_type | 주체 유형 | USER |
| role_srn | 권한 세트 설명 | Permissions for administrators |
| target_account_id | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
10.4.1.2 - CreateBulkGroupUsers
10.4.1.2.1 - 1.2
scpcli iam-identity-center group bulk user add
--group_id <value>
--user_uuids <value>
--instance_id <value>
Description
add multiple users to a specific group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | 사용자 ID 목록 | user-12345 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.2.2 - 1.1
scpcli iam-identity-center group bulk user add
--group_id <value>
--user_uuids <value>
--instance_id <value>
Description
add multiple users to a specific group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | 사용자 ID 목록 | user-12345 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.2.3 - 1.0
scpcli iam-identity-center group bulk user add
--group_id <value>
--user_uuids <value>
--instance_id <value>
Description
add multiple users to a specific group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | 사용자 ID 목록 | user-12345 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.3 - CreateGroup
10.4.1.3.1 - 1.2
scpcli iam-identity-center group create
--name <value>
--instance_id <value>
[--description <value>]
[--user_uuids <value>]
Description
create a group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 그룹 이름 | Admin_Group |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| description optional | string | 그룹 설명 | Group for administrators |
| user_uuids optional | array | 그룹에 추가할 사용자 ID 목록 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.3.2 - 1.1
scpcli iam-identity-center group create
--name <value>
--instance_id <value>
[--description <value>]
[--user_uuids <value>]
Description
create a group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 그룹 이름 | Admin_Group |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| description optional | string | 그룹 설명 | Group for administrators |
| user_uuids optional | array | 그룹에 추가할 사용자 ID 목록 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.3.3 - 1.0
scpcli iam-identity-center group create
--name <value>
--instance_id <value>
[--description <value>]
[--user_uuids <value>]
Description
create a group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 그룹 이름 | Admin_Group |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| description optional | string | 그룹 설명 | Group for administrators |
| user_uuids optional | array | 그룹에 추가할 사용자 ID 목록 | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.4 - CreateInstance
10.4.1.4.1 - 1.2
scpcli iam-identity-center instance create
--name <value>
[--description <value>]
[--identity_store_type <value>]
[--bind_credential <value>]
[--bind_dn <value>]
[--connection_url <value>]
[--rdn_ldap_attribute <value>]
[--user_object_classes <value>]
[--username_ldap_attribute <value>]
[--users_dn <value>]
Description
create a instance
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 인스턴스 이름 | My Instance |
| description optional | string | 인스턴스 설명 | My Instance Description |
| identity_store_type optional | string | 자격 증명 소스 유형 | - |
| bind_credential optional | string | Bind 비밀번호 | password |
| bind_dn optional | string | Bind DN | CN=Administrator,CN=Users,DC=test,DC=add |
| connection_url optional | string | LDAP 서버 URL | ldaps://test.subdomain.company.com:123 |
| rdn_ldap_attribute optional | string | RDN LDAP 속성 | cn |
| user_object_classes optional | string | 사용자 객체 클래스 | person, organizationalPerson, user |
| username_ldap_attribute optional | string | 사용자 이름 LDAP 속성 | sAMAccountName |
| users_dn optional | string | 사용자 DN | OU=Employees,OU=Accounts,DC=sub,DC=org |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인스턴스 ID | ssoins-12345 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delegated_account_id | 위임된 관리자 계정 ID | acc-2353 |
| delegated_at | 위임 일시 | 2023-10-15 14:30:00 |
| delegated_by | 위임자 ID | sef2w3c8c29a449dbfa8681f8f1d78e2 |
| description | 인스턴스 설명 | My Instance Description |
| identity_store_config | 자격 증명 소스 설정 | {‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’} |
| identity_store_id | 자격 증명 소스 ID | d-12345 |
| identity_store_type | 자격 증명 소스 유형 | |
| last_sync_at | 마지막 동기화 날짜 | 2025-08-06 10:30:00 |
| last_sync_status | 마지막 동기화 상태 | [‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’] |
| master_account_id | 관리자 계정 ID | acc-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 인스턴스 이름 | My Instance |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | 인스턴스 SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| sso_start_url | SSO 시작 URL | https://login.e.samsungsdscloud.com/d-12345 |
| state | 상태 |
10.4.1.4.2 - 1.1
scpcli iam-identity-center instance create
--name <value>
[--description <value>]
[--identity_store_type <value>]
[--bind_credential <value>]
[--bind_dn <value>]
[--connection_url <value>]
[--rdn_ldap_attribute <value>]
[--user_object_classes <value>]
[--username_ldap_attribute <value>]
[--users_dn <value>]
Description
create a instance
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 인스턴스 이름 | My Instance |
| description optional | string | 인스턴스 설명 | My Instance Description |
| identity_store_type optional | string | 자격 증명 소스 유형 | - |
| bind_credential optional | string | Bind 비밀번호 | password |
| bind_dn optional | string | Bind DN | CN=Administrator,CN=Users,DC=test,DC=add |
| connection_url optional | string | LDAP 서버 URL | ldaps://test.subdomain.company.com:123 |
| rdn_ldap_attribute optional | string | RDN LDAP 속성 | cn |
| user_object_classes optional | string | 사용자 객체 클래스 | person, organizationalPerson, user |
| username_ldap_attribute optional | string | 사용자 이름 LDAP 속성 | sAMAccountName |
| users_dn optional | string | 사용자 DN | OU=Employees,OU=Accounts,DC=sub,DC=org |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인스턴스 ID | ssoins-12345 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| delegated_account_id | 위임된 관리자 계정 ID | acc-2353 |
| delegated_at | 위임 일시 | 2023-10-15 14:30:00 |
| delegated_by | 위임자 ID | sef2w3c8c29a449dbfa8681f8f1d78e2 |
| description | 인스턴스 설명 | My Instance Description |
| identity_store_config | 자격 증명 소스 설정 | {‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’} |
| identity_store_id | 자격 증명 소스 ID | d-12345 |
| identity_store_type | 자격 증명 소스 유형 | |
| last_sync_at | 마지막 동기화 날짜 | 2025-08-06 10:30:00 |
| last_sync_status | 마지막 동기화 상태 | [‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’] |
| master_account_id | 관리자 계정 ID | acc-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 인스턴스 이름 | My Instance |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | 인스턴스 SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| sso_start_url | SSO 시작 URL | https://login.e.samsungsdscloud.com/d-12345 |
| state | 상태 |
10.4.1.5 - CreatePermissionSet
10.4.1.5.1 - 1.2
scpcli iam-identity-center permission set create
--session_duration <value>
--name <value>
--instance_id <value>
[--custom_policies <value>]
[--description <value>]
[--inline_policies <value>]
[--managed_policies <value>]
Description
create a permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| session_duration required | integer | 최대 세션 지속 시간 | 3600 |
| name required | string | 인스턴스 이름 | My Instance |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| custom_policies optional | array | 고객 관리 정책 | - |
| description optional | string | 인스턴스 설명 | My Instance Description |
| inline_policies optional | array | 인라인 정책 | - |
| managed_policies optional | array | 관리 정책 | '{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| custom_policies | 고객 관리 정책 | |
| description | 권한 세트 설명 | Permissions for administrators |
| inline_policies | 인라인 정책 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| managed_policies | 관리 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| session_duration | 최대 세션 지속 시간 | 3600 |
| srn | 권한 세트 SRN | srn: |
| state | 상태 |
10.4.1.5.2 - 1.1
scpcli iam-identity-center permission set create
--session_duration <value>
--name <value>
--instance_id <value>
[--customer_policies <value>]
[--description <value>]
[--inline_policies <value>]
[--managed_policies <value>]
Description
create a permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| session_duration required | integer | 최대 세션 지속 시간 | 3600 |
| name required | string | 인스턴스 이름 | My Instance |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| customer_policies optional | array | 고객 관리 정책 | - |
| description optional | string | 인스턴스 설명 | My Instance Description |
| inline_policies optional | array | 인라인 정책 | - |
| managed_policies optional | array | 관리 정책 | '{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| customer_policies | 고객 관리 정책 | |
| description | 권한 세트 설명 | Permissions for administrators |
| inline_policies | 인라인 정책 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| managed_policies | 관리 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| session_duration | 최대 세션 지속 시간 | 3600 |
| srn | 권한 세트 SRN | srn: |
| state | 상태 |
10.4.1.5.3 - 1.0
scpcli iam-identity-center permission set create
--session_duration <value>
--name <value>
--instance_id <value>
[--customer_policies <value>]
[--description <value>]
[--inline_policies <value>]
[--managed_policies <value>]
Description
create a permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| session_duration required | integer | 최대 세션 지속 시간 | 3600 |
| name required | string | 인스턴스 이름 | My Instance |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| customer_policies optional | array | 고객 관리 정책 | - |
| description optional | string | 인스턴스 설명 | My Instance Description |
| inline_policies optional | array | 인라인 정책 | - |
| managed_policies optional | array | 관리 정책 | '{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| customer_policies | 고객 관리 정책 | |
| description | 권한 세트 설명 | Permissions for administrators |
| inline_policies | 인라인 정책 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| managed_policies | 관리 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| session_duration | 최대 세션 지속 시간 | 3600 |
| srn | 권한 세트 SRN | srn: |
| state | 상태 |
10.4.1.6 - CreateUser
10.4.1.6.1 - 1.2
scpcli iam-identity-center user create
--user_id <value>
--name <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--group_ids <value>]
[--manager <value>]
[--nation_id <value>]
[--password <value>]
[--phone_number <value>]
[--temporary_password <value>]
Description
create a user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | 사용자 로그인 ID | johndoe |
| name required | string | 사용자 실명 | John Doe |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| business_unit optional | string | 사업부 | Business Unit A |
| department optional | string | 부서 | Department X |
| description optional | string | 사용자 설명 | Description of John Doe |
| email optional | string | 사용자 이메일 | john.doe@example.com |
| employee_id optional | string | 사번 | emp-12345 |
| group_ids optional | array | 사용자 속한 그룹 목록 | 39520424-440c-41c0-9b9c-f22b2129f6f9 |
| manager optional | string | 관리자 | Alice Smith |
| nation_id optional | string | 국가 ID | +82 |
| password optional | string | 비밀번호 | - |
| phone_number optional | string | 휴대폰 번호 | 010-1234-5678 |
| temporary_password optional | boolean | 임시 비밀번호 여부 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | 사업부 | Business Unit A |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| department | 부서 | Department X |
| description | 사용자 설명 | Description of John Doe |
| 사용자 이메일 | john.doe@example.com | |
| email_authenticated | 이메일 인증 여부 | |
| employee_id | 사번 | emp-12345 |
| groups | 그룹 목록 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| last_login_at | 마지막 로그인 일시 | 2024-12-19 01:09:05.000 |
| last_password_update_at | 최근 비밀번호 변경 일시 | 2025-11-24T08:14:51.694996 |
| manager | 관리자 | Alice Smith |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 사용자 실명 | John Doe |
| nation_id | 국가 ID | +82 |
| password | 비밀번호 | |
| password_failed_count | 비밀번호 실패 횟수 | 6 |
| password_reuse_count | 비밀번호 재사용 제한 횟수 | 6 |
| phone_authenticated | 휴대폰 인증 여부 | |
| phone_number | 휴대폰 번호 | 010-1234-5678 |
| temporary_password | 임시 비밀번호 여부 | |
| tz_id | 타임존 ID | Asia/Seoul |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.6.2 - 1.1
scpcli iam-identity-center user create
--user_id <value>
--name <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--group_ids <value>]
[--manager <value>]
[--nation_id <value>]
[--password <value>]
[--phone_number <value>]
[--temporary_password <value>]
Description
create a user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | 사용자 로그인 ID | johndoe |
| name required | string | 사용자 실명 | John Doe |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| business_unit optional | string | 사업부 | Business Unit A |
| department optional | string | 부서 | Department X |
| description optional | string | 사용자 설명 | Description of John Doe |
| email optional | string | 사용자 이메일 | john.doe@example.com |
| employee_id optional | string | 사번 | emp-12345 |
| group_ids optional | array | 사용자 속한 그룹 목록 | 39520424-440c-41c0-9b9c-f22b2129f6f9 |
| manager optional | string | 관리자 | Alice Smith |
| nation_id optional | string | 국가 ID | +82 |
| password optional | string | 비밀번호 | - |
| phone_number optional | string | 휴대폰 번호 | 010-1234-5678 |
| temporary_password optional | boolean | 임시 비밀번호 여부 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | 사업부 | Business Unit A |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| department | 부서 | Department X |
| description | 사용자 설명 | Description of John Doe |
| 사용자 이메일 | john.doe@example.com | |
| email_authenticated | 이메일 인증 여부 | |
| employee_id | 사번 | emp-12345 |
| groups | 그룹 목록 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| last_login_at | 마지막 로그인 일시 | 2024-12-19 01:09:05.000 |
| last_password_update_at | 최근 비밀번호 변경 일시 | 2025-11-24T08:14:51.694996 |
| manager | 관리자 | Alice Smith |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 사용자 실명 | John Doe |
| nation_id | 국가 ID | +82 |
| password | 비밀번호 | |
| password_failed_count | 비밀번호 실패 횟수 | 6 |
| password_reuse_count | 비밀번호 재사용 제한 횟수 | 6 |
| phone_authenticated | 휴대폰 인증 여부 | |
| phone_number | 휴대폰 번호 | 010-1234-5678 |
| temporary_password | 임시 비밀번호 여부 | |
| tz_id | 타임존 ID | Asia/Seoul |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.6.3 - 1.0
scpcli iam-identity-center user create
--user_id <value>
--name <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--group_ids <value>]
[--manager <value>]
[--nation_id <value>]
[--password <value>]
[--phone_number <value>]
[--temporary_password <value>]
Description
create a user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | 사용자 로그인 ID | johndoe |
| name required | string | 사용자 실명 | John Doe |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| business_unit optional | string | 사업부 | Business Unit A |
| department optional | string | 부서 | Department X |
| description optional | string | 사용자 설명 | Description of John Doe |
| email optional | string | 사용자 이메일 | john.doe@example.com |
| employee_id optional | string | 사번 | emp-12345 |
| group_ids optional | array | 사용자 속한 그룹 목록 | 39520424-440c-41c0-9b9c-f22b2129f6f9 |
| manager optional | string | 관리자 | Alice Smith |
| nation_id optional | string | 국가 ID | +82 |
| password optional | string | 비밀번호 | - |
| phone_number optional | string | 휴대폰 번호 | 010-1234-5678 |
| temporary_password optional | boolean | 임시 비밀번호 여부 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | 사업부 | Business Unit A |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| department | 부서 | Department X |
| description | 사용자 설명 | Description of John Doe |
| 사용자 이메일 | john.doe@example.com | |
| email_authenticated | 이메일 인증 여부 | |
| employee_id | 사번 | emp-12345 |
| groups | 그룹 목록 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| last_login_at | 마지막 로그인 일시 | 2024-12-19 01:09:05.000 |
| last_password_update_at | 최근 비밀번호 변경 일시 | 2025-11-24T08:14:51.694996 |
| manager | 관리자 | Alice Smith |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 사용자 실명 | John Doe |
| nation_id | 국가 ID | +82 |
| password | 비밀번호 | |
| password_failed_count | 비밀번호 실패 횟수 | 6 |
| password_reuse_count | 비밀번호 재사용 제한 횟수 | 6 |
| phone_authenticated | 휴대폰 인증 여부 | |
| phone_number | 휴대폰 번호 | 010-1234-5678 |
| temporary_password | 임시 비밀번호 여부 | |
| tz_id | 타임존 ID | Asia/Seoul |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.7 - DeleteAccountAssignment
10.4.1.7.1 - 1.2
scpcli iam-identity-center account delete
--account_assignment_id <value>
--target_account_id <value>
--instance_id <value>
[--only_user_removed <value>]
Description
delete a specific account Assignment
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_assignment_id required | string | 할당 ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| target_account_id required | string | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| only_user_removed optional | boolean | 직접 적용 제외 여부 | - |
10.4.1.7.2 - 1.1
scpcli iam-identity-center account delete
--account_assignment_id <value>
--target_account_id <value>
--instance_id <value>
[--only_user_removed <value>]
Description
delete a specific account Assignment
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_assignment_id required | string | 할당 ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| target_account_id required | string | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| only_user_removed optional | boolean | 직접 적용 제외 여부 | - |
10.4.1.7.3 - 1.0
scpcli iam-identity-center account delete
--account_assignment_id <value>
--target_account_id <value>
--instance_id <value>
[--only_user_removed <value>]
Description
delete a specific account Assignment
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_assignment_id required | string | 할당 ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| target_account_id required | string | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| only_user_removed optional | boolean | 직접 적용 제외 여부 | - |
10.4.1.8 - DeleteBulkAccountAssignment
10.4.1.8.1 - 1.2
scpcli iam-identity-center account bulk delete
--target_account_id <value>
--instance_id <value>
[--account_assignment_ids <value>]
[--only_user_removed <value>]
Description
delete multiple account Assignment
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| account_assignment_ids optional | array | 할당 ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| only_user_removed optional | boolean | 직접 적용 제외 여부 | - |
10.4.1.8.2 - 1.1
scpcli iam-identity-center account bulk delete
--target_account_id <value>
--instance_id <value>
[--account_assignment_ids <value>]
[--only_user_removed <value>]
Description
delete multiple account Assignment
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| account_assignment_ids optional | array | 할당 ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| only_user_removed optional | boolean | 직접 적용 제외 여부 | - |
10.4.1.8.3 - 1.0
scpcli iam-identity-center account bulk delete
--target_account_id <value>
--instance_id <value>
[--account_assignment_ids <value>]
[--only_user_removed <value>]
Description
delete multiple account Assignment
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| account_assignment_ids optional | array | 할당 ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| only_user_removed optional | boolean | 직접 적용 제외 여부 | - |
10.4.1.9 - DeleteBulkGroups
10.4.1.9.1 - 1.2
scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>
Description
delete groups
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| group_ids required | array | 그룹 ID 목록 | group-12345 |
10.4.1.9.2 - 1.1
scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>
Description
delete groups
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| group_ids required | array | 그룹 ID 목록 | group-12345 |
10.4.1.9.3 - 1.0
scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>
Description
delete groups
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| group_ids required | array | 그룹 ID 목록 | group-12345 |
10.4.1.10 - DeleteBulkGroupUsers
10.4.1.10.1 - 1.2
scpcli iam-identity-center group user remove
--group_id <value>
--user_uuids <value>
--instance_id <value>
Description
remove users from the specific group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | 사용자 ID 목록 | user-12345 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.10.2 - 1.1
scpcli iam-identity-center group user remove
--group_id <value>
--user_uuids <value>
--instance_id <value>
Description
remove users from the specific group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | 사용자 ID 목록 | user-12345 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.10.3 - 1.0
scpcli iam-identity-center group user remove
--group_id <value>
--user_uuids <value>
--instance_id <value>
Description
remove users from the specific group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | 사용자 ID 목록 | user-12345 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.11 - DeleteBulkUsers
10.4.1.11.1 - 1.2
scpcli iam-identity-center user bulk delete
--user_uuids <value>
--instance_id <value>
Description
delete bulk users
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuids required | array | 사용자 ID 목록 | user-12345 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.11.2 - 1.1
scpcli iam-identity-center user bulk delete
--user_uuids <value>
--instance_id <value>
Description
delete bulk users
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuids required | array | 사용자 ID 목록 | user-12345 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.11.3 - 1.0
scpcli iam-identity-center user bulk delete
--user_uuids <value>
--instance_id <value>
Description
delete bulk users
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuids required | array | 사용자 ID 목록 | user-12345 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.12 - DeleteGroup
10.4.1.12.1 - 1.2
scpcli iam-identity-center group delete
--group_id <value>
--instance_id <value>
Description
delete a specific group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.12.2 - 1.1
scpcli iam-identity-center group delete
--group_id <value>
--instance_id <value>
Description
delete a specific group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.12.3 - 1.0
scpcli iam-identity-center group delete
--group_id <value>
--instance_id <value>
Description
delete a specific group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.13 - DeleteInstance
10.4.1.13.1 - 1.2
scpcli iam-identity-center instance delete
--instance_id <value>
Description
delete a specific instance
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.13.2 - 1.1
scpcli iam-identity-center instance delete
--instance_id <value>
Description
delete a specific instance
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.13.3 - 1.0
scpcli iam-identity-center instance delete
--instance_id <value>
Description
delete a specific instance
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.14 - DeletePermissionSet
10.4.1.14.1 - 1.2
scpcli iam-identity-center permission set delete
--permission_set_id <value>
--instance_id <value>
Description
delete a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.14.2 - 1.1
scpcli iam-identity-center permission set delete
--permission_set_id <value>
--instance_id <value>
Description
delete a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.14.3 - 1.0
scpcli iam-identity-center permission set delete
--permission_set_id <value>
--instance_id <value>
Description
delete a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.15 - DeletePermissionSetPolicies
10.4.1.15.1 - 1.2
scpcli iam-identity-center permission set delete policies
--permission_set_id <value>
--policy_ids <value>
--instance_id <value>
Description
delete policies to a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| policy_ids required | array | - | |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.15.2 - 1.1
scpcli iam-identity-center permission set delete policies
--permission_set_id <value>
--policy_ids <value>
--instance_id <value>
Description
delete policies to a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| policy_ids required | array | - | |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.15.3 - 1.0
scpcli iam-identity-center permission set delete policies
--permission_set_id <value>
--policy_ids <value>
--instance_id <value>
Description
delete policies to a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| policy_ids required | array | - | |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.16 - DeleteUser
10.4.1.16.1 - 1.2
scpcli iam-identity-center user delete
--user_uuid <value>
--instance_id <value>
Description
delete a specific user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.16.2 - 1.1
scpcli iam-identity-center user delete
--user_uuid <value>
--instance_id <value>
Description
delete a specific user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.16.3 - 1.0
scpcli iam-identity-center user delete
--user_uuid <value>
--instance_id <value>
Description
delete a specific user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
10.4.1.17 - ListAccountAssignments
10.4.1.17.1 - 1.2
scpcli iam-identity-center list account assignment
--target_account_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--target_account_name <value>]
[--target_account_email <value>]
[--permission_set_id <value>]
[--principal_name <value>]
[--role_srn <value>]
Description
get account assignment list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| target_account_name optional | string | 할당된 Account명 | Admin Account |
| target_account_email optional | string | 할당된 계정 이메일 | target_account@example.com |
| permission_set_id optional | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_name optional | string | 주체 이름 | GROUP0407 |
| role_srn optional | string | 역할 SRN | srn:role:kr-j:1234:role/admin@example.com |
Responses
| Name | Description | Example |
|---|---|---|
| instance_id | 인스턴스 ID | ssoins-12345 |
| permission_sets | ||
| principal_id | 주체 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_name | 주체 이름 | GROUP0407 |
| principal_type | 주체 유형 | USER |
| role_srn | 권한 세트 설명 | Permissions for administrators |
| target_account_email | 할당된 계정 이메일 | target_account@example.com |
| target_account_id | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| target_account_name | 할당된 Account명 | Admin Account |
10.4.1.17.2 - 1.1
scpcli iam-identity-center list account assignment
--target_account_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--target_account_name <value>]
[--target_account_email <value>]
[--permission_set_id <value>]
[--principal_name <value>]
[--role_srn <value>]
Description
get account assignment list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| target_account_name optional | string | 할당된 Account명 | Admin Account |
| target_account_email optional | string | 할당된 계정 이메일 | target_account@example.com |
| permission_set_id optional | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_name optional | string | 주체 이름 | GROUP0407 |
| role_srn optional | string | 역할 SRN | srn:role:kr-j:1234:role/admin@example.com |
Responses
| Name | Description | Example |
|---|---|---|
| instance_id | 인스턴스 ID | ssoins-12345 |
| permission_sets | ||
| principal_id | 주체 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_name | 주체 이름 | GROUP0407 |
| principal_type | 주체 유형 | USER |
| role_srn | 권한 세트 설명 | Permissions for administrators |
| target_account_email | 할당된 계정 이메일 | target_account@example.com |
| target_account_id | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| target_account_name | 할당된 Account명 | Admin Account |
10.4.1.17.3 - 1.0
scpcli iam-identity-center list account assignment
--target_account_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--target_account_name <value>]
[--target_account_email <value>]
[--permission_set_id <value>]
[--principal_name <value>]
[--role_srn <value>]
Description
get account assignment list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| target_account_name optional | string | 할당된 Account명 | Admin Account |
| target_account_email optional | string | 할당된 계정 이메일 | target_account@example.com |
| permission_set_id optional | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_name optional | string | 주체 이름 | GROUP0407 |
| role_srn optional | string | 역할 SRN | srn:role:kr-j:1234:role/admin@example.com |
Responses
| Name | Description | Example |
|---|---|---|
| instance_id | 인스턴스 ID | ssoins-12345 |
| permission_sets | ||
| principal_id | 주체 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_name | 주체 이름 | GROUP0407 |
| principal_type | 주체 유형 | USER |
| role_srn | 권한 세트 설명 | Permissions for administrators |
| target_account_email | 할당된 계정 이메일 | target_account@example.com |
| target_account_id | 할당된 계정 ID | 3265ab469f0d406d83073da3e11e7a6c |
| target_account_name | 할당된 Account명 | Admin Account |
10.4.1.18 - ListGroups
10.4.1.18.1 - 1.2
scpcli iam-identity-center group list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--excluded_user_uuid <value>]
[--excluded_account_id <value>]
Description
get groups list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 그룹 이름 | Admin_Group |
| excluded_user_uuid optional | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.18.2 - 1.1
scpcli iam-identity-center group list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--excluded_user_uuid <value>]
[--excluded_account_id <value>]
Description
get groups list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 그룹 이름 | Admin_Group |
| excluded_user_uuid optional | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.18.3 - 1.0
scpcli iam-identity-center group list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--excluded_user_uuid <value>]
[--excluded_account_id <value>]
Description
get groups list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 그룹 이름 | Admin_Group |
| excluded_user_uuid optional | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.19 - ListGroupUsers
10.4.1.19.1 - 1.2
scpcli iam-identity-center group users list
--group_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
Description
get group users list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| group_count | 사용자 속한 그룹 개수 | 2 |
| groups | 사용자 속한 그룹 목록 | [{‘created_at’: ‘2025-07-03T12:05:11’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘39520424-440c-41c0-9b9c-f22b2129f6f9’, ‘modified_at’: ‘2025-07-03T12:05:11’, ‘modified_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ’name’: ‘admin’}, {‘created_at’: ‘2025-07-03T12:05:36’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘80c53fe1-4e27-4cce-92be-151cf0f2873e’, ‘modified_at’: ‘2025-07-07T05:16:58’, ‘modified_by’: ‘941e76c4b9424cd9b0ac3a12d5f4335d’, ’name’: ’test-group’}] |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 사용자 실명 | John Doe |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.19.2 - 1.1
scpcli iam-identity-center group users list
--group_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
Description
get group users list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| group_count | 사용자 속한 그룹 개수 | 2 |
| groups | 사용자 속한 그룹 목록 | [{‘created_at’: ‘2025-07-03T12:05:11’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘39520424-440c-41c0-9b9c-f22b2129f6f9’, ‘modified_at’: ‘2025-07-03T12:05:11’, ‘modified_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ’name’: ‘admin’}, {‘created_at’: ‘2025-07-03T12:05:36’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘80c53fe1-4e27-4cce-92be-151cf0f2873e’, ‘modified_at’: ‘2025-07-07T05:16:58’, ‘modified_by’: ‘941e76c4b9424cd9b0ac3a12d5f4335d’, ’name’: ’test-group’}] |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 사용자 실명 | John Doe |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.19.3 - 1.0
scpcli iam-identity-center group users list
--group_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
Description
get group users list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| group_count | 사용자 속한 그룹 개수 | 2 |
| groups | 사용자 속한 그룹 목록 | [{‘created_at’: ‘2025-07-03T12:05:11’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘39520424-440c-41c0-9b9c-f22b2129f6f9’, ‘modified_at’: ‘2025-07-03T12:05:11’, ‘modified_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ’name’: ‘admin’}, {‘created_at’: ‘2025-07-03T12:05:36’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘80c53fe1-4e27-4cce-92be-151cf0f2873e’, ‘modified_at’: ‘2025-07-07T05:16:58’, ‘modified_by’: ‘941e76c4b9424cd9b0ac3a12d5f4335d’, ’name’: ’test-group’}] |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 사용자 실명 | John Doe |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.20 - ListInstances
10.4.1.20.1 - 1.2
scpcli iam-identity-center instance list
[--size <value>]
[--page <value>]
[--sort <value>]
Description
get instances list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인스턴스 ID | ssoins-12345 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| master_account_id | 관리자 계정 ID | acc-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | 인스턴스 SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| state | 상태 |
10.4.1.20.2 - 1.1
scpcli iam-identity-center instance list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
get instances list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
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 | 인스턴스 이름 | My Instance |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인스턴스 ID | ssoins-12345 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| master_account_id | 관리자 계정 ID | acc-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | 인스턴스 SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| state | 상태 |
10.4.1.20.3 - 1.0
scpcli iam-identity-center instance list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
get instances list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
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 | 인스턴스 이름 | My Instance |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인스턴스 ID | ssoins-12345 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| master_account_id | 관리자 계정 ID | acc-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | 인스턴스 SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| state | 상태 |
10.4.1.21 - ListPermissionSetPolicies
10.4.1.21.1 - 1.2
scpcli iam-identity-center permission set get policies
--permission_set_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--category <value>]
[--name <value>]
Description
get policies to a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| category optional | **** | 정책 유형 | INLINE_POLICY |
| name optional | string | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | 정책 ID | 37f2e31ff86b415698d7e8eeafab445d |
| category | 정책 유형 | INLINE_POLICY |
| contents | JSON Document | |
| name | 기본 정책명 | PolicyName |
| permission_set_id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
10.4.1.21.2 - 1.1
scpcli iam-identity-center permission set get policies
--permission_set_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--category <value>]
[--name <value>]
Description
get policies to a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| category optional | **** | 정책 유형 | INLINE_POLICY |
| name optional | string | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | 정책 ID | 37f2e31ff86b415698d7e8eeafab445d |
| category | 정책 유형 | INLINE_POLICY |
| contents | JSON Document | |
| name | 기본 정책명 | PolicyName |
| permission_set_id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
10.4.1.21.3 - 1.0
scpcli iam-identity-center permission set get policies
--permission_set_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--category <value>]
[--name <value>]
Description
get policies to a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| category optional | **** | 정책 유형 | INLINE_POLICY |
| name optional | string | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | 정책 ID | 37f2e31ff86b415698d7e8eeafab445d |
| category | 정책 유형 | INLINE_POLICY |
| contents | JSON Document | |
| name | 기본 정책명 | PolicyName |
| permission_set_id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
10.4.1.22 - ListPermissionSets
10.4.1.22.1 - 1.2
scpcli iam-identity-center permission set list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
get permission sets list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 권한 세트 이름 | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| custom_policies | 고객 관리 정책 | |
| description | 권한 세트 설명 | Permissions for administrators |
| inline_policies | 인라인 정책 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| managed_policies | 관리 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| session_duration | 최대 세션 지속 시간 | 3600 |
| srn | 권한 세트 SRN | srn: |
| state | 상태 |
10.4.1.22.2 - 1.1
scpcli iam-identity-center permission set list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
get permission sets list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 권한 세트 이름 | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| description | 권한 세트 설명 | Permissions for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| state | 상태 |
10.4.1.22.3 - 1.0
scpcli iam-identity-center permission set list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
get permission sets list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 권한 세트 이름 | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| description | 권한 세트 설명 | Permissions for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| state | 상태 |
10.4.1.23 - ListUsers
10.4.1.23.1 - 1.2
scpcli iam-identity-center user list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
[--excluded_group_id <value>]
[--excluded_account_id <value>]
Description
get users list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | 사용자 로그인 ID | johndoe |
| excluded_group_id optional | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name | 사용자 실명 | John Doe |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.23.2 - 1.1
scpcli iam-identity-center user list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
[--excluded_group_id <value>]
[--excluded_account_id <value>]
Description
get users list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | 사용자 로그인 ID | johndoe |
| excluded_group_id optional | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name | 사용자 실명 | John Doe |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.23.3 - 1.0
scpcli iam-identity-center user list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
[--excluded_group_id <value>]
[--excluded_account_id <value>]
Description
get users list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | 사용자 로그인 ID | johndoe |
| excluded_group_id optional | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name | 사용자 실명 | John Doe |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.24 - SetGroup
10.4.1.24.1 - 1.2
scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]
Description
set a specific group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| description optional | string | 그룹 설명 | Group for administrators |
| name optional | string | 그룹 이름 | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
10.4.1.24.2 - 1.1
scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]
Description
set a specific group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| description optional | string | 그룹 설명 | Group for administrators |
| name optional | string | 그룹 이름 | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
10.4.1.24.3 - 1.0
scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]
Description
set a specific group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| description optional | string | 그룹 설명 | Group for administrators |
| name optional | string | 그룹 이름 | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
10.4.1.25 - SetPermissionSet
10.4.1.25.1 - 1.2
scpcli iam-identity-center permission set set
--permission_set_id <value>
--instance_id <value>
[--description <value>]
[--session_duration <value>]
Description
set a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| description optional | string | 인스턴스 설명 | My Instance Description |
| session_duration optional | integer | 최대 세션 지속 시간 | 3600 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| custom_policies | 고객 관리 정책 | |
| description | 권한 세트 설명 | Permissions for administrators |
| inline_policies | 인라인 정책 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| managed_policies | 관리 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| session_duration | 최대 세션 지속 시간 | 3600 |
| srn | 권한 세트 SRN | srn: |
| state | 상태 |
10.4.1.25.2 - 1.1
scpcli iam-identity-center permission set set
--permission_set_id <value>
--instance_id <value>
[--description <value>]
[--session_duration <value>]
Description
set a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| description optional | string | 인스턴스 설명 | My Instance Description |
| session_duration optional | integer | 최대 세션 지속 시간 | 3600 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| customer_policies | 고객 관리 정책 | |
| description | 권한 세트 설명 | Permissions for administrators |
| inline_policies | 인라인 정책 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| managed_policies | 관리 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| session_duration | 최대 세션 지속 시간 | 3600 |
| srn | 권한 세트 SRN | srn: |
| state | 상태 |
10.4.1.25.3 - 1.0
scpcli iam-identity-center permission set set
--permission_set_id <value>
--instance_id <value>
[--description <value>]
[--session_duration <value>]
Description
set a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| description optional | string | 인스턴스 설명 | My Instance Description |
| session_duration optional | integer | 최대 세션 지속 시간 | 3600 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| customer_policies | 고객 관리 정책 | |
| description | 권한 세트 설명 | Permissions for administrators |
| inline_policies | 인라인 정책 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| managed_policies | 관리 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| session_duration | 최대 세션 지속 시간 | 3600 |
| srn | 권한 세트 SRN | srn: |
| state | 상태 |
10.4.1.26 - SetPermissionSetPolicies
10.4.1.26.1 - 1.2
scpcli iam-identity-center permission set set policies
--permission_set_id <value>
--instance_id <value>
[--custom_policies <value>]
[--inline_policies <value>]
[--managed_policies <value>]
Description
set policies to a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| custom_policies optional | array | 고객 관리 정책 | - |
| inline_policies optional | array | 인라인 정책 | - |
| managed_policies optional | array | 관리 정책 | - |
10.4.1.26.2 - 1.1
scpcli iam-identity-center permission set set policies
--permission_set_id <value>
--instance_id <value>
[--customer_policies <value>]
[--inline_policies <value>]
[--managed_policies <value>]
Description
set policies to a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| customer_policies optional | array | 고객 관리 정책 | - |
| inline_policies optional | array | 인라인 정책 | - |
| managed_policies optional | array | 관리 정책 | - |
10.4.1.26.3 - 1.0
scpcli iam-identity-center permission set set policies
--permission_set_id <value>
--instance_id <value>
[--customer_policies <value>]
[--inline_policies <value>]
[--managed_policies <value>]
Description
set policies to a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| customer_policies optional | array | 고객 관리 정책 | - |
| inline_policies optional | array | 인라인 정책 | - |
| managed_policies optional | array | 관리 정책 | - |
10.4.1.27 - SetUser
10.4.1.27.1 - 1.2
scpcli iam-identity-center user set
--user_uuid <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--manager <value>]
[--name <value>]
[--nation_id <value>]
[--phone_number <value>]
[--tz_id <value>]
Description
set a specific user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| business_unit optional | string | 사업부 | Business Unit A |
| department optional | string | 부서 | Department X |
| description optional | string | 사용자 설명 | Description of John Doe |
| email optional | string | 사용자 이메일 | john.doe@example.com |
| employee_id optional | string | 사번 | emp-12345 |
| manager optional | string | 관리자 | Alice Smith |
| name optional | string | 사용자 실명 | John Doe |
| nation_id optional | string | 국가 ID | +82 |
| phone_number optional | string | 휴대폰 번호 | 010-1234-5678 |
| tz_id optional | string | 타임존 ID | Asia/Seoul |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | 사업부 | Business Unit A |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| department | 부서 | Department X |
| description | 사용자 설명 | Description of John Doe |
| 사용자 이메일 | john.doe@example.com | |
| email_authenticated | 이메일 인증 여부 | |
| employee_id | 사번 | emp-12345 |
| groups | 그룹 목록 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| last_login_at | 마지막 로그인 일시 | 2024-12-19 01:09:05.000 |
| last_password_update_at | 최근 비밀번호 변경 일시 | 2025-11-24T08:14:51.694996 |
| manager | 관리자 | Alice Smith |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 사용자 실명 | John Doe |
| nation_id | 국가 ID | +82 |
| password | 비밀번호 | |
| password_failed_count | 비밀번호 실패 횟수 | 6 |
| password_reuse_count | 비밀번호 재사용 제한 횟수 | 6 |
| phone_authenticated | 휴대폰 인증 여부 | |
| phone_number | 휴대폰 번호 | 010-1234-5678 |
| temporary_password | 임시 비밀번호 여부 | |
| tz_id | 타임존 ID | Asia/Seoul |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.27.2 - 1.1
scpcli iam-identity-center user set
--user_uuid <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--manager <value>]
[--name <value>]
[--nation_id <value>]
[--phone_number <value>]
[--tz_id <value>]
Description
set a specific user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| business_unit optional | string | 사업부 | Business Unit A |
| department optional | string | 부서 | Department X |
| description optional | string | 사용자 설명 | Description of John Doe |
| email optional | string | 사용자 이메일 | john.doe@example.com |
| employee_id optional | string | 사번 | emp-12345 |
| manager optional | string | 관리자 | Alice Smith |
| name optional | string | 사용자 실명 | John Doe |
| nation_id optional | string | 국가 ID | +82 |
| phone_number optional | string | 휴대폰 번호 | 010-1234-5678 |
| tz_id optional | string | 타임존 ID | Asia/Seoul |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | 사업부 | Business Unit A |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| department | 부서 | Department X |
| description | 사용자 설명 | Description of John Doe |
| 사용자 이메일 | john.doe@example.com | |
| email_authenticated | 이메일 인증 여부 | |
| employee_id | 사번 | emp-12345 |
| groups | 그룹 목록 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| last_login_at | 마지막 로그인 일시 | 2024-12-19 01:09:05.000 |
| last_password_update_at | 최근 비밀번호 변경 일시 | 2025-11-24T08:14:51.694996 |
| manager | 관리자 | Alice Smith |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 사용자 실명 | John Doe |
| nation_id | 국가 ID | +82 |
| password | 비밀번호 | |
| password_failed_count | 비밀번호 실패 횟수 | 6 |
| password_reuse_count | 비밀번호 재사용 제한 횟수 | 6 |
| phone_authenticated | 휴대폰 인증 여부 | |
| phone_number | 휴대폰 번호 | 010-1234-5678 |
| temporary_password | 임시 비밀번호 여부 | |
| tz_id | 타임존 ID | Asia/Seoul |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.27.3 - 1.0
scpcli iam-identity-center user set
--user_uuid <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--manager <value>]
[--name <value>]
[--nation_id <value>]
[--phone_number <value>]
[--tz_id <value>]
Description
set a specific user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
| business_unit optional | string | 사업부 | Business Unit A |
| department optional | string | 부서 | Department X |
| description optional | string | 사용자 설명 | Description of John Doe |
| email optional | string | 사용자 이메일 | john.doe@example.com |
| employee_id optional | string | 사번 | emp-12345 |
| manager optional | string | 관리자 | Alice Smith |
| name optional | string | 사용자 실명 | John Doe |
| nation_id optional | string | 국가 ID | +82 |
| phone_number optional | string | 휴대폰 번호 | 010-1234-5678 |
| tz_id optional | string | 타임존 ID | Asia/Seoul |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | 사업부 | Business Unit A |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| department | 부서 | Department X |
| description | 사용자 설명 | Description of John Doe |
| 사용자 이메일 | john.doe@example.com | |
| email_authenticated | 이메일 인증 여부 | |
| employee_id | 사번 | emp-12345 |
| groups | 그룹 목록 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| last_login_at | 마지막 로그인 일시 | 2024-12-19 01:09:05.000 |
| last_password_update_at | 최근 비밀번호 변경 일시 | 2025-11-24T08:14:51.694996 |
| manager | 관리자 | Alice Smith |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 사용자 실명 | John Doe |
| nation_id | 국가 ID | +82 |
| password | 비밀번호 | |
| password_failed_count | 비밀번호 실패 횟수 | 6 |
| password_reuse_count | 비밀번호 재사용 제한 횟수 | 6 |
| phone_authenticated | 휴대폰 인증 여부 | |
| phone_number | 휴대폰 번호 | 010-1234-5678 |
| temporary_password | 임시 비밀번호 여부 | |
| tz_id | 타임존 ID | Asia/Seoul |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.28 - ShowGroup
10.4.1.28.1 - 1.2
scpcli iam-identity-center group show
--group_id <value>
--instance_id <value>
Description
show a specific group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.28.2 - 1.1
scpcli iam-identity-center group show
--group_id <value>
--instance_id <value>
Description
show a specific group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.28.3 - 1.0
scpcli iam-identity-center group show
--group_id <value>
--instance_id <value>
Description
show a specific group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 그룹 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| description | 그룹 설명 | Group for administrators |
| instance_id | 인스턴스 ID | ssoins-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 그룹 이름 | Admin_Group |
| user_count | 그룹에 속한 사용자 수 | 1 |
| users | 그룹에 속한 사용자 목록 | [{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}] |
10.4.1.29 - ShowInstance
10.4.1.29.1 - 1.2
scpcli iam-identity-center instance show
--instance_id <value>
Description
show a specific instance
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인스턴스 ID | ssoins-12345 |
| account_id | Account ID | 1234ab567cd64769e8f9g490hi304891 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| delegated_account_id | 위임된 관리자 계정 ID | acc-2353 |
| delegated_at | 위임 일시 | 2023-10-15 14:30:00 |
| delegated_by | 위임자 ID | sef2w3c8c29a449dbfa8681f8f1d78e2 |
| description | 인스턴스 설명 | My Instance Description |
| identity_store_config | 자격 증명 소스 설정 | {‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’} |
| identity_store_id | 자격 증명 소스 ID | d-12345 |
| identity_store_type | 자격 증명 소스 유형 | |
| last_sync_at | 마지막 동기화 날짜 | 2025-08-06 10:30:00 |
| last_sync_status | 마지막 동기화 상태 | [‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’] |
| master_account_id | 관리자 계정 ID | acc-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 인스턴스 이름 | My Instance |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| resource_name | 자원명 | resource-name-1 |
| resource_type | 자원 유형 [instance | permission-set] |
| resource_type_display_name | 자원 유형명 | Virtual Server |
| service | SERVICE | virtualserver |
| service_name | 서비스명 | Virtual Server |
| srn | 인스턴스 SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| sso_start_url | SSO 시작 URL | https://login.e.samsungsdscloud.com/d-12345 |
| state | 상태 |
10.4.1.29.2 - 1.1
scpcli iam-identity-center instance show
--instance_id <value>
Description
show a specific instance
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 인스턴스 ID | ssoins-12345 |
| account_id | Account ID | 1234ab567cd64769e8f9g490hi304891 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| delegated_account_id | 위임된 관리자 계정 ID | acc-2353 |
| delegated_at | 위임 일시 | 2023-10-15 14:30:00 |
| delegated_by | 위임자 ID | sef2w3c8c29a449dbfa8681f8f1d78e2 |
| description | 인스턴스 설명 | My Instance Description |
| identity_store_config | 자격 증명 소스 설정 | {‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’} |
| identity_store_id | 자격 증명 소스 ID | d-12345 |
| identity_store_type | 자격 증명 소스 유형 | |
| last_sync_at | 마지막 동기화 날짜 | 2025-08-06 10:30:00 |
| last_sync_status | 마지막 동기화 상태 | [‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’] |
| master_account_id | 관리자 계정 ID | acc-12345 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 인스턴스 이름 | My Instance |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| resource_name | 자원명 | resource-name-1 |
| resource_type | 자원 유형 [instance | permission-set] |
| resource_type_display_name | 자원 유형명 | Virtual Server |
| service | SERVICE | virtualserver |
| service_name | 서비스명 | Virtual Server |
| srn | 인스턴스 SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| sso_start_url | SSO 시작 URL | https://login.e.samsungsdscloud.com/d-12345 |
| state | 상태 |
10.4.1.30 - ShowPermissionSet
10.4.1.30.1 - 1.2
scpcli iam-identity-center permission set show
--permission_set_id <value>
--instance_id <value>
Description
show a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| account_id | ||
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| custom_policies | 고객 관리 정책 | |
| description | 권한 세트 설명 | Permissions for administrators |
| inline_policies | 인라인 정책 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| managed_policies | 관리 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| resource_name | ||
| resource_type | ||
| resource_type_display_name | ||
| service | ||
| service_name | ||
| session_duration | 최대 세션 지속 시간 | 3600 |
| srn | 권한 세트 SRN | srn: |
| state | 상태 |
10.4.1.30.2 - 1.1
scpcli iam-identity-center permission set show
--permission_set_id <value>
--instance_id <value>
Description
show a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| account_id | ||
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| customer_policies | 고객 관리 정책 | |
| description | 권한 세트 설명 | Permissions for administrators |
| inline_policies | 인라인 정책 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| managed_policies | 관리 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| resource_name | ||
| resource_type | ||
| resource_type_display_name | ||
| service | ||
| service_name | ||
| session_duration | 최대 세션 지속 시간 | 3600 |
| srn | 권한 세트 SRN | srn: |
| state | 상태 |
10.4.1.30.3 - 1.0
scpcli iam-identity-center permission set show
--permission_set_id <value>
--instance_id <value>
Description
show a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 권한 세트 ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| account_id | ||
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | |
| customer_policies | 고객 관리 정책 | |
| description | 권한 세트 설명 | Permissions for administrators |
| inline_policies | 인라인 정책 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| managed_policies | 관리 정책 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | |
| name | 권한 세트 이름 | Permission Set |
| resource_name | ||
| resource_type | ||
| resource_type_display_name | ||
| service | ||
| service_name | ||
| session_duration | 최대 세션 지속 시간 | 3600 |
| srn | 권한 세트 SRN | srn: |
| state | 상태 |
10.4.1.31 - ShowUser
10.4.1.31.1 - 1.2
scpcli iam-identity-center user show
--user_uuid <value>
--instance_id <value>
Description
show a specific user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | 사업부 | Business Unit A |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| department | 부서 | Department X |
| description | 사용자 설명 | Description of John Doe |
| 사용자 이메일 | john.doe@example.com | |
| email_authenticated | 이메일 인증 여부 | |
| employee_id | 사번 | emp-12345 |
| groups | 그룹 목록 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| last_login_at | 마지막 로그인 일시 | 2024-12-19 01:09:05.000 |
| last_password_update_at | 최근 비밀번호 변경 일시 | 2025-11-24T08:14:51.694996 |
| manager | 관리자 | Alice Smith |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 사용자 실명 | John Doe |
| nation_id | 국가 ID | +82 |
| password | 비밀번호 | |
| password_failed_count | 비밀번호 실패 횟수 | 6 |
| password_reuse_count | 비밀번호 재사용 제한 횟수 | 6 |
| phone_authenticated | 휴대폰 인증 여부 | |
| phone_number | 휴대폰 번호 | 010-1234-5678 |
| temporary_password | 임시 비밀번호 여부 | |
| tz_id | 타임존 ID | Asia/Seoul |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.31.2 - 1.1
scpcli iam-identity-center user show
--user_uuid <value>
--instance_id <value>
Description
show a specific user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | 사업부 | Business Unit A |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| department | 부서 | Department X |
| description | 사용자 설명 | Description of John Doe |
| 사용자 이메일 | john.doe@example.com | |
| email_authenticated | 이메일 인증 여부 | |
| employee_id | 사번 | emp-12345 |
| groups | 그룹 목록 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| last_login_at | 마지막 로그인 일시 | 2024-12-19 01:09:05.000 |
| last_password_update_at | 최근 비밀번호 변경 일시 | 2025-11-24T08:14:51.694996 |
| manager | 관리자 | Alice Smith |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 사용자 실명 | John Doe |
| nation_id | 국가 ID | +82 |
| password | 비밀번호 | |
| password_failed_count | 비밀번호 실패 횟수 | 6 |
| password_reuse_count | 비밀번호 재사용 제한 횟수 | 6 |
| phone_authenticated | 휴대폰 인증 여부 | |
| phone_number | 휴대폰 번호 | 010-1234-5678 |
| temporary_password | 임시 비밀번호 여부 | |
| tz_id | 타임존 ID | Asia/Seoul |
| user_id | 사용자 로그인 ID | johndoe |
10.4.1.31.3 - 1.0
scpcli iam-identity-center user show
--user_uuid <value>
--instance_id <value>
Description
show a specific user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | 인스턴스 ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 사용자 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | 사업부 | Business Unit A |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | 생성자 명 | John Doe |
| department | 부서 | Department X |
| description | 사용자 설명 | Description of John Doe |
| 사용자 이메일 | john.doe@example.com | |
| email_authenticated | 이메일 인증 여부 | |
| employee_id | 사번 | emp-12345 |
| groups | 그룹 목록 | |
| instance_id | 인스턴스 ID | ssoins-12345 |
| last_login_at | 마지막 로그인 일시 | 2024-12-19 01:09:05.000 |
| last_password_update_at | 최근 비밀번호 변경 일시 | 2025-11-24T08:14:51.694996 |
| manager | 관리자 | Alice Smith |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | 수정자 명 | Smith |
| name | 사용자 실명 | John Doe |
| nation_id | 국가 ID | +82 |
| password | 비밀번호 | |
| password_failed_count | 비밀번호 실패 횟수 | 6 |
| password_reuse_count | 비밀번호 재사용 제한 횟수 | 6 |
| phone_authenticated | 휴대폰 인증 여부 | |
| phone_number | 휴대폰 번호 | 010-1234-5678 |
| temporary_password | 임시 비밀번호 여부 | |
| tz_id | 타임존 ID | Asia/Seoul |
| user_id | 사용자 로그인 ID | johndoe |
10.5 - Logging&Audit
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Logging&Audit 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260223 |
| 1.1 | CURRENT | - |
10.5.1 - CLIs
10.5.1.1 - CreateTrail
10.5.1.1.1 - 1.1
scpcli loggingaudit trail create
--trail_save_type <value>
--trail_name <value>
--bucket_region <value>
--bucket_name <value>
--account_id <value>
[--log_archive_account_id <value>]
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--organization_trail_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--tag_create_requests <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--user_total_yn <value>]
Description
create a trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_save_type required | string | Trail save type | JSON |
| trail_name required | string | Trail name | TestTrail01 |
| bucket_region required | string | Bucket region | RegionOne |
| bucket_name required | string | Bucket name | TestBucket00 |
| account_id required | string | Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_archive_account_id optional | string | Log Archive Account ID. Only for Organization Trail.(organization_trail_yn = y) | ACCOUNT_ID-ABCDEF1234 |
| log_type_total_yn optional | string | Target log type total y/n | N |
| log_verification_yn optional | string | Log verification y/n | N |
| organization_trail_yn optional | string | Organization trail y/n | N |
| region_names optional | array | Region name list | - |
| region_total_yn optional | string | Target region total y/n | Y |
| resource_type_total_yn optional | string | Target resource type total y/n | Y |
| tag_create_requests optional | array | Tag create requests | {'key': '11', 'value': '22'} |
| target_log_types optional | array | Target log type list | - |
| target_resource_types optional | array | Target resource type list | - |
| target_users optional | array | Target user list | - |
| trail_description optional | string | Trail description | This is a test trail |
| user_total_yn optional | string | Target user total y/n | Y |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_archive_account_id | Log Archive Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_trail_yn | Organization trail y/n | Y |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2025-11-07T09:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2025-10-28T10:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2025-11-07T09:00:00Z |
| trail_batch_success_at | Trail batch success date | 2025-11-07T09:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
10.5.1.1.2 - 1.0
scpcli loggingaudit trail create
--trail_save_type <value>
--trail_name <value>
--bucket_region <value>
--bucket_name <value>
--account_id <value>
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--tag_create_requests <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--user_total_yn <value>]
Description
create a trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_save_type required | string | Trail save type | JSON |
| trail_name required | string | Trail name | TestTrail01 |
| bucket_region required | string | Bucket region | RegionOne |
| bucket_name required | string | Bucket name | TestBucket00 |
| account_id required | string | Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_type_total_yn optional | string | Target log type total y/n | N |
| log_verification_yn optional | string | Log verification y/n | N |
| region_names optional | array | Region name list | - |
| region_total_yn optional | string | Target region total y/n | Y |
| resource_type_total_yn optional | string | Target resource type total y/n | Y |
| tag_create_requests optional | array | Tag create requests | {'key': '11', 'value': '22'} |
| target_log_types optional | array | Target log type list | - |
| target_resource_types optional | array | Target resource type list | - |
| target_users optional | array | Target user list | - |
| trail_description optional | string | Trail description | This is a test trail |
| user_total_yn optional | string | Target user total y/n | Y |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2025-11-07T09:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2025-10-28T10:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2025-11-07T09:00:00Z |
| trail_batch_success_at | Trail batch success date | 2025-11-07T09:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
10.5.1.2 - DeleteTrail
10.5.1.2.1 - 1.1
scpcli loggingaudit trail delete
--trail_id <value>
Description
delete a specific trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
10.5.1.2.2 - 1.0
scpcli loggingaudit trail delete
--trail_id <value>
Description
delete a specific trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
10.5.1.3 - DownloadLogs
10.5.1.3.1 - 1.1
scpcli loggingaudit log file download
--time_zone_info <value>
--start_at <value>
--file_type <value>
--end_at <value>
[--product_name <value>]
[--region <value>]
[--resource_name <value>]
[--resource_type <value>]
[--root_resource_id <value>]
[--status <value>]
[--user_name <value>]
Description
download log file
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| time_zone_info required | string | Timezone info | Asia/Seoul |
| start_at required | string | Query start date | 2025-08-09T10:00:00Z |
| file_type required | string | Download file type | JSON |
| end_at required | string | Query finish date | 2025-11-07T10:00:00Z |
| product_name optional | string | Product name | - |
| region optional | string | Region name | - |
| resource_name optional | string | Resource name | - |
| resource_type optional | string | Resource type | - |
| root_resource_id optional | string | Root resource ID | - |
| status optional | string | Task result | - |
| user_name optional | string | Username | - |
Responses
| Name | Description | Example |
|---|---|---|
| EventTopic | Event type | |
| RegionName | Region name | |
| ResourceId | Resource ID | |
| ResourceName | Resource name | |
| ResourceType | Resource type | |
| WorkInfo | Event name | |
| WorkResult | Task result | |
| WorkTime | Work time | |
| WorkerEmail | Worker email | |
| WorkerID | Worker ID | |
| WorkerName | Worker name |
10.5.1.3.2 - 1.0
scpcli loggingaudit log file download
--time_zone_info <value>
--start_at <value>
--file_type <value>
--end_at <value>
[--product_name <value>]
[--region <value>]
[--resource_name <value>]
[--resource_type <value>]
[--root_resource_id <value>]
[--status <value>]
[--user_name <value>]
Description
download log file
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| time_zone_info required | string | Timezone info | Asia/Seoul |
| start_at required | string | Query start date | 2025-08-09T10:00:00Z |
| file_type required | string | Download file type | JSON |
| end_at required | string | Query finish date | 2025-11-07T10:00:00Z |
| product_name optional | string | Product name | - |
| region optional | string | Region name | - |
| resource_name optional | string | Resource name | - |
| resource_type optional | string | Resource type | - |
| root_resource_id optional | string | Root resource ID | - |
| status optional | string | Task result | - |
| user_name optional | string | Username | - |
Responses
| Name | Description | Example |
|---|---|---|
| EventTopic | Event type | |
| RegionName | Region name | |
| ResourceId | Resource ID | |
| ResourceName | Resource name | |
| ResourceType | Resource type | |
| WorkInfo | Event name | |
| WorkResult | Task result | |
| WorkTime | Work time | |
| WorkerEmail | Worker email | |
| WorkerID | Worker ID | |
| WorkerName | Worker name |
10.5.1.4 - ListLogs
10.5.1.4.1 - 1.1
scpcli loggingaudit log list
--end_at <value>
--start_at <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--resource_id <value>]
[--resource_name <value>]
[--resource_type <value>]
[--product_name <value>]
[--product_type <value>]
[--status <value>]
[--event_type <value>]
[--user_id <value>]
[--user_name <value>]
[--region <value>]
[--root_resource_id <value>]
[--service_type <value>]
Description
get log list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| end_at required | string | Query finish date | 2025-11-07T10:00:00Z |
| start_at required | string | Query start date | 2025-08-09T10:00:00Z |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| resource_id optional | string | Resource ID | - |
| resource_name optional | string | Resource name | - |
| resource_type optional | string | Resource type | - |
| product_name optional | string | Product name | - |
| product_type optional | string | Product type | - |
| status optional | string | Task result | - |
| event_type optional | string | Event type | - |
| user_id optional | string | User ID | - |
| user_name optional | string | Username | - |
| region optional | string | Region name | - |
| root_resource_id optional | string | Root resource ID | - |
| service_type optional | string | Service type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log ID | ID-A1B2C3D4E5F6G7H8I9J0 |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| event_name | Event name | scp-extension.event.create |
| event_type | Event type | scp-extension.event.create |
| product_name | Product name | scp-extension |
| product_type | Product type | scp-extension |
| region | Region name | RegionOne |
| request_user_name | Username | Hong Gildong |
| resource_id | Resource ID | RESOURCE_ID-ABCDEF1234 |
| resource_name | Resource name | RESOURCE_NAME-ABCDEF1234 |
| resource_type | Resource type | scp-extension |
| role_name | Username | Tester |
| status | Task result | Success |
| timestamp | Timestamp | 2025-11-07T10:00:00Z |
| type | User ID | ROLE |
| user_id | User ID | USER_ID-ABCDEF1234 |
10.5.1.4.2 - 1.0
scpcli loggingaudit log list
--end_at <value>
--start_at <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--resource_id <value>]
[--resource_name <value>]
[--resource_type <value>]
[--product_name <value>]
[--product_type <value>]
[--status <value>]
[--event_type <value>]
[--user_id <value>]
[--user_name <value>]
[--region <value>]
[--root_resource_id <value>]
[--service_type <value>]
Description
get log list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| end_at required | string | Query finish date | 2025-11-07T10:00:00Z |
| start_at required | string | Query start date | 2025-08-09T10:00:00Z |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| resource_id optional | string | Resource ID | - |
| resource_name optional | string | Resource name | - |
| resource_type optional | string | Resource type | - |
| product_name optional | string | Product name | - |
| product_type optional | string | Product type | - |
| status optional | string | Task result | - |
| event_type optional | string | Event type | - |
| user_id optional | string | User ID | - |
| user_name optional | string | Username | - |
| region optional | string | Region name | - |
| root_resource_id optional | string | Root resource ID | - |
| service_type optional | string | Service type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log ID | ID-A1B2C3D4E5F6G7H8I9J0 |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| event_name | Event name | scp-extension.event.create |
| event_type | Event type | scp-extension.event.create |
| product_name | Product name | scp-extension |
| product_type | Product type | scp-extension |
| region | Region name | RegionOne |
| request_user_name | Username | Hong Gildong |
| resource_id | Resource ID | RESOURCE_ID-ABCDEF1234 |
| resource_name | Resource name | RESOURCE_NAME-ABCDEF1234 |
| resource_type | Resource type | scp-extension |
| role_name | Username | Tester |
| status | Task result | Success |
| timestamp | Timestamp | 2025-11-07T10:00:00Z |
| type | User ID | ROLE |
| user_id | User ID | USER_ID-ABCDEF1234 |
10.5.1.5 - ListTrails
10.5.1.5.1 - 1.1
scpcli loggingaudit trail list
[--size <value>]
[--page <value>]
[--sort <value>]
[--trail_name <value>]
[--bucket_name <value>]
[--state <value>]
[--resource_type <value>]
Description
get trails list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| trail_name optional | string | Trail name | - |
| bucket_name optional | string | Bucket name | - |
| state optional | string | Trail state | - |
| resource_type optional | string | Resource type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_archive_account_id | Log Archive Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_trail_yn | Organization trail y/n | Y |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2025-11-07T09:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2025-10-28T10:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2025-11-07T09:00:00Z |
| trail_batch_success_at | Trail batch success date | 2025-11-07T09:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
10.5.1.5.2 - 1.0
scpcli loggingaudit trail list
[--size <value>]
[--page <value>]
[--sort <value>]
[--trail_name <value>]
[--bucket_name <value>]
[--state <value>]
[--resource_type <value>]
Description
get trails list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| trail_name optional | string | Trail name | - |
| bucket_name optional | string | Bucket name | - |
| state optional | string | Trail state | - |
| resource_type optional | string | Resource type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2025-11-07T09:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2025-10-28T10:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2025-11-07T09:00:00Z |
| trail_batch_success_at | Trail batch success date | 2025-11-07T09:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
10.5.1.6 - SetTrail
10.5.1.6.1 - 1.1
scpcli loggingaudit trail set
--trail_id <value>
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--organization_trail_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--trail_save_type <value>]
[--user_total_yn <value>]
Description
set a specific trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
| log_type_total_yn optional | string | Target log type total y/n | N |
| log_verification_yn optional | string | Log verification y/n | N |
| organization_trail_yn optional | string | Organization trail y/n | Y |
| region_names optional | array | Region name list | - |
| region_total_yn optional | string | Target region total y/n | Y |
| resource_type_total_yn optional | string | Target resource type total y/n | Y |
| target_log_types optional | array | Target log type list | - |
| target_resource_types optional | array | Target resource type list | - |
| target_users optional | array | Target user list | - |
| trail_description optional | string | Trail description | This is a test trail |
| trail_save_type optional | string | Trail save type | JSON |
| user_total_yn optional | string | Target user total y/n | Y |
10.5.1.6.2 - 1.0
scpcli loggingaudit trail set
--trail_id <value>
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--trail_save_type <value>]
[--user_total_yn <value>]
Description
set a specific trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
| log_type_total_yn optional | string | Target log type total y/n | N |
| log_verification_yn optional | string | Log verification y/n | N |
| region_names optional | array | Region name list | - |
| region_total_yn optional | string | Target region total y/n | Y |
| resource_type_total_yn optional | string | Target resource type total y/n | Y |
| target_log_types optional | array | Target log type list | - |
| target_resource_types optional | array | Target resource type list | - |
| target_users optional | array | Target user list | - |
| trail_description optional | string | Trail description | This is a test trail |
| trail_save_type optional | string | Trail save type | JSON |
| user_total_yn optional | string | Target user total y/n | Y |
10.5.1.7 - ShowLog
10.5.1.7.1 - 1.1
scpcli loggingaudit log show
--logging_id <value>
Description
show a specific log
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| logging_id required | string | Log ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log ID | ID-A1B2C3D4E5F6G7H8I9J0 |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| details | Audit detail contents(JSON String) | |
| event_name | Event name | scp-extension.event.create |
| event_type | Event type | scp-extension.event.create |
| product_name | Product name | scp-extension |
| product_type | Product type | scp-extension |
| region | Region name | RegionOne |
| request_user_name | Username | Hong Gildong |
| resource_id | Resource ID | RESOURCE_ID-ABCDEF1234 |
| resource_name | Resource name | RESOURCE_NAME-ABCDEF1234 |
| resource_type | Resource type | scp-extension |
| role_name | Username | Tester |
| status | Task result | Success |
| timestamp | Timestamp | 2025-11-07T10:00:00Z |
| type | User ID | ROLE |
| user_id | User ID | USER_ID-ABCDEF1234 |
10.5.1.7.2 - 1.0
scpcli loggingaudit log show
--logging_id <value>
Description
show a specific log
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| logging_id required | string | Log ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log ID | ID-A1B2C3D4E5F6G7H8I9J0 |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| details | Audit detail contents(JSON String) | |
| event_name | Event name | scp-extension.event.create |
| event_type | Event type | scp-extension.event.create |
| product_name | Product name | scp-extension |
| product_type | Product type | scp-extension |
| region | Region name | RegionOne |
| request_user_name | Username | Hong Gildong |
| resource_id | Resource ID | RESOURCE_ID-ABCDEF1234 |
| resource_name | Resource name | RESOURCE_NAME-ABCDEF1234 |
| resource_type | Resource type | scp-extension |
| role_name | Username | Tester |
| status | Task result | Success |
| timestamp | Timestamp | 2025-11-07T10:00:00Z |
| type | User ID | ROLE |
| user_id | User ID | USER_ID-ABCDEF1234 |
10.5.1.8 - ShowTrail
10.5.1.8.1 - 1.1
scpcli loggingaudit trail show
--trail_id <value>
Description
show a specific trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_archive_account_id | Log Archive Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_trail_yn | Organization trail y/n | Y |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2025-11-07T09:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2025-10-28T10:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2025-11-07T09:00:00Z |
| trail_batch_success_at | Trail batch success date | 2025-11-07T09:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
10.5.1.8.2 - 1.0
scpcli loggingaudit trail show
--trail_id <value>
Description
show a specific trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2025-11-07T09:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2025-10-28T10:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2025-11-07T09:00:00Z |
| trail_batch_success_at | Trail batch success date | 2025-11-07T09:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
10.5.1.9 - StartTrail
10.5.1.9.1 - 1.1
scpcli loggingaudit trail start
--trail_id <value>
Description
start a specific trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_archive_account_id | Log Archive Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_trail_yn | Organization trail y/n | Y |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2025-11-07T09:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2025-10-28T10:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2025-11-07T09:00:00Z |
| trail_batch_success_at | Trail batch success date | 2025-11-07T09:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
10.5.1.9.2 - 1.0
scpcli loggingaudit trail start
--trail_id <value>
Description
start a specific trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2025-11-07T09:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2025-10-28T10:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2025-11-07T09:00:00Z |
| trail_batch_success_at | Trail batch success date | 2025-11-07T09:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
10.5.1.10 - StopTrail
10.5.1.10.1 - 1.1
scpcli loggingaudit trail stop
--trail_id <value>
Description
stop a specific trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_archive_account_id | Log Archive Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_trail_yn | Organization trail y/n | Y |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2025-11-07T09:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2025-10-28T10:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2025-11-07T09:00:00Z |
| trail_batch_success_at | Trail batch success date | 2025-11-07T09:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
10.5.1.10.2 - 1.0
scpcli loggingaudit trail stop
--trail_id <value>
Description
stop a specific trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2025-11-07T09:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2025-10-28T10:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2025-11-07T09:00:00Z |
| trail_batch_success_at | Trail batch success date | 2025-11-07T09:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
10.6 - Network Logging
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다. 본 가이드는 Network Logging 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
10.6.1 - CLIs
10.6.1.1 - Create Network Logging Storage
10.6.1.1.1 - 1.0
scpcli network-logging network-logging-storage create
--resource_type <value>
--bucket_name <value>
Description
Network Logging Storage 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | string | 리소스 타입 | - |
| bucket_name required | string | 저장소 버킷 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Network Logging Storage ID | |
| account_id | Account ID | |
| bucket_name | 저장소 버킷 이름 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| resource_type | 리소스 타입 |
10.6.1.2 - Delete Network Logging Storage
10.6.1.2.1 - 1.0
scpcli network-logging network-logging-storage delete
--network_logging_storage_id <value>
Description
Network Logging Storage 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| network_logging_storage_id required | string | Network Logging Storage ID | - |
10.6.1.3 - List Network Logging Configurations
10.6.1.3.1 - 1.0
scpcli network-logging network-logging-configuration list
--resource_type <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--resource_id <value>]
[--resource_name <value>]
Description
Network Logging Configuration 목록 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | 리소스 타입 | - |
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| resource_id optional | string | 리소스 ID | - |
| resource_name optional | string | 리소스 이름 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Network Logging Configuration ID | |
| account_id | Account ID | |
| bucket_name | 저장소 버킷 이름 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| down_interface | 하향 인터페이스 | |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| resource_id | 리소스 ID | |
| resource_name | 리소스 이름 | |
| resource_type | 리소스 타입 | |
| security_group_log_id | Security Group 로그 ID | |
| up_interface | 상향 인터페이스 |
10.6.1.4 - List Network Logging Storages
10.6.1.4.1 - 1.0
scpcli network-logging network-logging-storage list
--resource_type <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
Description
Network Logging Storage 목록 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | 리소스 타입 | - |
| with_count optional | string | with count | true |
| limit optional | integer | 한도 | 20 |
| marker optional | string | 마커 | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Network Logging Storage ID | |
| account_id | Account ID | |
| bucket_name | 저장소 버킷 이름 | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| resource_type | 리소스 타입 |
10.7 - Organization
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Organization 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
10.7.1 - CLIs
10.7.1.1 - AcceptInvitation
10.7.1.1.1 - 1.1
scpcli organization invitation accept
--invitation_id <value>
Description
accept a specific invitation
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| invitation_id required | string | 초대 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
10.7.1.1.2 - 1.0
scpcli organization invitation accept
--invitation_id <value>
Description
accept a specific invitation
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| invitation_id required | string | 초대 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
10.7.1.2 - AttachPolicyBindings
10.7.1.2.1 - 1.1
scpcli organization policy attach
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]
Description
attach policy bindings
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_ids required | array | 타겟 정보 | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| policy_ids required | array | 제어 정책 목록 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| entity required | string | 개체 유형 | POLICY |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | error code | Conflict |
| failed_caused | 실패 원인 | Account 482d111a302547fbbd11ee0141ea23bb is not found |
| failed_id | 실패 ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
10.7.1.2.2 - 1.0
scpcli organization policy attach
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]
Description
attach policy bindings
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_ids required | array | 타겟 정보 | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| policy_ids required | array | 제어 정책 목록 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| entity required | string | 개체 유형 | POLICY |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | error code | Conflict |
| failed_caused | 실패 원인 | Account 482d111a302547fbbd11ee0141ea23bb is not found |
| failed_id | 실패 ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
10.7.1.3 - CancelInvitations
10.7.1.3.1 - 1.1
scpcli organization invitation cancel
--ids <value>
[--organization_id <value>]
Description
cancel invitations
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | 초대 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.3.2 - 1.0
scpcli organization invitation cancel
--ids <value>
[--organization_id <value>]
Description
cancel invitations
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | 초대 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.4 - CreateAccount
10.7.1.4.1 - 1.1
scpcli organization account create
--role_name <value>
--organization_id <value>
--name <value>
--login_id <value>
Description
create a account
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_name required | string | 역할명 | OrganizationAccountAccessRole |
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name required | string | 계정명 | score-account |
| login_id required | string | 로그인 ID | log-archive@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| failed | 계정 생성 실패 정보 | |
| success | 계정 생성 성공 정보 |
10.7.1.4.2 - 1.0
scpcli organization account create
--role_name <value>
--organization_id <value>
--name <value>
--login_id <value>
Description
create a account
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_name required | string | 역할명 | OrganizationAccountAccessRole |
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name required | string | 계정명 | score-account |
| login_id required | string | 로그인 ID | log-archive@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| failed | 계정 생성 실패 정보 | |
| success | 계정 생성 성공 정보 |
10.7.1.5 - CreateDelegationPolicy
10.7.1.5.1 - 1.1
scpcli organization delegation policy create
[--organization_id <value>]
[--statement <value>]
[--version <value>]
Description
create a delegation policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| statement optional | array | 정책 문법 | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | 정책 버전 | - |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| document | 위임 정책 문서 | {‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.5.2 - 1.0
scpcli organization delegation policy create
[--organization_id <value>]
[--statement <value>]
[--version <value>]
Description
create a delegation policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| statement optional | array | 정책 문법 | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | 정책 버전 | - |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| document | 위임 정책 문서 | {‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.6 - CreateInvitation
10.7.1.6.1 - 1.1
scpcli organization invitation create
--target_login_ids <value>
[--organization_id <value>]
Description
create an invitation
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_login_ids required | array | 초대 수신자 계정 이메일 목록 | score-1@samsung.com |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | error code | Invitation.AlreadySentError |
| failed_caused | 실패 사유 | Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found |
| failed_id | 조직 초대 실패 Login ID 목록 | [‘score-1@samsung.com’] |
10.7.1.6.2 - 1.0
scpcli organization invitation create
--target_login_ids <value>
[--organization_id <value>]
Description
create an invitation
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_login_ids required | array | 초대 수신자 계정 이메일 목록 | score-1@samsung.com |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | error code | Invitation.AlreadySentError |
| failed_caused | 실패 사유 | Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found |
| failed_id | 조직 초대 실패 Login ID 목록 | [‘score-1@samsung.com’] |
10.7.1.7 - CreateOrganization
10.7.1.7.1 - 1.1
scpcli organization organization create
--name <value>
Description
create a organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 조직 이름 | My Organization |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| delegation_account_id | 위임 계정 | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_email | 관리자 계정 이메일 | admin@example.com |
| master_account_id | 관리자 계정 ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 조직 이름 | My Organization |
| root_unit_id | 루트 유닛 ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| srn | 조직 SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn | 통제 정책 사용 여부 | True |
10.7.1.7.2 - 1.0
scpcli organization organization create
--name <value>
Description
create a organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 조직 이름 | My Organization |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| delegation_account_id | 위임 계정 | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_email | 관리자 계정 이메일 | admin@example.com |
| master_account_id | 관리자 계정 ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 조직 이름 | My Organization |
| root_unit_id | 루트 유닛 ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| srn | 조직 SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn | 통제 정책 사용 여부 | True |
10.7.1.8 - CreateOrganizationUnit
10.7.1.8.1 - 1.1
scpcli organization organization unit create
--name <value>
[--description <value>]
[--organization_id <value>]
[--parent_unit_id <value>]
[--policy_ids <value>]
Description
create an organization unit
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 조직 단위명 | score-organization-unit |
| description optional | string | 조직 단위 설명 | 에스코어 조직 단위 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id optional | string | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| policy_ids optional | array | 제어 정책 목록 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
Responses
| Name | Description | Example |
|---|---|---|
| organization_unit | 조직 단위 정보 |
10.7.1.8.2 - 1.0
scpcli organization organization unit create
--name <value>
[--description <value>]
[--organization_id <value>]
[--parent_unit_id <value>]
[--policy_ids <value>]
Description
create an organization unit
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 조직 단위명 | score-organization-unit |
| description optional | string | 조직 단위 설명 | 에스코어 조직 단위 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id optional | string | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| policy_ids optional | array | 제어 정책 목록 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
Responses
| Name | Description | Example |
|---|---|---|
| organization_unit | 조직 단위 정보 |
10.7.1.9 - CreateServiceControlPolicy
10.7.1.9.1 - 1.1
scpcli organization service control policy create
--organization_id <value>
--name <value>
--description <value>
[--type <value>]
[--statement <value>]
[--version <value>]
Description
create a service control policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name required | string | 서비스 제어 정책 이름 | MyPolicy |
| description required | string | 정책 설명 | This is an example policy. |
| type optional | string | 서비스 제어 정책 유형 | MANAGED |
| statement optional | array | 정책 문법 | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | 정책 버전 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | 정책 카테고리 | SCP |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| description | 정책 설명 | This is an example policy. |
| document | 정책 문서 | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 서비스 제어 정책 이름 | MyPolicy |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| service_name | 서비스명 | Organization |
| source | 정책 생성 주체 | ORGANIZATION |
| srn | 정책 SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 |
| state | 정책 상태 | ACTIVE |
| type | 서비스 제어 정책 유형 | MANAGED |
10.7.1.9.2 - 1.0
scpcli organization service control policy create
--organization_id <value>
--name <value>
--description <value>
[--type <value>]
[--statement <value>]
[--version <value>]
Description
create a service control policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name required | string | 서비스 제어 정책 이름 | MyPolicy |
| description required | string | 정책 설명 | This is an example policy. |
| type optional | string | 서비스 제어 정책 유형 | MANAGED |
| statement optional | array | 정책 문법 | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | 정책 버전 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | 정책 카테고리 | SCP |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| description | 정책 설명 | This is an example policy. |
| document | 정책 문서 | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 서비스 제어 정책 이름 | MyPolicy |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| service_name | 서비스명 | Organization |
| source | 정책 생성 주체 | ORGANIZATION |
| srn | 정책 SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 |
| state | 정책 상태 | ACTIVE |
| type | 서비스 제어 정책 유형 | MANAGED |
10.7.1.10 - DeclineInvitation
10.7.1.10.1 - 1.1
scpcli organization invitation decline
--invitation_id <value>
Description
decline a specific invitation
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| invitation_id required | string | 초대 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
10.7.1.10.2 - 1.0
scpcli organization invitation decline
--invitation_id <value>
Description
decline a specific invitation
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| invitation_id required | string | 초대 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
10.7.1.11 - DeleteDelegationPolicy
10.7.1.11.1 - 1.1
scpcli organization delegation policy delete
[--organization_id <value>]
Description
delete a specific delegation policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.11.2 - 1.0
scpcli organization delegation policy delete
[--organization_id <value>]
Description
delete a specific delegation policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.12 - DeleteOrganization
10.7.1.12.1 - 1.1
scpcli organization organization delete
--organization_id <value>
Description
delete a specific organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.12.2 - 1.0
scpcli organization organization delete
--organization_id <value>
Description
delete a specific organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.13 - DeleteOrganizationUnits
10.7.1.13.1 - 1.1
scpcli organization organization unit delete
--ids <value>
[--organization_id <value>]
Description
delete organization units
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | 조직 단위 ID 목록 | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.13.2 - 1.0
scpcli organization organization unit delete
--ids <value>
[--organization_id <value>]
Description
delete organization units
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | 조직 단위 ID 목록 | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.14 - DeleteServiceControlPolicies
10.7.1.14.1 - 1.1
scpcli organization service control policy delete
--organization_id <value>
--ids <value>
Description
delete service control policies
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| ids required | array | 서비스 제어 정책 목록ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
10.7.1.14.2 - 1.0
scpcli organization service control policy delete
--organization_id <value>
--ids <value>
Description
delete service control policies
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| ids required | array | 서비스 제어 정책 목록ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
10.7.1.15 - LeaveOrganization
10.7.1.15.1 - 1.1
scpcli organization organization leave
--organization_id <value>
Description
leave a specific organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.15.2 - 1.0
scpcli organization organization leave
--organization_id <value>
Description
leave a specific organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.16 - ListAccountInvitations
10.7.1.16.1 - 1.1
scpcli organization account invitation list
Description
get account invitation list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| expired_time | 초대 만료 일시 | 2024-04-30T12:34:56.789Z |
| master_account_email | 관리자 계정 이메일 | admin@example.com |
| master_account_id | 관리자 계정명 | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_login_id | 로그인 ID | log-archive@samsung.com |
| master_account_name | 관리자 계정명 | CoreKim |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| organization_name | 조직 이름 | My Organization |
| requested_time | 초대 요청 일시 | 2024-04-17T12:34:56.789Z |
| state | 초대 상태 | INVITING |
| target_account_id | 초대 수신자 계정 ID | 338c2fc8c29a449dbfa8681f8f1d78e5 |
10.7.1.16.2 - 1.0
scpcli organization account invitation list
Description
get account invitation list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| expired_time | 초대 만료 일시 | 2024-04-30T12:34:56.789Z |
| master_account_email | 관리자 계정 이메일 | admin@example.com |
| master_account_id | 관리자 계정명 | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_login_id | 로그인 ID | log-archive@samsung.com |
| master_account_name | 관리자 계정명 | CoreKim |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| organization_name | 조직 이름 | My Organization |
| requested_time | 초대 요청 일시 | 2024-04-17T12:34:56.789Z |
| state | 초대 상태 | INVITING |
| target_account_id | 초대 수신자 계정 ID | 338c2fc8c29a449dbfa8681f8f1d78e5 |
10.7.1.17 - ListAccounts
10.7.1.17.1 - 1.1
scpcli organization account list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--email <value>]
[--login_id <value>]
[--joined_start_date <value>]
[--joined_end_date <value>]
[--joined_method <value>]
[--exclude_policy_id <value>]
[--parent_unit_id <value>]
[--parent_unit_name <value>]
[--type <value>]
Description
get accounts list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | 조직 계정 ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| name optional | string | 계정명 | score-account |
| email optional | string | 계정 이메일 | score@samsung.com |
| login_id optional | string | 로그인 ID | log-archive@samsung.com |
| joined_start_date optional | string | 가입 조회 시작 일시 | 2024-05-17T12:34:56.789Z |
| joined_end_date optional | string | 가입 조회 종료 일시 | 2024-05-17T12:34:56.789Z |
| joined_method optional | **** | 가입 방법 | INVITED |
| exclude_policy_id optional | string | 제외할 정책 ID | 238c2fc8c29a449dbfa8681f8f1d78e2 |
| parent_unit_id optional | string | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name optional | string | ROOT 또는 부모 조직 단위명 | parent-unit-name |
| type optional | **** | 계정 유형 | MEMBER |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| 계정 이메일 | score@samsung.com | |
| joined_method | 가입 방법 | INVITED |
| joined_time | 가입 일시 | 2024-05-17T12:34:56.789Z |
| login_id | 로그인 ID | log-archive@samsung.com |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| name | 계정명 | score-account |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | ROOT 또는 부모 조직 단위명 | parent-unit-name |
| state | 계정 상태 | ACTIVE |
| type | 계정 유형 | MEMBER |
10.7.1.17.2 - 1.0
scpcli organization account list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--email <value>]
[--login_id <value>]
[--joined_start_date <value>]
[--joined_end_date <value>]
[--joined_method <value>]
[--exclude_policy_id <value>]
[--parent_unit_id <value>]
[--parent_unit_name <value>]
[--type <value>]
Description
get accounts list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | 조직 계정 ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| name optional | string | 계정명 | score-account |
| email optional | string | 계정 이메일 | score@samsung.com |
| login_id optional | string | 로그인 ID | log-archive@samsung.com |
| joined_start_date optional | string | 가입 조회 시작 일시 | 2024-05-17T12:34:56.789Z |
| joined_end_date optional | string | 가입 조회 종료 일시 | 2024-05-17T12:34:56.789Z |
| joined_method optional | **** | 가입 방법 | INVITED |
| exclude_policy_id optional | string | 제외할 정책 ID | 238c2fc8c29a449dbfa8681f8f1d78e2 |
| parent_unit_id optional | string | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name optional | string | ROOT 또는 부모 조직 단위명 | parent-unit-name |
| type optional | **** | 계정 유형 | MEMBER |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| 계정 이메일 | score@samsung.com | |
| joined_method | 가입 방법 | INVITED |
| joined_time | 가입 일시 | 2024-05-17T12:34:56.789Z |
| login_id | 로그인 ID | log-archive@samsung.com |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| name | 계정명 | score-account |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | ROOT 또는 부모 조직 단위명 | parent-unit-name |
| state | 계정 상태 | ACTIVE |
| type | 계정 유형 | MEMBER |
10.7.1.18 - ListOrganizationInvitations
10.7.1.18.1 - 1.1
scpcli organization organization invitation list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--account_id <value>]
[--account_name <value>]
[--account_email <value>]
[--state <value>]
[--login_id <value>]
Description
get organization invitation list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | 관리자 계정명 | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| account_name optional | string | 관리자 계정명 | CoreKim |
| account_email optional | string | 관리자 계정 이메일 | admin@example.com |
| state optional | **** | 초대 상태 | INVITING |
| login_id optional | string | 로그인 ID | log-archive@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| account_email | 관리자 계정 이메일 | admin@example.com |
| account_name | 관리자 계정명 | CoreKim |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| login_id | 로그인 ID | log-archive@samsung.com |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| state | 초대 상태 | INVITING |
| target_account_id | 관리자 계정명 | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
10.7.1.18.2 - 1.0
scpcli organization organization invitation list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--account_id <value>]
[--account_name <value>]
[--account_email <value>]
[--state <value>]
[--login_id <value>]
Description
get organization invitation list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | 관리자 계정명 | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| account_name optional | string | 관리자 계정명 | CoreKim |
| account_email optional | string | 관리자 계정 이메일 | admin@example.com |
| state optional | **** | 초대 상태 | INVITING |
| login_id optional | string | 로그인 ID | log-archive@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| account_email | 관리자 계정 이메일 | admin@example.com |
| account_name | 관리자 계정명 | CoreKim |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| login_id | 로그인 ID | log-archive@samsung.com |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| state | 초대 상태 | INVITING |
| target_account_id | 관리자 계정명 | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
10.7.1.19 - ListOrganizations
10.7.1.19.1 - 1.1
scpcli organization organization list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--master_account_id <value>]
Description
get organizations list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 조직 이름 | My Organization |
| master_account_id optional | string | 조직 계정 ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| delegation_account_id | 위임 계정 | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_id | 관리자 계정 ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| name | 조직 이름 | My Organization |
| root_unit_id | 루트 유닛 ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| use_scp_yn | 통제 정책 사용 여부 | True |
10.7.1.19.2 - 1.0
scpcli organization organization list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--master_account_id <value>]
Description
get organizations list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 조직 이름 | My Organization |
| master_account_id optional | string | 조직 계정 ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| delegation_account_id | 위임 계정 | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_id | 관리자 계정 ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| name | 조직 이름 | My Organization |
| root_unit_id | 루트 유닛 ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| use_scp_yn | 통제 정책 사용 여부 | True |
10.7.1.20 - ListOrganizationUnits
10.7.1.20.1 - 1.1
scpcli organization organization unit list
--parent_unit_id <value>
[--organization_id <value>]
[--name <value>]
[--exclude_policy_id <value>]
Description
get organization unit list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_unit_id required | string | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name optional | string | 조직 단위명 | score-organization-unit |
| exclude_policy_id optional | string | 제외할 정책 ID | 238c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 단위 ID 또는 조직 계정 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| depth | 계층(0~5) | 1 |
| 계정 이메일 | score@samsung.com | |
| joined_method | 가입 방법 | INVITED |
| joined_time | 가입 일시 | 2024-05-17T12:34:56.789Z |
| login_id | 로그인 ID | log-archive@samsung.com |
| name | 조직 단위명 또는 계정명 | score-organization-unit |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | ROOT 또는 부모 조직 단위명 | parent-unit-name |
| type | 유형(ROOT 또는 조직 단위) 또는 계정 유형 | MEMBER |
10.7.1.20.2 - 1.0
scpcli organization organization unit list
--parent_unit_id <value>
[--organization_id <value>]
[--name <value>]
[--exclude_policy_id <value>]
Description
get organization unit list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_unit_id required | string | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name optional | string | 조직 단위명 | score-organization-unit |
| exclude_policy_id optional | string | 제외할 정책 ID | 238c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 단위 ID 또는 조직 계정 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| depth | 계층(0~5) | 1 |
| 계정 이메일 | score@samsung.com | |
| joined_method | 가입 방법 | INVITED |
| joined_time | 가입 일시 | 2024-05-17T12:34:56.789Z |
| login_id | 로그인 ID | log-archive@samsung.com |
| name | 조직 단위명 또는 계정명 | score-organization-unit |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| type | 유형(ROOT 또는 조직 단위) 또는 계정 유형 | MEMBER |
10.7.1.21 - ListParents
10.7.1.21.1 - 1.1
scpcli organization organization unit parent list
--unit_id <value>
[--organization_id <value>]
Description
get organization unit parent list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | 조직 단위 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 단위 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| depth | 계층(0~5) | 1 |
| description | 조직 단위 설명 | 에스코어 조직 단위 |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 조직 단위명 | score-organization-unit |
| parent_unit_id | 유형(ROOT 또는 조직 단위) | ou-fc8c29a138d78e24bf1fa86812fc8b |
| service_name | 서비스명 | Organization |
| srn | 조직 단위 SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| type | 유형(ROOT 또는 조직 단위) | OU |
10.7.1.21.2 - 1.0
scpcli organization organization unit parent list
--unit_id <value>
[--organization_id <value>]
Description
get organization unit parent list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | 조직 단위 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 단위 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| depth | 계층(0~5) | 1 |
| description | 조직 단위 설명 | 에스코어 조직 단위 |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 조직 단위명 | score-organization-unit |
| parent_unit_id | 유형(ROOT 또는 조직 단위) | ou-fc8c29a138d78e24bf1fa86812fc8b |
| service_name | 서비스명 | Organization |
| srn | 조직 단위 SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| type | 유형(ROOT 또는 조직 단위) | OU |
10.7.1.22 - ListPoliciesForTarget
10.7.1.22.1 - 1.1
scpcli organization target policy list
--target_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]
Description
list policies for target
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_id required | string | 타겟 ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_category optional | **** | 정책 카테고리 | SCP |
| name optional | string | 제어 정책 이름 | test-policy-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| link_types | 연결 유형 | {‘DIRECTED’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’, ’target_type’: ‘OU’}], ‘INHERITED’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’, ’target_type’: ‘ROOT’}]} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| policy_name | 제어 정책 이름 | test-policy-name |
| policy_type | 제어 정책 유형 | SYSTEM_MANAGED |
| source | 정책 생성 주체 | ORGANIZATION |
10.7.1.22.2 - 1.0
scpcli organization target policy list
--target_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]
Description
list policies for target
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_id required | string | 타겟 ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_category optional | **** | 정책 카테고리 | SCP |
| name optional | string | 제어 정책 이름 | test-policy-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| link_types | 연결 유형 | {‘DIRECTED’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’, ’target_type’: ‘OU’}], ‘INHERITED’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’, ’target_type’: ‘ROOT’}]} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| policy_name | 제어 정책 이름 | test-policy-name |
| policy_type | 제어 정책 유형 | SYSTEM_MANAGED |
| source | 정책 생성 주체 | ORGANIZATION |
10.7.1.23 - ListServiceControlPolicies
10.7.1.23.1 - 1.1
scpcli organization service control policy list
--organization_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--exclude_target_id <value>]
Description
get service control policies list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name optional | array | 서비스 제어 정책 이름 | M |
| type optional | **** | 서비스 제어 정책 유형 | MANAGED |
| exclude_target_id optional | string | 제외 대상 ID | 112c2fc8c29a449dbfa8681f8f1d7442 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | 정책 카테고리 | SCP |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| description | 정책 설명 | This is an example policy. |
| document | 정책 문서 | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 서비스 제어 정책 이름 | MyPolicy |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| source | 정책 생성 주체 | ORGANIZATION |
| state | 정책 상태 | ACTIVE |
| type | 서비스 제어 정책 유형 | MANAGED |
10.7.1.23.2 - 1.0
scpcli organization service control policy list
--organization_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--exclude_target_id <value>]
Description
get service control policies list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name optional | array | 서비스 제어 정책 이름 | M |
| type optional | **** | 서비스 제어 정책 유형 | MANAGED |
| exclude_target_id optional | string | 제외 대상 ID | 112c2fc8c29a449dbfa8681f8f1d7442 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | 정책 카테고리 | SCP |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| description | 정책 설명 | This is an example policy. |
| document | 정책 문서 | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 서비스 제어 정책 이름 | MyPolicy |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| source | 정책 생성 주체 | ORGANIZATION |
| state | 정책 상태 | ACTIVE |
| type | 서비스 제어 정책 유형 | MANAGED |
10.7.1.24 - ListTargetsForPolicy
10.7.1.24.1 - 1.1
scpcli organization policy target list
--target_type <value>
--policy_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]
Description
list targets for policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_type required | **** | 타겟 유형 | OU |
| policy_id required | string | 제어 정책 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_category optional | **** | 정책 카테고리 | SCP |
| name optional | string | 타겟명 | example-target |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| control_policies | 통제 정책 아이디 목록 | |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| target_name | 타겟명 | example-target |
10.7.1.24.2 - 1.0
scpcli organization policy target list
--target_type <value>
--policy_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]
Description
list targets for policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_type required | **** | 타겟 유형 | OU |
| policy_id required | string | 제어 정책 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_category optional | **** | 정책 카테고리 | SCP |
| name optional | string | 타겟명 | example-target |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| control_policies | 통제 정책 아이디 목록 | |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| target_name | 타겟명 | example-target |
10.7.1.25 - MoveAccount
10.7.1.25.1 - 1.1
scpcli organization account move
--target_account_ids <value>
--parent_unit_id <value>
[--organization_id <value>]
Description
move a specific account to a different OU
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_ids required | array | 타겟 계정 아이디 목록 | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| parent_unit_id required | string | ROOT ID 또는 조직 단위 ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.25.2 - 1.0
scpcli organization account move
--target_account_ids <value>
--parent_unit_id <value>
[--organization_id <value>]
Description
move a specific account to a different OU
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_ids required | array | 타겟 계정 아이디 목록 | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| parent_unit_id required | string | ROOT ID 또는 조직 단위 ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.26 - RemoveAccounts
10.7.1.26.1 - 1.1
scpcli organization account remove
--target_account_ids <value>
[--organization_id <value>]
Description
Remove accounts from organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_ids required | array | 타겟 계정 아이디 목록 | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.26.2 - 1.0
scpcli organization account remove
--target_account_ids <value>
[--organization_id <value>]
Description
Remove accounts from organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_ids required | array | 타겟 계정 아이디 목록 | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.27 - RemovePolicyBindings
10.7.1.27.1 - 1.1
scpcli organization policy remove
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]
Description
remove policy bindings
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_ids required | array | 타겟 정보 | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| policy_ids required | array | 제어 정책 목록 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| entity required | string | 개체 유형 | POLICY |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.27.2 - 1.0
scpcli organization policy remove
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]
Description
remove policy bindings
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_ids required | array | 타겟 정보 | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| policy_ids required | array | 제어 정책 목록 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| entity required | string | 개체 유형 | POLICY |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.28 - SetDelegationPolicy
10.7.1.28.1 - 1.1
scpcli organization delegation policy set
[--organization_id <value>]
[--statement <value>]
[--version <value>]
Description
set a specific delegation policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| statement optional | array | 정책 문법 | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | 정책 버전 | - |
10.7.1.28.2 - 1.0
scpcli organization delegation policy set
[--organization_id <value>]
[--statement <value>]
[--version <value>]
Description
set a specific delegation policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| statement optional | array | 정책 문법 | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | 정책 버전 | - |
10.7.1.29 - SetOrganization
10.7.1.29.1 - 1.1
scpcli organization organization set
--organization_id <value>
[--delegation_account_id <value>]
[--name <value>]
[--organization_id <value>]
[--use_scp_yn <value>]
Description
set a specific organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| delegation_account_id optional | string | 위임 계정 | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| name optional | string | 조직 이름 | My Organization |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn optional | boolean | 통제 정책 사용 여부 | True |
10.7.1.29.2 - 1.0
scpcli organization organization set
--organization_id <value>
[--delegation_account_id <value>]
[--name <value>]
[--organization_id <value>]
[--use_scp_yn <value>]
Description
set a specific organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| delegation_account_id optional | string | 위임 계정 | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| name optional | string | 조직 이름 | My Organization |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn optional | boolean | 통제 정책 사용 여부 | True |
10.7.1.30 - SetOrganizationUnit
10.7.1.30.1 - 1.1
scpcli organization organization unit set
--unit_id <value>
[--description <value>]
[--name <value>]
[--organization_id <value>]
Description
set a specific organization unit
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | 조직 단위 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| description optional | string | 조직 단위 설명 | 에스코어 조직 단위 |
| name optional | string | 조직 단위명 | score-organization-unit |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.30.2 - 1.0
scpcli organization organization unit set
--unit_id <value>
[--description <value>]
[--name <value>]
[--organization_id <value>]
Description
set a specific organization unit
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | 조직 단위 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| description optional | string | 조직 단위 설명 | 에스코어 조직 단위 |
| name optional | string | 조직 단위명 | score-organization-unit |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.31 - SetServiceControlPolicy
10.7.1.31.1 - 1.1
scpcli organization service control policy set
--policy_id <value>
--organization_id <value>
[--description <value>]
[--name <value>]
[--statement <value>]
[--version <value>]
Description
set a specific service control policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| description optional | string | 정책 설명 | This is an example policy. |
| name optional | string | 서비스 제어 정책 이름 | MyPolicy |
| statement optional | array | 정책 문법 | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | 정책 버전 | - |
10.7.1.31.2 - 1.0
scpcli organization service control policy set
--policy_id <value>
--organization_id <value>
[--description <value>]
[--name <value>]
[--statement <value>]
[--version <value>]
Description
set a specific service control policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| description optional | string | 정책 설명 | This is an example policy. |
| name optional | string | 서비스 제어 정책 이름 | MyPolicy |
| statement optional | array | 정책 문법 | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | 정책 버전 | - |
10.7.1.32 - ShowAccount
10.7.1.32.1 - 1.1
scpcli organization account show
--account_id <value>
[--organization_id <value>]
[--lazy_policy <value>]
Description
show a specific account
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | 조직 계정 ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| lazy_policy optional | boolean | 연결된 정책 조회 여부 | True |
Responses
| Name | Description | Example |
|---|---|---|
| account | 조직 계정 상세 정보 |
10.7.1.32.2 - 1.0
scpcli organization account show
--account_id <value>
[--organization_id <value>]
[--lazy_policy <value>]
Description
show a specific account
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | 조직 계정 ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| lazy_policy optional | boolean | 연결된 정책 조회 여부 | True |
Responses
| Name | Description | Example |
|---|---|---|
| account | 조직 계정 상세 정보 |
10.7.1.33 - ShowDelegationPolicy
10.7.1.33.1 - 1.1
scpcli organization delegation policy show
[--organization_id <value>]
Description
show a specific delegation policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| document | 위임 정책 문서 | {‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.33.2 - 1.0
scpcli organization delegation policy show
[--organization_id <value>]
Description
show a specific delegation policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| document | 위임 정책 문서 | {‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
10.7.1.34 - ShowOrganization
10.7.1.34.1 - 1.1
scpcli organization organization show
--organization_id <value>
Description
show a specific organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| delegation_account_id | 위임 계정 | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_email | 관리자 계정 이메일 | admin@example.com |
| master_account_id | 관리자 계정 ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 조직 이름 | My Organization |
| root_unit_id | 루트 유닛 ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| srn | 조직 SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn | 통제 정책 사용 여부 | True |
10.7.1.34.2 - 1.0
scpcli organization organization show
--organization_id <value>
Description
show a specific organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| delegation_account_id | 위임 계정 | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_email | 관리자 계정 이메일 | admin@example.com |
| master_account_id | 관리자 계정 ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 조직 이름 | My Organization |
| root_unit_id | 루트 유닛 ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| srn | 조직 SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn | 통제 정책 사용 여부 | True |
10.7.1.35 - ShowOrganizationUnit
10.7.1.35.1 - 1.1
scpcli organization organization unit show
--unit_id <value>
[--organization_id <value>]
Description
show a specific organization unit
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | 조직 단위 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| organization_unit | 조직 단위 정보 |
10.7.1.35.2 - 1.0
scpcli organization organization unit show
--unit_id <value>
[--organization_id <value>]
Description
show a specific organization unit
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | 조직 단위 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| organization_unit | 조직 단위 정보 |
10.7.1.36 - ShowServiceControlPolicy
10.7.1.36.1 - 1.1
scpcli organization service control policy show
--policy_id <value>
[--organization_id <value>]
Description
show a specific service control policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | 정책 카테고리 | SCP |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| description | 정책 설명 | This is an example policy. |
| document | 정책 문서 | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 서비스 제어 정책 이름 | MyPolicy |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| service_name | 서비스명 | Organization |
| source | 정책 생성 주체 | ORGANIZATION |
| srn | 정책 SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 |
| state | 정책 상태 | ACTIVE |
| type | 서비스 제어 정책 유형 | MANAGED |
10.7.1.36.2 - 1.0
scpcli organization service control policy show
--policy_id <value>
[--organization_id <value>]
Description
show a specific service control policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id optional | string | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 서비스 제어 정책 ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | 정책 카테고리 | SCP |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| description | 정책 설명 | This is an example policy. |
| document | 정책 문서 | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| name | 서비스 제어 정책 이름 | MyPolicy |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| service_name | 서비스명 | Organization |
| source | 정책 생성 주체 | ORGANIZATION |
| srn | 정책 SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 |
| state | 정책 상태 | ACTIVE |
| type | 서비스 제어 정책 유형 | MANAGED |
10.8 - Quota Service
Overview
None
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260223 |
| 1.1 | DEPRECATED | 20260223 |
| 1.2 | CURRENT | - |
10.8.1 - CLIs
10.8.1.1 - ListAccountQuota
10.8.1.1.1 - 1.2
scpcli quota account-quota list
[--size <value>]
[--page <value>]
[--sort <value>]
[--request_class <value>]
[--service <value>]
[--quota_item <value>]
[--description <value>]
Description
account quota 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| request_class optional | string | Request Class | Account |
| service optional | string | Service Name | IAM |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| description optional | string | Description | Virtual Server disk max size |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account Inc. |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| max_per_account | Max per Account Value | 1000 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
10.8.1.1.2 - 1.1
scpcli quota account-quota list
[--size <value>]
[--page <value>]
[--sort <value>]
[--request_class <value>]
[--service <value>]
[--quota_item <value>]
[--description <value>]
Description
account quota 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| request_class optional | string | Request Class | Account |
| service optional | string | Service Name | IAM |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| description optional | string | Description | Virtual Server disk max size |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account Inc. |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| max_per_account | Max per Account Value | 1000 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
10.8.1.1.3 - 1.0
scpcli quota account-quota list
[--size <value>]
[--page <value>]
[--sort <value>]
[--request_class <value>]
[--service <value>]
[--quota_item <value>]
[--description <value>]
Description
account quota 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| request_class optional | string | Request Class | Account |
| service optional | string | Service Name | IAM |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| description optional | string | Description | Virtual Server disk max size |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account Inc. |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
10.8.1.2 - ListQuotaRequests
10.8.1.2.1 - 1.2
scpcli quota quota-request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--service <value>]
[--quota_item <value>]
[--requester <value>]
[--request_class <value>]
[--requested_start_at <value>]
[--requested_end_at <value>]
[--applied_start_at <value>]
[--applied_end_at <value>]
[--state <value>]
Description
quota request 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| service optional | string | Service Name | Virtual Server |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| requester optional | string | Requester Information | cloud.kim |
| request_class optional | string | Request Class | Account |
| requested_start_at optional | string | Start date of the request | 2024-05-01 |
| requested_end_at optional | string | End date of the request | 2024-05-31 |
| applied_start_at optional | string | Start date of the application | 2024-05-01 |
| applied_end_at optional | string | End date of the application | 2024-05-31 |
| state optional | string | Request State | BEFORE_APPROVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| request_class | Request Class | Account |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| service | Service Name | Virtual Server |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
10.8.1.2.2 - 1.1
scpcli quota quota-request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--service <value>]
[--quota_item <value>]
[--requester <value>]
[--request_class <value>]
[--requested_start_at <value>]
[--requested_end_at <value>]
[--applied_start_at <value>]
[--applied_end_at <value>]
[--state <value>]
Description
quota request 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| service optional | string | Service Name | Virtual Server |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| requester optional | string | Requester Information | cloud.kim |
| request_class optional | string | Request Class | Account |
| requested_start_at optional | string | Start date of the request | 2024-05-01 |
| requested_end_at optional | string | End date of the request | 2024-05-31 |
| applied_start_at optional | string | Start date of the application | 2024-05-01 |
| applied_end_at optional | string | End date of the application | 2024-05-31 |
| state optional | string | Request State | BEFORE_APPROVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| request_class | Request Class | Account |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| service | Service Name | Virtual Server |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
10.8.1.2.3 - 1.0
scpcli quota quota-request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--service <value>]
[--quota_item <value>]
[--requester <value>]
[--request_class <value>]
[--requested_start_at <value>]
[--requested_end_at <value>]
[--applied_start_at <value>]
[--applied_end_at <value>]
[--state <value>]
Description
quota request 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| service optional | string | Service Name | Virtual Server |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| requester optional | string | Requester Information | cloud.kim |
| request_class optional | string | Request Class | Account |
| requested_start_at optional | string | Start date of the request | 2024-05-01 |
| requested_end_at optional | string | End date of the request | 2024-05-31 |
| applied_start_at optional | string | Start date of the application | 2024-05-01 |
| applied_end_at optional | string | End date of the application | 2024-05-31 |
| state optional | string | Request State | BEFORE_APPROVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| request_class | Request Class | Account |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| service | Service Name | Virtual Server |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
10.8.1.3 - ShowAccountQuota
10.8.1.3.1 - 1.2
scpcli quota account-quota show
--account_quota_id <value>
Description
account quota 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_quota_id required | string | Account Quota ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account Inc. |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| max_per_account | Max per Account Value | 1000 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
10.8.1.3.2 - 1.1
scpcli quota account-quota show
--account_quota_id <value>
Description
account quota 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_quota_id required | string | Account Quota ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account Inc. |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| max_per_account | Max per Account Value | 1000 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
10.8.1.3.3 - 1.0
scpcli quota account-quota show
--account_quota_id <value>
Description
account quota 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_quota_id required | string | Account Quota ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account Inc. |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
10.8.1.4 - ShowQuotaRequest
10.8.1.4.1 - 1.2
scpcli quota quota-request show
--request_id <value>
Description
quota request 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | 0c2a06f2f06d42248a6bb88b1a78d4cc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_quota_id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| class_value | Value associated with the request class | Global |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
10.8.1.4.2 - 1.1
scpcli quota quota-request show
--request_id <value>
Description
quota request 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | 0c2a06f2f06d42248a6bb88b1a78d4cc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_quota_id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| class_value | Value associated with the request class | Global |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
10.8.1.4.3 - 1.0
scpcli quota quota-request show
--request_id <value>
Description
quota request 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | 0c2a06f2f06d42248a6bb88b1a78d4cc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_quota_id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| class_value | Value associated with the request class | Global |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
10.9 - Resource Manager
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Resourcemanager 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
10.9.1 - CLIs
10.9.1.1 - CreateResourceGroup
10.9.1.1.1 - 1.0
scpcli resourcemanager resource group create
--name <value>
--description <value>
[--region <value>]
[--resource_types <value>]
[--tags <value>]
Description
create a resource_group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | 리소스 그룹명 | resource-group-1 |
| description required | string | 리소스 그룹 설명 | resource group 1 |
| region optional | string | 리전 | kr-west1 |
| resource_types optional | array | 자원 유형 목록 (service:resource_type) | [ |
| tags optional | array | 태그 목록 | '{"key": "tag-key", "value": "tag-value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| resource_group | 리소스 그룹 |
10.9.1.2 - DeleteComponentsTag
10.9.1.2.1 - 1.0
scpcli resourcemanager components tag key delete
--key <value>
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
Description
delete a specific components tag
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | 태그 key (base64 encoded KEY) | dGFnLWtleQ== |
| resource_identifier required | string | 자원 ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | 자원 유형 | virtual-server |
| service required | string | 서비스 명 | virtualserver |
| region required | string | 리전 | kr-west1 |
10.9.1.3 - DeleteComponentsTags
10.9.1.3.1 - 1.0
scpcli resourcemanager components tag delete
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
Description
delete components tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_identifier required | string | 자원 ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | 자원 유형 | virtual-server |
| service required | string | 서비스 명 | virtualserver |
| region required | string | 리전 | kr-west1 |
10.9.1.4 - DeleteResourceGroup
10.9.1.4.1 - 1.0
scpcli resourcemanager resource group delete
--resource_group_id <value>
Description
delete a specific resource_group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_group_id required | string | 리소스 그룹 ID | 1486t61d84b354fb9135cc467owe1346 |
10.9.1.5 - DeleteResourceGroups
10.9.1.5.1 - 1.0
scpcli resourcemanager resource group delete bulk
[--ids <value>]
Description
delete a specific resource_groups
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | 리소스 그룹 ID 목록 | [ |
10.9.1.6 - DeleteResourceTag
10.9.1.6.1 - 1.0
scpcli resourcemanager resource tag key delete
--key <value>
--srn <value>
Description
delete a specific resource tag
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | 태그 key (base64 encoded KEY) | dGFnLWtleQ== |
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
10.9.1.7 - DeleteResourceTags
10.9.1.7.1 - 1.0
scpcli resourcemanager resource tag delete
--srn <value>
Description
delete resource tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
10.9.1.8 - DeleteTags
10.9.1.8.1 - 1.0
scpcli resourcemanager tag delete
--tags <value>
Description
delete tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags required | dict | 태그 키 목록 | {"srn:e::PROJECT-NTcEraJPrRhNGqldsJLTnf:kr-east1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m": ["key1", "key4"]} |
10.9.1.9 - ListComponentsTags
10.9.1.9.1 - 1.0
scpcli resourcemanager components tag list
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--key <value>]
[--value <value>]
Description
get components tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_identifier required | string | 자원 ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | 자원 유형 | virtual-server |
| service required | string | 서비스 명 | virtualserver |
| region required | string | 리전 | kr-west1 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| key optional | string | 태그 key | tag-key |
| value optional | string | 태그 value | tag-value |
Responses
| Name | Description | Example |
|---|---|---|
| content | 태그 목록 | |
| count | count | 20 |
| page | page | 0 |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
10.9.1.10 - ListResourceGroupResources
10.9.1.10.1 - 1.0
scpcli resourcemanager resource group resource list
--resource_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
list a specific resource_group_resources
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_group_id required | string | 리소스 그룹 ID | 1486t61d84b354fb9135cc467owe1346 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 어카운트ID | 1234ab567cd64769e8f9g490hi304891 |
| created_at | 생성 일시 | 2025-02-27T10:23:43Z |
| created_by | 생성자 | 7123ke8439734e5789lj355b17ef5473 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| product_name | 상품/서비스 | Virtual Server |
| region | 리전 | kr-west1 |
| resource_name | 자원명 | resource-name-1 |
| resource_type | 자원 유형 | virtual-server |
| resource_type_display_name | 자원 유형명 | Virtual Server |
| service | SERVICE | virtualserver |
| service_name | 서비스 명 | Virtual Server |
| srn | SRN | srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 |
| state | 상태 | Success |
| tags | 태그 목록 | [{“key1”: “value1”}, {“key2”: “value2”}] |
10.9.1.11 - ListResourceGroups
10.9.1.11.1 - 1.0
scpcli resourcemanager resource group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--region <value>]
Description
get resource_groups list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 리소스 그룹 ID | 1486t61d84b354fb9135cc467owe1346 |
| name optional | string | 리소스 그룹명 | resource-group-1 |
| region optional | string | 리전 | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 리소스 그룹 ID | 1486t61d84b354fb9135cc467owe1346 |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | 리소스 그룹 설명 | resource group 1 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | 리소스 그룹명 | resource-group-1 |
| region | 리전 | kr-west1 |
| resource_types | 자원 유형 목록 | [“resourcemanager:resource-group”, “loggingaudit:trail”] |
| tags | 태그 목록 | [{“key”: “key1”, “value”: “value1”}, {“key”: “key2”, “value”: “value2”}] |
10.9.1.12 - ListResources
10.9.1.12.1 - 1.0
scpcli resourcemanager resource list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--resource_name <value>]
[--service_name <value>]
[--resource_type <value>]
[--region <value>]
Description
get resources list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 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 | 자원 ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_name optional | string | 자원명 | resource-name-1 |
| service_name optional | string | 서비스 명 | Virtual Server |
| resource_type optional | string | 자원 유형 | virtual-server |
| region optional | string | 리전 | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 어카운트ID | 1234ab567cd64769e8f9g490hi304891 |
| created_at | 생성 일시 | 2025-02-27T10:23:43Z |
| created_by | 생성자 | 7123ke8439734e5789lj355b17ef5473 |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| product_name | 상품/서비스 | Virtual Server |
| region | 리전 | kr-west1 |
| resource_name | 자원명 | resource-name-1 |
| resource_type | 자원 유형 | virtual-server |
| resource_type_display_name | 자원 유형명 | Virtual Server |
| service | SERVICE | virtualserver |
| service_name | 서비스 명 | Virtual Server |
| srn | SRN | srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 |
| state | 상태 | Success |
| tags | 태그 목록 | [{“key1”: “value1”}, {“key2”: “value2”}] |
10.9.1.13 - ListResourceTags
10.9.1.13.1 - 1.0
scpcli resourcemanager resource tag list
--srn <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--key <value>]
[--value <value>]
Description
get resource tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| key optional | string | 태그 key | tag-key |
| value optional | string | 태그 value | tag-value |
Responses
| Name | Description | Example |
|---|---|---|
| content | 태그 목록 | |
| count | count | 20 |
| page | page | 0 |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
10.9.1.14 - ListTagKeys
10.9.1.14.1 - 1.0
scpcli resourcemanager tag key list
[--key <value>]
[--region <value>]
Description
get tag key list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key optional | string | 태그 key | tag-key |
| region optional | string | 리전 | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| count | 개수 | 6 |
| keys | 태그 key 목록 | [“key1”, “key2”] |
10.9.1.15 - ListTags
10.9.1.15.1 - 1.0
scpcli resourcemanager tag list
[--size <value>]
[--page <value>]
[--sort <value>]
[--account_id <value>]
[--key <value>]
[--value <value>]
[--resource_identifier <value>]
[--resource_type <value>]
[--service <value>]
[--offering <value>]
[--region <value>]
Description
get tag list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | 어카운트 ID | 1234ab567cd64769e8f9g490hi304891 |
| key optional | string | 태그 key | tag-key |
| value optional | string | 태그 value | tag-value |
| resource_identifier optional | string | 자원 ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type optional | string | 자원 유형 | virtual-server |
| service optional | string | 서비스 명 | virtualserver |
| offering optional | string | SCP 운영 단위 | dev2 |
| region optional | string | 리전 | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| key | 태그 key | tag-key |
| srn | SRN | srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 |
| value | 태그 value | tag-value |
10.9.1.16 - ListTagValues
10.9.1.16.1 - 1.0
scpcli resourcemanager tag value list
[--key <value>]
[--region <value>]
[--value <value>]
Description
get tag value list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key optional | string | 태그 key | tag-key |
| region optional | string | 리전 | kr-west1 |
| value optional | string | 태그 value | tag-value |
Responses
| Name | Description | Example |
|---|---|---|
| count | 개수 | 6 |
| values | 태그 value 목록 | [“value1”, “value2”] |
10.9.1.17 - SetResourceGroup
10.9.1.17.1 - 1.0
scpcli resourcemanager resource group set
--resource_group_id <value>
--description <value>
[--resource_types <value>]
[--tags <value>]
Description
set resource_group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_group_id required | string | 리소스 그룹 ID | 1486t61d84b354fb9135cc467owe1346 |
| description required | string | 리소스 그룹 설명 | resource group 1 |
| resource_types optional | array | 자원 유형 목록 (service:resource_type) | [ |
| tags optional | array | 태그 목록 | '{"key": "tag-key", "value": "tag-value"}' |
10.9.1.18 - ShowComponentsTag
10.9.1.18.1 - 1.0
scpcli resourcemanager components tag show
--key <value>
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
Description
get a specific components tag
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | 태그 key (base64 encoded KEY) | dGFnLWtleQ== |
| resource_identifier required | string | 자원 ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | 자원 유형 | virtual-server |
| service required | string | 서비스 명 | virtualserver |
| region required | string | 리전 | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| content | 태그 |
10.9.1.19 - ShowResource
10.9.1.19.1 - 1.0
scpcli resourcemanager resource show
--srn <value>
Description
get a specific resource
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
Responses
| Name | Description | Example |
|---|---|---|
| resource | 자원 |
10.9.1.20 - ShowResourceByComponents
10.9.1.20.1 - 1.0
scpcli resourcemanager resource show by components
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
Description
get a specific resource
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_identifier required | string | 자원 ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | 자원 유형 | virtual-server |
| service required | string | 서비스 명 | virtualserver |
| region required | string | 리전 | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| resource | 자원 |
10.9.1.21 - ShowResourceGroup
10.9.1.21.1 - 1.0
scpcli resourcemanager resource group show
--resource_group_id <value>
Description
show a specific resource_group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_group_id required | string | 리소스 그룹 ID | 1486t61d84b354fb9135cc467owe1346 |
Responses
| Name | Description | Example |
|---|---|---|
| resource_group | 리소스 그룹 |
10.9.1.22 - ShowResourceTag
10.9.1.22.1 - 1.0
scpcli resourcemanager resource tag show
--key <value>
--srn <value>
Description
get a specific resource tag
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | 태그 key (base64 encoded KEY) | dGFnLWtleQ== |
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
Responses
| Name | Description | Example |
|---|---|---|
| content | 태그 |
10.9.1.23 - UpdateComponentsTags
10.9.1.23.1 - 1.0
scpcli resourcemanager components tag set
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
--tags <value>
Description
update components tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_identifier required | string | 자원 ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | 자원 유형 | virtual-server |
| service required | string | 서비스 명 | virtualserver |
| region required | string | 리전 | kr-west1 |
| tags required | array | 태그 목록 | '{"key": "tag-key", "value": "tag-value"}' |
10.9.1.24 - UpdateComponentsTagValue
10.9.1.24.1 - 1.0
scpcli resourcemanager components tag value set
--key <value>
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
--value <value>
Description
update components tag value
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | 태그 key (base64 encoded KEY) | dGFnLWtleQ== |
| resource_identifier required | string | 자원 ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | 자원 유형 | virtual-server |
| service required | string | 서비스 명 | virtualserver |
| region required | string | 리전 | kr-west1 |
| value required | string | SRN | tag-value |
10.9.1.25 - UpdateResourceTags
10.9.1.25.1 - 1.0
scpcli resourcemanager resource tag set
--srn <value>
--tags <value>
Description
update resource tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
| tags required | array | 태그 목록 | '{"key": "tag-key", "value": "tag-value"}' |
10.9.1.26 - UpdateResourceTagValue
10.9.1.26.1 - 1.0
scpcli resourcemanager resource tag value set
--key <value>
--srn <value>
--value <value>
Description
update resource tag value
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | 태그 key (base64 encoded KEY) | dGFnLWtleQ== |
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
| value required | string | SRN | tag-value |
10.9.1.27 - UpdateTags
10.9.1.27.1 - 1.0
scpcli resourcemanager tag set
--tags <value>
Description
update tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags required | dict | 태그 목록 | - |
10.10 - ServiceWatch
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 ServiceWatch 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | SUPPORTED | 20260630 |
| 1.1 | CURRENT | - |
10.10.1 - CLIs
10.10.1.1 - CreateCustomLogEvents
10.10.1.1.1 - 1.1
scpcli servicewatch logeventcustom create
--resourcelogs <value>
Description
Create custom log events
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resourcelogs required | array | Resource Logs | '{"resource": {"attributes": [{"key": "log_stream_value", "value": {"stringValue": "a1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "log_group_value", "value": {"stringValue": "b1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "account_id", "value": {"stringValue": "c1e2f3045678901a2b3c4d5e6f7a8b81"}}]}, "scopeLogs": [{"logRecords": [{"body": {"stringValue": "level=info otlp test log"}, "timeUnixNano": "1762336464000000000"}]}]}' |
Responses
| Name | Description | Example |
|---|---|---|
| status | Status | success |
10.10.1.2 - CreateCustomLogStream
10.10.1.2.1 - 1.1
scpcli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>
Description
Create a custom log stream
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_stream_name required | string | Log stream name | testls01 |
| log_group_name required | string | Log group name | testlg01 |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| log_group_value | Log group value | fa6169af200b4d5db229aff384b2a028 |
| log_stream_value | Log stream value | 551513c5182b45beb22eadb634cdccfb |
| requests_per_second | 초당 로그 요청 내보내기 | 500 |
10.10.1.3 - CreateCustomMetricMetas
10.10.1.3.1 - 1.1
scpcli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>
Description
Create Custom Metric Metas
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| namespace required | string | Namespace | MyCustom/filestorage |
| metricmetas required | array | '{"descriptionEn": "filestorage volume total byte", "descriptionKo": "\ud30c\uc77c\uc2a4\ud1a0\ub9ac\uc9c0 \ucd1d \ubc14\uc774\ud2b8 \uc218", "dimensions": [["image_id"]], "metricName": "Custom_filestorage_volume_total_byte", "storageResolution": 60, "unit": "Bytes"}' |
Responses
| Name | Description | Example |
|---|---|---|
| code | RESPONSE STATUS CODE of Metric | Success |
| message | Message about Updated Unit Info | [libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes |
10.10.1.4 - CreateCustomMetrics
10.10.1.4.1 - 1.1
scpcli servicewatch metriccustom create
--resource_metrics <value>
Description
Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_metrics required | array | The resourceMetrics field holds a set of all metric data associated with a specific resource | '{"resource": {"attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}]}, "scope_metrics": [{"metrics": [{"description": "The total number of bytes read successfully.", "gauge": {"data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}]}, "name": "node_disk_read_bytes_total", "sum": {"aggregation_temporality": "2", "data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}], "is_monotonic": true}, "unit": "Bytes"}], "scope": {"name": "ServiceWatch-Agent", "version": "1.0.0"}}]}' |
Responses
| Name | Description | Example |
|---|
10.10.1.5 - CreateDashboard
10.10.1.5.1 - 1.1
scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Dashboard's name | New-Monitoring-Dashboard |
| widgets optional | array | List of widgets included in the dashboard | ```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
Responses
| Name | Description | Example |
|---|---|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
10.10.1.5.2 - 1.0
scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Dashboard's name | New-Monitoring-Dashboard |
| widgets optional | array | List of widgets included in the dashboard | ```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
Responses
| Name | Description | Example |
|---|---|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
10.10.1.6 - DeleteBulkDashboards
10.10.1.6.1 - 1.1
scpcli servicewatch dashboard delete
--dashboard_ids <value>
Description
Delete bulk dashboards
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
10.10.1.6.2 - 1.0
scpcli servicewatch dashboard delete
--dashboard_ids <value>
Description
Delete bulk dashboards
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
10.10.1.7 - DownloadMetricDataImage
10.10.1.7.1 - 1.1
scpcli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]
Description
Download metric data image
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
| height optional | integer | Chart Image Height(pixels) | 400 |
| timezone optional | string | 타임존 | UTC |
| title optional | string | Chart Title | Virtual Server Metric Chart |
| width optional | integer | Chart Image Width(pixels) | 600 |
Responses
| Name | Description | Example |
|---|
10.10.1.7.2 - 1.0
scpcli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]
Description
Download metric data image
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
| height optional | integer | Chart Image Height(pixels) | 400 |
| timezone optional | string | 타임존 | UTC |
| title optional | string | Chart Title | Virtual Server Metric Chart |
| width optional | integer | Chart Image Width(pixels) | 600 |
Responses
| Name | Description | Example |
|---|
10.10.1.8 - ListDashboards
10.10.1.8.1 - 1.1
scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
Description
Get list of dashboards
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | name:asc or modified_at:desc |
| name optional | string | Dashboard's name | MyProd |
| name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
| favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |
10.10.1.8.2 - 1.0
scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
Description
Get list of dashboards
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | name:asc or modified_at:desc |
| name optional | string | Dashboard's name | MyProd |
| name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
| favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |
10.10.1.9 - ListMetricData
10.10.1.9.1 - 1.1
scpcli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
Description
Get metric data list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
Responses
| Name | Description | Example |
|---|---|---|
| display_name | Metric Display Name | Virtual Server |
| status | ||
| values | List of Metric Series Values | [[1640995200, “45.5”]] |
10.10.1.9.2 - 1.0
scpcli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
Description
Get metric data list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
Responses
| Name | Description | Example |
|---|---|---|
| display_name | Metric Display Name | Virtual Server |
| status | ||
| values | List of Metric Series Values | [[1640995200, “45.5”]] |
10.10.1.10 - ListMetricInfos
10.10.1.10.1 - 1.1
scpcli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]
Description
Get metric list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| metric_name optional | string | Metric Name | CPU Usage/Core[Basic] |
| namespaces optional | array | List of Namespace | '{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}' |
| resource_id optional | string | Resource ID | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| resource_name optional | string | Resource Name | VirtualServer01 |
| tags optional | array | List of Tags | '{"key": "key01", "value": "value01"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
| dimensions | ||
| name | Namespace | Virtual Server |
| service_name |
10.10.1.10.2 - 1.0
scpcli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]
Description
Get metric list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| metric_name optional | string | Metric Name | CPU Usage/Core[Basic] |
| namespaces optional | array | List of Namespace | '{"dimensions": "[\"resource_id\"]", "name": "Virtual Server"}' |
| resource_id optional | string | Resource ID | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| resource_name optional | string | Resource Name | VirtualServer01 |
| tags optional | array | List of Tags | '{"key": "key01", "value": "value01"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
| dimensions | ||
| name | Namespace | Virtual Server |
| service_name |
10.10.1.11 - SetDashboard
10.10.1.11.1 - 1.1
scpcli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]
Description
Set dashboard
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| name optional | string | Dashboard's name | Renamed-Dashboard |
| widgets optional | array | List of widgets included in the dashboard | ```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
10.10.1.11.2 - 1.0
scpcli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]
Description
Set dashboard
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| name optional | string | Dashboard's name | Renamed-Dashboard |
| widgets optional | array | List of widgets included in the dashboard | ```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server |
10.10.1.12 - ShowAgentDownloadLink
10.10.1.12.1 - 1.1
scpcli servicewatch show agent download link
Description
Show link to agent download
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| Name | Description | Example |
|---|---|---|
| download_link | URL to download agent | download_link = ‘https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip’ |
10.10.1.13 - ShowDashboard
10.10.1.13.1 - 1.1
scpcli servicewatch dashboard show
--dashboard_id <value>
Description
Show dashboard
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
10.10.1.13.2 - 1.0
scpcli servicewatch dashboard show
--dashboard_id <value>
Description
Show dashboard
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
10.11 - Support
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Support 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
10.11.1 - CLIs
10.11.1.1 - Get Inquiry List
10.11.1.1.1 - 1.0
scpcli support inquiry list
[--size <value>]
[--page <value>]
[--sort <value>]
[--title <value>]
[--state <value>]
[--inquiry_type <value>]
[--region_id <value>]
[--created_at <value>]
[--filter_inquiry_codes <value>]
[--filter_states <value>]
Description
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| title optional | string | title | VM usage inquiry |
| state optional | string | state | CLOSED |
| inquiry_type optional | string | inquiry type | General Inquiry - Account and connection inquiry |
| region_id optional | string | region id | kr-west1 |
| created_at optional | string | created at | 2024-06-01T00:12:57.000000Z |
| filter_inquiry_codes optional | string | filter inquiry codes | FL01,FL02 |
| filter_states optional | string | filter states | TODO,INPROGRESS |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | sr-240530-00028-nuri |
| account_id | account id | 2010571da2f7458e97c3b881b2362b72 |
| closed_at | closed at | 2024-06-27T08:12:57.000000Z |
| contents | contents | VM usage inquiry |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| files | ||
| inquiry_code | inquiry code | G01 |
| inquiry_type | inquiry type | General Inquiry - Account and connection inquiry |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_id | region id | kr-west1 |
| resource_name | resource name | lb1 |
| service_category | service category | Networking |
| service_item | service item | Load Balancer |
| state | state | CLOSED |
| title | title | VM usage inquiry |
10.11.1.2 - Get Service Request List
10.11.1.2.1 - 1.0
scpcli support service request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--filter_operation_type_ids <value>]
[--filter_service_item_ids <value>]
[--filter_title <value>]
[--filter_states <value>]
[--from_created_at <value>]
[--to_created_at <value>]
[--operation_type <value>]
[--service_item_name <value>]
[--title <value>]
[--state <value>]
Description
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| filter_operation_type_ids optional | string | 2010571da2f7458e97c3b881b2362b72,1h6q5kqt42f7458e97c3b881b2311utn | e8fea87728164808860ad81c6ce779b6 |
| filter_service_item_ids optional | string | service item id list | VIRTUAL_SERVER,LOAD_BALANCER |
| filter_title optional | string | title | Virtual Server operation related |
| filter_states optional | string | filter states | REQUESTING,CLOSED |
| from_created_at optional | string | from created at | 2024-07-01T00:00:00Z |
| to_created_at optional | string | to created at | 2024-07-05T23:59:59Z |
| operation_type optional | string | operation type | Placement Group Set Up Request |
| service_item_name optional | string | service item | Load Balancer |
| title optional | string | title | Virtual Server operation related |
| state optional | string | state | REQUESTING |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | 007d8cc7d60c4b26bb5a833b06686db3 |
| account_id | account id | 2010571da2f7458e97c3b881b2362b72 |
| account_name | account name | dev_project |
| closed_at | closed at | 2024-06-27T08:12:57.000000Z |
| contents | contents | I need assistance with working with Virtual Server. |
| created_at | created at | 2024-06-01T00:12:57.000000Z |
| created_by | created by | e3bff0c980dc41b2b6f3ac080b6d3ba0 |
| created_by_name | created by name and email | KimSamSung(test@samsung.com) |
| files | ||
| iops_result | iops result | Processing completed. |
| iops_sr_id | iops sr id | SR0002834921 |
| modified_at | modified at | 2024-06-11T00:12:57.000000Z |
| modified_by | modified by | e3bff0c980dc41b2b6f3ac080b6d3ba0 |
| operation_type | operation type | Placement Group Set Up Request |
| region | region | kr-west1 |
| service_category_name | service category | Networking |
| service_item_name | service item | Load Balancer |
| state | state | ACTIVE |
| template_id | template_id | e8fea87728164808860ad81c6ce779b6 |
| title | title | Virtual Server operation related |
10.11.1.3 - Show Inquiry
10.11.1.3.1 - 1.0
scpcli support inquiry show
--inquiry_id <value>
Description
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| inquiry_id required | string | id | sr-240530-00028-nuri |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | File-008ccb7ff65244689dacd605fafec92f |
| file_name | name | test.txt |
| size | size | 298426 |
10.11.1.4 - Show Service Request
10.11.1.4.1 - 1.0
scpcli support service request show
--service_request_id <value>
Description
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_request_id required | string | id | 007d8cc7d60c4b26bb5a833b06686db3 |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | File-008ccb7ff65244689dacd605fafec92f |
| file_name | name | test.txt |
| size | size | 298426 |
11 - Platform
11.1 - Product
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 PRODUCT 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
11.1.1 - CLIs
11.1.1.1 - List Product Categories
11.1.1.1.1 - 1.0
scpcli product product categories list
[--limit <value>]
[--page <value>]
[--display_name <value>]
[--display_name_ko <value>]
[--is_exposed_menu <value>]
[--created_by <value>]
[--modified_by <value>]
[--created_start_date <value>]
[--created_end_date <value>]
[--modified_start_date <value>]
[--modified_end_date <value>]
[--sort <value>]
Description
List product categories
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | LIMIT | 10 |
| page optional | integer | Page | 1 |
| display_name optional | array | Product Category Name | N |
| display_name_ko optional | array | Product Category Name | N |
| is_exposed_menu optional | array | Product Category Menu Exposed Status | T |
| created_by optional | string | Created by | 김삼성 |
| modified_by optional | string | Modified by | 김삼성 |
| created_start_date optional | string | Created start date | 2024-01-01T00:00:00 |
| created_end_date optional | string | Created end date | 2024-01-01T00:00:00 |
| modified_start_date optional | string | Modified start date | 2024-01-01T00:00:00 |
| modified_end_date optional | string | Modified end date | 2024-01-01T00:00:00 |
| sort optional | string | Sort | created_at:asc |
Responses
| Name | Description | Example |
|---|---|---|
| category_id | Product Category ID | NETWORKING |
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product Category Name | Networking |
| display_name_ko | Product Category Name | Networking |
| icon_file_id | Icon File ID | c1d5c1f63bf24f73b32c37f6f7b50310 |
| is_exposed_menu | Product Category Menu Exposed Status | True |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| seq | Seq | 9 |
| service_group_color_id | Service Group Color | ffff00 |
11.1.1.2 - List Products
11.1.1.2.1 - 1.0
scpcli product product list
[--limit <value>]
[--page <value>]
[--product_category_id <value>]
[--product_id <value>]
[--display_name <value>]
[--display_name_ko <value>]
[--kind <value>]
[--created_start_date <value>]
[--created_end_date <value>]
[--modified_start_date <value>]
[--modified_end_date <value>]
[--sort <value>]
Description
List products.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | LIMIT | 10 |
| page optional | integer | Page | 1 |
| product_category_id optional | array | Product Category ID | N |
| product_id optional | array | Product ID | V |
| display_name optional | array | Product name | V |
| display_name_ko optional | array | Product name | V |
| kind optional | array | Product Kind | P |
| created_start_date optional | string | Created start date | 2024-01-01T00:00:00 |
| created_end_date optional | string | Created end date | 2024-01-01T00:00:00 |
| modified_start_date optional | string | Modified start date | 2024-01-01T00:00:00 |
| modified_end_date optional | string | Modified end date | 2024-01-01T00:00:00 |
| sort optional | string | Sort | created_at:asc |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product name | VPC |
| display_name_ko | Product name | VPC |
| kind | Product Kind | PRODUCT |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| product_category_id | Product Category ID | NETWORKING |
| product_category_name | Product Category Name | Networking |
| product_id | Product ID | VPC |
11.1.1.3 - Show Product
11.1.1.3.1 - 1.0
scpcli product product show
--product_id <value>
Description
Show product.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| product_id required | string | Product ID | VPC |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product name | VPC |
| display_name_ko | Product name | VPC |
| kind | Product Kind | PRODUCT |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| product_category_id | Product Category ID | NETWORKING |
| product_category_name | Product Category Name | Networking |
| product_id | Product ID | VPC |
11.1.1.4 - Show Product category
11.1.1.4.1 - 1.0
scpcli product product category show
--category_id <value>
Description
Show product category.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| category_id required | string | Product Category ID | NETWORKING |
Responses
| Name | Description | Example |
|---|---|---|
| category_id | Product Category ID | NETWORKING |
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product Category Name | Networking |
| display_name_ko | Product Category Name | Networking |
| icon_file_id | Icon File ID | c1d5c1f63bf24f73b32c37f6f7b50310 |
| is_exposed_menu | Product Category Menu Exposed Status | True |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| seq | Seq | 9 |
| service_group_color_id | Service Group Color | ffff00 |
11.2 - STS
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 STS 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
11.2.1 - CLIs
11.2.1.1 - Acquire temporary role credential
11.2.1.1.1 - 1.0
scpcli sts sts assume role
--role_session_name <value>
--role_indicator <value>
[--duration_seconds <value>]
Description
Acquire temporary role credential
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_session_name required | string | Identifier for the assumed role session | - |
| role_indicator required | string | Identifier of the role to assume. [offering:account_id:role_name] | - |
| duration_seconds optional | integer | Duration of seconds of the role session | - |
Responses
| Name | Description | Example |
|---|---|---|
| assumed_role_user | SRN and assumed role ID | |
| credentials | Temporary security credentials |
11.2.1.2 - Acquire temporary role credential from SAML Assertion
11.2.1.2.1 - 1.0
scpcli sts sts assume role with saml
--saml_assertion <value>
--role_indicator <value>
--principal_indicator <value>
[--duration_seconds <value>]
Description
Acquire temporary role credential from SAML Assertion
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_assertion required | string | BASE64 encoded SAML response | - |
| role_indicator required | string | Identifier of the role to assume. [offering:account_id:role_name] | - |
| principal_indicator required | string | Identifier of the SAML provider in IAM. [offering:account_id:provider_name] | - |
| duration_seconds optional | integer | Duration of seconds of the role session | - |
Responses
| Name | Description | Example |
|---|---|---|
| assumed_role_user | SRN and assumed role ID | |
| audience | Value of Recipient attribute of SubjectConfirmationData element of SAML | |
| credentials | Temporary security credentials | |
| issuer | Value of Issuer element of SAML | |
| subject | Value of NameID element in the Subject element of SAML | |
| subject_type | Format of nameID |
11.2.1.3 - Create new Signature based on Session Token
11.2.1.3.1 - 1.0
scpcli sts sts object store authorization
--x_amz_date <value>
--x_amz_content_sha256 <value>
--url <value>
--method <value>
[--region <value>]
[--service <value>]
Description
Create new Signature based on Session Token
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| x_amz_date required | string | Date and time at which the request is signed | - |
| x_amz_content_sha256 required | string | SHA256 hash of the request body | - |
| url required | string | The URL of the request | - |
| method required | string | HTTP method used in the request | - |
| region optional | string | Region where the request is made | - |
| service optional | string | Service to which the request is made | - |
Responses
| Name | Description | Example |
|---|---|---|
| Authorization | Authorization header for object store authentication |
12 - Financial Management
12.1 - BillingPlan
Overview
SCP에서 제공하는 BillingPlan 서비스를 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 BillingPlan 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
12.1.1 - CLIs
12.1.1.1 - Change Request Planned Compute
12.1.1.1.1 - 1.0
scpcli billingplan set planned compute
--planned_compute_id <value>
[--action <value>]
[--contract_type <value>]
[--server_type <value>]
Description
Change action request planned compute.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| planned_compute_id required | string | Planned Compute Id | 5f3688a192094ddeb0c94166a3e88935 |
| action optional | string | Planned Compute change request action type | EXTEND_CHANGE |
| contract_type optional | **** | Contract type is required in the case of EXTEND_APPLY or EXTEND_CHANGE | 01 |
| server_type optional | string | Server Type is required in the case of SERVER_TYPE_CHANGE | s1v1m2 |
12.1.1.2 - Create Request Planned Computes
12.1.1.2.1 - 1.0
scpcli billingplan create planned computes
--contract_type <value>
--os_type <value>
--server_type <value>
--service_id <value>
[--service_name <value>]
[--tag <value>]
Description
Create request planned compute.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| contract_type required | string | Contract Type | 01 |
| os_type required | string | OS Type | OPEN_SOURCE |
| server_type required | string | Server Type | s1v1m2 |
| service_id required | string | Service Id | VIRTUAL_SERVER |
| service_name optional | string | Service Name | Virtual Server |
| tag optional | array | Tag Form | '{"key": "key1", "value": "value1"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Planned Compute Id | 5f3688a192094ddeb0c94166a3e88935 |
| start_date | Start date (YYYY-MM-dd) | 2024-08-01 |
| end_date | End date (YYYY-MM-dd) | 2024-08-01 |
| contract_id | Contract Id | C002612775 |
| account_id | Account Id | 228cb9e4a7934f84853594c7f26f7a21 |
| region | Region | kr-west1 |
| service_id | Service Id | VIRTUAL_SERVER |
| service_name | Service Name | Virtual Server |
| os_type | OS Type | OPEN_SOURCE |
| os_name | OS Name | Open Source |
| server_type | Server Type | s1v1m2 |
| server_type_description | Server Type Description | |
| srn | SRN | srn:e::26affb52e16944038a0cd2cc26060e1c:kr1-west1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m |
| resource_type | Resource Type | instance |
| contract_type | Contract Type | 1-year |
| next_contract_type | Next Contract Type | 1-year |
| first_contract_start_at | Start date (YYYY-MM-dd) | 2024-08-01 |
| next_start_date | Next Start date (YYYY-MM-dd) | 2024-08-01 |
| next_end_date | Next End date (YYYY-MM-dd) | 2024-08-31 |
| state | Planned Compute State | ACTIVE |
| delete_yn | Delete or not | N |
| resource_name | Resource Name | test-vm |
| created_at | Created date | 2024-08-01 00:00:00 |
| created_by | Created by | user123 |
| modified_at | Modified date | 2024-08-01 00:00:00 |
| modified_by | Modified by | kim |
12.1.1.3 - Get Planned Compute
12.1.1.3.1 - 1.0
scpcli billingplan get planned computes
--planned_compute_id <value>
Description
Get planned compute.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| planned_compute_id required | string | Planned Compute Id | 5f3688a192094ddeb0c94166a3e88935 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Planned Compute Id | 5f3688a192094ddeb0c94166a3e88935 |
| start_date | Start date (YYYY-MM-dd) | 2024-08-01 |
| end_date | End date (YYYY-MM-dd) | 2024-08-01 |
| contract_id | Contract Id | C002612775 |
| account_id | Account Id | 228cb9e4a7934f84853594c7f26f7a21 |
| region | Region | kr-west1 |
| service_id | Service Id | VIRTUAL_SERVER |
| service_name | Service Name | Virtual Server |
| os_type | OS Type | OPEN_SOURCE |
| os_name | OS Name | Open Source |
| server_type | Server Type | s1v1m2 |
| server_type_description | Server Type Description | |
| srn | SRN | srn:e::26affb52e16944038a0cd2cc26060e1c:kr1-west1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m |
| resource_type | Resource Type | instance |
| contract_type | Contract Type | 1-year |
| next_contract_type | Next Contract Type | 1-year |
| first_contract_start_at | Start date (YYYY-MM-dd) | 2024-08-01 |
| next_start_date | Next Start date (YYYY-MM-dd) | 2024-08-01 |
| next_end_date | Next End date (YYYY-MM-dd) | 2024-08-31 |
| state | Planned Compute State | ACTIVE |
| delete_yn | Delete or not | N |
| resource_name | Resource Name | test-vm |
| created_at | Created date | 2024-08-01 00:00:00 |
| created_by | Created by | user123 |
| modified_at | Modified date | 2024-08-01 00:00:00 |
| modified_by | Modified by | kim |
12.1.1.4 - GetCancellationFee
12.1.1.4.1 - 1.0
scpcli billingplan get cancellation fee
--planned_compute_id <value>
[--region <value>]
Description
Get Cancellation Fee
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| planned_compute_id required | array | Planned Compute Id | 5 |
| region optional | string | Region | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| code | Currency code | KRW |
| symbol | Currency Symbol | ₩ |
12.1.1.5 - List Contract Type
12.1.1.5.1 - 1.0
scpcli billingplan list planned compute contract types
[--service_id <value>]
[--server_type <value>]
Description
Get Contract Type List.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_id optional | string | Service Id | VIRTUAL_SERVER |
| server_type optional | string | Server Type | s1v1m2 |
Responses
| Name | Description | Example |
|---|---|---|
| code | Contract Code | 01 |
| display_name | Display Name | 1-year |
12.1.1.6 - List OS System
12.1.1.6.1 - 1.0
scpcli billingplan list os types
[--service_id <value>]
Description
Get Os System List.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_id optional | string | Service Id | VIRTUAL_SERVER |
Responses
| Name | Description | Example |
|---|---|---|
| os_type_id | OS Type id | OPEN_SOURCE |
| display_name | Display Name | Open Source |
| os_type_value | Display Name | opensource |
12.1.1.7 - List Planned Compute Covered Resource
12.1.1.7.1 - 1.0
scpcli billingplan list planned compute instances
--end_date <value>
--start_date <value>
--server_type <value>
--os_type <value>
--service_id <value>
Description
Get Planned Compute Covered Resource List.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| end_date required | string | End date (YYYY-MM-dd) | 2024-08-01 |
| start_date required | string | Start date (YYYY-MM-dd) | 2024-08-01 |
| server_type required | string | Server Type | s1v1m2 |
| os_type required | string | OS Type | OPEN_SOURCE |
| service_id required | string | Service Id | VIRTUAL_SERVER |
Responses
| Name | Description | Example |
|---|---|---|
| resource_name | Resource Name | test-vm |
| contract_id | Contract Id | C002612775 |
| used_time | Used time Hour | 10 |
| unit_price | Unit Price | |
| used_amount | Used amount | |
| non_applied_amount | Non Applied Amount | |
| request_at | Request At | 2024-08-01 00:00:00 |
12.1.1.8 - ListServerType
12.1.1.8.1 - 1.0
scpcli billingplan list planned compute server types
[--service_id <value>]
[--current_server_type <value>]
[--os_type <value>]
Description
Get Server Type List
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_id optional | string | Service Id | VIRTUAL_SERVER |
| current_server_type optional | string | Server Type | s1v1m2 |
| os_type optional | string | OS Type | OPEN_SOURCE |
Responses
| Name | Description | Example |
|---|---|---|
| server_type | Server Type | s1v1m2 |
| server_type_description | Server Type Description | |
| instance_type | Instance Type | s1 |
| core | Instance Core | 1 |
| memory_gb | Instance Memory GB | 2 |
| gpu_name | Gpu Model Name | a100 |
| scale_up_yn | Scale up or not. If server_type > current_server_type, it’s represented as Y. if smaller N. | Y |
12.1.1.9 - ListServiceType
12.1.1.9.1 - 1.0
scpcli billingplan list planned compute service types
Description
Get Service Type List
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Responses
| Name | Description | Example |
|---|---|---|
| service_id | Service Id | VIRTUAL_SERVER |
| display_name | Display Name | Virtual Server |
12.2 - Budget
Overview
SCP에서 제공하는 Budget 서비스를 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Budget 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|
12.2.1 - CLIs
12.2.1.1 - CreateAccountBudget
12.2.1.1.1 - 1.0
scpcli budget account budget create
--unit <value>
--start_month <value>
--name <value>
--amount <value>
[--is_use_notification <value>]
[--notification_send_period <value>]
[--receivers <value>]
[--thresholds <value>]
[--is_use_prevention <value>]
[--threshold <value>]
Description
어카운트 예산 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit required | string | Budget management unit (MONTHLY or OVERALL) | MONTHLY |
| start_month required | string | Budget start month (ex.YYYY-MM) | 2026-01 |
| name required | string | Budget name | test_budget |
| amount required | integer | Budget amount | 1000000 |
| is_use_notification optional | boolean | Notification use state | True |
| notification_send_period optional | string | The notification frequency can be FIRST, DAILY, or NONE. | FIRST |
| receivers optional | array | Prevention notification recipient email list. | test_user1@test.com |
| thresholds optional | array | Thresholds for receiving threshold exceed notification email: 70/80/90/100. | 80 |
| is_use_prevention optional | boolean | Auto Generation prevent use state | True |
| threshold optional | integer | Threshold for receiving prevention notification email: 70/80/90/100. | 80 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Budget id | 240200fd2b02490ca63bb3965048b493 |
| amount | Budget amount | 1000000 |
| created_at | Created datetime | 2025-11-01T00:00:00 |
| created_by | Created user | TEST |
| modified_at | Modified datetime | 2025-11-01T00:00:00 |
| modified_by | Modified user | TEST |
| name | Budget name | my_budget_ex |
| start_month | Budget start month (ex.YYYY-MM) | 2025-11 |
| type | Budget type | COST |
| unit | Budget management unit (MONTHLY or OVERALL) | MONTHLY |
12.2.1.2 - DeleteAccountBudget
12.2.1.2.1 - 1.0
scpcli budget account budget delete
--budget_id <value>
Description
어커운트 예산 삭제
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| budget_id required | string | Budget id | 240200fd2b02490ca63bb3965048b493 |
12.2.1.3 - ListAccountBudgets
12.2.1.3.1 - 1.0
scpcli budget account budget list
[--size <value>]
[--page <value>]
[--sort <value>]
[--search_name <value>]
[--budget_name <value>]
Description
어카운트 예산 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| search_name optional | string | Budget name | my_budget_ex |
| budget_name optional | string | Budget name | my_budget_ex |
Responses
| Name | Description | Example |
|---|---|---|
| id | Budget id | 240200fd2b02490ca63bb3965048b493 |
| amount | Budget amount | 1000000 |
| created_at | Created datetime | 2025-11-01T00:00:00 |
| created_by | Created user | TEST |
| modified_at | Modified datetime | 2025-11-01T00:00:00 |
| modified_by | Modified user | TEST |
| name | Budget name | my_budget_ex |
| start_month | Budget start month (ex.YYYY-MM) | 2025-11 |
| type | Budget type | COST |
| unit | Budget management unit (MONTHLY or OVERALL) | MONTHLY |
12.2.1.4 - SetAccountBudget
12.2.1.4.1 - 1.0
scpcli budget account budget set
--budget_id <value>
--unit <value>
--start_month <value>
--name <value>
--amount <value>
[--is_use_notification <value>]
[--notification_send_period <value>]
[--receivers <value>]
[--thresholds <value>]
[--is_use_prevention <value>]
[--threshold <value>]
Description
어카운트 예산 수정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| budget_id required | string | Budget id | 240200fd2b02490ca63bb3965048b493 |
| unit required | string | Budget management unit (MONTHLY or OVERALL) | MONTHLY |
| start_month required | string | Budget start month (ex.YYYY-MM) | 2026-01 |
| name required | string | Budget name | test_budget |
| amount required | integer | Budget amount | 1000000 |
| is_use_notification optional | boolean | Notification use state | True |
| notification_send_period optional | string | The notification frequency can be FIRST, DAILY, or NONE. | FIRST |
| receivers optional | array | Prevention notification recipient email list. | test_user1@test.com |
| thresholds optional | array | Thresholds for receiving threshold exceed notification email: 70/80/90/100. | 80 |
| is_use_prevention optional | boolean | Auto Generation prevent use state | True |
| threshold optional | integer | Threshold for receiving prevention notification email: 70/80/90/100. | 80 |
12.2.1.5 - ShowAccountBudget
12.2.1.5.1 - 1.0
scpcli budget account budget show
--budget_id <value>
Description
어카운트 예산 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| budget_id required | string | Budget id | 240200fd2b02490ca63bb3965048b493 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Budget id | 240200fd2b02490ca63bb3965048b493 |
| amount | Budget amount | 1000000 |
| created_at | Created datetime | 2025-11-01T00:00:00 |
| created_by | Created user | TEST |
| modified_at | Modified datetime | 2025-11-01T00:00:00 |
| modified_by | Modified user | TEST |
| name | Budget name | my_budget_ex |
| start_month | Budget start month (ex.YYYY-MM) | 2025-11 |
| type | Budget type | COST |
| unit | Budget management unit (MONTHLY or OVERALL) | MONTHLY |
12.3 - CostExplorer
Overview
SCP에서 제공하는 CostExplorer 서비스를 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 CostExplorer 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
12.3.1 - CLIs
12.3.1.1 - GetPaymentMonthly
12.3.1.1.1 - 1.0
scpcli costexplorer payment monthly show
[--size <value>]
[--page <value>]
Description
Get payment monthly data.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | Size | 10 |
| page optional | integer | Page | 1 |
Responses
| Name | Description | Example |
|---|---|---|
| payer_account_id | Payer Account Id | 228cb9e4a7934f84853594c7f26f7a21 |
| payer_account_name | Payer Account Name | test-account |
| payer_account_type | Payer Account Type | MEMBER |
| bill_year_month | Bill year Month | 2024-08 |
| used_year_month | Year-Month (YYYY-mm) | 2024-08 |
| payment_date | Payment date | 2024-08-01 |
| bill_currency | Currency | KRW |
| payment_currency | Currency | KRW |
| payment_state | Billing State | PAID |
| bill_amount | ||
| used_amount | ||
| unpaid_amount | ||
| paid_amount | ||
| accumulated_unpaid_amount | ||
| suspended_year_month | Year-Month (YYYY-mm) | 2024-08 |
12.3.1.2 - ListBills
12.3.1.2.1 - 1.0
scpcli costexplorer bill list
[--start_year_month <value>]
[--end_year_month <value>]
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--service_category <value>]
[--billing_item_id <value>]
[--resource_name <value>]
[--region <value>]
[--contract_id <value>]
[--order_status <value>]
[--bill_year_month <value>]
[--bill_state <value>]
Description
Get bill list.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| start_year_month optional | string | Start year-month (YYYY-mm) | 2024-08 |
| end_year_month optional | string | End year-month (YYYY-mm) | 2024-08 |
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | Account Id | 228cb9e4a7934f84853594c7f26f7a21 |
| service_category optional | string | Service Category | COMPUTE |
| billing_item_id optional | string | Billing Item Id | VIRTUAL_SERVER |
| resource_name optional | string | Resource Name | test-vm |
| region optional | string | Region | kr-west1 |
| contract_id optional | string | Contract Id | C002612775 |
| order_status optional | string | CCBS Order Status | 04 |
| bill_year_month optional | string | Bill Date (YYYY-MM) | 2024-07 |
| bill_state optional | string | Billing State | USED |
Responses
| Name | Description | Example |
|---|---|---|
| id | Bill Id | 5f3688a192094ddeb0c94166a3e88935 |
| amounts | Total Amounts | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| discount_amounts | Total Discount Amounts | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| asset | Asset amount | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| operation | Operation amount | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| option | Option amount | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| support_plan | Support Plan | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| cancellation_fee | 해지 수수료 | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| planned_compute | Planned Compute | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| msp_discount | MSP 할인 | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| new_business_discount | 신규 사업 할인 | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| sales_discount | 영업(기타) 할인 | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| sla_discount | SLA | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| reseller_discount | 리셀러 할인 | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| account_cost_savings | Account Cost Savings | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| project_cost_savings | Project Cost Savings | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| account_credit | Account Credit | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| project_credit | Project Credit | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| edp | EDP | {‘krw’: ‘500.000’, ‘usd’: ‘0.000’} |
| account_id | Account Id | 228cb9e4a7934f84853594c7f26f7a21 |
| service_category | Service Category | COMPUTE |
| billing_item_id | Billing Item Id | VIRTUAL_SERVER |
| resource_id | Resource Id | 7f6741f3-d9f0-4262-9a5f-627e373567a7 |
| resource_name | Resource Name | test-vm |
| region | Region | kr-west1 |
| contract_id | Contract Id | C002612775 |
| order_status | CCBS Order Status | 04 |
| bill_year_month | Bill year Month | 2024-07 |
| bill_state | Billing State | USED |
12.3.1.3 - ListUsages
12.3.1.3.1 - 1.0
scpcli costexplorer usages list
[--start_date <value>]
[--end_date <value>]
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--service_category <value>]
[--billing_item_id <value>]
[--resource_name <value>]
[--region <value>]
[--contract_id <value>]
[--order_status <value>]
Description
Get usage list.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| start_date optional | string | Start date (YYYY-MM-dd) | 2024-08-01 |
| end_date optional | string | End date (YYYY-MM-dd) | 2024-08-01 |
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | Account Id | 228cb9e4a7934f84853594c7f26f7a21 |
| service_category optional | string | Service Category | COMPUTE |
| billing_item_id optional | string | Billing Item Id | VIRTUAL_SERVER |
| resource_name optional | string | Resource Name | test-vm |
| region optional | string | Region | kr-west1 |
| contract_id optional | string | Contract Id | C002612775 |
| order_status optional | string | CCBS Order Status | 04 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Usages Id | 5f3688a192094ddeb0c94166a3e88935 |
| account_id | Account Id | 228cb9e4a7934f84853594c7f26f7a21 |
| service_category | Service Category | COMPUTE |
| billing_item_id | Billing Item Id | VIRTUAL_SERVER |
| ccbs_product_code | CCBS Product Code | PD00013862 |
| resource_id | Resource Id | 7f6741f3-d9f0-4262-9a5f-627e373567a7 |
| contract_id | Contract Id | C002612775 |
| order_status | CCBS Order Status | 04 |
| usage_date | Usage date | 2024-08-01T00:00:00 |
| amounts | Amount | {‘krw’: ‘500.0000000000’, ‘usd’: ‘0.0’} |
| status_code | Usage status code | 0 |
13 - DevOps Tools
13.1 - DevOps Service
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 DevOps Service 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
13.1.1 - CLIs
13.1.1.1 - Check Deletable DevOps Service
13.1.1.1.1 - 1.0
scpcli devopsservice devops service check deletable
--devops_service_id <value>
Description
check deletable a specific devops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| devops_service_id required | string | DevOps Service ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| result | DevOps Service 확인 결과 | False |
13.1.1.2 - Check Duplication DevOps Service
13.1.1.2.1 - 1.0
scpcli devopsservice devops service check duplication
[--tenant_code <value>]
[--tenant_name <value>]
Description
check duplication a specific devops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tenant_code optional | string | 테넌트 코드 | test-tenant |
| tenant_name optional | string | 테넌트 명 | test-tenant |
Responses
| Name | Description | Example |
|---|---|---|
| result | DevOps Service 확인 결과 | False |
13.1.1.3 - Create DevOps Service
13.1.1.3.1 - 1.0
scpcli devopsservice devops service create
--tenant_name <value>
--tenant_code <value>
--members <value>
[--tags <value>]
Description
create a devops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tenant_name required | string | 테넌트 명 | - |
| tenant_code required | string | 테넌트 코드 | - |
| members required | array | 테넌트 멤버 | - |
| tags optional | array | 태그 목록 | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 어카운트 ID | |
| console_url | DevOps Service Console URL | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| status | DevOps Service 상태 | |
| tenant_code | 테넌트 코드 | |
| tenant_name | 테넌트 명 |
13.1.1.4 - Delete DevOps Service
13.1.1.4.1 - 1.0
scpcli devopsservice devops service delete
--devops_service_id <value>
Description
delete a specific devops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| devops_service_id required | string | DevOps Service ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
13.1.1.5 - List DevOps Services
13.1.1.5.1 - 1.0
scpcli devopsservice devops service list
Description
get devops service list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 어카운트 ID | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| status | DevOps Service 상태 | |
| tenant_code | 테넌트 코드 | |
| tenant_name | 테넌트 명 |
13.1.1.6 - Show DevOps Service
13.1.1.6.1 - 1.0
scpcli devopsservice devops service show
--devops_service_id <value>
Description
show a specific devops service
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| devops_service_id required | string | DevOps Service ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | 어카운트 ID | |
| console_url | DevOps Service Console URL | |
| created_at | 생성 시간 | 2024-05-17T00:23:17Z |
| created_by | 생성자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | 수정 시간 | 2024-05-17T00:23:17Z |
| modified_by | 수정자 | 90dddfc2b1e04edba54ba2b41539a9ac |
| status | DevOps Service 상태 | |
| tenant_code | 테넌트 코드 | |
| tenant_name | 테넌트 명 |
14 - AI-ML
14.1 - AI&MLOps Platform
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 AI&MLOps Platform 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|
14.1.1 - CLIs
14.1.1.1 - Check Cluster Version
14.1.1.1.1 - 1.0
scpcli aimlops-platform check cluster version
--cluster_id <value>
--cluster_version <value>
Description
Check AI&MLOps Platform Cluster Version.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| cluster_version required | string | Version | 1.28.1 |
Responses
| Name | Description | Example |
|---|---|---|
| result | Result |
14.1.1.2 - Check Duplication AI&MLOps Platform Name
14.1.1.2.1 - 1.0
scpcli aimlops-platform check duplication
--release_name <value>
Description
Check Duplication AI&MLOps Platform Name. (false: no duplicate value, true: duplicate value)
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| release_name required | string | Release Name | aiml-test |
Responses
| Name | Description | Example |
|---|---|---|
| result | Result |
14.1.1.3 - Create AI&MLOps Platform
14.1.1.3.1 - 1.0
scpcli aimlops-platform create aiml platform
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--keypair_name <value>
--image_os_version <value>
--image_os <value>
--vpc_id <value>
--volume_id <value>
--subnet_id <value>
--security_group_id_list <value>
--kubernetes_engine_name <value>
--k8s_version <value>
--release_name <value>
--image_id <value>
--ai_ml_ops_platform_type <value>
[--ai_ml_ops_platform_endpoint_type <value>]
[--cluster_id <value>]
[--initial_user_email <value>]
[--initial_user_password <value>]
[--storage_class_name <value>]
[--tags <value>]
[--cifs_volume_id <value>]
[--cloud_logging_enabled <value>]
[--lb_id <value>]
[--private_acl_ip_resource <value>]
[--public_acl_ip_address <value>]
[--desired_node_count <value>]
[--is_auto_recovery <value>]
[--is_auto_scale <value>]
[--kubernetes_version <value>]
[--max_node_count <value>]
[--min_node_count <value>]
Description
Create AI&MLOps Platform.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_type_name required | string | Volume Type Name | SSD |
| volume_size required | integer | Volume Size | 104 |
| server_type_id required | string | Server Type ID | s1v16m64 |
| name required | string | Nodepool Name | nodepool-test |
| keypair_name required | string | Keypair Name | keypair |
| image_os_version required | string | Image OS Version | 22.04 |
| image_os required | string | Image OS | ubuntu |
| vpc_id required | string | VPC ID | 10a599e031e749b7b260868f441e862b |
| volume_id required | string | Volume ID | 10a599e031e749b7b260868f441e862b |
| subnet_id required | string | Subnet ID | 10a599e031e749b7b260868f441e862b |
| security_group_id_list required | array | List Of Security Group ID | 10a599e031e749b7b260868f441e862b |
| kubernetes_engine_name required | string | Cluster Name | cluster-test |
| k8s_version required | string | Kubernetes Version | v1.28.1 |
| release_name required | string | Release Name | aiml-test |
| image_id required | string | Image ID | 10a599e031e749b7b260868f441e862b |
| ai_ml_ops_platform_type required | string | Product Type | Enterprise |
| ai_ml_ops_platform_endpoint_type optional | string | Endpoint Type | - |
| cluster_id optional | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| initial_user_email optional | string | Initial User Email | example@gmail.com |
| initial_user_password optional | string | Initial User Password | 147@53A69a |
| storage_class_name optional | string | Storage Class Name | - |
| tags optional | array | Tags | - |
| cifs_volume_id optional | string | Cifs Volume ID | - |
| cloud_logging_enabled optional | boolean | Cloud Logging Enabled | - |
| lb_id optional | string | Load Balancer ID | - |
| private_acl_ip_resource optional | array | Private Acl Ip Resource | - |
| public_acl_ip_address optional | string | Public Acl Ip Address | - |
| desired_node_count optional | integer | Desired Node Count | 2 |
| is_auto_recovery optional | boolean | Is Auto Recovery | False |
| is_auto_scale optional | boolean | Is Auto Scale | False |
| kubernetes_version optional | string | Kubernetes Version | v1.28.1 |
| max_node_count optional | integer | Max Node Count | 3 |
| min_node_count optional | integer | Min Node Count | 2 |
Responses
| Name | Description | Example |
|---|---|---|
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
| request_id | Request ID | 10a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 10a599e031e749b7b260868f441e862b |
14.1.1.4 - Delete AI&MLOps Platform
14.1.1.4.1 - 1.0
scpcli aimlops-platform delete aiml platform
--release_id <value>
[--with_k8s <value>]
Description
Delete AI&MLOps Platform.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| release_id required | string | Release ID | 10a599e031e749b7b260868f441e862b |
| with_k8s optional | boolean | With K8s Engine | - |
14.1.1.5 - Get AI&MLOps Platform details
14.1.1.5.1 - 1.0
scpcli aimlops-platform show aiml platform
--release_id <value>
Description
Get AI&MLOps Platform details.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| release_id required | string | Release ID | 10a599e031e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| ai_ml_ops_platform_domain_service | Domain Service | |
| ai_ml_ops_platform_endpoint_ip_address | Endpoint Ip Address | |
| ai_ml_ops_platform_endpoint_port | Endpoint Port | |
| ai_ml_ops_platform_endpoint_type | Endpoint Type | |
| ai_ml_ops_platform_type | Product Type | Enterprise |
| cluster_id | Cluster ID | 10a599e031e749b7b260868f441e862b |
| cluster_name | Cluster Name | cluster-test |
| cluster_state | Cluster State | RUNNING |
| created_by | Created By | 10a599e031e749b7b260868f441e862b |
| created_dt | Created Datetime | 2024-05-17T00:23:17Z |
| dashboard_state | Dashboard State | |
| image_id | Image ID | 10a599e031e749b7b260868f441e862b |
| image_name | Image Name | |
| initial_user_email | Initial User Email | |
| modified_by | Modified By | 10a599e031e749b7b260868f441e862b |
| modified_dt | Modified Datetime | 2024-05-17T00:23:17Z |
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
| project_name | Project Name | |
| release_id | Release ID | 10a599e031e749b7b260868f441e862b |
| release_name | Release Name | aiml-test |
| release_state | Service State | DEPLOYED |
| storage_class_name | Storage Class Name | |
| version | Product Version | v1.7.1 |
14.1.1.6 - List AI&MLOps Platform
14.1.1.6.1 - 1.0
scpcli aimlops-platform list aiml platform
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--release_name <value>]
[--cluster_name <value>]
[--aimlopsplatform_version <value>]
[--kubeflow_type <value>]
[--status <value>]
Description
Get List of AI&MLOps Platform.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | Size | 20 |
| page optional | integer | Page | 0 |
| sort optional | string | Sort | created_dt:asc |
| created_by optional | string | Created By | 10a599e031e749b7b260868f441e862b |
| release_name optional | string | Release Name | aiml-test |
| cluster_name optional | string | Cluster Name | cluster-test |
| aimlopsplatform_version optional | string | Version | v1.7.1 |
| kubeflow_type optional | string | Kubeflow Type | Mini |
| status optional | string | Service State | DEPLOYED |
Responses
| Name | Description | Example |
|---|---|---|
| cluster_id | Cluster ID | 10a599e031e749b7b260868f441e862b |
| cluster_name | Cluster Name | cluster-test |
| created_by | Created By | 10a599e031e749b7b260868f441e862b |
| created_dt | Created Datetime | 2024-05-17T00:23:17Z |
| kubeflow_type | Product Type | Enterprise |
| modified_by | Modified By | 10a599e031e749b7b260868f441e862b |
| modified_dt | Modified Datetime | 2024-05-17T00:23:17Z |
| release_id | Release ID | 10a599e031e749b7b260868f441e862b |
| release_name | Release Name | aiml-test |
| status | Service State | DEPLOYED |
| version | Product Version | v1.7.1 |
14.1.1.7 - List Images
14.1.1.7.1 - 1.0
scpcli aimlops-platform list image
[--size <value>]
[--page <value>]
[--sort <value>]
[--image_name <value>]
Description
Get List of AI&MLOps Platform Images.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | Size | 20 |
| page optional | integer | Page | 0 |
| sort optional | string | Sort | created_dt:asc |
| image_name optional | string | Image Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| base_image | Base Image | |
| category | Category | |
| created_by | Created By | 10a599e031e749b7b260868f441e862b |
| created_dt | Created Datetime | 2024-05-17T00:23:17Z |
| description | Description | |
| icon_file | Icon File | |
| icon_file_name | Icon File Name | |
| image_attr | Image Attribute | |
| image_id | Image ID | |
| image_name | Image Name | |
| modified_by | Modified By | 10a599e031e749b7b260868f441e862b |
| modified_dt | Modified Datetime | 2024-05-17T00:23:17Z |
| os_type | OS Type | |
| product_type | Product Type | Enterprise |
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
14.1.1.8 - List Nodes
14.1.1.8.1 - 1.0
scpcli aimlops-platform list node
--cluster_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
Get List of AI&MLOps Platform Nodes.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| size optional | integer | Size | 20 |
| page optional | integer | Page | 0 |
| sort optional | string | Sort | created_dt:asc |
Responses
| Name | Description | Example |
|---|---|---|
| age | age | |
| cluster_id | cluster_id | |
| container_version | container_version | |
| created_at | created_at | |
| external_ip_address | external_ip_address | |
| gpu_name | gpu_name | |
| ip | ip | |
| kernel_version | kernel_version | |
| kubernetes_version | kubernetes_version | |
| name | name | |
| node_capacities | node_capacities | |
| node_status | node_status | |
| number_of_allocated_pods | number_of_allocated_pods | |
| number_of_gpu | number_of_gpu | |
| os_image | os_image | |
| uid | uid |
14.1.1.9 - List StorageClasses
14.1.1.9.1 - 1.0
scpcli aimlops-platform list storageclasse
--cluster_id <value>
Description
Get List of AI&MLOps Platform StorageClasses.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| age | age | |
| allow_volume_expansion | allow_volume_expansion | |
| cluster_id | cluster_id | |
| created_at | created_at | |
| default_class | default_class | |
| name | name | |
| provisioner | provisioner | |
| pv_reclaim_policy | pv_reclaim_policy | |
| uid | uid | |
| volume_binding_mode | volume_binding_mode |
14.1.1.10 - Update AI&MLOps Platform
14.1.1.10.1 - 1.0
scpcli aimlops-platform set aiml platform
--release_id <value>
[--ai_ml_ops_platform_endpoint_type <value>]
[--dns_id <value>]
[--domain_service_name <value>]
[--ip <value>]
[--operation_type <value>]
[--record_id <value>]
[--record_name <value>]
Description
Update AI&MLOps Platform.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| release_id required | string | Release ID | 10a599e031e749b7b260868f441e862b |
| ai_ml_ops_platform_endpoint_type optional | string | Endpoint Type | ```Public |
| dns_id optional | string | DNS ID | acdd205d-b1d3-44e7-ab7a-429ca090e941 |
| domain_service_name optional | string | Domain Service Name | sample.aimlopsplatform.com |
| ip optional | string | IP | 192.168.3.197 |
| operation_type optional | string | Operation Type | ```CREATE |
| record_id optional | string | Record ID | 8af744b9-4893-4f98-881d-4df984de7162 |
| record_name optional | string | Record Name | sample |
14.1.1.11 - Validate Cluster Namespace
14.1.1.11.1 - 1.0
scpcli aimlops-platform validate namespace
--cluster_id <value>
Description
Validate instability for AI&MLOps Platform. (whether already installed or not)
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
Responses
| Name | Description | Example |
|---|---|---|
| result | Result |
14.1.1.12 - Validate Cluster Resource Size
14.1.1.12.1 - 1.0
scpcli aimlops-platform validate cluster resource
--cluster_id <value>
--product_type <value>
Description
Validate whether Cluster Resource size is large enough or not for AI&MLOps Platform.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| product_type required | string | Product Type | Enterprise |
Responses
| Name | Description | Example |
|---|---|---|
| result | Result |
14.2 - Cloud ML
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Cloud ML 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|
14.2.1 - CLIs
14.2.1.1 - CheckDuplicationNameAndDomainName
14.2.1.1.1 - 1.0
scpcli cloud-ml check duplication name and domain name
[--name <value>]
[--domain_name <value>]
[--accept <value>]
[--content_type <value>]
Description
check duplication name and domain name(Please use either the ’name’ or ‘domain_name’ query parameter.)
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | name | - |
| domain_name optional | string | Domain Name | - |
| accept optional | string | Accept | - |
| content_type optional | string | Content-Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| result | Result |
14.2.1.2 - CloudMLClusterCheckEstimate
14.2.1.2.1 - 1.0
scpcli cloud-ml cloud ml cluster estimate
--cluster_id <value>
[--use_copilot <value>]
[--accept <value>]
[--content_type <value>]
Description
cloud ml cluster estimate
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| use_copilot optional | boolean | Use Copilot | - |
| accept optional | string | Accept | - |
| content_type optional | string | Content-Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| analytics | Analytics Estimate | |
| application | Application Estimate | |
| copilot | Copilot Estimate |
14.2.1.3 - CloudMLImages
14.2.1.3.1 - 1.0
scpcli cloud-ml cloud ml images
[--accept <value>]
[--content_type <value>]
Description
cloud ml images
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| accept optional | string | Accept | - |
| content_type optional | string | Content-Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| copilot_enabled | Copilot Enabled | |
| display_version | Display Version | |
| image_id | Image ID | |
| image_name | Image Name | |
| k8s_version | K8s Version |
14.2.1.4 - ClusterCheckReleasable
14.2.1.4.1 - 1.0
scpcli cloud-ml cluster check releasable
--cluster_id <value>
[--accept <value>]
[--content_type <value>]
Description
cluster check releasable
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| accept optional | string | Accept | - |
| content_type optional | string | Content-Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| default_message | Default Message | |
| detail_message | Detail Message | |
| error_code | Error Code |
14.2.1.5 - ClusterProduct
14.2.1.5.1 - 1.0
scpcli cloud-ml cluster product
--cluster_id <value>
[--accept <value>]
[--content_type <value>]
Description
cluster product
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| accept optional | string | Accept | - |
| content_type optional | string | Content-Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cloud_ml | Cloud ML | |
| cloud_ml_common | Cloud ML Common |
14.2.1.6 - CreateCloudML
14.2.1.6.1 - 1.0
scpcli cloud-ml create cloud ml
--image_id <value>
--endpoint_type <value>
--domain_name <value>
--custom_registry_host <value>
--custom_registry_access_secret_key <value>
--custom_registry_access_key <value>
--cluster_id <value>
--cloud_ml_name <value>
--application_resource <value>
--analytics_resource <value>
[--copilot <value>]
[--custom_registry_access_project_id <value>]
[--custom_registry_access_region <value>]
[--description <value>]
[--product_group_id <value>]
[--tags <value>]
[--use_copilot <value>]
[--accept <value>]
[--content_type <value>]
Description
create cloud ML
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| image_id required | string | Image ID | 10a599e031e749b7b260868f441e862b |
| endpoint_type required | string | Endpoint Type | 147@53A69a |
| domain_name required | string | Domain Name | 147@53A69a |
| custom_registry_host required | string | Custom Registry Host | 10a599e031e749b7b260868f441e862b |
| custom_registry_access_secret_key required | string | Custom Registry Access Secret Key | 10a599e031e749b7b260868f441e862b |
| custom_registry_access_key required | string | Custom Registry Access Key | 10a599e031e749b7b260868f441e862b |
| cluster_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| cloud_ml_name required | string | Cloud ML Name | aiml-test |
| application_resource required | object | Application Resource | {'cpu': 0, 'memory': 0} |
| analytics_resource required | object | Analytics Resource | {'cpu': 0, 'gpu': '', 'memory': 0} |
| copilot optional | object | Copilot | {'cpu': 0, 'gpu': '', 'memory': 0} |
| custom_registry_access_project_id optional | string | Custom Registry Access Project ID | 10a599e031e749b7b260868f441e862b |
| custom_registry_access_region optional | string | Custom Registry Access Region | 10a599e031e749b7b260868f441e862b |
| description optional | string | Description | 147@53A69a |
| product_group_id optional | string | Product Group ID | 10a599e031e749b7b260868f441e862b |
| tags optional | array | Tags | - |
| use_copilot optional | boolean | Use Copilot | True |
| accept optional | string | Accept | - |
| content_type optional | string | Content-Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
| request_id | Request ID | 10a599e031e749b7b260868f441e862b |
| resource_id | Resource ID | 10a599e031e749b7b260868f441e862b |
14.2.1.7 - DeleteCloudML
14.2.1.7.1 - 1.0
scpcli cloud-ml delete cloud ml
--cloud_ml_id <value>
[--accept <value>]
[--content_type <value>]
Description
delete cloud ML
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_ml_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| accept optional | string | Accept | - |
| content_type optional | string | Content-Type | - |
14.2.1.8 - ShowCloudML
14.2.1.8.1 - 1.0
scpcli cloud-ml show cloud ml
--cloud_ml_id <value>
[--accept <value>]
[--content_type <value>]
Description
get cloud ML
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_ml_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| accept optional | string | Accept | - |
| content_type optional | string | Content-Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| cloud_ml_id | Cloud ML Id | 10a599e031e749b7b260868f441e862b |
| cloud_ml_name | Cloud ML Name | aiml-test |
| cloud_ml_state | Cloud ML State | DEPLOYED |
| cluster_id | Cluster ID | 10a599e031e749b7b260868f441e862b |
| cluster_name | Cluster Name | cluster-test |
| cluster_permission | Cluster Permission | {} |
| cluster_request_failed | Cluster Request Fail | False |
| copilot_enabled | Copilot Enable | False |
| created_by | Created By | 10a599e031e749b7b260868f441e862b |
| created_dt | Created Datetime | 2024-05-17T00:23:17Z |
| custom_registry_access_key | Custom Registry Access Key | aiml-test |
| custom_registry_host | Custom Registry Host | aiml-test |
| description | Description | aiml-test |
| display_version | Display Version | 22.04 |
| domain_name | Domain Name | aiml-test |
| endpoint_ip_address | Endpoint Ip Address | aiml-test |
| endpoint_type | Endpoint Type | private |
| image_id | Image ID | 10a599e031e749b7b260868f441e862b |
| image_name | Image Name | aiml-test |
| modified_by | Modified By | 10a599e031e749b7b260868f441e862b |
| modified_dt | Modified Datetime | 2024-05-17T00:23:17Z |
| namespace_name | Namepsace Name | aiml-test |
| product_group_id | Product Group ID | 10a599e031e749b7b260868f441e862b |
| project_id | Project ID | 10a599e031e749b7b260868f441e862b |
| request_id | Request ID | 10a599e031e749b7b260868f441e862b |
| resource_limit_text | Resource Limit Text | aiml-test |
| resource_request_text | Resource Request Text | aiml-test |
| storage_class_name | Storage Class Name | aiml-test |
14.2.1.9 - UpdateCloudML
14.2.1.9.1 - 1.0
scpcli cloud-ml update-cloud-ml
--cloud_ml_id <value>
--description <value>
[--accept <value>]
[--content_type <value>]
Description
update cloud ML
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cloud_ml_id required | string | Cluster ID | 10a599e031e749b7b260868f441e862b |
| description required | string | Description | 147@53A69a |
| accept optional | string | Accept | - |
| content_type optional | string | Content-Type | - |