ucloud server API v

Transcription

1 ucloud server API v

2 목 차 1. 개요 UCLOUD SERVER API 개요 API 요청 인증서명서 명령어유형 파라미터 API 응답 API 응답포맷 ASYNCHRONOUS COMMANDS RESPONSE ERROR HANDLING API 사용팁 (QUICK START) VM 생성및접속 DATA DISK VOLUME 추가생성 공인 IP 추가할당 LOAD BALANCER 설정 명령어 VM(VIRTUAL MACHINE) LISTAVAILABLEPRODUCTTYPES (*) DEPLOYVIRTUALMACHINE (A) (*) DESTROYVIRTUALMACHINE (A) REBOOTVIRTUALMACHINE(A) STOPVIRTUALMACHINE (A) STARTVIRTUALMACHINE (A) RESETPASSWORDFORVIRTUALMACHINE (A) LISTVIRTUALMACHINES... 31

3 3.2 VOLUME CREATEVOLUME (A) (*) ATTACHVOLUME (A) DETACHVOLUME (A) DELETEVOLUME (A) LISTVOLUMES ADDRESS ASSOCIATEIPADDRESS (*) DISASSOCIATEIPADDRESS (A) LISTPUBLICIPADDRESSES PORTFOWARDING CREATEPORTFORWARDINGRULE (A) DELETEPORTFORWARDINGRULE (A) LISTPORTFORWARDINGRULES CREATEFIREWALLRULE (A) DELETEFIREWALLRULE (A) LISTFIREWALLRULES LOAD BALANCER CREATELOADBALANCERRULE (A) UPDATELOADBALANCERRULE (A) DELETELOADBALANCERRULE (A) LISTLOADBALANCERRULES ASSIGNTOLOADBALANCERRULE (A) REMOVEFROMLOADBALANCERRULE (A) LISTLOADBALANCERRULEINSTANCES ACCOUNT LISTACCOUNTS ASYNCH JOB QUERYASYNCJOBRESULT EVENT LISTEVENTS SNAPSHOT... 84

4 3.9.1 CREATESNAPSHOT (A) DELETESNAPSHOT (A) LISTSNAPSHOTS TEMPLATE CREATETEMPLATE(A) DELETETEMPLATE(A) UPDATETEMPLATE LISTTEMPLATE... 95

5 Revision History Version 변경사항작성일 1.1 공식배포버전 2012 년 2 월 17 일 Preminum 서비스의 Disk Offering 내용추가 2012 년 2 월 22 일 1.2 Firewall, Snapshot, Template API 추가 deployvirtualmachine API 에 runsysprep 파라미터추가 2012 년 4 월 13 일 1

6 1. 개요 본문서는 ucloud server API 규격을제시한다. API 요청 / 응답메시지와공개하고있는명령어설명및예시를포함하고있다. 본규격은 CloudStack Version 버전과호환성을지원한다. 이용자는 API 를활용하여클라우드컴퓨팅자원생성및관리를수행할수있다 ucloud server API 개요 ucloud server API 는 REST 형태로제공된다. 컴퓨팅자원 (Vurtual Machine[ 이하 VM], Disk 볼륨, Public IP) 등에대한요청은표준 HTTP 방식의 GET 메소드호출을통해서이루어진다 API 요청 API 요청메시지는아래와같이구성된다. (1)API URL + (2) 요청명령어 + (3) 명령어파라미터 + (4) 응답포맷 + (5)API Key + (6) 인증서명서 각필드의값과내용은아래표와같다. Field Description (1) API URL - ucloud server API URL - Value : (2) 요청명령어 - 컴퓨팅자원요청명령어 ( 생성, 삭제, 조회및기타명령 ) - Syntax : command= 명령어이름, [ 상세설명은 3 장참조 ] (3) 명령어파라미터 - 요청명령어관련파라미터 - Syntax : [&field=value]*, [ 상세설명은 3 장참조 ] (4) 응답포맷 - XML, JSON 응답포맷을지원한다. [Optional 필드 ] - Syntax : &response=[xml json], default 는 xml. (5) API Key - 사용자계정별 API Key (ucloudbiz site 에서확인 ) - Syntax : &apikey=apikey (6) 인증서명서 - API 요청메시지수행권한여부를체크하는인증서명서 - Syntax : &signature= 인증서명서 * API Key, Secret Key 확인 (1) 로그인 (2) 클라우드콘솔선택 (3) API Key 관리메뉴선택 2

7 API 요청 Sample &state=Running&response=xml&apiKey=miVr6X&signature=ZC1u%2B03yj592LZ%2BgmA3 ac%2fqthws%3d API 요청 Sample 분석 (1) API URL (2) command=listvirtualmachines 요청명령어 (3) &name=vm_33111&state=running 명령어파라미터 (4) &response=xml 응답포맷 (5) &apikey=mivr6x API Key (6) &signature=zc1u%2b03yj592lz%2bgma3ac%2fqthws%3d 인증서명서 인증서명서 ucloud server 에서는 API Key 와인증서명서로인증을수행한다. 사용자별로발급되는 Secret Key 와 HMAC SHA-1 알고리즘그리고명령문자열 (2 번 ~5 번 ) 을이용하여 인증서명서를생성한다. [ 인증서명서생성 ] Secret Key 예 : keokzhd 명령문자열예 : command=listvirtualmachines&name=vm_33111&state=running &response=xml&apikey=mivr6x (1) 명령문자열의각필드와값을 URL 인코딩한다. URL 인코딩 : 공백문자가 %20 으로인코딩되도록해야한다. [ + 안됨 ] API 요청메시지 : API_URL + URL 인코딩된문자열 + &signature= 인증서명서 (2) 명령문자열을소문자로변경한다. (3) 필드이름을기준으로알파벳순으로정렬한다. apikey=mivr6x&command=listvirtualmachines&name=vm_33111&response=xml&state=ru nning (4) Secret Key 와 HMAC SHA - 1 해시알고리즘을이용하여명령문자열을암호화한다. 아래는 java sample code 이다. 3

8 Mac mac = Mac.getInstance ( "HmacSHA1" ); SecretKeySpec keyspec = new SecretKeySpec(secretkey.getBytes(), "HmacSHA1"); mac.init( keyspec ); mac.update ( commandstring.getbytes() ); byte[] encryptedbytes = mac.dofinal(); Sample_URL oudstack#signing_api_requests (5) 마지막으로얻어진바이트배열을 Base64 인코딩후, 다시 UTF - 8 로 URL 인코딩을 수행한다. 생성된인증서명서와 API 요청메시지는다음과같다. 인증서명서 : ZC1u%2B03yj592LZ%2BgmA3ac%2FQThws%3D API 요청메시지 : chines&name=vm_33111&state=running&response=xml&apikey=mivr6x &signautre=zc1u%2b03yj592lz%2bgma3ac%2fqthws%3d 명령어유형 VM / DISK 볼륨생성과같이실행소요시간이긴명령은비동기명령어로이외의명령은동기명령어로수행한다. 3 장에서기술하고있는비동기명령어에 (A) 를표시하여구분하고있다. CloudStack 에존재하지않는명령어및명령어파라미터설명하는부분에는 (*) 를표시하여기술하고있다 파라미터 API 요청시수행되는파라미터는앞에서언급한것과같이쌍 (field=value) 으로존재하며 대소문자사용규칙은다음과같다. field : 대소문자구별안함, command 만대소문자구별. value : 대소문자구별함. 4

9 1.3 API 응답 지원하고있는응답포맷설명과명령유형 ( 동기명령어, 비동기명령어 ) 에따른 API 응답확인절차를기술한다 API 응답포맷 API 응답포맷으로 xml, json 을지원하며, API 요청시 response=xml 과같이응답포맷을지정할수있다. 명령수행결과에해당필드정보가없을경우, 정의된필드와값이표시되지않을수있다. 다음표는응답포맷예제이다. Response Format xml Sample <listipaddressesresponse> <allocatedipaddress> <ipaddress> </ipaddress> <allocated> t13:16: </allocated> <zoneid>4</zoneid> <zonename>wc</zonename> <issourcenat>true</issourcenat> </allocatedipaddress> </listipaddressesresponse> json { "listipaddressesresponse" : { "allocatedipaddress" : [ { "ipaddress" : " ", "allocated" : " T13:16: ", "zoneid" : "4", "zonename" : "WC", "issourcenat" : "true" } ] } } 5

