Instance List - iwinv IaaS(Infrastructure as a Service) API

For more information, put in the fields value from https://api-kr.iwinv.kr/fields/v1/instances

If don't have instances running in API supported zones, it will return an empty array.

Request

Query Params

status

enum<string>

optional

Instance Status

Allowed values:

pendingactiveerrorworkoff

string

optional

IP Address or CIDR

Public or Private IP

To request more than 1, separate with a comma

name

string

optional

Instance Name

Filter Images Containing {name}

zone_id

string

optional

zone_code from [Zone > Zone List]

To request more than 1, separate with a comma

image_id

string

optional

image_id from [Images]

To request more than 1, separate with a comma

type

enum<string>

optional

Instance Type

To request more than 1, separate with a comma

Allowed values:

vmgpusolutionvdi

core_type

enum<string>

optional

Core Type

To request more than 1, separate with a comma

Allowed values:

SINGLEMAXIOSINGLE_X4

min_vcpu

integer

optional

Minimum vCPU

max_vcpu

integer

optional

Maximum vCPU

min_memory

integer

optional

Minimum Memory(Unit: MB)

max_memory

integer

optional

Maximum Memory(Unit: MB)

min_disk

integer

optional

Minimum Disk(Unit: GB)

max_disk

integer

optional

Maximum Disk(Unit: GB)

min_gpu

integer

optional

Minimum Number of GPU

max_gpu

integer

optional

Maximum Number of GPU

page_no

string

optional

Page Number

Default:

page_size

string

optional

Page Size

Default:

fields

integer

optional

Value From https://api-kr.iwinv.kr/fields/v1/instances

Header Params

X-iwinv-Timestamp

integer

required

Refer to [API Request]

Example:

X-iwinv-Credential

string

required

Refer to [API Request]

Example:

X-iwinv-Signature

string

required

Refer to [API Request]

Example:

Body Params multipart/form-data

object {0}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

code

string

required

Status code

error_code

string

required

Error message

message

string

required

Status message

result

array [object {17}]

required

Result

instance_id

string

required

Instance ID

name

string

required

Instance Name

description

null

required

Description

status

string

required

Status

provide

string

required

Providing type

start_date

string

required

Instance create datetime

stop_date

null

required

Instance delete datetime

default_account

object

required

Default account

array [object {3}]

required

IP info

zone

object

required

Zone info

flavor

object

required

Flavor info

image

object

required

Image info

monitoring

object

required

Monitoring info

block_storage

array[string]

required

Block Storage Details

vnc

object

required

VNC info

connection_limit

object

required

Connection Limit

traffic

object

required

Traffic info

count

integer

required

Number of instances returned

page_no

integer

required

Page number

page_size

integer

required

Page size

Example

