URL说明

AI-VAULT API符合RESTful API的设计理论。

REST从资源的角度来观察整个网络,分布在各处的资源由URI(Uniform Resource Identifier)确定,而客户端的应用通过URL(Uniform Resource Locator)来获取资源。

  • 可以在URL中加入路径参数,如https://localhost:26335/rest/uam/v1/roles/{parm1}/{parm2},这里parm1、parm2为路径参数。还可以在URL后面用‘?’和‘&’添加不同的查询条件组合,如https://localhost: 26335/rest/uam/v1/roles/{parm1}/{parm2}?parm3=value3&parm4=value4,这里parm3、parm4是查询参数,value3、value4分别是参数对应的值。
  • URL中不能包含URL特殊字符(RFC1738标准),需要使用特殊字符时需要做URL encode。
  • AI-VAULT会自动对url进行重定向,例如:https://ip:port/AIVAULT/v1/version/ 在访问时,不添加末尾‘/’也可正常访问。

请求URI

请求URI由如下部分组成。

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。

为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。