构造请求
本节介绍REST API请求的组成，并以调用KVS服务的创建表来说明如何调用API，该API可以创建表。
请求URI
请求URI由如下部分组成（方括号部分可选）：
{URI-scheme}://[{store-name}.]{Endpoint}/{resource-path}[?{query-string}]
尽管请求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在同一个区域也相同，所以简洁起见将这两部分省略。
请求方法
方法 |
说明 |
|---|---|
POST |
请求服务器新增资源或执行特殊操作。 |
在具体API接口的URI部分，您可以看到其请求方法为“POST”，则其请求为：
POST https://${store-name}.kvs.cn-north-4.myhuaweicloud.com/v1/create-table
其中${store-name}为仓名。
请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。
名称 |
描述 |
是否必选 |
示例 |
|---|---|---|---|
Host |
请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 |
否 使用AK/SK认证时该字段必选。 |
code.test.com or code.test.com:443 |
Content-Type |
消息体的类型（格式）。推荐用户使用默认值application/bson，有其他取值时会在具体接口中专门说明。 |
是 |
application/bson |
Content-Length |
请求body长度，单位为Byte。 |
否 |
3495 |
X-Project-Id |
project id，项目编号。请参考获取项目ID章节获取项目编号。 |
否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 |
e9993fc787d94b6c886cbaa340f9c0f4 |
API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。
AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。
请求消息体（可选）
该部分可选。请求消息体通常以Bson格式发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），列举仓接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于创建表接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中${store-name}为仓名，$YOUR_TABLE_NAME为表名，$YOUR_SHARD_KEY_NAME为分区键名称，$YOUR_SORT_KEY_NAME为排序键名称。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
POST https://${store-name}.kvs.cn-north-4.myhuaweicloud.com/v1/create-table Content-Type: application/bson { "table_name" : "$YOUR_TABLE_NAME", "primary_key_schema" : { "shard_key_fields" : [ { "name" : "$YOUR_SHARD_KEY_NAME", "order" : true } ], "sort_key_fields" : [ { "name" : "$YOUR_SORT_KEY_NAME", "order" : true } ] } } |
到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于创建表接口，返回的响应体中包含了创建表的属性信息。表创建好以后，您就可以调用其他API执行向表中插入数据、查询表中数据等其他操作了。
