iwinv IaaS(Infrastructure as a Service) API
HomeMain PageConsoleDocsError CodeFieldsAPI TEST
HomeMain PageConsoleDocsError CodeFieldsAPI TEST
  1. Instances
  • Introduction
  • API Request
  • API Response
  • Zones
    • Zone List
      GET
  • Flavors
    • Flavor List
      GET
    • Flavor Detail
      GET
  • Images
    • Image List
      GET
    • Image Detail
      GET
  • Instances
    • Instance List
      GET
    • Instance Detail
      GET
    • Create Instance
      POST
    • Edit Instance Info
      PUT
    • Delete Instance
      DELETE
    • Start(ON) Instance
      POST
    • Shutdown(OFF) Instance
      POST
    • Reboot Instance
      POST
    • Rebuild(Image) Instance
      POST
    • Resize(Flavor) Instance
      POST
    • Remote Console
      GET
    • User Script List
      GET
  • Block Storages
    • Block Storage Types
      GET
    • Block Storage List
      GET
    • Block Storage Detail
      GET
    • Create Block Storage
      POST
    • Delete Block Storage
      DELETE
    • Attach Block Storage
      POST
    • Detach Block Storage
      POST
  • Bill
    • Live Bill
    • Billing and Payment List
    • Billing and Payment Detail
  • Authentication
    • SSH Key List
  • Usage Example
    • Zone List
  • Firewall
    • Firewall List
    • Firewall Detail
    • Create Firewall
    • Edit Firewall
    • Delete Firewall
    • Attach Firewall
    • Detach Firewall
  1. Instances

Edit Instance Info

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

Request

Path Params
instance_id
string 
required
Instance ID of instance
Query Params
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:
{{timestamp}}
X-iwinv-Credential
string 
required
Refer to [API Request]
Example:
{{accesskey}}
X-iwinv-Signature
string 
required
Refer to [API Request]
Example:
{{signature}}
Body Params multipart/form-data
name
string 
optional
Instance Name
URL encode the string when requesting
Min Length: 4, Max Length: 32(Allowed Characters: English, Korean, Numbers, Special Characters Below)
Allowed Special Characters: ! @ # $ % ^ & * - _ = + ( ) [ ] { } ; : ‘ “ , . < > / ?
description
string 
optional
Instance Description
Max Length: 50
URL encode the string when requesting

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api-kr.iwinv.kr/v1/instances/?fields=' \
--header 'X-iwinv-Timestamp: {{timestamp}}' \
--header 'X-iwinv-Credential: {{accesskey}}' \
--header 'X-iwinv-Signature: {{signature}}' \
--form 'name=""' \
--form 'description=""'

Responses

🟢200OK
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 
optional
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
ip
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": "iwinv API test",
      "description": "API example instance",
      "status": "active",
      "provide": "dedicated",
      "start_date": "2024-11-18 17:09:35",
      "stop_date": null,
      "default_account": {
        "username": "root",
        "password": "/EVM=97P"
      },
      "ip": [
        {
          "public": {
            "address": "49.247.194.234",
            "attached": true
          },
          "private": {
            "address": "10.100.1.115",
            "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-api.iwinv.kr:6080/vnc_auto.html?path=%3Ftoken%3Dfdd2ca8c-2b89-4930-989f-b41e21a21967",
        "type": "novnc"
      },
      "connection_limit": {
        "block_storage": 3,
        "ip": 3
      },
      "traffic": {
        "default": 1000,
        "period": "DAYMONTH",
        "limit": null,
        "reset_allow_count": null
      }
    }
  ],
  "count": 1
}
Previous
Create Instance
Next
Delete Instance
Built with