Queries the details of a node.
Debugging
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 ID of the node. You can call the ListNodes operation to query the node ID. |
ProjectEnv | String | Yes | PROD |
The environment of the workspace. Valid values: PROD and DEV. |
RegionId | String | Yes | cn-shanghai |
The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and the ID of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint that is used to call the operation. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
HttpStatusCode | Integer | 200 |
The HTTP status code returned. |
RequestId | String | E6F0DBDD-5AD**** |
The ID of the request. You can use the ID to locate logs and troubleshoot issues. |
ErrorMessage | String | The connection does not exist. |
The error message returned. |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
The error code returned. |
Success | Boolean | true |
Indicates whether the request is successful. |
Data | Object |
The details of the node. |
|
SchedulerType | String | NORMAL |
The scheduling type of the node. Valid values:
|
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 ID of the workspace. |
ProgramType | String | ODPS_SQL |
The type of the node. |
Priority | Integer | 1 |
The priority of the node. Valid values: 1, 3, 5, 7, and 8. |
OwnerId | String | 17366294**** |
The ID of the owner of the node. |
Connection | String | odps_first_dev |
The connection string. |
ParamValues | String | a=b |
Other parameters. |
RelatedFlowId | Long | 123 |
The ID of the workflow to which the node belongs. |
DqcType | Integer | 1 |
Indicates whether the node is associated with Data Quality. Valid values: 0 and 1. A value of 0 indicates that the node is associated with Data Quality. A value of 1 indicates that the node is not associated with Data Quality. |
BaselineId | Long | 123456 |
The ID of the baseline. |
Description | String | test |
The description of the node. |
NodeName | String | SQL node |
The name of the node. |
ResGroupName | String | Default resource group |
The name of the resource group. |
BusinessId | Long | 123 |
The ID of the workflow. |
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 returned. |
NodeId | Long | 1234 |
The ID of the node. |
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_first_dev</Connection>
<ParamValues>a=b</ParamValues>
<RelatedFlowId>123</RelatedFlowId>
<DqcType>1</DqcType>
<BaselineId>123456</BaselineId>
<Description>test</Description>
<NodeName>SQL node</NodeName>
<ResGroupName>Default 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>
</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_first_dev",
"ParamValues" : "a=b",
"RelatedFlowId" : 123,
"DqcType" : 1,
"BaselineId" : 123456,
"Description" : "test",
"NodeName" : "SQL node",
"ResGroupName" : "Default 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
}
}
Error codes
For a list of error codes, visit the API Error Center.