RevokeKnowledgeBaseRetrieval - 撤销知识库检索权限-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

接口说明

撤销用户检索权限。仅知识库 Owner 或管理员可操作，调用者与租户由 POP 认证上下文确定。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
KnowledgeBaseId	string	是	知识库 ID	12345678-1234-4234-8234-123456789abc
PrincipalType	string	否	接收分享的主体类型，可选，省略默认 USER；首期仅支持 USER。枚举值： USER	USER
PrincipalId	string	是	目标用户的 DataWorks UserId，不是 RAM UID，也不是调用者身份。	1000000000000000

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次请求的唯一标识，可用于定位问题。	00000000-0000-4000-8000-000000000001
Success	boolean	请求是否成功
Data	object	成功时返回的业务数据。
KnowledgeBaseId	string	所属知识库的稳定 ID。	12345678-1234-4234-8234-123456789abc
PrincipalType	string	接收分享的对象类型；请求可选，省略默认 USER；响应固定返回 USER	USER
PrincipalId	string	接收分享的 DataWorks UserId，新增时校验同租户成员	1000000000000000
Code	string	业务错误码；请求失败时用于判断错误类型。	InvalidParameter
Message	string	请求失败时的安全错误信息。	请求参数不合法。

示例

正常返回示例

JSON格式

{
  "RequestId": "00000000-0000-4000-8000-000000000001",
  "Success": true,
  "Data": {
    "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
    "PrincipalType": "USER",
    "PrincipalId": "1000000000000000"
  },
  "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.

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

变更历史

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