All Products
Search
Document Center

Data Management:ListLhTaskFlowAndScenario

Last Updated:Feb 27, 2024

Queries the task flows corresponding to a specific business scenario in 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:ListLhTaskFlowAndScenarioRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SpaceIdlongYes

The ID of the workspace. You can call the GetLhSpaceByName operation to obtain the workspace ID.

24
UserIdlongNo

The ID of the user. You can call the ListUsers or GetUser operation to obtain the user ID.

51****
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

3***

Response parameters

ParameterTypeDescriptionExample
object
RawDAGListobject []

The task flows in the default business scenario.

Idlong

The ID of the task flow.

134137****
CreatorIdstring

The ID of the user who creates the task flow.

51****
IsDeletedboolean

Indicates whether the task flow is deleted. Valid values:

  • true: deleted
  • false: not deleted
false
DemoIdstring

The extended field. No meaning is specified for this field.

-
DeployIdlong

The ID of the latest deployment record.

12**
DataFlowIdlong

The extended field. No meaning is specified for this field.

-
ScenarioIdlong

The ID of the business scenario.

2**
SpaceIdlong

The ID of the workspace.

1
CreatorNickNamestring

The name of the user who creates the workspace.

Creator_Name
DagOwnerNickNamestring

The name of the task flow owner.

Owner_Name
CanEditboolean

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
Statusinteger

The status of the task flow. Valid values:

  • 0: invalid
  • 1: scheduling disabled
  • 2: waiting to be scheduled
2
LatestInstanceStatusinteger

The status of the latest execution. Valid values:

  • 0: invalid
  • 1: scheduling disabled
  • 2: waiting to be scheduled
0
LatestInstanceTimeinteger

The time when the latest execution record was generated.

2022-04-14
DagNamestring

The name of the task flow.

Dag_Name
DagOwnerIdstring

The user ID of the task flow owner.

51****
ScenarioDAGListobject []

The task flows in other business scenarios.

Scenarioobject

The information about the business scenario.

ScenarioNamestring

The name of the business scenario.

Scenario_2
CreatorIdstring

The ID of the user who creates the business scenario.

51****
Descriptionstring

The description of the business scenario.

test
DagListobject []

The list of task flows.

Idlong

The ID of the task flow.

9***
CreatorIdstring

The ID of the user who creates the task flow.

51****
IsDeletedboolean

Indicates whether the task flow is deleted. Valid values:

  • true: deleted
  • false: not deleted
false
DemoIdstring

The extended field. No meaning is specified for this field.

-
DeployIdlong

The ID of the latest deployment record.

12**
DataFlowIdlong

The extended field. No meaning is specified for this field.

-
ScenarioIdlong

The ID of the business scenario.

2**
SpaceIdlong

The ID of the workspace.

1
CreatorNickNamestring

The name of the user who creates the workspace.

Creator_Name
DagOwnerNickNamestring

The name of the task flow owner.

Owner_Name
CanEditboolean

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
Statusinteger

The status of the task flow. Valid values:

  • 0: invalid
  • 1: scheduling disabled
  • 2: waiting to be scheduled
1
LatestInstanceStatusinteger

The status of the latest execution. Valid values:

  • 0: invalid
  • 1: scheduling disabled
  • 2: waiting to be scheduled
1
LatestInstanceTimeinteger

The time when the latest execution record was generated.

2022-04-14
DagNamestring

The name of the task flow.

Dag_Name
DagOwnerIdstring

The user ID of the task flow owner.

51****
RequestIdstring

The ID of the request.

48602B78-0DDF-414C-8688-70CAB6070115
ErrorCodestring

The error code returned if the request fails.

UnknownError
ErrorMessagestring

The error message returned if the request fails.

UnknownError
Successboolean

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 timeSummary of changesOperation
No change history