文档

ListFileType - 查询任务节点类型

更新时间:

查询任务节点的类型信息,包括类型Code和类型名称。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*Read
  • 全部资源
    *

请求参数

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

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

10000
ProjectIdentifierstring

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

dw_project
PageNumberinteger

请求数据的页码数。

1
PageSizeinteger

每页显示的数据条数,最大值为 100。

50
Keywordstring

节点类型的名称。您可以登录 DataWorks 控制台,进入数据开发界面,在左侧导航栏查看某类型节点的名称。配置说明如下:

  • 支持查看中英文名称,但该参数查看的名称语言需要与 Locale 参数的语言类型一致。
  • 支持模糊搜索。
  • 如果不配置该参数,则会返回所有节点类型的名称。
ODPS SQL
Localestring

选择查询的语言,支持查询 zh-CN 和 en-US 语言的节点类型信息。

zh-CN

返回参数

名称类型描述示例值
object
RequestIdstring

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

0000-ABCD-EFG****
NodeTypeInfoListobject

返回的节点类型信息列表。

PageNumberinteger

当前数据页的页码。

1
PageSizeinteger

当前数据页显示的数据条数。

50
TotalCountinteger

满足查询条件的数据总条数。

127
NodeTypeInfoobject []

单个节点类型的信息。

NodeTypeNamestring

节点类型的名称。 常用的代码及名称类型对应关系如下: 6(Shell)、10(ODPS SQL)、11(ODPS MR)、23(数据集成)、24(ODPS Script)、99(虚拟节点)、221(PyODPS 2)、225(ODPS Spark)、227(EMR Hive)、228(EMR Spark)、229(EMR Spark SQL)、230(EMR MR)、239(OSS 对象检查)、257(EMR Shell)、258(EMR Spark Shell)、259(EMR Presto)、260(EMR Impala)、900(实时同步)、1089(跨租户节点)、1091(Hologres 开发)、1093(Hologres SQL)、1100(赋值节点)、1221(PyODPS 3)。

ODPS SQL
NodeTypeinteger

节点类型的 Code 信息。 常用的代码及名称类型对应关系如下: 6(Shell)、10(ODPS SQL)、11(ODPS MR)、23(数据集成)、24(ODPS Script)、99(虚拟节点)、221(PyODPS 2)、225(ODPS Spark)、227(EMR Hive)、228(EMR Spark)、229(EMR Spark SQL)、230(EMR MR)、239(OSS 对象检查)、257(EMR Shell)、258(EMR Spark Shell)、259(EMR Presto)、260(EMR Impala)、900(实时同步)、1089(跨租户节点)、1091(Hologres 开发)、1093(Hologres SQL)、1100(赋值节点)、1221(PyODPS 3)。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "0000-ABCD-EFG****",
  "NodeTypeInfoList": {
    "PageNumber": 1,
    "PageSize": 50,
    "TotalCount": 127,
    "NodeTypeInfo": [
      {
        "NodeTypeName": "ODPS SQL",
        "NodeType": 10
      }
    ]
  }
}

错误码

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.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。

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

  • 本页导读 (1)