ListSemanticJobs-DataWorks(DataWorks)-阿里云帮助中心

Queries the semantic node definitions of the current tenant with paging. The Name, ProjectId, and Source fields in the list items can be used for running/deleting nodes, querying run details, and verifying input scope, respectively.

Operation description

Scenarios

Queries the saved semantic node definitions of the current tenant with paging. Use this operation to display the node list, select a node to run, or obtain the workspace to which a node belongs.

Invoke flow

Use PageNumber and PageSize to read Data.SemanticJobs with paging.
Use the Name field of a list item to invoke RunSemanticJob, DeleteSemanticJob, or ListSemanticJobRuns.
Use the ProjectId field of a list item together with ExecutorJobId to invoke the details, log, and stop operations.

Notes

This operation returns node definitions, not real-time run statuses. To query run statuses, invoke ListSemanticJobRuns.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number, starting from 1. If this parameter is not specified or is set to a value less than or equal to 0, page 1 is returned.	1
PageSize	integer	No	The number of job definitions per page. If this parameter is not specified or is set to a value less than or equal to 0, the default value 50 is used. Maximum value: 200.	50

Construct the call parameters based on the descriptions of each request field.

Response elements

Element	Type	Description	Example
	object	The standard response for paging query of node definitions. Each item in Data.SemanticJobs is a node definition that is active for subsequent runs or queries.
RequestId	string	The request ID. Used for locating logs and troubleshooting issues.	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	Indicates whether the request was successful.
Data	object	The paginated result of job definitions. Use the Name field of a list item to run, delete, query run records, or download results. Use the ProjectId field to query run details, logs, or stop a run.
TotalCount	integer	The total number of job definitions that meet the conditions in the current tenant.	1
PageNumber	integer	The page number returned, starting from 1.	1
PageSize	integer	The number of job definitions per page returned.	50
SemanticJobs	array<object>	The list of job definitions.
	array<object>	A saved semantic job definition. The fields have the same meanings as those in the Data parameter of CreateSemanticJob.
Id	integer	The internal unique ID of the task definition.	1
Name	string	The task name. Used for RunSemanticJob, DeleteSemanticJob, ListSemanticJobRuns, and DownloadSemanticResults.	semantic-job-demo
UserId	string	The user ID of the semantic task creator.	user-demo
Creator	string	The user ID of the semantic task creator.	user-demo
ProjectId	integer	The workspace ID to which the task belongs. Used for GetSemanticJobDetail, GetSemanticJobLog, and KillSemanticJob.	100
Type	string	The Source.type data source type saved in the task.	maxcompute
Source	object	The input datasource config saved in the node. This configuration determines the analysis scope at runtime.
ReferenceFileIds	array	The list of uploaded file IDs associated with the task.
	string	The optional list of uploaded reference file IDs.	semantic-job-value
ReferenceFileUris	array	The list of external reference file URIs associated with the task.
	string	The optional list of accessible reference file URIs.	semantic-job-value
GmtCreate	integer	The creation time, expressed as a UNIX timestamp in milliseconds.	1700000000000
GmtModified	integer	The last modification time, expressed as a UNIX timestamp in milliseconds.	1700000000000
ResourceGroupId	string	The ID of the resource group used to run this task.	rg-demo

Refer to the field descriptions for the meanings of response fields and their relationships to subsequent calls.

Examples

Success response

JSON format

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 50,
    "SemanticJobs": [
      {
        "Id": 1,
        "Name": "semantic-job-demo",
        "UserId": "user-demo",
        "Creator": "user-demo",
        "ProjectId": 100,
        "Type": "maxcompute",
        "Source": {
          "test": "test",
          "test2": 1
        },
        "ReferenceFileIds": [
          "semantic-job-value"
        ],
        "ReferenceFileUris": [
          "semantic-job-value"
        ],
        "GmtCreate": 1700000000000,
        "GmtModified": 1700000000000,
        "ResourceGroupId": "rg-demo"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.