ncloud_create_snapshot
Create a snapshot from a block storage instance to back up volume data and enable recovery. Use dryRun to preview the operation before applying.
Instructions
Create a snapshot from a block storage instance. The source volume is sent to the API as 'originalBlockStorageInstanceNo' — either parameter name is accepted here. Use dryRun=true to preview.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dryRun | No | If true, returns a preview without actually creating | |
| regionCode | No | Region code (e.g. KR, SGN, JPN). Defaults to the client region | |
| snapshotTypeCode | No | Snapshot type — XEN (Gen2, HDD/SSD volumes) ONLY: FULL (default) or INCREMENTAL. INCREMENTAL requires an existing full snapshot of the same volume and is capped at 7 per full snapshot. KVM (Gen3, CB1/CB2/FB1/FB2 volumes) has no snapshot type: the API accepts this parameter on a KVM volume but SILENTLY IGNORES it and creates a FULL snapshot (verified against the live API), so do not rely on it there — omit it for KVM volumes. | |
| blockStorageInstanceNo | No | Block storage instance number to create snapshot from. Sent to the API as originalBlockStorageInstanceNo. Provide this or originalBlockStorageInstanceNo. | |
| blockStorageSnapshotName | No | Name for the snapshot (3-30 chars: letters, digits, '-', '_'). Auto-generated when omitted | |
| originalBlockStorageInstanceNo | No | Same as blockStorageInstanceNo, spelled with the Ncloud API's own parameter name. Takes precedence when both are given. | |
| blockStorageSnapshotDescription | No | Description for the snapshot (max 1000 bytes) |