全部产品
Search
文档中心

大数据开发治理平台 DataWorks:GetFolder - 获取文件夹的详情

更新时间:Jul 09, 2024

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
ProjectIdlong

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

10000
ProjectIdentifierstring

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

dw_project
FolderIdstring

文件夹的 ID。您可以调用 ListFolders 接口获取文件夹 ID。 该参数与 FolderPath 参数配置一个即可。

273****
FolderPathstring

文件夹的路径。您可以调用 ListFolders 接口获取文件夹路径。 该参数与 FolderId 参数配置一个即可。

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

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
ErrorMessagestring

错误信息。

The connection does not exist.
RequestIdstring

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

0000-ABCD-EFG****
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。

true
Dataobject

文件夹的详情。

FolderPathstring

文件夹的路径。

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

文件夹的 ID。

2735****

示例

正常返回示例

JSON格式

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

JSON格式

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

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.UserId.MissingAn internal system error occurred. Try again later.-

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

变更历史

变更时间变更内容概要操作
暂无变更历史