AI-VAULT API符合RESTful API的设计理论。
REST从资源的角度来观察整个网络,分布在各处的资源由URI(Uniform Resource Identifier)确定,而客户端的应用通过URL(Uniform Resource Locator)来获取资源。
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。
表示用于传输请求的协议,当前所有API均采用HTTPS协议。
指定承载REST服务端点的服务器域名或IP(通常为K8s集群的master节点IP,端口默认为6443),您可以从环境管理员获取。
资源路径,也即API访问路径。例如“获取namespace下的所有Volcano Job”API的resource-path为“/apis/batch.volcano.sh/v1alpha1/namespaces/{namepace}/jobs”,其中{namepace}为任务的命令空间。
查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数值”,例如“limit=10”,表示查询不超过10条数据。
为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。