All Products
Search
Document Center

:GetNode

更新時間:May 10, 2024

Queries the information about a node.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

GetNode

The operation that you want to perform. Set the value to GetNode.

NodeId

Long

Yes

1234

The node ID. You can call the ListNodes operation to query the ID.

ProjectEnv

String

Yes

PROD

The environment of the workspace. Valid values: PROD and DEV.

Response parameters

Parameter

Type

Example

Description

HttpStatusCode

Integer

200

The HTTP status code.

RequestId

String

E6F0DBDD-5AD****

The request ID.

ErrorMessage

String

The connection does not exist.

The error message.

ErrorCode

String

Invalid.Tenant.ConnectionNotExists

The error code.

Success

Boolean

true

Indicates whether the request was successful.

Data

Object

The details of the node.

SchedulerType

String

NORMAL

The scheduling type of the node. Valid values:

  • NORMAL: The node is an auto triggered node.

  • MANUAL: The node is a manually triggered node. The scheduling system does not run the node on a regular basis.

  • PAUSE: The node is a paused node.

  • SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the scheduling system sets the status of the nodes to successful when the scheduling system starts to run the nodes.

RepeatInterval

Long

60

The interval at which the node is rerun after the node fails to run.

Repeatability

String

true

Indicates whether the node can be rerun.

ProjectId

Long

1234

The workspace ID.

ProgramType

String

ODPS_SQL

The type of the node.

Priority

Integer

1

The node priority. Valid values: 1, 3, 5, 7, and 8.

OwnerId

String

17366294****

The owner ID.

Connection

String

odps_source_dev

The connection string.

ParamValues

String

a=b

The additional parameters.

RelatedFlowId

Long

123

The associated workflow ID.

DqcType

Integer

1

Indicates whether the node is associated with a monitoring rule in Data Quality. Valid values: 0 and 1. The value 0 indicates that the node is not associated with a monitoring rule in Data Quality. The value 1 indicates that the node is associated with a monitoring rule in Data Quality.

BaselineId

Long

123456

The baseline ID.

Description

String

test

The description of the node.

NodeName

String

SQL node

The name of the node.

ResGroupName

String

Shared resource group

The name of the resource group.

BusinessId

Long

123

The workflow ID.

DqcDescription

String

[{"projectName":"test_0923001","tableName":"test_table_001","partition":"ds\u003d$[yyyymmdd]"},{"projectName":"test_0923001","tableName":"test_table_002","partition":"NOTAPARTITIONTABLE"}]

The table and partition filter expression in Data Quality that are associated with the node.

CronExpress

String

00 00 00 * * ?

The CRON expression.

NodeId

Long

1234

The node ID.

ResGroupIdentifier

String

group_123

The identifier of the resource group.

FileType

Integer

10

The type of the code in the file. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetNode
&NodeId=1234
&ProjectEnv=PROD
&<Common request parameters>

Sample success responses

XML format

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

<GetNodeResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>E6F0DBDD-5AD****</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <SchedulerType>NORMAL</SchedulerType>
        <RepeatInterval>60</RepeatInterval>
        <Repeatability>true</Repeatability>
        <ProjectId>1234</ProjectId>
        <ProgramType>ODPS_SQL</ProgramType>
        <Priority>1</Priority>
        <OwnerId>17366294****</OwnerId>
        <Connection>odps_source_dev</Connection>
        <ParamValues>a=b</ParamValues>
        <RelatedFlowId>123</RelatedFlowId>
        <DqcType>1</DqcType>
        <BaselineId>123456</BaselineId>
        <Description>test</Description>
        <NodeName>SQL node</NodeName>
        <ResGroupName>Shared resource group</ResGroupName>
        <BusinessId>123</BusinessId>
        <DqcDescription>[{"projectName":"test_0923001","tableName":"test_table_001","partition":"ds\u003d$[yyyymmdd]"},{"projectName":"test_0923001","tableName":"test_table_002","partition":"NOTAPARTITIONTABLE"}]</DqcDescription>
        <CronExpress>00 00 00 * * ?</CronExpress>
        <NodeId>1234</NodeId>
        <ResGroupIdentifier>group_123</ResGroupIdentifier>
        <FileType>10</FileType>
    </Data>
</GetNodeResponse>

JSON format

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" : {
    "SchedulerType" : "NORMAL",
    "RepeatInterval" : 60,
    "Repeatability" : true,
    "ProjectId" : 1234,
    "ProgramType" : "ODPS_SQL",
    "Priority" : 1,
    "OwnerId" : "17366294****",
    "Connection" : "odps_source_dev",
    "ParamValues" : "a=b",
    "RelatedFlowId" : 123,
    "DqcType" : 1,
    "BaselineId" : 123456,
    "Description" : "test",
    "NodeName" : "SQL node",
    "ResGroupName" : "Shared resource group",
    "BusinessId" : 123,
    "DqcDescription" : "[{\"projectName\":\"test_0923001\",\"tableName\":\"test_table_001\",\"partition\":\"ds\\u003d$[yyyymmdd]\"},{\"projectName\":\"test_0923001\",\"tableName\":\"test_table_002\",\"partition\":\"NOTAPARTITIONTABLE\"}]",
    "CronExpress" : "00 00 00 * * ?",
    "NodeId" : 1234,
    "ResGroupIdentifier" : "group_123",
    "FileType" : 10
  }
}

Error codes

For a list of error codes, see Service error codes.