文档

ListNodes - 获取节点的列表

更新时间:

调用ListNodes获取节点的列表。

调试

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

授权信息

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

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

请求参数

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

负责人的 ID。

193379****
BizNamestring

业务流程的名称。

test_bizName
ProgramTypestring

节点的类型。您可以调用 ListFileType 查看节点类型。

ODPS_SQL
PageNumberinteger

页码数。最小值 1,最大值 100

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
ProjectIdlong

工作空间的 ID。

1234
ProjectEnvstring

运行的环境,包括 DEV 和 PROD。

PROD
NodeNamestring

节点的名称。

liux_test_n****
SchedulerTypestring

调度的类型,取值如下:

  • NORMAL:正常调度任务。
  • PAUSE:暂停任务。
  • SKIP:空跑任务,被日常调度,但启动调度时直接被置为成功。
NORMAL

返回参数

名称类型描述示例值
object

返回实体。

HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

请求的 ID。用于定位日志,排查问题。

E6F0DBDD-5AD****
ErrorMessagestring

错误信息。

The connection does not exist.
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。

true
Dataobject

节点的列表。

PageNumberinteger

页码数。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
TotalCountinteger

符合条件的节点总数。

66
Nodesobject []

节点的信息。

SchedulerTypestring

调度的类型,取值如下:

  • NORMAL:正常调度任务。
  • PAUSE:暂停任务。
  • SKIP:空跑任务,被日常调度,但启动调度时直接被置为成功。
NORMAL
RepeatIntervallong

出错后重新调度频率。

60
Repeatabilityboolean

是否可以重复运行。

true
ProjectIdlong

工作空间的 ID。

33671
ProgramTypestring

节点的类型。

ODPS_SQL
Priorityinteger

优先级,1/3/5/7/8

1
OwnerIdstring

负责人的 ID。

19337906836551
Connectionstring

连接串。

odps_source
ParamValuesstring

额外的参数。

a=b
RelatedFlowIdlong

关联业务流程 ID。

1231123
DqcTypeinteger

DQC 类型,0 表示没有关联 dqc,1 表示有关联 dqc。

1
BaselineIdlong

基线 ID。

123456
Descriptionstring

节点的描述信息。

test
NodeNamestring

节点的名称。

liux_test_n****
ResGroupNamestring

资源组的名称。

默认资源组
BusinessIdlong

业务流程 ID。

123
DqcDescriptionstring

DQC 分区规则串。

[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
CronExpressstring

cron 表达式。

00 00 00 * * ?
NodeIdlong

节点的 ID。

1234
ResGroupIdentifierstring

资源组标识

group_123
FileTypeinteger

文件类型

10

示例

正常返回示例

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_source",
        "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,
        "FileId": 0,
        "FileVersion": 0,
        "DeployDate": 0,
        "CreateTime": 0,
        "ModifyTime": 0
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-30OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-06-25API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)