ListKnowledgePoints - 查询知识点列表-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

按类型分页浏览知识库中的知识点。

接口说明

分页列出一个知识库当前可见的知识点，支持按 GRAPH、WIKI 和 KNOWLEDGE_CONTENT 筛选。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListKnowledgePoints

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
KnowledgeBaseId	string	是	目标知识库的稳定 ID，可通过 ListKnowledgeBases 获取。	12345678-1234-4234-8234-123456789abc
Type	string	否	知识点类型：GRAPH 为局部图入口，WIKI 为 Wiki 页面，KNOWLEDGE_CONTENT 为知识内容。省略时列出全部类型。枚举值： GRAPH WIKI KNOWLEDGE_CONTENT	GRAPH
MaxResults	integer	否	每页最多返回的知识点数量，取值 1～100，省略时为 20。	20
NextToken	string	否	分页游标。第一页不传；后续页原样传入上次响应的 NextToken，保持知识库、类型和页大小不变。游标为空表示结束；当前页为空但游标非空时仍应继续。	eyJvZmZzZXQiOjIwfQ

返回参数

名称	类型	描述	示例值
	object	接口成功响应。
RequestId	string	本次请求的唯一标识，可用于定位问题。	00000000-0000-4000-8000-000000000001
Success	boolean	本次请求是否成功。
Data	object	本页知识点摘要及下一页游标。
KnowledgePoints	array<object>	本页当前调用者有权读取的知识点摘要。每项的 KnowledgeBaseId、Type 和 Id 可直接用于 GetKnowledgePoint。
	object
KnowledgeBaseId	string	知识点所属的知识库 ID。与 Type、Id 一起定位知识点。	12345678-1234-4234-8234-123456789abc
Type	string	知识点读取类别：GRAPH 为局部图，WIKI 为主题页面，KNOWLEDGE_CONTENT 为知识内容。	GRAPH
Id	string	当前知识点的读取标识。GRAPH 为局部图入口节点 ID，WIKI 为页面 ID，KNOWLEDGE_CONTENT 为内容 ID。原样用于 GetKnowledgePoint，不解析或拼接。	node-sales
Title	string	知识点的可阅读标题；GRAPH 使用入口节点名称。	销售额
Summary	string	知识点的可读摘要，不保证包含完整内容；需要详情时调用 GetKnowledgePoint。	销售额指标及其关联订单表。
NextToken	string	分页游标。第一页不传；后续页原样传入上次响应的 NextToken，保持知识库、类型和页大小不变。游标为空表示结束；当前页为空但游标非空时仍应继续。	eyJvZmZzZXQiOjIwfQ
Code	string	业务错误代码。成功时可省略；失败遵循公共错误响应协议。	InvalidParameter
Message	string	业务错误的可读说明，成功时可省略。失败定位时请同时提供 RequestId。	The request parameters are invalid.
MaxResults	integer	每页最多返回的知识库数量，取值 1～100。	20

示例

正常返回示例

JSON格式

{
  "RequestId": "00000000-0000-4000-8000-000000000001",
  "Success": true,
  "Data": {
    "KnowledgePoints": [
      {
        "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
        "Type": "GRAPH",
        "Id": "node-sales",
        "Title": "销售额",
        "Summary": "销售额指标及其关联订单表。"
      }
    ],
    "NextToken": "eyJvZmZzZXQiOjIwfQ"
  },
  "Code": "InvalidParameter",
  "Message": "The request parameters are invalid.",
  "MaxResults": 20
}

错误码

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.

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

变更历史

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