文档首页/ 键值存储服务 KVS/ API参考/ 如何调用API/ 返回结果
更新时间：2024-06-20 GMT+08:00
查看PDF
分享

返回结果

状态码

请求发送以后，您会收到响应，其中包含状态码、响应消息头和消息体。

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。

对于创建表接口，如果调用后返回状态码为“200”，则表示请求成功。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-type”。

对于创建表接口，返回如图1所示的消息头。表创建好后，可以开始调用其他API接口执行向表中插入KV数据、查询KV数据等其他操作。

图1 创建表响应消息头

响应消息体（可选）

该部分可选。响应消息体通常以Bson格式返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。

对于创建表接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
 
{
  "table_name" : "example-table",
  "primary_key_schema" : {
    "shard_key_fields" : [ {
      "name" : "user_id",
      "order" : true
    } ],
    "sort_key_fields" : [ {
      "name" : "user_name",
      "order" : true
    } ]
  }
......

当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。

1
2
3
4
 
{
    "errorCode": KVS.00001001
    "errorMsg": table_name: string element has invalid char.
}

其中，errorCode表示错误码，errorMsg表示错误描述信息。

父主题： 如何调用API

相关文档