需求管理 CODEARTS REQ-构造请求:请求URI

时间:2024-11-19 10:32:39

请求URI

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

请求URI由四部分构成:{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

参数

说明

URI-scheme

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

Endpoint

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

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

resource-path

资源路径,即API访问路径,从具体API的URI模块获取。例如,获取用户Token接口的resource-path为/v3/auth/tokens

query-string

查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个,形式为参数名=参数取值。例如,limit=10表示查询不超过10条数据。

例如,您需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token获取请求认证的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。

https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
图1 URI示意图

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

support.huaweicloud.com/api-projectman/projectman_03_0007.html