Knowledge Base OpenAPI
Feature Overview
This section provides the Knowledge Base OpenAPIs.
Access Guide
Invoking the following APIs requires either an AccessToken or an API key using the header Authorization: Bearer <token> or Authorization: Bearer <ApiKey>. For instructions on obtaining an AccessToken, see https://docs.cloudbase.net/http-api/basic/access-token.
For instructions on obtaining an API key, see https://docs.cloudbase.net/http-api/basic/api-key.
HTTP Status Codes
Depending on the response result, status codes in the ranges 2xx, 4xx, or 5xx may appear.
Error Codes
The following table lists the error codes specific to this group of APIs. For the complete list, refer to https://docs.cloudbase.net/error-code/service.
| Error Code | Description |
| INVALID_PARAMETER | Invalid request parameters |
| MISSING_PARAMETER | Required parameters are missing |
| RESOURCE_NOTFOUND | The requested resource was not found |
| INVALID_PARAMETER_VALUE | Invalid parameter value |
| REQUEST_LIMIT_EXCEEDED | The request exceeded the rate limit |
| SYS_ERR | Internal system error |
| FAILED_OPERATION | The operation failed |
Authentication
- HTTP: Bearer Auth
- API Key: APIKey
Token corresponding to the environment ID, obtained through login authentication (v2)
| Security Scheme Type: | http |
|---|---|
| HTTP Authorization Scheme: | bearer |
Tencent Cloud TC3-HMAC-SHA256 signature with Timestamp and Token appended to the end
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | Authorization |