ListLhTaskFlowAndScenario API Overview - Data Management - Alibaba Cloud - Data Management

Queries the task flow list corresponding to business scenarios in a DMS data warehouse development project workspace.

Operation description

Before you begin: You must have access permissions on the target project workspace. If you do not have access permissions on the project workspace, a DMS administrator, DBA, or storage management administrator can invoke AddLhMembers to add you as a member of the target project workspace.
Additional information: If your user role is DMS administrator or storage management administrator, you can specify a user ID to query the common scenarios and node flow list associated with that user in a project workspace.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListLhTaskFlowAndScenario

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SpaceId	integer	Yes	The project workspace ID (Id). You can call GetLhSpaceByName to obtain this parameter.	24
UserId	integer	No	The user ID. You can call ListUsers or GetUser to obtain this parameter.	51****
Tid	integer	No	The tenant ID. You can call GetUserActiveTenant or ListUserTenants to obtain this parameter.	3***

Response elements

Element	Type	Description	Example
	object
RawDAGList	object
Dag	array<object>	The task flow list of the default business scenario.
	object	The task flow list of the default business scenario.
Id	integer	The task flow ID.	134137****
CreatorId	string	The user ID of the creator.	51****
IsDeleted	boolean	Indicates whether the task flow has been deleted. Valid values: true: Deleted. false: Not deleted.	false
DemoId	string	The extension field. This field is currently not used.	-
DeployId	integer	The ID of the most recent deployment record.	12**
DataFlowId	integer	The extension field. This field is currently not used.	-
ScenarioId	integer	The common scenarios ID.	2**
SpaceId	integer	The project workspace ID.	1
CreatorNickName	string	The nickname of the creator.	Creator_Name
DagOwnerNickName	string	The nickname of the task flow owner.	Owner_Name
CanEdit	boolean	Indicates whether the task flow can be edited. Valid values: true: The task flow can be edited. false: The task flow cannot be edited.	true
Status	integer	The status of the task flow. Valid values: 0: invalid 1: no scheduling configuration 2: waiting for scheduling	2
LatestInstanceStatus	integer	The status of the most recent run record. Valid values: 0: invalid 1: no scheduling configuration 2: waiting for scheduling	0
LatestInstanceTime	integer	The creation time of the most recent run record.	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	object
ScenarioDAG	array<object>	The task flow list of other business scenarios.
	array<object>	The task flow list of the business scenario.
Scenario	object	The business scenario information.
ScenarioName	string	The common scenarios name.	Scenario_2
CreatorId	string	The user ID of the creator.	51****
Description	string	The description.	test
DagList	object
Dag	array<object>	The task flow information list.
	object	The task flow information list.
Id	integer	The task flow ID.	9***
CreatorId	string	The user ID of the creator.	51****
IsDeleted	boolean	Indicates whether the task flow has been deleted. Valid values: true: Deleted. false: Not deleted.	false
DemoId	string	The extension field. This field is currently not used.	-
DeployId	integer	The ID of the most recent deployment record.	12**
DataFlowId	integer	The extension field. This field is currently not used.	-
ScenarioId	integer	The common scenarios ID.	2**
SpaceId	integer	The project workspace ID.	1
CreatorNickName	string	The nickname of the creator.	Creator_Name
DagOwnerNickName	string	The nickname of the task flow owner.	Owner_Name
CanEdit	boolean	Indicates whether the task flow can be edited. Valid values: true: The task flow can be edited. false: The task flow cannot be edited.	true
Status	integer	The status of the task flow. Valid values: 0: invalid 1: no scheduling configuration 2: waiting for scheduling	1
LatestInstanceStatus	integer	The status of the most recent run instance. Valid values: 0: invalid 1: no scheduling configuration 2: waiting for scheduling	1
LatestInstanceTime	integer	The creation time of the most recent run record.	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 request ID.	48602B78-0DDF-414C-8688-70CAB6070115
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.