键值存储服务 KVS-构造请求:请求URI

时间:2024-12-09 15:46:54

请求URI

请求URI由如下部分组成(方括号部分可选):

{URI-scheme}://[{store-name}.]{Endpoint}/{resource-path}[?{query-string}]

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

表1 URI中的参数说明

参数

描述

URI-scheme

请求使用的协议类型,如HTTP、HTTPS。HTTPS表示通过安全的HTTPS访问该资源,键值存储服务支持HTTP,HTTPS两种传输协议。

store-name

请求使用的仓名称,是可选部分,并不是每个API都有仓名称。存储仓的命名规范为{用户自定义前缀}-{KVS所在区域的区 域名 }-{用户的账号ID} ,例如:exampleprefix-cn-north-4-exampledomainid。如何获取账号ID请参见获取账号ID

Endpoint

指定承载KVS服务端点的服务器域名或IP。Endpoint需要通过购买 VPC终端节点 ,创建内网域名来获取,具体操作请参见VPC终端节点对接KVS

resource-path

资源路径,即API访问路径。从具体API的URI模块获取,例如“创建表”API接口的resource-path为“/v1/create-table”。

query-string

查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?store-name=exampleprefix-cn-north-4-exampledomainid”,表示仓名称为exampleprefix-cn-north-4-exampledomainid

例如您需要在KVS的“华北-北京四”区域创建表,则需使用“华北-北京四”区域的Endpoint(kvs.cn-north-4.myhuaweicloud.com),并在具体API的URI部分找到resource-path(/v1/create-table),拼接起来如下所示。其中${store-name}为仓名。

1
https://${store-name}.kvs.cn-north-4.myhuaweicloud.com/v1/create-table

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

support.huaweicloud.com/api-kvs/kvs_02_0009.html