{
    "code": "0x00",
    "error_code": "SUCCESS",
    "message": "",
    "result": [
        {
            "instance_id": "INSTANCE-z3oB3PugYnKmmyxKyGzr9",
            "name": "API test",
            "description": null,
            "status": "active",
            "provide": "dedicated",
            "start_date": "2024-11-18 17:09:35",
            "stop_date": null,
            "default_account": {
                "username": "root",
                "password": "********"
            },
            "ip": [
                {
                    "public": {
                        "address": "49.247.***.***",
                        "attached": true
                    },
                    "private": {
                        "address": "10.100.***.***",
                        "netmask": "255.255.0.0",
                        "network": "10.100.0.0",
                        "broadcast": "10.100.255.255",
                        "gateway": "10.100.0.1"
                    },
                    "type": "default"
                }
            ],
            "zone": {
                "zone_id": "kr2-z01",
                "name": "KR2-Z01 API Beta"
            },
            "flavor": {
                "flavor_id": "soi_2.8_s",
                "name": "soi_2.8_s",
                "type": "STORAGE",
                "vcpu": 2,
                "memory": 8192,
                "disk": 200,
                "network": 10,
                "gpu": null
            },
            "image": {
                "image_id": "PIMAGE-1Pos3S8VaJXq3wgC8c4BMi",
                "visibility": "public",
                "os": {
                    "type": "OS",
                    "name": "Rocky Linux release 9.0 (Blue Onyx)",
                    "status": "available",
                    "content": [
                        "[NEW]*EOL 2032 05.31",
                        "Kernel : 5.14.0-362.18.1.el9_3.x86_64Used Disk Size : 1.9 G IPTABLE 미적용[ 상세 정보 확인 ]",
                        "[ 주의 사항 ]iproute, dhclient, initscripts 패키지 삭제 금지"
                    ],
                    "os_type": "ROCKYLINUX",
                    "version": "9.X",
                    "oid": "0e46f055-b19b-4ae2-bcdb-ca34f79058f4"
                },
                "image_type": "os_linux",
                "zone": [
                    "kr2-z01"
                ]
            },
            "monitoring": {
                "port": "OFF",
                "resource": "OFF"
            },
            "block_storage": [],
            "vnc": {
                "link": "https://*****.iwinv.kr:****/vnc_auto.html?path=********************",
                "type": "novnc"
            },
            "connection_limit": {
                "block_storage": 3,
                "ip": 3
            },
            "traffic": {
                "default": 1000,
                "period": "DAYMONTH",
                "limit": null,
                "reset_allow_count": null
            }
        },
        {
            "instance_id": "INSTANCE-55ZTUKmSFQimeAaduObFBV",
            "name": "API test web",
            "description": null,
            "status": "active",
            "provide": "dedicated",
            "start_date": "2024-11-18 17:12:20",
            "stop_date": null,
            "default_account": {
                "username": "root",
                "password": "********"
            },
            "ip": [
                {
                    "public": {
                        "address": "49.247.***.***",
                        "attached": true
                    },
                    "private": {
                        "address": "10.100.***.***",
                        "netmask": "255.255.0.0",
                        "network": "10.100.0.0",
                        "broadcast": "10.100.255.255",
                        "gateway": "10.100.0.1"
                    },
                    "type": "default"
                }
            ],
            "zone": {
                "zone_id": "kr2-z01",
                "name": "KR2-Z01 API Beta"
            },
            "flavor": {
                "flavor_id": "soi_2.8_s",
                "name": "soi_2.8_s",
                "type": "STORAGE",
                "vcpu": 2,
                "memory": 8192,
                "disk": 200,
                "network": 10,
                "gpu": null
            },
            "image": {
                "image_id": "PIMAGE-1Pos3S8VaJXq3wgC8c4BMi",
                "visibility": "public",
                "os": {
                    "type": "OS",
                    "name": "Rocky Linux release 9.0 (Blue Onyx)",
                    "status": "available",
                    "content": [
                        "[NEW]*EOL 2032 05.31",
                        "Kernel : 5.14.0-362.18.1.el9_3.x86_64Used Disk Size : 1.9 G IPTABLE 미적용[ 상세 정보 확인 ]",
                        "[ 주의 사항 ]iproute, dhclient, initscripts 패키지 삭제 금지"
                    ],
                    "os_type": "ROCKYLINUX",
                    "version": "9.X",
                    "oid": "0e46f055-b19b-4ae2-bcdb-ca34f79058f4"
                },
                "image_type": "os_linux",
                "zone": [
                    "kr2-z01"
                ]
            },
            "monitoring": {
                "port": "OFF",
                "resource": "OFF"
            },
            "block_storage": [],
            "vnc": {
                "link": "https://*****.iwinv.kr:****/vnc_auto.html?path=********************",
                "type": "novnc"
            },
            "connection_limit": {
                "block_storage": 3,
                "ip": 3
            },
            "traffic": {
                "default": 1000,
                "period": "DAYMONTH",
                "limit": null,
                "reset_allow_count": null
            }
        }
    ],
    "count": 2,
    "page_no": 1,
    "page_size": 10
}