全部产品
Search
文档中心

大数据开发治理平台 DataWorks:UmountDirectory

更新时间:Oct 13, 2023

将指定内容从数据分析左侧导航目录中移除。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String UmountDirectory

系统规定参数。取值:UmountDirectory

TargetType String META_ALBUM

移除数据分析左侧导航的类型,例如,META_ALBUM、元数据-数据专辑。

TargetId String album.339

与TargetType配合使用,为添加到数据分析左侧导航的元素的唯一ID。

例如,TargetType=META_ALBUM,即类型为元数据-数据专辑,则TargetId为元数据-数据专辑的唯一ID,参见:ListMetaCollections#QualifiedName。

TargetUserId String 1234567890

租户内指定用户的UserId。

  • 如果此字段为空,则代表修改自己的目录。
  • 如果此字段不为空,则修改此UserId的目录。

返回数据

名称

类型

示例值

描述

RequestId String 0bc5aa2716455247597991794e65bd

本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。

HttpStatusCode Integer 200

HTTP请求返回的响应状态码,200表示请求成功。

Data Integer 1

成功移除的数据量,例如:

  • 0:可能是左侧导航中不存在此数据,所以生效是0条。
  • 1:成功移除1条。
ErrorMessage String You have no permission.

调用失败时,返回的错误信息。

Success Boolean true

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。
ErrorCode String 200

错误码。200标识查询任务成功。

示例

请求示例

http(s)://[Endpoint]/?Action=UmountDirectory
&TargetType=META_ALBUM
&TargetId=album.339
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UmountDirectoryResponse>
    <RequestId>0bc5aa2716455247597991794e65bd</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>1</Data>
    <ErrorMessage>You have no permission.</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>200</ErrorCode>
</UmountDirectoryResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0bc5aa2716455247597991794e65bd",
  "HttpStatusCode" : 200,
  "Data" : 1,
  "ErrorMessage" : "You have no permission.",
  "Success" : true,
  "ErrorCode" : 200
}

错误码

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