数据面 API

请求成功

此时http响应状态码为200，响应体的code值为Success。
响应体示例：

{
    "code": "Success",
    "message": "The API call was executed successfully.",
    "request_id": "req_t_1754903451200",
    "result": {
        ......
    }
}

请求失败

此时http响应状态码不为200，其中的code字段是string类型的错误码，枚举值如“错误码Code”小节介绍，message字段是string类型的错误详情。
响应体示例：

{
    "code": "NotFound.VikingdbCollection",
    "message": "The specified collection 'test_coll_xx' of VikingDB does not exist.",
    "request_id": "req_t_1754903615941",
    "result": null
}

控制面 API

请求成功

此时http响应状态码为200，响应体的ResponseMetadata中无Error字段。
响应体示例：

{
    "ResponseMetadata": {
        "Action": "GetVikingdbCollection",
        "Region": "cn-beijing",
        "RequestId": "20250811170347F97382CA6AA2194B7E4C",
        "Service": "vikingdb",
        "Version": "2025-06-09"
    },
    "Result": {
        "ProjectName": "default",
        "CollectionName": "my_coll_1",
        ......
    }
}

请求失败

此时http响应状态码不为200，响应体的ResponseMetadata中包括Error字段。其中的Code字段是string类型的错误码，枚举值如“错误码Code”小节介绍。
响应体示例：

{
    "ResponseMetadata": {
        "Action": "GetVikingdbCollection",
        "Error": {
            "Code": "NotFound.VikingdbCollection",
            "Message": "The specified collection 'my_coll_1_xx' of VikingDB does not exist."
        },
        "Region": "cn-beijing",
        "RequestId": "202508111705278269DB3C6ED5DD706B24",
        "Service": "vikingdb",
        "Version": "2025-06-09"
    }
}

错误码（Code）

控制面和数据面采用统一的一套错误码，类型为string，简洁地描述了错误的归因。错误码遵循“错误类型”或“错误原因.错误元素”的描述形式。您可以根据错误码（Code）和错误详情信息（Message）来定位错误根因。
常用错误码枚举值如下：