应用管理与运维平台 SERVICESTAGE-构造请求:请求URI

时间:2024-12-19 11:44:35

请求URI

请求URI由如下部分组成。

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

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

  • URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。
  • Endpoint:指定承载REST服务端点的服务器 域名 或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点处获取。例如 IAM 服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”
  • resource-path:资源路径,也即API访问路径。从具体API的URI模块获取,例如“管理员创建IAM用户”API的resource-path为“/v3.0/OS-USER/users”。
  • query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”。例如“limit=10”,表示查询不超过10条数据。

例如您需要获取创建IAM用户,由于IAM为全局服务。则使用任一区域的Endpoint(比如“华北-北京四”区域的Endpoint:iam.cn-north-4.myhuaweicloud.com),并在管理员创建IAM用户的URI部分找到resource-path(/v3.0/OS-USER/users),拼接起来如下所示。

https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users
图1 URI示意图

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

support.huaweicloud.com/api-servicestage/servicestage_06_0009.html