CreateKnowledgeSource - 创建知识来源-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

登记知识库可引用的项目、数据源或外部文档来源。

接口说明

知识库知识来源管理。身份由 POP 上下文确定，凭证不在查询响应中返回。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
KnowledgeBaseId	string	是	所属知识库	12345678-1234-4234-8234-123456789abc
Name	string	是	来源名称	销售主题项目
Description	string	否	描述	销售指标与制度文档
Type	string	是	PROJECT、DATA_SOURCE 或 DOCUMENT 枚举值： PROJECT DATA_SOURCE DOCUMENT	PROJECT
ClientToken	string	否	创建幂等键	source-create-001
Project	object	否	Type=PROJECT 时必填
ProjectId	integer	否	DataWorks 工作空间 ID；来源定位字段	12345
EnvType	string	否	可选，限定读取环境为 Dev 或 Prod；未限定时不表示可以越权读取两个环境	Prod
DataSource	object	否	Type=DATA_SOURCE 时必填
DataSourceId	integer	否	DataWorks 数据源 ID；服务端据此解析所属工作空间、环境和数据源类型	12345
Document	object	否	Type=DOCUMENT 时必填
ConnectorType	string	否	DINGTALK、FEISHU、LARK、WECOM 或 YUQUE；创建后不可改变	WECOM
DingTalk	object	否	仅 DingTalk 时存在
McpKey	string	否	钉钉文档连接器的 MCP 授权凭证，仅用于创建或更新，不在响应中返回。	123456****
SourceUrls	array	否	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。
	string	否	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。	https://alidocs.dingtalk.com/i/nodes/example-document
Feishu	object	否	仅 Feishu 时存在
AppSecret	string	否	飞书或 Lark 应用的密钥，仅用于创建或更新，不在响应中返回。	123456****
SourceUrls	array	否	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。
	string	否	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。	https://example.feishu.cn/wiki/example-document
AppId	string	否	Feishu/Lark 应用 ID；不是 AppSecret	app-001
Lark	object	否	仅 Lark 时存在
AppSecret	string	否	飞书或 Lark 应用的密钥，仅用于创建或更新，不在响应中返回。	123456****
SourceUrls	array	否	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。
	string	否	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。	https://example.larksuite.com/wiki/example-document
AppId	string	否	Feishu/Lark 应用 ID；不是 AppSecret	app-001
WeCom	object	否	仅 WeCom 时存在
BotSecret	string	否	企业微信机器人的密钥，仅用于创建或更新，不在响应中返回。	123456****
SpaceIds	array	否	企业微信连接器选定的共享空间 ID。
	string	否	企业微信连接器选定的共享空间 ID。	space-001
BotId	string	否	企业微信机器人 ID	bot-001
Yuque	object	否	仅 Yuque 时存在
Teams	array<object>	否	语雀团队配置；各团队独立选择同步范围
	object	否
Host	string	否	团队站点地址	https://www.yuque.com
Token	string	否	语雀团队访问凭证，仅用于创建或更新，不在响应中返回。	123456****
SourceUrls	array	否	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。
	string	否	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。	https://www.yuque.com/example-team/example-book

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次请求的唯一标识，可用于定位问题。	00000000-0000-4000-8000-000000000001
Success	boolean	请求是否成功
Data	object	成功时返回的业务数据。
SourceId	string	服务生成的稳定来源 ID	src-001
KnowledgeBaseId	string	所属知识库 ID；创建后不可迁移到其他知识库	12345678-1234-4234-8234-123456789abc
Name	string	用户识别来源的名称	销售主题项目
Description	string	用途说明，可选	销售指标与制度文档
Type	string	来源类型：PROJECT（工作空间）、DATA_SOURCE（DataWorks 数据源）或 DOCUMENT（外部文档来源）。	PROJECT
CreateUser	string	创建者，服务端写入	1000000000000000
Project	object	仅 Type=PROJECT 时存在
ProjectId	integer	DataWorks 工作空间 ID；来源定位字段	12345
EnvType	string	可选，限定读取环境为 Dev 或 Prod；未限定时不表示可以越权读取两个环境	Prod
DataSource	object	仅 Type=DATA_SOURCE 时存在
DataSourceId	integer	DataWorks 数据源 ID；服务端据此解析所属工作空间、环境和数据源类型	12345
Document	object	仅 Type=DOCUMENT 时存在
ConnectorType	string	DINGTALK、FEISHU、LARK、WECOM 或 YUQUE；创建后不可改变	WECOM
CredentialConfigured	boolean	是否已配置连接器所需凭证；只读，不返回凭证内容或密文
DingTalk	object	仅 DingTalk 时存在
SourceUrls	array	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。
	string	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。	https://alidocs.dingtalk.com/i/nodes/example-document
