客户运营能力-构造请求:请求URI

时间:2024-12-24 10:04:23

请求URI

请求URI由如下部分组成:

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

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

表1 URI中的参数说明

参数

描述

URI-scheme

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

Endpoint

指定承载REST服务端点的服务器 域名 或IP。

客户运营能力API的Endpoint为“bss.myhuaweicloud.com”。

说明:
  • 该Endpoint为全局Endpoint,中国站所有区域均可使用。
  • 支持TLS 1.2。

resource-path

资源路径,也即API访问路径。从具体API的URI模块获取,例如“创建客户”API的resource-path为“/v2/partners/sub-customers”。

query-string

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

例如您需要获取创建客户的请求URI,则需找到创建客户resource-path/v2/partners/sub-customers),拼接起来如下所示。

https://bss.myhuaweicloud.com/v2/partners/sub-customers 

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

support.huaweicloud.com/api-oce/zh-cn_topic_0075200705.html