API V2错误码与故障排查指南--向量数据库VikingDB-火山引擎

文档中心

向量数据库VikingDB

请输入

API V2参考

API V2错误码与故障排查指南

API V2

数据面 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）来定位错误根因。
常用错误码枚举值如下：

错误码	含义	触发条件	处理建议
MissingParameter	缺失参数	缺失必要的请求参数	根据报错信息，完善请求参数。
InvalidParameter	参数不合法	输入请求参数的类型或格式等不正确	根据报错信息，检查请求参数。如报错内容不清晰请及时反馈。
AccessDenied	鉴权失败	缺失对资源的访问权限	检查ak、sk是否正确、请求签名是否正确、ak所属子账户是否拥有对该project下的该资源有访问权限。
TooManyRequests	请求限流	单位时间内请求过多	若检索请求出现限流，请增加 CPU Quota。若其他接口出现限流，请检查调用方式是否存在问题。各接口的限流配额介绍参考：https://www.volcengine.com/docs/84313/1478243
InternalError	服务内部错误	服务端出现不符合预期的报错	及时联系客服反馈。
OperationDenied.Xxx	禁止对Xxx操作	虽然接口请求鉴权成功，但不符合内部执行逻辑。	例如，`OperationDenied.VikingdbCollection`表示，您必须删除完关联的索引后，才能删除数据集。
NotFound.Xxx	Xxx资源不存在	找不到请求参数中的资源	例如，`NotFound.VikingdbIndex`表示，找不到索引，您需要先创建这个索引再进行相关操作。
AlreadyExists.Xxx	Xxx资源已存在	对于不可重复的资源，不能重复创建。	例如，`AlreadyExists.Xxx`表示，请求中的ResourceId值已经存在，不能再重复创建。

最近更新时间：2026.04.14 17:18:21

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

数据面 API #

请求成功 #

请求失败 #

控制面 API #

请求成功 #

请求失败 #

错误码（Code） #

数据面 API

请求成功

请求失败

控制面 API

请求成功

请求失败

错误码（Code）