• URL路径为相对路径,基础路径 https://api.gocloud.cn/agent 不再重复。
  • URL路径中<…>表示变量。
  • 输入参数是[…],则该参数是可选的。
  • 输出的字段是[…],则该字段不一定存在。

本文的接口虽然覆盖业务各不相同,但统一采用Restful风格,因此具有非常类似的访问方式,以某种资源为例:

增: POST /resources
删: DELETE /resources/<resource-id>
改: POST /resources/<resource-id> 
查(多个): GET /resources
查(单个): GET /resources/<resource-id>

如果存在次级资源,则相应的对URL做级联。例如操作某个resource上的attributes:

增: POST /resources/<resource-id>/attributes
删: DELETE /resources/<resource-id>/attributes/<attribute-id>
改: POST /resources/<resource-id>/attributes/<attribute-id>
查(多个): GET /resources/<resource-id>/attributes
查(单个): GET /resources/<resource-id>/attributes/<attribute-id>

注意:URL中的资源名用复数

文档更新时间: 2019-01-16 17:07   作者:Gocloud