ListLhTaskFlowAndScenario - Data Management - Alibaba Cloud Documentation Center

Queries the information about task flows in the business scenarios of a workspace in Data Management (DMS).

Operation description

Before you call this operation, make sure that you have the access permissions on the workspace. If you do not have the access permissions on the workspace, you can contact a DMS administrator, database administrator (DBA), or workspace administrator to add you as a member of the workspace. The AddLhMembers operation can be called to add a workspace member.
If you are a DMS administrator or a workspace administrator, you can query the business scenarios and task flows related to a user in a workspace based on the user ID.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SpaceId	long	Yes	The ID of the workspace. You can call the GetLhSpaceByName operation to obtain the workspace ID.	24
UserId	long	No	The ID of the user. You can call the ListUsers or GetUser operation to obtain the user ID.	51****
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	3***

Response parameters

Parameter	Type	Description	Example
	object
RawDAGList	array<object>	The task flows in the default business scenario.
Dag	object
Id	long	The ID of the task flow.	134137****
CreatorId	string	The ID of the user who creates the task flow.	51****
IsDeleted	boolean	Indicates whether the task flow is deleted. Valid values: true: deleted false: not deleted	false
DemoId	string	The extended field. No meaning is specified for this field.	-
DeployId	long	The ID of the latest deployment record.	12**
DataFlowId	long	The extended field. No meaning is specified for this field.	-
ScenarioId	long	The ID of the business scenario.	2**
SpaceId	long	The ID of the workspace.	1
CreatorNickName	string	The name of the user who creates the workspace.	Creator_Name
DagOwnerNickName	string	The name of the task flow owner.	Owner_Name
CanEdit	boolean	Indicates whether the task flow can be modified. Valid values: true: The task flow can be modified. false: The task flow cannot be modified.	true
Status	integer	The status of the task flow. Valid values: 0: invalid 1: scheduling disabled 2: waiting to be scheduled	2
LatestInstanceStatus	integer	The status of the latest execution. Valid values: 0: invalid 1: scheduling disabled 2: waiting to be scheduled	0
LatestInstanceTime	integer	The time when the latest execution record was generated.	2022-04-14
DagName	string	The name of the task flow.	Dag_Name
DagOwnerId	string	The user ID of the task flow owner.	51****
ScenarioDAGList	array<object>	The task flows in other business scenarios.
ScenarioDAG	object
Scenario	object	The information about the business scenario.
ScenarioName	string	The name of the business scenario.	Scenario_2
CreatorId	string	The ID of the user who creates the business scenario.	51****
Description	string	The description of the business scenario.	test
DagList	array<object>	The list of task flows.
Dag	object
Id	long	The ID of the task flow.	9***
CreatorId	string	The ID of the user who creates the task flow.	51****
IsDeleted	boolean	Indicates whether the task flow is deleted. Valid values: true: deleted false: not deleted	false
DemoId	string	The extended field. No meaning is specified for this field.	-
DeployId	long	The ID of the latest deployment record.	12**
DataFlowId	long	The extended field. No meaning is specified for this field.	-
ScenarioId	long	The ID of the business scenario.	2**
SpaceId	long	The ID of the workspace.	1
CreatorNickName	string	The name of the user who creates the workspace.	Creator_Name
DagOwnerNickName	string	The name of the task flow owner.	Owner_Name
CanEdit	boolean	Indicates whether the task flow can be modified. Valid values: true: The task flow can be modified. false: The task flow cannot be modified.	true
Status	integer	The status of the task flow. Valid values: 0: invalid 1: scheduling disabled 2: waiting to be scheduled	1
LatestInstanceStatus	integer	The status of the latest execution. Valid values: 0: invalid 1: scheduling disabled 2: waiting to be scheduled	1
LatestInstanceTime	integer	The time when the latest execution record was generated.	2022-04-14
DagName	string	The name of the task flow.	Dag_Name
DagOwnerId	string	The user ID of the task flow owner.	51****
RequestId	string	The ID of the request.	48602B78-0DDF-414C-8688-70CAB6070115
ErrorCode	string	The error code returned if the request fails.	UnknownError
ErrorMessage	string	The error message returned if the request fails.	UnknownError
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Sample success responses

JSONformat

{
  "RawDAGList": {
    "Dag": [
      {
        "Id": 0,
        "CreatorId": "51****",
        "IsDeleted": false,
        "DemoId": "-",
        "DeployId": 0,
        "DataFlowId": 0,
        "ScenarioId": 0,
        "SpaceId": 1,
        "CreatorNickName": "Creator_Name",
        "DagOwnerNickName": "Owner_Name",
        "CanEdit": true,
        "Status": 2,
        "LatestInstanceStatus": 0,
        "LatestInstanceTime": 0,
        "DagName": "Dag_Name",
        "DagOwnerId": "51****"
      }
    ]
  },
  "ScenarioDAGList": {
    "ScenarioDAG": [
      {
        "Scenario": {
          "ScenarioName": "Scenario_2",
          "CreatorId": "51****",
          "Description": "test"
        },
        "DagList": {
          "Dag": [
            {
              "Id": 0,
              "CreatorId": "51****",
              "IsDeleted": false,
              "DemoId": "-",
              "DeployId": 0,
              "DataFlowId": 0,
              "ScenarioId": 0,
              "SpaceId": 1,
              "CreatorNickName": "Creator_Name",
              "DagOwnerNickName": "Owner_Name",
              "CanEdit": true,
              "Status": 1,
              "LatestInstanceStatus": 1,
              "LatestInstanceTime": 0,
              "DagName": "Dag_Name",
              "DagOwnerId": "51****"
            }
          ]
        }
      }
    ]
  },
  "RequestId": "48602B78-0DDF-414C-8688-70CAB6070115",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history