Queries nodes in a baseline.

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 ListNodesByBaseline

The operation that you want to perform.

BaselineId Long Yes 1234

The ID of the baseline. You can call the GetNode operation to query the ID.

RegionId String Yes cn-shanghai

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation.

Response parameters

Parameter Type Example Description
Data Array of Data

The nodes in the baseline.

NodeId Long 1234

The ID of the node.

NodeName String Node name

The name of the node.

Owner String 9527952****

The ID of the Alibaba Cloud account used by the node owner.

ProjectId Long 1234

The ID of the workspace to which the node belongs.

ErrorCode String 1031203110005

The error code returned.

ErrorMessage String The specified parameters are invalid.

The error message returned.

HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String 0000-ABCD-E****

The ID of the request. You can use the ID to troubleshoot issues.

Success String true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListNodesByBaseline
&BaselineId=1234
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-E****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <Owner>9527952****</Owner>
    <NodeName>Node name</NodeName>
    <ProjectId>1234</ProjectId>
    <NodeId>1234</NodeId>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "0000-ABCD-E****",
    "HttpStatusCode": 200,
    "Data": {
        "Owner": "9527952****",
        "NodeName": "Node name"
        "ProjectId": 1234,
        "NodeId": 1234
    },
    "ErrorCode": 1031203110005,
    "ErrorMessage": "The specified parameters are invalid.",
    "Success": true
}

Error codes

Http status code Error code Error message Description
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. The error message returned because the DataWorks API is unavailable in this region. Try another region.
500 Forbidden.Wkbench.BaselineNoPermission You are not authorized to access the baseline. The error message returned because you have no permissions on the baseline.
500 Forbidden.Wkbench.ProjectNoPermission You are not authorized to access the workspace. The error message returned because you have no permissions on the workspace.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal system error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal system error has occurred. Try again later.
500 InternalError.Wkbench.ServiceError An internal error occurred. The error message returned because an error has occurred on the service.
500 Invalid.Wkbench.Parameter The specified parameters are invalid. The error message returned because the values specified for one or more parameters are invalid.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the number of requests per day for the resource has exceeded the upper limit.
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. The error message returned because the maximum number of times that you can use the resource has been reached. Submit a ticket for help.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500 Invalid.Wkbench.BaselineNotExist The baseline does not exist. The error message returned because the baseline does not exist.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or Ultimate Edition.

For a list of error codes, visit the API Error Center.