ZStack Cloud 5.2.0提供原生RESTful支持。您可以通过REST定义的架构设计原则和约束条件,并使用支持HTTP的编程语言进行开发。
方法名 | 描述 |
---|---|
GET | 获取资源信息。
|
POST | 创建一个资源。 |
PUT | 修改一个资源。
|
DELETE | 删除一个资源。 |
URL、Query String、HTTP body三种方式均可用于传参。每种方式可以单独使用,也可以混合使用,具体使用哪种传参方式由具体API决定。
当对某具体资源进行操作时,资源的UUID通过编码到URL的方式进行传参。
zstack/v1/vm-instances/f97143d60f1042c9badd9a1336d3c105/actions
这里UUID编码到URL路径当中。
所有使用HTTP GET方法的API均使用Query String传参。
zstack/v1/vm-instances?q=state=Running
当使用POST方法创建一个资源,或PUT方法修改一个资源时,除通过URL传参的部分外,剩余参数均通过HTTP Body传参。
PUT zstack/v1/vm-instances/f97143d60f1042c9badd9a1336d3c105/actions { "startVmInstance": { "hostUuid": "8aef7e3a53b34eedaa05027a919156d9" } }
这里虚拟机的UUID通过URL传参,参数hostUuid则通过HTTP Body传递。
当前API使用如下自定义HTTP Headers:
Authorization: OAuth 会话UUID
Authorization: OAuth 34cbfddd470a47d8bdb0727cd2182618
X-Job-UUID: d825b1a26f4e474b8c59306081920ff2
如果未指定该HTTP Header,ZStack Cloud会自动为API Job生成一个UUID。
X-Job-UUID必须为一个v4版本的UUID(即随机UUID)字符串去掉连接符-。ZStack Cloud会验证X-Job-UUID格式的合法性,并对非法的字符串返回一个400 Bad Request的错误。
X-Web-Hook: http://localhost:5000/api-callback
X-Web-Hook
回调的方式获取异步API结果时,ZStack Cloud推送给回调URL的HTTP Post请求中会包含X-Job-Success
HTTP Header指明该异步API的执行结果是成功还是失败。例如:X-Job-Success: true
当值为true时执行成功,为false时执行失败。
学习路径
ZStack Cloud 产品学习路径
快速梳理文档,点击相应文本链接,快速跳转到相应文档的页面,学习 ZStack Cloud 产品。
业务咨询:
400-962-2212 转 1售后咨询:
400-962-2212 转 2其他(漏洞提交、投诉举报等)
400-962-2212 转 3业务咨询:
400-962-2212 转 1ZStack学院:
training@zstack.io业务咨询:
400-962-2212 转 1售后咨询:
400-962-2212 转 2其他(漏洞提交、投诉举报等)
400-962-2212 转 3业务咨询:
400-962-2212 转 1售后咨询:
400-962-2212 转 2其他(漏洞提交、投诉举报等)
400-962-2212 转 3业务咨询:
400-962-2212 转 1商务联系:
channel@zstack.io业务咨询:
400-962-2212 转 1商务联系:
channel@zstack.io下载链接已发送至您的邮箱。
如未收到,请查看您的垃圾邮件、订阅邮件、广告邮件。 当您收到电子邮件后,请点击 URL 链接,以完成下载。感谢您使用 ZStack 产品和服务。
成功提交申请。
我们将安排工作人员尽快与您取得联系。感谢您使用 ZStack 产品和服务。
信息提交成功。
我们将安排工作人员尽快与您取得联系,请保持电话畅通。感谢您使用 ZStack 产品和服务。
商务咨询:
400-962-2212 转 1售后咨询:
400-962-2212 转 2商务联系:
sales@zstack.io成功提交申请。
我们将安排工作人员尽快与您取得联系。感谢您使用 ZStack 产品和服务。