Version: 1.0.0
知识库 OpenAPI
功能介绍
这里是知识库相关openapi。
接入指引
调用以下接口需要传递 AccessToken 或者ApiKey,格式如Authorization: Bearer <token>
或者 Authorization: Bearer <ApiKey>
。Token 获取方式参考:https://docs.cloudbase.net/http-api/basic/access-token;
ApiKey 获取方式参考:https://docs.cloudbase.net/http-api/basic/api-key
HTTP 状态码
根据返回结果的不同,可能会出现 2xx
, 4xx
, 5xx
状态码。
错误码
以下列出了该系列 API 特定的错误码,完整列表参考:https://docs.cloudbase.net/error-code/service
错误码 | 含义 |
INVALID_PARAMETER | 参数错误 |
MISSING_PARAMETER | 缺少参数错误 |
RESOURCE_NOTFOUND | 资源不存在 |
INVALID_PARAMETER_VALUE | 参数取值错误 |
REQUEST_LIMIT_EXCEEDED | 请求的次数超过了频率限制 |
SYS_ERR | 内部错误 |
FAILED_OPERATION | 操作失败 |
Authentication
- HTTP: Bearer Auth
- API Key: APIKey
环境 ID 所对应的 token,使用登录鉴权(v2)获取
Security Scheme Type: | http |
---|---|
HTTP Authorization Scheme: | bearer |
TC3-HMAC-SHA256开头的腾讯云 3.0 版签名,将 Timestamp 和 Token 拼接在签名最后
Security Scheme Type: | apiKey |
---|---|
Header parameter name: | Authorization |