API网关 APIG-构造请求:请求URI

时间:2023-11-01 16:18:59

请求URI

请求URI由如下部分组成。

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

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

表1 URI中的参数说明

参数

描述

URI-scheme

表示用于传输请求的协议,当前所有API均采用HTTPS协议。

Endpoint

指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从终端节点中获取。

例如APIG服务在“华北-北京一”区域的Endpoint为“apig.cn-north-1.myhuaweicloud.com”。

resource-path

资源路径,也即API访问路径。从具体API的URI模块获取,例如“创建API分组”API的resource-path为“/v2/{project_id}/apigw/instances/{instance_id}/api-groups”,project_id为项目ID,instance_id为实例ID(在APIG控制台的“实例信息”中查看)。

query-string

查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询最多10条数据。多个查询参数之间使用“&”隔开。

例如您需要在“华北-北京一”区域创建API分组,将URI中的参数拼接起来即可。

https://apig.cn-north-1.myhuaweicloud.com/v2/{project_id}/apigw/instances/{instance_id}/api-groups

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

support.huaweicloud.com/api-apig/apig-api-180713011.html