云地图服务 KOOMAP-构造请求:请求URI
请求URI
请求URI由如下部分组成:
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。
参数 |
描述 |
---|---|
URI-scheme |
表示用于传输请求的协议,当前KooMap所有API均采用HTTPS协议。 |
Endpoint |
指定承载REST服务端点的服务器 域名 或IP,不同服务不同区域的Endpoint不同,当前KooMap只在“华北-北京四”部署,Endpoint为“koomap.cn-north-4.myhuaweicloud.com”。 |
resource-path |
资源路径,即API访问路径。从具体API的URI模块获取,例如“创建工作共享空间”API的resource-path为“/v1/workspaces”。 |
query-string |
可选参数,用于查询指定参数数据。设置查询参数时,查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 |
例如您需要获取KooMap在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(koomap.cn-north-4.myhuaweicloud.com),并在创建工作共享空间的URI部分找到resource-path(/v1/workspaces),拼接起来如下所示。
https://koomap.cn-north-4.myhuaweicloud.com/v1/workspaces
图1 URI示意图
为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。