10 1.3.2 Asynchronous Commands Response VM / DISK 볼륨생성과같이실행소요시간이긴명령은비동기명령어로이외의 명령은동기명령어로수행한다. 동기 / 비동기명령 API 응답확인절차는다르며아래와 같다. API 명령어 응답확인절차 동기명령어 비동기명령어 (1) API 요청으로명령수행 (2) 명령수행결과확인 (1) API 요청으로명령수행 (2) jobid ( 작업 ID) 반홖확인 (3) queryasyncjobresult 명령수행 ( jobid 인자로젂달 ) (4) 명령수행진행확인 ( jobstatus) 0: 진행중, 1: 성공, 2: 실패 [ jobresult 에결과표시 ] ** jobstatus 가 1 또는 2 가될때까지주기적으로 (3), (4) 수행하여명령결과를확인한다. 비동기명령결과예는다음과같다. 비동기명령확인 Sample (1) API 요청 ( 명령수행 ) command=listvirtualmachines &name=vm_33111&state=running&response=xml &apikey=mivr6x &signature=zc1u%2b03yj592lz%2bgma3ac%2fqthws%3d (2) 명령응답반홖 <deployvirtualmachineresponse> <jobid> </ jobid> <id> 100 </ id> </ deployvirtualmachineresponse> (3) queryasyncjobresult 수행 command=queryasyncjobresult&jobid=37120 &apikey=h6kxwcratdqfwf3xa &signature=z5f11yym6yzqomy9b%2f4%3d 6

11 (4) jobstatus = 0 [ 진행중 ] <queryasyncjobresult> <jobid>37120</jobid> <jobstatus>0</jobstatus> <jobprocstatus>1</jobprocstatus> <queryasyncjobresult> (4) jobstatus = 1 [ 성공 ] <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>37120</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <virtualmachine> <id>100</id> <state>running</state>.. </virtualmachine> </jobresult> </queryasyncjobresultresponse> (4) jobstatus = 2 [ 실패 ] <queryasyncjobresult> <jobid>37120</jobid> <jobstatus>2</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>551</jobresultcode> <jobresulttype>text</jobresulttype> <jobresult> Unable to deploy virtual machine id = 10 due to not enough capacity </jobresult> <queryasyncjobresult> 7

12 1.3.3 Error Handling API 요청이잘못되거나처리도중오류가발생하면 Error 정보를응답으로반환한다. Error 정보는오류코드 <errorcode> 와오류텍스트 <errortext> 로구성되어있다. <?xml version="1.0" encoding="utf-8"?> <listvirtualmachinesresponse cloud-stack-version=" "> <errorcode>401</errorcode> <errortext>unable to verify user credentials and/or request signature</errortext> </listvirtualmachinesresponse> 현재지원하는에러코드는다음과같다. Error Code Description 401 AUTHENTICATION_ERROR 406 MALICIOUS_CODE_INJECTION 430 MALFORMED_PARAMETER_ERROR 431 PARAM_ERROR 432 UNSUPPORTED_ACTION_ERROR 433 PAGE_LIMIT_EXCEED 503 EXCESSIVE_TRAFFIC_ERROR 504 INTERNAL_ERROR (TIMEOUT) 530 INTERNAL_ERROR 531 ACCOUNT_ERROR 532 ACCOUNT_RESOURCE_LIMIT_ERROR 533 INSUFFICIENT_CAPACITY_ERROR 534 RESOURCE_UNAVAILABLE_ERROR 535 RESOURCE_ALLOCATION_ERROR 536 RESOURCE_IN_USE_ERROR 537 NETWORK_RULE_CONFLICT_ERROR 8

13 [Example 1] <?xml version="1.0" encoding="iso "?> <deployvirtualmachineresponse cloud-stack-version=" "> <errorcode>431</errorcode> <errortext>unable to find zone by id=2111</errortext> </deployvirtualmachineresponse> [Example 2] <?xml version="1.0" encoding="iso "?> <errorresponse cloud-stack-version=" "> <errorcode>432</errorcode> <errortext>the given command does not exist</errortext> </errorresponse> 9

14 2. API 사용팁 (Quick Start) 이장에서는 ucloud server API 사용하여활용할수있는몇가지팁을기술하였다. 2.1 VM 생성및접속 VM 을생성하여접속하기위해서는다음의과정을수행한다. (1) listavailableproducttypes 명령으로 ucloud server 에서제공하는상품목록조회한다. ( 자세한내용은 참조 ) (2) deployvirtualmachine 명령으로 VM 생성한다. ( 상세내용 : 참조 ) (3) queryasyncjobresult 명령으로 VM 생성완료확인한다 - 응답결과에서 id<vm ID>, password< 패스워드 > 필드확인 (4) listpublicipaddresses 명령으로공인 IP 정보 [id, ip 주소 ] 확인한다. - 응답결과에서 id<publicipaddress ID>, ipaddress<ip 주소 > 정보확인 - ( 상세내용 : 참조 ) (5) createportforwardingrule 로 22 번 (ssh 접속포트 ) 외부오픈 ( 상세내용 : 참조 ) - 공인 IP ID, publicport(22), 생성 VM ID, privateport(22), protocol (TCP) 요청 ( 윈도우 VM 의경우 mstsc 로접속하는 3389 port 를외부오픈 ) (6) queryasyncjobresult 명령으로포트포워딩생성완료확인한다 - 응답결과에서 ipaddress<publicipaddress>, publicport, privateport 필드확인 (7) putty, mstsc 와같은 terminal 을통해생성된 VM 에접속 - 접속 IP : 포트포워딩생성시사용한 IP 주소 - 접속포트 : 포트포워딩생성시사용한 publicport 22 ( 또는 3389) - 접속계정 : root ( 또는 Administrator) - 접속패스워드 : VM 생성완료응답시, password [ (3) 번항목 ] 10

15 2.2 DATA DISK Volume 추가생성 VM 생성시만들어지는기본스토리지 (ROOT Volume, Data Volume) 이외에추가적인 DATA DISK Volume 생성하여 VM 에서사용하기위해서는다음과정을수행한다. (1) createvolume 명령으로추가스토리지를생성한다. ( 상세내용 : 참조 ) (2) queryasyncjobresult 명령으로응답결과완료확인한다. (3) attachvolume 명령으로특정 VM 에생성한스토리지연결한다. - id <Disk Volume ID>, virtualmachineid <VM ID> 요청 - ( 상세내용 : 참조 ) (4) queryasyncjobresult 명령으로응답결과완료확인한다. (5) 추가된스토리지는 VM 에서 fdisk 명령어로확인가능. mount 하여사용 2.3 공인 IP 추가할당상품청약시할당받은기본공인 IP 이외에추가적인 IP 할당필요시다음명령을수행한다. (1) associateipaddress 명령으로공인 IP 할당받는다. ( 상세내용 : 참조 ) (2) queryasyncjobresult 명령으로응답결과완료확인한다. 2.4 Load Balancer 설정 VM 의로드밸런싱을설정을위한절차는다음과같다. (1) listpublicipaddresses 명령수행한다. ( 상세내용 : 참조 ) - LoadBalancer 로사용할 IP 를선택한다. (2) createloadbalancerrule 명령으로 Load Balancer Rule 을생성한다. - ( 상세내용 : 참조 ) (3) queryasyncjobresult 명령으로응답결과완료확인한다. - Load Balancer Rule 정보 (id, name, publicid, publicport,...) 를확인한다 11

