全部产品
Search
文档中心

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

更新时间:Sep 20, 2023

调用GetFolder获取文件夹的详情。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String GetFolder

系统规定参数。取值:GetFolder

ProjectId Long 10000

DataWorks工作空间的ID。您可以登录DataWorks管控台,进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。

ProjectIdentifier String dw_project

DataWorks工作空间名称。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。

FolderId String 273****

文件夹的ID,该参数与FolderPath参数,二者必须设置其一。您可以调用ListFolders接口获取文件夹ID。

FolderPath String 业务流程/我的第一个业务流程/MaxCompute/ods层

文件夹的路径,该参数与FolderId参数,二者必须设置其一。您可以调用ListFolders接口获取文件夹路径。

返回数据

名称

类型

示例值

描述

HttpStatusCode Integer 200

HTTP状态码。

ErrorMessage String The connection does not exist.

错误信息。

RequestId String 0000-ABCD-EFG****

请求ID。用于出现错误后排查问题。

ErrorCode String Invalid.Tenant.ConnectionNotExists

错误码。

Success Boolean true

调用是否成功。

Data Object

文件夹的详情。

FolderPath String 业务流程/我的第一个业务流程/MaxCompute/ods层

文件夹的路径。

FolderId String 2735****

文件夹的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=GetFolder
&FolderId=273****
&FolderPath=业务流程/我的第一个业务流程/MaxCompute/ods层
&RegionId=cn-zhangjiakou
&<公共请求参数>

正常返回示例

XML格式

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

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <FolderPath>业务流程/我的第一个业务流程/MaxCompute/ods层</FolderPath>
    <FolderId>2735****</FolderId>
</Data>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>

JSON格式

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

{
  "RequestId" : "0000-ABCD-EFG****",
  "HttpStatusCode" : 200,
  "Data" : {
    "FolderPath" : "业务流程/我的第一个业务流程/MaxCompute/ods层",
    "FolderId" : "2735****"
  },
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "ErrorMessage" : "The connection does not exist.",
  "Success" : true
}

错误码

HttpCode

错误码

错误信息

描述

429 Throttling.Api The request for this resource has exceeded your available limit. 对该资源的请求已超过您的可用上限。
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks系统繁忙,请稍后再试。
429 Throttling.User Your request is too frequent. Try again later. 您的请求过于频繁,请尝试放缓请求速度。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。

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