ListNodes - 大数据开发治理平台 DataWorks

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListNodes	系统规定参数。取值：ListNodes。
Owner	String	否	193379****	负责人的ID。
BizName	String	否	test_bizName	业务流程的名称。
ProgramType	String	否	ODPS_SQL	节点的类型。您可以调用ListFileType查看节点类型。
PageNumber	Integer	否	1	页码数。最小值1，最大值100
PageSize	Integer	否	10	每页显示的条数，默认为10条，最大100条。
ProjectId	Long	是	1234	工作空间的ID。
ProjectEnv	String	是	PROD	运行的环境，包括DEV和PROD。
NodeName	String	否	liux_test_n****	节点的名称。

返回数据


名称	类型	示例值	描述
HttpStatusCode	Integer	200	HTTP状态码。
RequestId	String	E6F0DBDD-5AD****	请求的ID。用于定位日志，排查问题。
ErrorMessage	String	The connection does not exist.	错误信息。
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	错误码。
Success	Boolean	true	调用是否成功。
Data	Object		节点的列表。
PageNumber	Integer	1	页码数。
PageSize	Integer	10	每页显示的条数，默认为10条，最大100条。
TotalCount	Integer	66	符合条件的节点总数。
Nodes	Array of Nodes		节点的信息。
SchedulerType	String	NORMAL	调度的类型，取值如下： NORMAL：正常调度任务。 PAUSE：暂停任务。 SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。
RepeatInterval	Long	60	出错后重新调度频率。
Repeatability	Boolean	true	是否可以重复运行。
ProjectId	Long	33671	工作空间的ID。
ProgramType	String	ODPS_SQL	节点的类型。
Priority	Integer	1	优先级，1/3/5/7/8
OwnerId	String	19337906836551	负责人的ID。
Connection	String	odps_first	连接串。
ParamValues	String	a=b	额外的参数。
RelatedFlowId	Long	1231123	关联业务流程ID。
DqcType	Integer	1	DQC类型，0表示有关联dqc，1表示没有关联dqc。
BaselineId	Long	123456	基线ID。
Description	String	test	节点的描述信息。
NodeName	String	liux_test_n****	节点的名称。
ResGroupName	String	默认资源组	资源组的名称。
BusinessId	Long	123	业务流程ID。
DqcDescription	String	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]	DQC分区规则串。
CronExpress	String	00 00 00 * * ?	cron表达式。
NodeId	Long	1234	节点的ID。
ResGroupIdentifier	String	group_123	资源组标识
FileType	Integer	10	文件类型

示例

请求示例

http(s)://[Endpoint]/?Action=ListNodes
&Owner=193379****
&BizName=test_bizName
&ProgramType=ODPS_SQL
&PageNumber=1
&PageSize=10
&ProjectId=1234
&ProjectEnv=PROD
&NodeName=liux_test_n****
&公共请求参数

正常返回示例

XML格式

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

<ListNodesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>E6F0DBDD-5AD****</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>66</TotalCount>
        <Nodes>
            <SchedulerType>NORMAL</SchedulerType>
            <RepeatInterval>60</RepeatInterval>
            <Repeatability>true</Repeatability>
            <ProjectId>33671</ProjectId>
            <ProgramType>ODPS_SQL</ProgramType>
            <Priority>1</Priority>
            <OwnerId>19337906836551</OwnerId>
            <Connection>odps_first</Connection>
            <ParamValues>a=b</ParamValues>
            <RelatedFlowId>1231123</RelatedFlowId>
            <DqcType>1</DqcType>
            <BaselineId>123456</BaselineId>
            <Description>test</Description>
            <NodeName>liux_test_n****</NodeName>
            <ResGroupName>默认资源组</ResGroupName>
            <BusinessId>123</BusinessId>
            <DqcDescription>[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]</DqcDescription>
            <CronExpress>00 00 00 * * ?</CronExpress>
            <NodeId>1234</NodeId>
            <ResGroupIdentifier>group_123</ResGroupIdentifier>
            <FileType>10</FileType>
        </Nodes>
    </Data>
</ListNodesResponse>

JSON格式

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "E6F0DBDD-5AD****",
  "ErrorMessage" : "The connection does not exist.",
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Success" : true,
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 66,
    "Nodes" : [ {
      "SchedulerType" : "NORMAL",
      "RepeatInterval" : 60,
      "Repeatability" : true,
      "ProjectId" : 33671,
      "ProgramType" : "ODPS_SQL",
      "Priority" : 1,
      "OwnerId" : "19337906836551",
      "Connection" : "odps_first",
      "ParamValues" : "a=b",
      "RelatedFlowId" : 1231123,
      "DqcType" : 1,
      "BaselineId" : 123456,
      "Description" : "test",
      "NodeName" : "liux_test_n****",
      "ResGroupName" : "默认资源组",
      "BusinessId" : 123,
      "DqcDescription" : "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
      "CronExpress" : "00 00 00 * * ?",
      "NodeId" : 1234,
      "ResGroupIdentifier" : "group_123",
      "FileType" : 10
    } ]
  }
}

错误码

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