vCloudAPI说明书(中文整理版).doc

vCloud API 说明书：这个说明书总结的是在版本1.5的vCloud API下，用户可进行的操作。协议：vCloud API浏览器请求的总结： 浏览器请求提供在只读模式下进入一个云或者浏览器自身包含的对象。1).API-URL形式像：/api。2).id是唯一标识。当你得到表示他们操作的对象时，请求的URLs保证可用。URL表单只供参考用途。表-2：vCloud API浏览器请求的总结操作请求请求主体返回为浏览器的操作检索一个列表的入口点新GET API-URL/Session无200 ok检索你可以进入的一个列表的组织GET API-URL/org/id无OrgList(组织列表)检索一个组织的内容GET API-URL/org/id无Org检索一个网络的属性GET API-URL/network /id无OrgNetwork检索一个目录的内容GET API-URL/catalog/id无Catalog检索一个目录子项的属性GET API-URL/catalogItem/id无CatalogItem检索一个vDC的内容GET API-URL/vdc/id无Vdc检索一个媒体图片的属性GET API-URL/media/id无Media检索一个vAPP的模板GET API-URL/vAppTemplate/vappTemplate-id无VAppTemplate检索一个vAPP的属性GET API-URL/vAPP/vapp-id无VApp检索一个虚拟机的属性GET API-URL/vAPP/vm-id无VmvCloud API Provisioning（预配置）请求总结：预配置请求可为vDC和目录增加一个云应用的模板或者媒体。你也可以利用预配置请求来复制、移动、重命名、删除这些对象。1).API-URL形式像：/api。2).id是唯一标识。当你得到表示他们操作的对象时，请求的URLs保证可用。URL表单只供参考用途。表-3：预配置请求的总结操作请求请求主体返回上传VOF创建一个云应用模板POST API-URL/vdc/id/action/uploadVAppTemplaUploadVAppTemplateParamsVAppTemplate下载一个云应用模板作为VOFGET download-URL无Depends on file type确保一个云应用模板可被下载Post APIURL/vApp Template/vApp Templateid/action/enableDownload无task使一个云应用模板无法被下载POST APIURL/vAppTemplate/vAppTemplateid/action/disableDownload无204 No Content没有内容上传一个媒体图片POST APIURL/vdc/id/mediaMediaMedia复制或者移动一个媒体图片POST APIURL/vdc/id/action/cloneMediaCloneMediaParamsMedia复制或者移动一个云应用模板POST APIURL/vdc/id/action/cloneVAppTemplateCloneVApp TemplateParamsVAppTemplate复制或者移动一个云应用POST APIURL/vdc/id/action/cloneVAppCloneVAppParamsVApp改变一个云应用模板的名字或者描述PUT APIURL/vAppTemplate/vappTemplate-idVAppTemplateTask改变一个云应用的名字或者描述PUT API-URL/vApp/vappidVAppTask改变一个媒体图片的名字或者描述PUT API-URL/media/id MediaTask删除一个云应用模板，或者云应用，或者媒体图片DELETE object-URL 无Task为目录增加一个子项POST APIURL/catalog/id/catalogItemsCatalogItem CatalogItem移除目录的一个子项DELETE API-URL/catalog/id/catalogItem/id无204 No content控制进入目录权限POST APIURL/catalog/id/action/controlAccessControlAccessParams ControlAccessParams检索一个目录对象的拥有者新GET APIURL/media/id/owner无Owner检索一个云应用模板的拥有者新GET APIURL/vAppTemplate/vappTemplate-id/owner无Owner检索一个云应用的拥有者新GET APIURL/vApp/id/owner无Owner更新一个云应用的拥有者新PUT APIURL/vApp/id/ownerOwner204 No Content更新一个目录的拥有者新PUT APIURL/vApp/id/ownerOwner204 No ContentvCloud API 云应用和虚拟机操作请求总结：这些vCloud API操作请求包含了云应用和虚拟机的创建、管理、操作和删除等。1).API-URL形式像：/api。2).id是唯一标识。 3). VApp-or-Vm-URL 形式： API-URL/vApp/vapp-id (对于云应用的对象) or API-URL/vApp/vmid（对于一个Vm对象） 4). Vm-URL 形式： API-URL/vApp/vm-id当你得到表示他们操作的对象时，请求的URLs保证可用。URL表单只供参考用途。表-4 vCloud API 操作请求总结操作请求请求主体返回实例化一个云应用模板POST API-URL/vdc/id/action/instantiateVAppTemplateInstantiateVAppTemplateParamsVApp构建一个云应用POST API-URL/vdc/id/action/composeVAppComposeVAppParamsVApp为增加或移除虚拟机而重建一个云应用POST APIURL/vApp/vapp-id/action/recomposeVAppRecomposeVAppParamsTask部署一个云应用或者虚拟机POST VApp-or-Vm-URL/action/deployDeployVAppParamsTask取消部署云应用或者虚拟机POST VApp-or-Vm-URL/action/undeployUndeployVAppParamsTask开启云应用或者虚拟机POST VApp-or-Vm-URL/action/powerOn无Task关闭云应用或者虚拟机POST VApp-or-Vm-URL/action/powerOff无Task重置一个云应用或者虚拟机POST VApp-or-Vm-URL/action/reset无Task暂停一个云应用或者虚拟机POST VApp-or-Vm-URL/action/suspend无Task遗弃暂停状态的云应用或者虚拟机POST VApp-or-Vm-URL/action/discardSuspendedState无Task关闭一个云应用或者虚拟机POST VApp-or-Vm-URL/action/shutdown无Task重启一个云应用或者虚拟机POST VApp-or-Vm-URL/action/reboot无Task检索在云应用或者虚拟机产品的选择（标签）新GET VApp-or-Vm-URL/productSections无ProductSectionList更新在云应用或则虚拟机产品的选择（标签）新PUT VApp-or-Vm-URL/productSectionsProductSectionListTask检索在云应用模板中产品的选择（标签）新GET APIURL/vAppTemplate/vappTemplate-id/productSections无ProductSectionList更新在云应用模板中产品的选择（标签）新PUT APIURL/vAppTemplate/vappTemplate-id/productSectionsProductSectionListTask在虚拟机中插入媒体POST Vm-URL/action/insertMediaMediaInsertOrEjectParamsTask移除一个虚拟机中的媒体POST Vm-URL/action/ejecttMediaMediaInsertOrEjectParamsTask列出一个虚拟机的媒体设备GET Vm-URL/virtualHardwareSection/media无RasdItemsList等到一个用户输入请求GET Vm-URL/question 无VmPendingQuestion提供被请求的用户输入POST Vm-URL/question/action/answerVmQuestionAnswer204无内容得到一个虚拟机的缩略屏幕图GET Vm-URL/screen 无Returns a screen thumbnail(Content-type: image/png) ifone is available. Otherwisereturns null (Content-Length: 0).得到虚拟机的屏幕图标签POST Vm-URL/screen/action/acquireTicket无ScreenTicket云应用重新配置请求总结 云应用重新配置请求适合可检索的或者可更新的云应用。1).API-URL形式像：/api。2).id是唯一标识。当你得到表示他们操作的对象时，请求的URLs保证可用。URL表单只供参考用途。表-5云应用重新配置请求总结操作请求请求主题返回检索云应用租约配置文件GET API-URL/vApp/vappid/leaseSettingsSection无LeaseSettingsSection更新云应租约配置文件PUT API-URL/vApp/vappid/leaseSettingsSection/LeaseSettingsSectionTask检索云应用启动配置GET API-URL/vApp/vappid/startupSection/无StartupSection更新云应用启动配置PUT API-URL/vApp/vappid/startupSection/StartupSectionTask检索云应用网络配置文件GET API-URL/vApp/vappid/networkConfigSection/无NetworkConfigSection更新云应用网络配置文件PUT API-URL/vApp/vappid/networkConfigSection/NetworkConfigSectionTaskVM 重新配置请求总结VM重新配置请求是对一个可修改的虚拟机进行检索或者更新操作。1).API-URL形式像：/api。2).id是唯一标识。当你得到表示他们操作的对象时，请求的URLs保证可用。URL表单只供参考用途。表-6 虚拟机重新配置请求总结操作请求请求主题返回检索一个虚拟机网络连接配置GET API-URL/vApp/vm-id/networkConnectionSection/NoneNetworkConnectionSection更新一个虚拟机网络连接配置PUT API-URL/vApp/vm-id/networkConnectionSection/NetworkConnectionSectionTask检索一个虚拟机用户定制配置GET API-URL/vApp/vm-id/guestCustomizationSection/NoneGuestCustomizationSection更新一个虚拟机用户定制配置PUT API-URL/vApp/vm-id/guestCustomizationSection/GuestCustomizationSectionTask检索一个虚拟机的操作系统配置GET API-URL/vApp/vm-id/operatingSystemSection/NoneOperatingSystemSection更新一个虚拟机的操作系统配置GET API-URL/vApp/vm-id/operatingSystemSection/NoneOperatingSystemSection检索一个虚拟机的虚拟硬件配置GET API-URL/vApp/vm-id/virtualHardwareSection/NoneVirtualHardwareSection更新一个虚拟机的虚拟硬件配置PUT API-URL/vApp/vm-id/virtualHardwareSection/VirtualHardwareSectionTask检索一个虚拟机的cpu配置GET API-URL/vApp/vm-id/virtualHardwareSection