AppId	string	Feishu/Lark 应用 ID；不是 AppSecret	app-001
Feishu	object	仅 Feishu 时存在
SourceUrls	array	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。
	string	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。	https://example.feishu.cn/wiki/example-document
AppId	string	Feishu/Lark 应用 ID；不是 AppSecret	app-001
Lark	object	仅 Lark 时存在
SourceUrls	array	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。
	string	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。	https://example.larksuite.com/wiki/example-document
AppId	string	Feishu/Lark 应用 ID；不是 AppSecret	app-001
WeCom	object	仅 WeCom 时存在
BotId	string	企业微信机器人 ID	bot-001
Spaces	array<object>	已选共享空间及其身份、展示名称。
	object
SpaceId	string	共享空间身份	space-001
SpaceName	string	服务端校验后的展示名，不参与身份判断	研发知识
Yuque	object	仅 Yuque 时存在
Teams	array<object>	语雀团队配置；各团队独立选择同步范围
	object
TeamId	string	服务端校验后的团队 ID	team-001
TeamLogin	string	团队登录名，只读展示信息	example-team
TeamName	string	团队名称，只读展示信息	示例团队
Host	string	团队站点地址	https://www.yuque.com
SourceUrls	array	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。
	string	该连接器选定的知识库、空间或文档 URL；实际允许的范围由连接器及授权决定。	https://www.yuque.com/example-team/example-book
CreateTime	integer	创建时间，毫秒时间戳	1790200000000
ModifyTime	integer	最近修改时间，毫秒时间戳	1790200300000
Code	string	业务错误码；请求失败时用于判断错误类型。	InvalidParameter
Message	string	请求失败时的安全错误信息。	请求参数不合法。

示例

正常返回示例

JSON格式

{
  "RequestId": "00000000-0000-4000-8000-000000000001",
  "Success": true,
  "Data": {
    "SourceId": "src-001",
    "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
    "Name": "销售主题项目",
    "Description": "销售指标与制度文档",
    "Type": "PROJECT",
    "CreateUser": "1000000000000000",
    "Project": {
      "ProjectId": 12345,
      "EnvType": "Prod"
    },
    "DataSource": {
      "DataSourceId": 12345
    },
    "Document": {
      "ConnectorType": "WECOM",
      "CredentialConfigured": true,
      "DingTalk": {
        "SourceUrls": [
          "https://alidocs.dingtalk.com/i/nodes/example-document"
        ],
        "AppId": "app-001"
      },
      "Feishu": {
        "SourceUrls": [
          "https://example.feishu.cn/wiki/example-document"
        ],
        "AppId": "app-001"
      },
      "Lark": {
        "SourceUrls": [
          "https://example.larksuite.com/wiki/example-document"
        ],
        "AppId": "app-001"
      },
      "WeCom": {
        "BotId": "bot-001",
        "Spaces": [
          {
            "SpaceId": "space-001",
            "SpaceName": "研发知识"
          }
        ]
      },
      "Yuque": {
        "Teams": [
          {
            "TeamId": "team-001",
            "TeamLogin": "example-team",
            "TeamName": "示例团队",
            "Host": "https://www.yuque.com",
            "SourceUrls": [
              "https://www.yuque.com/example-team/example-book"
            ]
          }
        ]
      }
    },
    "CreateTime": 1790200000000,
    "ModifyTime": 1790200300000
  },
  "Code": "InvalidParameter",
  "Message": "请求参数不合法。"
}

错误码

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.

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

变更历史

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