16 (4) assigntoloadbalancerrule 명령으로 VM 을로드밸런싱에등록한다. - id<lb ID>, virtualmachineids<vm ID> 요청 - ( 상세내용 : 참조 ) (5) queryasyncjobresult 명령으로응답결과완료확인한다. 12

17 3. 명령어 이장에서는명령어와명령어파라미터정보및명령에대한응답을기술하였다. 기능별로그룹핑하여이해를돕고자하였다. Example 에사용되는 ${API_URL} 변수는 ucloud server API URL ( 이다. 3.1 VM(Virtual Machine) VM 관련명령어를기술한다 listavailableproducttypes (*) ucloud server 상품으로제공되는목록조회시사용하는명령어로사용자는결과목록중하나를선택하여, VM 으로생성가능한 templateid, serviceofferingid, diskofferingid, zoneid 의조합을확인할수있있다. 디스플레이되는 diskofferingid 는 VM 생성시에만사용할수있으며추가적인 Volume 생성과관련한정보는 createvoumle 설명을참조한다. 상품의가격정보는 API 로제공되지않으며 ucloudbiz site 를방문하여확인가능하다. 명령어파라미터 : 없음, 응답결과항목 Response Name Description productid 상품구성 ID [ 예 : ] - zoneid-templateid-serviceofferingid-diskofferingid productstate 상품사용가능여부, [ available stop ] serviceofferingid 제공하는 cpu, memory 조합의 ID serviceoffering 설명 [ 예 premium 2vCore 2G RAM ] serviceofferingdesc - standard, premium 서비스설명 - CPU 와메모리사양표시 templateid 제공하는 OS 에대한관리 ID templatedesc template 설명, [ 예 : WIN2003 KOR ENT SP2 32bit ] diskofferingid 제공하는 disk 에대한 ID [ VM 생성시에만사용가능 ] diskofferingdesc diskoffering 에대한설명, [ 예 : Windows OS(50GB)] zoneid 제공하는 zone ID zonedesc zone ID 에대한설명 13

18 Example Sample Request ${API_URL}command=listAvailableProductTypes&apiKey=90kjkkr_HCg5B&signature=I HenaA0uYC%2Fy5j37FEkUd4fg%3D Sample Response <?xml version="1.0" encoding="utf-8"?> <listavailableproducttypesresponse> <count>272</count> <producttypes> <e> <productid> </productid> <productstate>availabe</productstate> <serviceofferingid>11</serviceofferingid> <serviceofferingdesc>standard 1core 1GB Instance, Virt</serviceofferingdesc> <templateid>309</templateid> <templatedesc>win2003 KOR ENT SP2 32bit</templatedesc> <diskofferingid>19</diskofferingid> <diskofferingdesc>windows OS(50GB)</diskofferingdesc> <zoneid>1</zoneid> <zonedesc>zone1</zonedesc> </e> </listavailableproducttypesresponse> 14

19 3.1.2 deployvirtualmachine (A) (*) VM 을생성및기동수행명령어로, 상품리스트명령 (listavailableproducttypes) 결과를이용하여명령을요청한다. usageplantype( 약정정보파라미터 ) 에따른각상품의가격정보는 ucloudbiz site 에서확인가능하다. 명령어파라미터 Parameter Name Description Required serviceofferingid 서비스제공 ID [ CPU, Memory 조합 : 2 core 1GB Mem ] TRUE templateid 템플릿 ID [ OS : WIN2003 KOR ENT SP2 32bit ] TRUE diskofferingid 디스크제공 ID TRUE zoneid zone ID (** 상품리스트에나오는 zoneid 만가능 ) TRUE oneyear(1 년약정 ), monthly( 무약정-월단위요금 ), usageplantype hourly( 시간요금 ) : (* default : hourly) FALSE runsysprep 사용자 custom 윈도우 OS 이미지사용시 sysprep 연동수행여부. true/false (*default : true) FALSE account 특정 account 에 VM 생성. domainid 파라미터와함께사용 FALSE domainid 특정 domainid 에 VM 생성. account 파라미터와함께사용 FALSE group VM 에대한옵션그룹 FALSE hostid VM 배포하는대상호스트 ID - 루트관리자만사용 FALSE hypervisor VM 배포하는하이퍼바이저 FALSE keypair VM 에로그인하는 SSH 키 FALSE name VM 호스트이름 FALSE displayname VM 표시이름 FALSE ipaddress 기본 VM 네트워크를위한 IP 주소 FALSE iptonetworklist IP 와네트워크간매핑정보. FALSE keyboard VM 키보드유형. [de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be, no, pt,uk,us] 중택 1 가능 FALSE networkids VM 에서사용되는네트워크목록 FALSE securitygroupids VM 에적용될보안그룹의목록. VM 이기본네트워크지원 zone 에서생성될때에만사용됨. securitygroupnames 파라미터와같이사용안함 FALSE securitygroupna mes VM 에적용될보안그룹의목록. VM 이기본네트워크지원 zone 에서생성될때에만사용됨. securitygroupids FALSE 15

20 파라미터와같이사용안함 size userdata DATA DISK 볼륨에대한임의의크기. diskofferingid 가필수파라미터이어현재지원안함. VM 생성후, 자동설정및수행할수있는명령문자열. 최대 2KB 까지 BASE64 인코딩하여사용 FALSE FALSE 응답결과항목 Response Name jobid jobstatus id cpunumber cpuspeed cpuused created displayname account domain domainid forvirtualnetwork group groupid guestosid haenable hostid hostname hypervisor ipaddress isodisplaytext isoid isoname memory name Description 현재보류중인비동기작업 ID 현재보류중인비동기작업상태 VM ID VM CPU 수 VM CPU 의속도현재사용하는 VM 의 CPU 양 VM 생성날짜와시간 VM 표시이름 VM 이속한계정 VM 이속한도메인이름 VM 이속한도메인 ID 서비스제공에대한가상네트워크 VM 그룹이름 VM 그룹 ID VM 운영체제유형 ID 고가용성이홗성화되면 true, 그외 false VM 호스트 ID VM 호스트이름관련하이퍼바이저 VM IP 주소 VM 에부착된 ISO 의대체표시텍스트 VM 에연결된 ISO 의 ID VM 에부착된 ISO 의이름 VM 에할당된메모리 VM 이름 16

21 networkkbsread networkkbswrite password passwordenabled rootdeviceid rootdevicetype serviceofferingid serviceofferingname state templatedisplaytext templateid templatename zoneid zonename nic(*) id broadcasturi gateway ipaddress isdefault isolationuri macaddress netmask networkid traffictype type securitygroup(*) id account description domain domainid name ingressrule(*) account VM 으로들어오는네트워크트래픽 VM 에서나가는네트워크트래픽 VM 암호 VM 암호홗성화정보. 홗성화된경우 true, 그외는 fasle 루트볼륨의장치 ID 루트볼륨의장치유형 VM 서비스제공 ID VM 서비스제공이름 VM 상태 VM 템플릿표시텍스트 VM 템플릿 ID VM 템플릿이름 VM 이속한 zone 의 ID VM 이속한 zone 의이름 VM 과관련네트워크정보목록 NIC ID NIC 의브로드캐스트 URI NIC 의게이트웨이 NIC 의 IP 주소 default NIC 이면 true, 그렇지않은경우 fasle NIC 의아이솔레이션 URI NIC MAC 주소 NIC 의넷마스크해당네트워크의 ID NIC 의트래픽유형 NIC 의종류 VM 과관련된보안그룹목록보안그룹의 ID 보안그룹을소유하는계정보안그룹의설명보안그룹의도메인이름보안그룹의도메인 ID 보안그룹의이름보안그룹과관련된진입규칙목록진입규칙을소유하는계정 17

22 cidr endport icmpcode icmptype protocol ruleid securitygroupname startport 진입규칙의기본 IP 주소에대해 CIDR 표기법진입규칙의종료 IP ICMP 메시지응답에대한코드 ICMP 메시지응답종류진입규칙의프로토콜진입규칙의 ID 보안그룹이름진입규칙의시작 IP Example Sample 1 VM 생성 Request ${API_URL}command=deployVirtualMachine&diskofferingid=31&serviceofferingid=73&te mplateid=46&zoneid=3&apikey=h6kxwcratdqfwf3xa&signature=bfytuy4bdocpk%3d Sample 2 VM 생성 Response <?xml version="1.0" encoding="iso "?> <deployvirtualmachineresponse cloud-stack-version=" "> <jobid>37120</jobid> <id>31627</id> </deployvirtualmachineresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=37120&apiKey=h6KXWcRAtdqfwF 3xA&signature=z5F11yym6YZqOmY9b%2F4%3D Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>37120</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> 18

23 <virtualmachine> <id>31669</id> <name>i vm</name> <displayname>i vm</displayname> <account>test_m123456_s1234</account> <domainid>4</domainid> <domain>epc_user</domain> <created> t16:34: </created> <state>running</state> <haenable>true</haenable> <zoneid>3</zoneid> <zonename>test-staging-kr-1</zonename> <templateid>460</templateid> <templatename>t2 CentOS bit</templatename> <templatedisplaytext>t2 CentOS bit</templatedisplaytext> <passwordenabled>true</passwordenabled> <serviceofferingid>73</serviceofferingid> <serviceofferingname>tier2 1core 2GB Instance. Virtual Networking</serviceofferingname> <cpunumber>1</cpunumber> <cpuspeed>2000</cpuspeed> <memory>2048</memory> <guestosid>14</guestosid> <rootdeviceid>0</rootdeviceid> <rootdevicetype>iscsilun</rootdevicetype> <password>py3ysigaq</password> <nic> <id>10737</id> <networkid>625</networkid> <netmask> </netmask> <gateway> </gateway> <ipaddress> </ipaddress> <traffictype>guest</traffictype> <type>virtual</type> <isdefault>true</isdefault> <macaddress>02:00:6c:00:00:00</macaddress> </nic> <hypervisor>xenserver</hypervisor> </virtualmachine> </jobresult> </queryasyncjobresultresponse> 19

24 3.1.3 destroyvirtualmachine (A) 생성한 VM 을삭제한다. 응답결과항목은 VM 생성과동일하다 (**1 년약정과무약정으로 생성된 VM 은생성당일삭제가불가하다 ) 명령어파라미터 Parameter Name Description Required id VM ID TRUE Example Sample 1 VM 삭제 Request ${API_URL}command=destroyVirtualMachine&id=31669&apiKey=hmL3yALU4r &signature=i4ssnfn0pgl3e0%2fikvvm4ikzv%2bc%3d Sample 2 VM 삭제 Response <?xml version="1.0" encoding="iso "?> <destroyvirtualmachineresponse cloud-stack-version=" "> <jobid>37237</jobid> </destroyvirtualmachineresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=37237&apiKey=hmL3yALU4r&sign ature=s3sdc3tdcnrat9drugzl24cyqwa%3d Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>37237</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> 20

25 <jobresult> <virtualmachine> <id>31669</id> <name>i vm</name> <displayname>i vm</displayname> <account>test_m123456_s1234</account> <domainid>4</domainid> <domain>epc_user</domain> <created> t16:34: </created> <state>destroyed</state> <haenable>true</haenable> <zoneid>3</zoneid> <zonename>test-staging-kr-1</zonename> <templateid>460</templateid> <templatename>t2 CentOS bit</templatename> <templatedisplaytext>t2 CentOS bit</templatedisplaytext> <passwordenabled>true</passwordenabled> <serviceofferingid>73</serviceofferingid> <serviceofferingname>tier2 1core 2GB Instance. Virtual Networking</serviceofferingname> <cpunumber>1</cpunumber> <cpuspeed>2000</cpuspeed> <memory>2048</memory> <cpuused>0.09%</cpuused> <networkkbsread>33</networkkbsread> <networkkbswrite>10</networkkbswrite> <guestosid>14</guestosid> <rootdeviceid>0</rootdeviceid> <rootdevicetype>iscsilun</rootdevicetype> <nic> <id>10737</id> <networkid>625</networkid> <netmask> </netmask> <gateway> </gateway> <ipaddress> </ipaddress> <traffictype>guest</traffictype> <type>virtual</type> <isdefault>true</isdefault> <macaddress>02:00:6c:00:00:00</macaddress> </nic> <hypervisor>xenserver</hypervisor> </virtualmachine> 21

26 </jobresult> </queryasyncjobresultresponse> rebootvirtualmachine(a) VM 을재부팅한다. 명령어파라미터 Parameter Name Description Required id VM ID TRUE 응답결과항목 : deployvirtualmachine 과결과동일. Example Sample 1 VM 재부팅 Request ${API_URL}command=rebootVirtualMachine&id=31232&apiKey=hmL3yALU4r&signat ure=nh0djfuwpdzpmlpirwlfbd7nhus%3d Sample 2 VM 재부팅 Response <?xml version="1.0" encoding="iso "?> <rebootvirtualmachineresponse cloud-stack-version=" "> <jobid>37232</jobid> </rebootvirtualmachineresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=37232&apiKey=hmL3yALU4r&sign ature=sx6oodjsbtcznetks8nbvdzmtco%3d Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> 22

27 <jobid>37232</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <virtualmachine> <id>31232</id> <name>i vm</name> <displayname>i vm</displayname> <account>test_m123456_s1234</account> <domainid>4</domainid> <domain>epc_user</domain> <created> t11:19: </created> <state>running</state> <haenable>true</haenable> <zoneid>3</zoneid> <zonename>test-staging-kr-1</zonename> <templateid>460</templateid> <templatename>t2 CentOS bit</templatename> <templatedisplaytext>t2 CentOS bit</templatedisplaytext> <passwordenabled>true</passwordenabled> <serviceofferingid>73</serviceofferingid> <serviceofferingname>tier2 1core 2GB Instance. Virtual Networking</serviceofferingname> <cpunumber>1</cpunumber> <cpuspeed>2000</cpuspeed> <memory>2048</memory> <cpuused>0.09%</cpuused> <networkkbsread> </networkkbsread> <networkkbswrite> </networkkbswrite> <guestosid>14</guestosid> <rootdeviceid>0</rootdeviceid> <rootdevicetype>iscsilun</rootdevicetype> <nic> <id>10240</id> <networkid>625</networkid> <netmask> </netmask> <gateway> </gateway> <ipaddress> </ipaddress> <traffictype>guest</traffictype> <type>virtual</type> 23

28 <isdefault>true</isdefault> <macaddress>02:00:4b:00:00:00</macaddress> </nic> <hypervisor>xenserver</hypervisor> </virtualmachine> </jobresult> </queryasyncjobresultresponse> stopvirtualmachine (A) VM 을중지한다. 명령어파라미터 Parameter Name Description Required id VM ID TRUE forced 강제수행선택사항 FALSE 응답결과항목 : deployvirtualmachine 과결과동일. Example Sample 1 VM 중지 Request ${API_URL}command=stopVirtualMachine&id=31232&apiKey=hmL3yALU4r &signature=grjkrjdqyezmot2o2c01vkcodv4%3d Sample 2 VM 중지 Response <?xml version="1.0" encoding="iso "?> <stopvirtualmachineresponse cloud-stack-version=" "> <jobid>37225</jobid> </stopvirtualmachineresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=37223&apiKey=hmL3yALU4r&sign ature=nnxdowy2s6kqudsqktvovsg4jai%3d 24

29 Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>37225</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <virtualmachine> <id>31232</id> <name>i vm</name> <displayname>i vm</displayname> <account>test_m123456_s1234</account> <domainid>4</domainid> <domain>epc_user</domain> <created> t11:19: </created> <state>stopped</state> <haenable>true</haenable> <zoneid>3</zoneid> <zonename>test-staging-kr-1</zonename> <templateid>460</templateid> <templatename>t2 CentOS bit</templatename> <templatedisplaytext>t2 CentOS bit</templatedisplaytext> <passwordenabled>true</passwordenabled> <serviceofferingid>73</serviceofferingid> <serviceofferingname>tier2 1core 2GB Instance. Virtual Networking</serviceofferingname> <cpunumber>1</cpunumber> <cpuspeed>2000</cpuspeed> <memory>2048</memory> <cpuused>0.09%</cpuused> <networkkbsread> </networkkbsread> <networkkbswrite> </networkkbswrite> <guestosid>14</guestosid> <rootdeviceid>0</rootdeviceid> <rootdevicetype>iscsilun</rootdevicetype> <nic> <id>10240</id> <networkid>625</networkid> <netmask> </netmask> <gateway> </gateway> 25

30 <ipaddress> </ipaddress> <traffictype>guest</traffictype> <type>virtual</type> <isdefault>true</isdefault> <macaddress>02:00:4b:00:00:00</macaddress> </nic> <hypervisor>xenserver</hypervisor> </virtualmachine> </jobresult> </queryasyncjobresultresponse> 26

31 3.1.6 startvirtualmachine (A) VM 을시작한다. 명령어파라미터 Parameter Name Description Required id VM ID TRUE 응답결과항목 : deployvirtualmachine 과결과동일 Example Sample 1 VM 생성 Request ${API_URL}command=startVirtualMachine&id=31232&apiKey=hmL3yALU4r &signature=ubrwtt8h22yi8msjfzunouyyfyw%3d Sample 2 VM 생성 Response <?xml version="1.0" encoding="iso "?> <startvirtualmachineresponse cloud-stack-version=" "> <jobid>37223</jobid> </startvirtualmachineresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=37223&apiKey=hmL3yALU4r&sig nature=nnxdowy2s6kqudsqktvovsg4jai%3d Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>37227</jobid> <jobstatus>1</jobstatus> 27

32 <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <virtualmachine> <id>31232</id> <name>i vm</name> <displayname>i vm</displayname> <account>test_m123456_s1234</account> <domainid>4</domainid> <domain>epc_user</domain> <created> t11:19: </created> <state>running</state> <haenable>true</haenable> <zoneid>3</zoneid> <zonename>test-staging-kr-1</zonename> <templateid>460</templateid> <templatename>t2 CentOS bit</templatename> <templatedisplaytext>t2 CentOS bit</templatedisplaytext> <passwordenabled>true</passwordenabled> <serviceofferingid>73</serviceofferingid> <serviceofferingname>tier2 1core 2GB Instance. Virtual Networking</serviceofferingname> <cpunumber>1</cpunumber> <cpuspeed>2000</cpuspeed> <memory>2048</memory> <cpuused>0.1%</cpuused> <networkkbsread> </networkkbsread> <networkkbswrite> </networkkbswrite> <guestosid>14</guestosid> <rootdeviceid>0</rootdeviceid> <rootdevicetype>iscsilun</rootdevicetype> <nic> <id>10240</id> <networkid>625</networkid> <netmask> </netmask> <gateway> </gateway> <ipaddress> </ipaddress> <traffictype>guest</traffictype> <type>virtual</type> <isdefault>true</isdefault> <macaddress>02:00:4b:00:00:00</macaddress> 28

33 </nic> <hypervisor>xenserver</hypervisor> </virtualmachine> </jobresult> </queryasyncjobresultresponse> resetpasswordforvirtualmachine (A) VM 에대한비밀번호초기화수행한다. 비밀번호초기화시 VM 은 reboot 된다. 명령어파라미터 Parameter Name Description Required id VM ID TRUE 응답결과항목 : deployvirtualmachine 과결과동일. Example Sample 1 패스워드초기화 Request ${API_URL}command=resetPasswordForVirtualMachine&id=31232&apiKey=hmL3yAL U4r&signature=2GOhbGuHKf%2BpMGQnHGZb4M7C9k0%3D Sample 2 패스워드 Response <?xml version="1.0" encoding="iso "?> <resetpasswordforvirtualmachineresponse cloud-stack-version=" "> <jobid>37224</jobid> </resetpasswordforvirtualmachineresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=37224&apiKey=hmL3yALU4r&sign ature=mq5n87ozpyvhxm5mtqa8v06khwi%3d Sample 4 비동기명령상태 Response 29

34 <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>37224</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <virtualmachine> <id>31232</id> <name>i vm</name> <displayname>i vm</displayname> <account>test_m123456_s1234</account> <domainid>4</domainid> <domain>epc_user</domain> <created> t11:19: </created> <state>running</state> <haenable>true</haenable> <zoneid>3</zoneid> <zonename>test-staging-kr-1</zonename> <templateid>460</templateid> <templatename>t2 CentOS bit</templatename> <templatedisplaytext>t2 CentOS bit</templatedisplaytext> <passwordenabled>true</passwordenabled> <serviceofferingid>73</serviceofferingid> <serviceofferingname>tier2 1core 2GB Instance. Virtual Networking</serviceofferingname> <cpunumber>1</cpunumber> <cpuspeed>2000</cpuspeed> <memory>2048</memory> <cpuused>0.08%</cpuused> <networkkbsread>24</networkkbsread> <networkkbswrite>14</networkkbswrite> <guestosid>14</guestosid> <rootdeviceid>0</rootdeviceid> <rootdevicetype>iscsilun</rootdevicetype> <password>ht9spvutx</password> <nic> <id>10240</id> <networkid>625</networkid> <netmask> </netmask> <gateway> </gateway> 30

35 <ipaddress> </ipaddress> <traffictype>guest</traffictype> <type>virtual</type> <isdefault>true</isdefault> <macaddress>02:00:4b:00:00:00</macaddress> </nic> <hypervisor>xenserver</hypervisor> </virtualmachine> </jobresult> </queryasyncjobresultresponse></jobresult> </queryasyncjobresultresponse> listvirtualmachines 생성한 VM 목록을조회한다. 명령어파라미터 Parameter Name Description Required account 계정이름 FALSE domainid 도메인 ID. FALSE forvirtualnetwork 가상네트워크유형 [ true false] FALSE groupid 그룹 ID FALSE hostid 호스트 ID FALSE hypervisor 관련하이퍼바이저 FALSE id VM ID FALSE isrecursive 도메인 ID 와같이사용됨. true 인경우도메인 ID 에포함된모듞 VM 나열. 디폴트는 false FALSE keyword List by keyword FALSE name VM 이름 FALSE networkid 네트워크 ID FALSE page 페이지번호 FALSE pagesize 페이지크기 FALSE podid POD ID FALSE state VM 상태 FALSE storageid Storage ID FALSE 31

36 zoneid zone ID FALSE 응답결과항목 : deployvirtualmachine 과결과동일. Example Sample Request ${API_URL}command=listVirtualMachines&state=Stopped&apiKey=hmL3yALU4r&sign ature=9v82nnfrhwwto1ohmmgq0%2ffmg38%3d Sample Response <?xml version="1.0" encoding="iso "?> <listvirtualmachinesresponse cloud-stack-version=" "> <count>1</count> <virtualmachine> <id>31626</id> <name>i vm</name> <displayname>i vm</displayname> <account>test_m123456_s1234</account> <domainid>4</domainid> <domain>epc_user</domain> <created> t18:04: </created> <state>stopped</state> <haenable>true</haenable> <zoneid>3</zoneid> <zonename>test-staging-kr-1</zonename> <templateid>460</templateid> <templatename>t2 CentOS bit</templatename> <templatedisplaytext>t2 CentOS bit</templatedisplaytext> <passwordenabled>true</passwordenabled> <serviceofferingid>73</serviceofferingid> <serviceofferingname>tier2 1core 2GB Instance. Virtual Networking</serviceofferingname> <cpunumber>1</cpunumber> <cpuspeed>2000</cpuspeed> <memory>2048</memory> <guestosid>14</guestosid> <rootdeviceid>0</rootdeviceid> 32

37 <rootdevicetype>iscsilun</rootdevicetype> <nic> <id>10648</id> <networkid>625</networkid> <netmask> </netmask> <gateway> </gateway> <ipaddress> </ipaddress> <traffictype>guest</traffictype> <type>virtual</type> <isdefault>true</isdefault> <macaddress>02:00:2c:00:00:00</macaddress> </nic> <hypervisor>xenserver</hypervisor> </virtualmachine> </listvirtualmachinesresponse> 33

38 3.2 Volume DISK Volume 관련명령어를기술한다 createvolume (A) (*) VM 생성시만들어진 Volume 이외에추가적인 Volume 을생성한다. ucloud server 에서제공하는 DISK Volume 을이용하여생성한후, 특정 VM 에 attach 하여사용한다. usageplantype( 약정정보파라미터 ) 에따른각상품의가격정보는 ucloudbiz site 에서확인가능하다. 추가가능한 Volumne 은다음과같으며, createvolume 명령호출시만사용가능하다. premium 서버와 standard 서버에서사용하는디스크가아래표와같이다르다. 즉, standard 디스크는 premium 서버에 attach 불가하며, premium 디스크도 standard 서버에 attach 불가하다. 용량 standard diskofferingid preminum 50 GB GB GB GB GB GB 명령어파라미터 Parameter Name Description Required name DISK Volume 이름 TRUE diskofferingid DISK Volume 제공 ID TRUE zoneid zone ID (** 상품리스트에나오는 zoneid 만가능 ) TRUE 34

39 usageplantype account domainid monthly( 무약정-월단위요금 ), hourly( 시간요금 ) : (* default : hourly) 특정 account 에 DISK Volume 생성. domainid 파라미터와함께사용특정 domainid 에 DISK Volume 생성. account 파라미터와함께사용 FALSE FALSE FALSE size 임의의볼륨크기 FALSE snapshotid DISK Volume 에대한스냅샷 ID. FALSE 응답결과항목 Response Name jobid jobstatus Description 현재보류중인비동기작업 ID 현재보류중인비동기작업상태 id DISK Volume ID account DISK Volume 관련계정 attached DISK Volume 에 VM 에연결된시간 created DISK Volume 이만들어진시간 destroyed 논리볼륨을파괴여부상태여부 deviceid VM 에연결된 DISK Volume 의장치 ID diskofferingdisplaytext 디스크제공의표시텍스트 diskofferingid 디스크의 ID 제공 diskofferingname 디스크제공의이름 domain DISK Volume 이속해있는도메인 domainid DISK Volume 이속해있는도메인의 ID hypervisor DISK Volume 이속한하이퍼바이저 isextractable DISK Volume 이추출여부표시 [ true false ] name DISK Volume 이름 serviceofferingdisplaytext 루트디스크에대한서비스제공의표시텍스트 serviceofferingid 루트디스크에대한서비스제공의 ID serviceofferingname 루트디스크에대한서비스제공의이름 size DISK Volume 크기 35

40 snapshotid state storage storagetype type virtualmachineid vmdisplayname vmname vmstate zoneid zonename DISK Volume 이만들어진에서스냅샷 ID DISK Volume 상태 DISK Volume 을호스팅하는주저장장치의이름공유또는로컬저장소 DISK Volume 종류 ( 루트또는 DATADISK) VM 의 ID VM 의표시이름 VM 의이름 VM 의상태 zone ID zone 이름 Example Sample 1 Request ${API_URL} command=createvolume&zoneid=2&name=sotest002&account=test_m123456_s1234& diskofferingid=24&domainid=2&apikey=hml3yalu4r&signature=0%2fgjchafxlwaho Sq%2B1UNla%2BfQI4%3D Sample 2 Response <?xml version="1.0" encoding="utf-8"?> <createvolumeresponse cloud-stack-version=" "> <id>34332</id> <jobid>124787</jobid> </createvolumeresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=124787&apiKey=hmL3yALU4r&sig nature=%2bpy3poro6dp14dkjnfhdynd%2blh4%3d Sample 4 비동기명령상태 Response 36

41 <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>124787</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <volume> <id>34332</id> <name>sotest002</name> <zoneid>2</zoneid> <zonename>kr-1</zonename> <type>datadisk</type> <size> </size> <created> t17:47: </created> <state>allocated</state> <account>test_m123456_s1234</account> <domainid>2</domainid> <domain>epc_user</domain> <storagetype>shared</storagetype> <hypervisor>none</hypervisor> <diskofferingid>24</diskofferingid> <diskofferingname>windows-root-50</diskofferingname> <diskofferingdisplaytext>windows%20os%20%2850gb%29</diskofferingdisplaytext> <storage>none</storage> <destroyed>false</destroyed> <isextractable>false</isextractable> </volume> </jobresult> </queryasyncjobresultresponse> 37

42 3.2.2 attachvolume (A) 생성한 DISK Volume 을 VM 에연결한다. 생성한 DISK 가 premium 인경우에는 preminum 서버 (VM) 에 standard 인경우에는 standard server(vm) 에연결해야한다. 다른유형의서버에 DISK Volume 연결이불가하다. 명령어파라미터 Parameter Name Description Required id DISK Volume ID TRUE virtualmachineid VM ID TRUE DISK Volume 에매핑될 deviceid. deviceid 파라미터미사용시 순차적으로사용가능한다음 deviceid 가선택됨. [OS 가 deviceid 리눅스인경우 ] 1 : / dev /xvdb, 2 : / dev / xvdc, 4 : / dev / xvde, 5 : / dev/ xvdf *, 6 : / dev / xvdg, 7 : / dev /xvdh, 8 : / dev / xvdi, 9: / dev / xvdj FALSE 응답결과항목 : createvolume 과결과동일. Example Sample 1 Request ${API_URL}command=attachVolume&id=34332&virtualmachineid=18658&apiKey=hmL 3yALU4r&signature=KeLsxqPu7u6UevgQtjTZ0GBdmPA%3D Sample 2 Response <?xml version="1.0" encoding="iso "?> <attachvolumeresponse cloud-stack-version=" "> <jobid>124788</jobid> </attachvolumeresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=124788&apiKey=hmL3yALU4r&sig 38

43 nature=nsm0grzcdnplq6ngdigzrlov4h8%3d Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>124788</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <volume> <id>34332</id> <name>sotest002</name> <zoneid>2</zoneid> <zonename>kr-1</zonename> <type>datadisk</type> <deviceid>2</deviceid> <virtualmachineid>18658</virtualmachineid> <vmname>i vm</vmname> <vmdisplayname>test1212</vmdisplayname> <vmstate>running</vmstate> <size> </size> <created> t17:47: </created> <state>ready</state> <account>test_m123456_s1234</account> <domainid>2</domainid> <domain>epc_user</domain> <storagetype>shared</storagetype> <hypervisor>xenserver</hypervisor> <diskofferingid>24</diskofferingid> <diskofferingname>windows-root-50</diskofferingname> <diskofferingdisplaytext>windows%20os%20%2850gb%29</diskofferingdisplaytext> <storage>p16c2v3</storage> <attached> t17:50: </attached> <destroyed>false</destroyed> <isextractable>false</isextractable> </volume> </jobresult> </queryasyncjobresultresponse> 39

44 3.2.2 detachvolume (A) DISK Volume 을 VM 에서분리한다. (** VM 생성시같이할당된 DISK Volume 의분리는 불가하다 ) 명령어파라미터 Parameter Name Description Required deviceid VM 의 device ID FALSE id DISK Volume ID FALSE virtualmachineid VM ID FALSE 응답결과항목 : createvolume 과결과동일. Example Sample 1 Request ${API_URL}command=detachVolume&id=34332&apiKey=hmL3yALU4r&signature=4UJ B%2FaHpwfoD9792lHjx0En0mYs%3D Sample 2 Response <?xml version="1.0" encoding="utf-8"?> <detachvolumeresponse cloud-stack-version=" "> <jobid>124789</jobid> </detachvolumeresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=124789&apiKey=hmL3yALU4r&sig nature=7amdpklrk0ezmcjtyerhrh6bxt8%3d Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> 40

45 <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>124789</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <volume> <id>34332</id> <name>sotest002</name> <zoneid>2</zoneid> <zonename>kr-1</zonename> <type>datadisk</type> <size> </size> <created> t17:47: </created> <state>ready</state> <account>test_m123456_s1234</account> <domainid>2</domainid> <domain>epc_user</domain> <storagetype>shared</storagetype> <hypervisor>xenserver</hypervisor> <diskofferingid>24</diskofferingid> <diskofferingname>windows-root-50</diskofferingname> <diskofferingdisplaytext>windows%20os%20%2850gb%29</diskofferingdisplaytext> <storage>p16c2v3</storage> <destroyed>false</destroyed> <isextractable>false</isextractable> </volume> </jobresult> </queryasyncjobresultresponse deletevolume (A) DISK Volume 을삭제한다. (** 무약정으로생성된 Volume 은생성당일삭제가불가하며, VM 생성시같이할당된 DISK Volume 은삭제불가하다 ) 명령어파라미터 Parameter Name Description Required id DISK Volume ID TRUE 41

46 응답결과항목 Response Name jobid jobstatus displaytext success Description 현재보류중인비동기작업 ID 현재보류중인비동기작업상태성공또는실패와관련된텍스트성공여부 [true false] Example Sample 1 Request ${API_URL}command=deleteVolume&id=34332&apiKey=hmL3yALU4r&signature=q08 MjJUxYnEcl5cQLyZdPes4jNM%3D Sample 2 Response <?xml version="1.0" encoding="utf-8"?> <deletevolumeresponse cloud-stack-version=" "> <success>true</success> </deletevolumeresponse> 42

47 3.2.5 listvolumes 사용자가보유하고있는 DISK Volume 을조회한다. 명령어파라미터 Parameter Name Description Required account 계정이름 FALSE domainid 도메인 ID. FALSE hostid 지정된호스트 ID 에대한 DISK Volume 목록요청 FALSE id DISK Volume ID FALSE isrecursive 도메인 ID 와같이사용됨. true 인경우도메인 ID 에포함된모듞볼륨나열. 디폴트는 false FALSE keyword 키워드 FALSE name DISK Volume 이름 FALSE page 페이지번호 FALSE pagesize 페이지크기 FALSE podid DISK Volume 이속하는포드 ID FALSE type DISK Volume 종류 FALSE virtualmachineid 연결된 VM ID FALSE zoneid zone ID FALSE 응답결과항목 : createvolume 과결과동일. Example Sample 1 Request ${API_URL} command=listvolumes&apikey=hml3yalu4r&signature=n2o%2fbccnb6lpzvumn65x %2BaHYWqs%3D 43

48 Sample 2 Response <?xml version="1.0" encoding="utf-8"?> <listvolumesresponse> <count>1</count> <volume> <e> <account>test_m123456_s1234</account> <created> t14:31: </created> <destroyed>false</destroyed> <deviceid>0</deviceid> <domain>epc_user</domain> <domainid>2</domainid> <hypervisor>xenserver</hypervisor> <id>34276</id> <isextractable>false</isextractable> <name>root-19526</name> <serviceofferingdisplaytext>minimum%201core%202gb%20instance%2c%20virtual%20 Networking</serviceofferingdisplaytext> <serviceofferingid>13</serviceofferingid> <serviceofferingname>minimum%201core%202gb%20instance%2c%20virtual%20netw orking</serviceofferingname> <size> </size> <state>ready</state> <storage>p16c2v2</storage> <storagetype>shared</storagetype> <type>root</type> <virtualmachineid>19526</virtualmachineid> <vmdisplayname>i vm</vmdisplayname> <vmname>i vm</vmname> <vmstate>running</vmstate> <zoneid>2</zoneid> <zonename>kr-1</zonename> </e> </volume> </listvolumesresponse> 44

49 3.3 Address 공인 IP 관련명령어를기술한다 associateipaddress (*) 새로운공인 IP 를추가한다. usageplantype( 약정정보파라미터 ) 에따른가격정보는 ucloudbiz site 에서확인가능하다. 명령어파라미터 Parameter Name Description Required zoneid zone ID (* 상품리스트에나오는 zoneid 만가능 ) TRUE usageplantype monthly( 무약정-월단위요금 ), hourly( 시간요금 ) : (* default : hourly) FALSE account 추가된 IP 를할당할계정 FALSE domainid 추가된 IP 를할당할도메인의 ID FALSE networkid 추가된 IP 와연관되는네트워크 ID FALSE 응답결과항목 Response Name Description jobid 현재보류중인비동기작업 ID jobstatus 현재보류중인비동기작업상태 id 공인 IP 주소 ID account 공인 IP 주소와관련된계정 allocated 공인 IP 주소를취득날짜 associatednetworkid 공인 IP 주소와관련된네트워크의 ID domain 공인 IP 주소와관련된도메인 domainid 공인 IP 주소와관련된도메인 ID forvirtualnetwork 공인 IP 주소에대한가상네트워크 ipaddress 공인 IP 주소 issourcenat 소스 NAT 여부 [ true false ] isstaticnat 정적 NAT 여부 [ true false ] 45

50 networkid state virtualmachinedisplay name virtualmachineid virtualmachinename vlanid vlanname zoneid zonename 공인 IP 가속한네트워크의 ID 공인 IP 주소상태공인 IP 가할당된 VM 표시이름공인 IP 가할당된 VM ID 공인 IP 가할당된 VM 이름공인 IP 주소와연관된 VLAN 의 ID 공인 IP 주소와연결된 VLAN 공인 IP 주소에속한 zone ID 공인 IP 주소에속한 zone 이름 Example Sample 1 Request ${API_URL}command=associateIpAddress&zoneid=2&apiKey=hmL3yALU4r&signature= UcL0H%2FSKjc7yeiEHw%2BlmJnWpOzY%3D Sample 2 Response <?xml version="1.0" encoding="utf-8"?> <associateipaddressresponse cloud-stack-version=" "> <id>2912</id> <jobid>124790</jobid> </associateipaddressresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=124790&apiKey=hmL3yALU4r&sig nature=ra7i0kqzikxmoy0vt68wmgrwkxy%3d Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>124790</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> 46

51 <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <ipaddress> <id>2912</id> <ipaddress> </ipaddress> <allocated> t17:59: </allocated> <zoneid>2</zoneid> <zonename>kr-1</zonename> <issourcenat>false</issourcenat> <account>test_m123456_s1234</account> <domainid>2</domainid> <domain>epc_user</domain> <forvirtualnetwork>true</forvirtualnetwork> <isstaticnat>false</isstaticnat> <associatednetworkid>1812</associatednetworkid> <networkid>330</networkid> <state>allocating</state> </ipaddress> </jobresult> </queryasyncjobresultresponse<jobresulttype>object</jobresulttype> <jobresult> <virtualmachine> <id>31232</id> <name>i vm</name> <displayname>i vm</displayname> <account>test_m123456_s1234</account> <domainid>4</domainid> <domain>epc_user</domain> <created> t11:19: </created> <state>running</state> <haenable>true</haenable> <zoneid>3</zoneid> <zonename>test-staging-kr-1</zonename> <templateid>460</templateid> <templatename>t2 CentOS bit</templatename> <templatedisplaytext>t2 CentOS bit</templatedisplaytext> <passwordenabled>true</passwordenabled> <serviceofferingid>73</serviceofferingid> <serviceofferingname>tier2 1core 2GB Instance. Virtual Networking</serviceofferingname> <cpunumber>1</cpunumber> 47

52 <cpuspeed>2000</cpuspeed> <memory>2048</memory> <cpuused>0.09%</cpuused> <networkkbsread> </networkkbsread> <networkkbswrite> </networkkbswrite> <guestosid>14</guestosid> <rootdeviceid>0</rootdeviceid> <rootdevicetype>iscsilun</rootdevicetype> <nic> <id>10240</id> <networkid>625</networkid> <netmask> </netmask> <gateway> </gateway> <ipaddress> </ipaddress> <traffictype>guest</traffictype> <type>virtual</type> <isdefault>true</isdefault> <macaddress>02:00:4b:00:00:00</macaddress> </nic> <hypervisor>xenserver</hypervisor> </virtualmachine> </jobresult> </queryasyncjobresultresponse> disassociateipaddress (A) 사용중인공인 IP 반환한다. ( 반납한다.) 반환이불가하다 ) (** 무약정으로추가된공인 IP 는추가당일 명령어파라미터 Parameter Name Description Required id 공인 IP 의 ID TRUE 응답결과항목 Response Name jobid jobstatus displaytext success Description 현재보류중인비동기작업 ID 현재보류중인비동기작업상태성공또는실패와관련된텍스트성공여부 [true false] 48

53 Example Sample 1 Request ${API_URL}command=disassociateIpAddress&id=2912&apiKey=hmL3yALU4r&signatur e=yjiz6bq80wpxcosijlyhbw%2fc29k%3d Sample 2 Response <?xml version="1.0" encoding="utf-8"?> <disassociateipaddressresponse cloud-stack-version=" "> <jobid>124791</jobid> </disassociateipaddressresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=124791&apiKey=hmL3yALU4r&sig nature=hfsb0bwimcgjhuyohv2gvqmw09y%3d Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>124791</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <success>true</success> </jobresult> </queryasyncjobresultresponse> 49

54 3.3.3 listpublicipaddresses 사용중인공인 IP 를조회한다. 명령어파라미터 Parameter Name Description Required account 계정이름 TRUE allocatedonly 할당된공인 IP 주소로제한검색결과 FALSE domainid 도메인 ID FALSE forvirtualnetwork IP 주소에대한가상네트워크 FALSE id 공인 IP 주소 ID FALSE ipaddress 공인 IP 주소 FALSE keyword 키워드로목록 FALSE page 페이지번호 FALSE pagesize 페이지크기 FALSE vlanid VLAN ID 로모듞공용 IP 주소 FALSE zoneid zone ID FALSE 응답결과항목 : associateipaddress 와결과동일. Example Sample 1 Request ${API_URL}command=listPublicIpAddresses&apiKey=hmL3yALU4r&signature=c6TVga TFxQDYpcEpxONeTaU4PJo%3D Sample 2 Response <?xml version="1.0" encoding="iso "?> <listpublicipaddressesresponse cloud-stack-version=" "> <count>1</count> <publicipaddress> <id>2779</id> 50

55 <ipaddress> </ipaddress> <allocated> t16:05: </allocated> <zoneid>2</zoneid> <zonename>kr-1</zonename> <issourcenat>false</issourcenat> <account>test_m123456_s1234</account> <domainid>2</domainid> <domain>epc_user</domain> <forvirtualnetwork>true</forvirtualnetwork> <isstaticnat>false</isstaticnat> <associatednetworkid>1812</associatednetworkid> <networkid>330</networkid> <state>allocated</state> </publicipaddress> </listpublicipaddressesresponse> 51

56 3.4 PortFowarding 포트포워딩관련명령을기술한다. 사용자가생성한 VM 에접속하거나 VM 에서제공하는서비스를이용하기위해서는공인 IP 의특정포트와 VM 의서비스포트매핑정보를등록하여야한다 createportforwardingrule (A) 포트포워딩규칙을만든다. (** 설정가능한 port : 1~10999, 12501~65535 번 ) 명령어파라미터 Parameter Name Description Required ipaddressid 포트포워딩규칙의공인 IP 주소 ID TRUE privateport 포트포워딩규칙의개인포트범위의시작포트 TRUE protocol 포트 fowarding 규칙에대한프로토콜. [ TCP UDP] TRUE publicport 포트포워딩규칙의공개포트범위의시작포트 TRUE virtualmachineid 포트포워딩규칙을위한 VM ID TRUE cidrlist Firewall 에등록할 source cidrlist ( 미기입시, 모듞 IP 허용정 ) FALSE openfirewall publicport 에자동 Firewall 설정여부 ( * default :true) FALSE privateendport 포트포워딩규칙의개인포트범위의끝포트 FALSE publicendport 포트포워딩규칙의공개포트범위의끝포트 FALSE 응답결과항목 Response Name id cidrlist ipaddress ipaddressid privateendport privateport Description 포트포워딩규칙 ID source cidrlist 포트포워딩규칙에대한공인 IP 주소포트포워딩규칙에대한공개 IP 주소 ID 포트포워딩규칙의개인포트범위의끝포트포트포워딩규칙의개인포트범위의시작포트 52

57 protocol publicendport publicport state virtualmachinedis playname virtualmachineid virtualmachinena me 포트포워딩규칙의프로토콜포트포워딩규칙의공개포트범위의끝포트포트포워딩규칙의공개포트범위의시작포트규칙의상태포트포워딩규칙에대한 VM 의표시이름포트포워딩규칙에대한 VM ID 포트포워딩규칙에대한 VM 의이름 Example Sample 1 Request ${API_URL}command=createPortForwardingRule&ipaddressid=374&publicport=80&virtu almachineid=31686&privateport=80&protocol=tcp&apikey=hml3yalu4r&signature=h smvqmwnvc7gqhn9sb8ovapcuds%3d Sample 2 Response <?xml version="1.0" encoding="iso "?> <createportforwardingruleresponse cloud-stack-version=" "> <jobid>37530</jobid> <id>13749</id> </createportforwardingruleresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=37530&apiKey=hmL3yALU4r&sign ature=kc%2fowxvix7y%2bijosacyuhri%2bqy8%3d Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>37530</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> 53

58 <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <portforwardingrule> <id>13749</id> <privateport>80</privateport> <privateendport>80</privateendport> <protocol>tcp</protocol> <publicport>80</publicport> <publicendport>80</publicendport> <virtualmachineid>31686</virtualmachineid> <virtualmachinename>i vm</virtualmachinename> <virtualmachinedisplayname>i vm</virtualmachinedisplayname> <ipaddressid>374</ipaddressid> <ipaddress> </ipaddress> <state>active</state> <cidrlist> </cidrlist> </portforwardingrule> </jobresult> </queryasyncjobresultresponse> deleteportforwardingrule (A) 포트포워딩규칙을삭제한다. 명령어파라미터 Parameter Name Description Required id 포트포워딩규칙 ID TRUE 응답결과항목 Response Name jobid jobstatus displaytext Description 현재보류중인비동기작업 ID 현재보류중인비동기작업상태성공또는실패와관련된텍스트 54

59 success 성공여부 [true false] Example Sample 1 Request ${API_URL}command=deletePortForwardingRule&id=13749&apiKey=hmL3yALU4r&sig nature=tdujmp410lshyvq6tzwnvwcbgbe%3d Sample 2 Response <?xml version="1.0" encoding="iso "?> <deleteportforwardingruleresponse cloud-stack-version=" "> <jobid>37531</jobid> </deleteportforwardingruleresponse> Sample 3 비동기명령상태 Request ${API_URL}command=queryAsyncJobResult&jobid=37531&apiKey=hmL3yALU4r&sign ature=vbgnxosjnn3e1k6ql7z80gv3g9k%3d Sample 4 비동기명령상태 Response <?xml version="1.0" encoding="iso "?> <queryasyncjobresultresponse cloud-stack-version=" "> <jobid>37531</jobid> <jobstatus>1</jobstatus> <jobprocstatus>0</jobprocstatus> <jobresultcode>0</jobresultcode> <jobresulttype>object</jobresulttype> <jobresult> <success>true</success> </jobresult> </queryasyncjobresultresponse> 55