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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListFileType

要执行的操作。

PageNumber Integer 1

请求数据的页码数。

PageSize Integer 50

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

RegionId String cn-zhangjiakou

地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

ProjectId Long 10000

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

ProjectIdentifier String dw_project

DataWorks工作空间名称。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间名称。

该参数与ProjectId参数,二者必须设置其一,用来确定本次API调用操作的DataWorks工作空间。

Keyword String ODPS SQL

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

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

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

返回数据

名称 类型 示例值 描述
NodeTypeInfoList Struct

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

NodeTypeInfo Array of NodeTypeInfo

单个节点类型的信息。

NodeType Integer 10

节点类型的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)。

NodeTypeName String ODPS SQL

节点类型的名称。

常用的代码及名称类型对应关系如下:

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)。

PageNumber Integer 1

当前数据页的页码。

PageSize Integer 50

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

TotalCount Integer 127

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

RequestId String 0000-ABCD-EFG****

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListFileType
&PageNumber=1
&PageSize=50
&RegionId=cn-zhangjiakou
&<公共请求参数>

正常返回示例

XML格式

<RequestId>0000-ABCD-EFG****</RequestId>
<NodeTypeInfoList>
    <TotalCount>127</TotalCount>
    <PageSize>50</PageSize>
    <PageNumber>1</PageNumber>
    <NodeTypeInfo>
        <NodeTypeName>ODPS SQL</NodeTypeName>
        <NodeType>10</NodeType>
    </NodeTypeInfo>
</NodeTypeInfoList>

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
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. 您的请求过于频繁,请尝试放缓请求速度。
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 您被限制访问,请开通DataWorks企业版或旗舰版。

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