You need to enable JavaScript to run this app.
文档中心
AgentKit

AgentKit

复制全文
下载 pdf
Knowledge
GetKnowledgeConnectionInfo - 查询知识库详情
复制全文
下载 pdf
GetKnowledgeConnectionInfo - 查询知识库详情
查询知识库详情。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:GetKnowledgeConnectionInfo​
要执行的操作,取值:GetKnowledgeConnectionInfo。​
​
Version string 必选 示例值:2025-10-30​
API的版本,取值:2025-10-30。​
​
KnowledgeId string 必选 示例值:kb-4yds45****​
知识库ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
ConnectionInfos object[] 示例值:--​
知识库的连接信息。​
AddrType string 示例值:PUBLIC​
网络地址类型,取值:​
  • PUBLIC:公网。​
  • PRIVATE:私网。​
​
AuthKey string 示例值:my-key​
认证密钥。​
​
AuthType string 示例值:BEARER_TOKEN​
鉴权类型,取值:​
  • BEARER_TOKEN:使用AuthKey中的值作为Bearer token。​
  • APIKEY:使用AuthKey中的值作为Authorization header。​
  • AK_SK:使用您的火山引擎AK/SK进行标准化签名后的值作为Authorization header。​
​
BaseUrl string 示例值:https://base.url​
知识库平台的基础URL地址。​
​
ExpireAt string 示例值:2025-09-17T10:00:00+8:00​
认证信息过期时间。​
​
ExtraConfig string 示例值:{}​
额外的平台特定配置。(JSON格式)​
​
Region string 示例值:cn-beijing​
服务区域。​
​
Status string 示例值:VAILABLE​
连接状态,取值:​
  • VAILABLE:可用。​
  • CREATING:创建中。​
  • UNAVAILABLE:不可用。​
​
VpcId string 示例值:vpc-123​
私有网络ID。​
​
VpcName string 示例值:Default​
私有网络名称。​
​
​
KnowledgeId string 示例值:kb-4yds45****​
知识库ID。​
​
Message string 示例值:No ready endpoints.​
状态消息,包含额外的状态信息或错误描述。​
​
Name string 示例值:my_collection​
知识库名称。​
​
ProjectName string 示例值:default​
已导入的知识库所属项目名称。​
​
ProviderKnowledgeId string 示例值:kb-ye7s2g****​
已导入的知识库所属项目ID。​
​
ProviderType string 示例值:VIKINGDB_KNOWLEDGE​
已导入的知识库平台类型。取值:​
  • VIKINGDB_KNOWLEDGE:Viking知识库。​
​
Status string 示例值:Ready​
知识库状态,取值:​
  • Importing:导入中。​
  • ImportFailed:导入失败。​
  • Ready:成功。​
  • Deleting:删除中。​
  • DeleteFailed:删除失败。​
  • Deleted:资源失效。​
  • Error:错误。​
​
​
​
请求示例​
​
POST https://agentkit.cn-beijing.volcengineapi.com?Action=GetKnowledgeConnectionInfo&Version=2025-10-30 HTTP/1.1​
Content-Type: application/json​
{​
{​
"KnowledgeId": "kb-4yds45****"​
}​
}​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202106111445100102252431000052****",​
"Action": "GetKnowledgeConnectionInfo",​
"Version": "2025-10-10",​
"Service": "agentkit",​
"Region": "cn-beijing"​
},​
"Result": {​
"KnowledgeId": "kb-4yds45****",​
"ProviderKnowledgeId": "kb-ye7s2g****",​
"ProviderType": "VIKINGDB_KNOWLEDGE",​
"Status": "Ready",​
"ConnectionInfos": [​
{​
"BaseUrl": "https://viking****.volces.com",​
"Region": "cn-beijing",​
"AuthType": "BEARER_TOKEN",​
"AuthKey": "ak-abc123d****",​
"ExpireAt": "2025-09-17T10:00:00Z",​
"ExtraConfig": "{\"endpoint\":\"https://custom.endpoint.com\"}"​
}​
],​
"Message": "Knowledge base is ready for use",​
"ProjectName": "default",​
"Name": "my_travel_knowledge"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter.KnowledgeId​
The required parameter KnowledgeId is not supplied.​
参数KnowledgeId不能为空。​
404​
InvalidResource.NotFound​
The specified resource does not exist.​
指定资源不存在。​
​
​
最近更新时间:2025.12.16 10:09:01
这个页面对您有帮助吗?
有用
有用
无用
无用