GetKnowledgeBase - 获取知识库-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

读取指定知识库的信息及当前调用者的访问角色。

接口说明

获取知识库。租户和调用者身份由 POP 认证上下文确定。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:GetKnowledgeBase

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
KnowledgeBaseId	string	是	目标知识库的稳定 ID，可通过 ListKnowledgeBases 获取。	12345678-1234-4234-8234-123456789abc

返回参数

名称	类型	描述	示例值
	object	接口成功响应。
RequestId	string	本次请求的唯一标识，可用于定位问题。	00000000-0000-4000-8000-000000000001
Success	boolean	本次请求是否成功。
Data	object	目标知识库的公共配置信息。
KnowledgeBaseId	string	知识库的稳定 ID，可用于限定检索范围。	12345678-1234-4234-8234-123456789abc
Name	string	知识库名称。	销售知识库
Description	string	知识库的描述信息，未设置时可以为空。	销售指标、订单及业务制度知识。
Type	string	知识库类型：PERSONAL 为个人知识库，ENTERPRISE 为企业知识库。	PERSONAL
Owner	string	知识库负责人的 DataWorks 用户 ID。	1000000000000000
AccessRole	string	当前调用者对知识库的只读访问角色：OWNER 为负责人，ADMIN 为管理员，VIEWER 为查看者。	OWNER
Status	string	知识库公共状态。本列表仅返回正常可见知识库，值为 ACTIVE。	ACTIVE
CreateTime	integer	知识库创建时间，Unix 毫秒时间戳。	1794369600000
ModifyTime	integer	知识库最近修改时间，Unix 毫秒时间戳。	1794373200000
Code	string	业务错误代码。成功时可省略；失败遵循公共错误响应协议。	InvalidParameter
Message	string	业务错误的可读说明，成功时可省略。失败定位时请同时提供 RequestId。	The request parameters are invalid.

示例

正常返回示例

JSON格式

{
  "RequestId": "00000000-0000-4000-8000-000000000001",
  "Success": true,
  "Data": {
    "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
    "Name": "销售知识库",
    "Description": "销售指标、订单及业务制度知识。",
    "Type": "PERSONAL",
    "Owner": "1000000000000000",
    "AccessRole": "OWNER",
    "Status": "ACTIVE",
    "CreateTime": 1794369600000,
    "ModifyTime": 1794373200000
  },
  "Code": "InvalidParameter",
  "Message": "The request parameters are invalid."
}

错误码

HTTP status code	错误码	错误信息
400	InvalidParameter	The request parameters are invalid.
403	Forbidden	You are not authorized to perform this operation.
404	ResourceNotFound	The requested resource does not exist or is not visible.
503	ServiceUnavailable	The service is temporarily unavailable.
409	Conflict	The resource state conflicts with this operation.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。