ListLhTaskFlowAndScenario API 概要 - DMS

Data Management (DMS) のワークスペース内のビジネスシナリオにおけるタスクフローの情報をクエリします。

操作説明

この操作を呼び出す前に、ワークスペースへのアクセス権限があることを確認してください。ワークスペースへのアクセス権限がない場合は、DMS 管理者、データベース管理者 (DBA)、またはワークスペース管理者に連絡し、ワークスペースのメンバーとして追加してもらってください。AddLhMembers 操作を呼び出して、ワークスペースメンバーを追加できます。
DMS 管理者またはワークスペース管理者の場合は、ユーザー ID を指定して、ワークスペース内の特定ユーザーに関連するビジネスシナリオおよびタスクフローをクエリできます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:ListLhTaskFlowAndScenario

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SpaceId	integer	必須	ワークスペースの ID です。GetLhSpaceByName 操作を呼び出して、ワークスペース ID を取得できます。	24
UserId	integer	任意	ユーザーの ID です。ListUsers または GetUser 操作を呼び出して、ユーザー ID を取得できます。	51****
Tid	integer	任意	テナントの ID です。GetUserActiveTenant または ListUserTenants 操作を呼び出して、テナント ID を取得できます。	3***

レスポンスフィールド

フィールド	型	説明	例
	object
RawDAGList	object
Dag	array<object>	デフォルトのビジネスシナリオ内のタスクフローです。
	object
Id	integer	タスクフローの ID です。	134137****
CreatorId	string	タスクフローを作成したユーザーの ID です。	51****
IsDeleted	boolean	タスクフローが削除されたかどうかを示します。有効な値は次のとおりです。 true：削除済み false：未削除	false
DemoId	string	拡張フィールドです。このフィールドには特定の意味はありません。	-
DeployId	integer	最新のデプロイメントレコードの ID です。	12**
DataFlowId	integer	拡張フィールドです。このフィールドには特定の意味はありません。	-
ScenarioId	integer	ビジネスシナリオの ID です。	2**
SpaceId	integer	ワークスペースの ID です。	1
CreatorNickName	string	ワークスペースを作成したユーザーの名前です。	Creator_Name
DagOwnerNickName	string	タスクフローのオーナー名です。	Owner_Name
CanEdit	boolean	タスクフローを変更できるかどうかを示します。有効な値は次のとおりです。 true：タスクフローを変更できます。 false：タスクフローを変更できません。	true
Status	integer	タスクフローのステータスです。有効な値は次のとおりです。 0：無効 1：スケジューリング無効 2：スケジューリング待ち	2
LatestInstanceStatus	integer	最新の実行ステータスです。有効な値は次のとおりです。 0：無効 1：スケジューリング無効 2：スケジューリング待ち	0
LatestInstanceTime	integer	最新の実行レコードが生成された時刻です。	2022-04-14
DagName	string	タスクフローの名前です。	Dag_Name
DagOwnerId	string	タスクフローのオーナーのユーザー ID です。	51****
ScenarioDAGList	object
ScenarioDAG	array<object>	その他のビジネスシナリオ内のタスクフローです。
	array<object>
Scenario	object	ビジネスシナリオに関する情報です。
ScenarioName	string	ビジネスシナリオの名前です。	Scenario_2
CreatorId	string	ビジネスシナリオを作成したユーザーの ID です。	51****
Description	string	ビジネスシナリオの説明です。	test
DagList	object
Dag	array<object>	タスクフローのリストです。
	object
Id	integer	タスクフローの ID です。	9***
CreatorId	string	タスクフローを作成したユーザーの ID です。	51****
IsDeleted	boolean	タスクフローが削除されたかどうかを示します。有効な値は次のとおりです。 true：削除済み false：未削除	false
DemoId	string	拡張フィールドです。このフィールドには特定の意味はありません。	-
DeployId	integer	最新のデプロイメントレコードの ID です。	12**
DataFlowId	integer	拡張フィールドです。このフィールドには特定の意味はありません。	-
ScenarioId	integer	ビジネスシナリオの ID です。	2**
SpaceId	integer	ワークスペースの ID です。	1
CreatorNickName	string	ワークスペースを作成したユーザーの名前です。	Creator_Name
DagOwnerNickName	string	タスクフローのオーナー名です。	Owner_Name
CanEdit	boolean	タスクフローを変更できるかどうかを示します。有効な値は次のとおりです。 true：タスクフローを変更できます。 false：タスクフローを変更できません。	true
Status	integer	タスクフローのステータスです。有効な値は次のとおりです。 0：無効 1：スケジューリング無効 2：スケジューリング待ち	1
LatestInstanceStatus	integer	最新の実行ステータスです。有効な値は次のとおりです。 0：無効 1：スケジューリング無効 2：スケジューリング待ち	1
LatestInstanceTime	integer	最新の実行レコードが生成された時刻です。	2022-04-14
DagName	string	タスクフローの名前です。	Dag_Name
DagOwnerId	string	タスクフローのオーナーのユーザー ID です。	51****
RequestId	string	リクエストの ID です。	48602B78-0DDF-414C-8688-70CAB6070115
ErrorCode	string	リクエストが失敗した場合に返されるエラーコードです。	UnknownError
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージです。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。有効な値は次のとおりです。 true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。