GetTableDesignProjectFlow によるスキーマ設計チケットのプロジェクトフロークエリ - DMS

スキーマ設計チケットに関する情報 (チケットの現在のノード、チケットをスキーマ設計ノードに戻せるかどうか、公開戦略など) をクエリします。

今すぐお試しください

この 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:GetTableDesignProjectFlow

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
OrderId	integer	必須	スキーマ設計チケットの ID。ID を取得するには、ListOrders 操作を呼び出します。	95****
Tid	integer	任意	テナント ID。説明テナント ID を表示するには、Data Management (DMS) コンソールに移動し、右上隅にあるプロフィール画像にポインターを合わせます。詳細については、「DMS テナントの管理」トピックの「現在のテナント情報の表示」をご参照ください。	3***

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。リクエスト ID を使用して、ログのクエリや問題のトラブルシューティングを実行できます。	B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773
Success	boolean	リクエストが成功したかどうかを示します。有効な値は次のとおりです。 true false	true
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージ。	UnknownError
ErrorCode	string	リクエストが失敗した場合に返されるエラーコード。	UnknownError
ProjectFlow	object	スキーマ設計プロセスに関する情報。
FlowNodeArray	array<object>	プロセス内のノード。
	object
NodeRole	string	プロセスにおけるノードのロール。 START: チケットが作成されました。 DESIGN: スキーマ作成中です。 PUBLISH: スキーマが公開されました。 END: チケットが完了しました。	DESIGN
NodeTitle	string	ノードのタイトル。	设计阶段
Position	integer	プロセスにおけるノードの位置。値は 1 から始まります。	1
PublishAnchor	boolean	ノードがアンカーノードであるかどうかを示します。スキーマ設計プロセスにはアンカーノードが 1 つだけあり、そのノードでスキーマが公開されます。スキーマがアンカーノードで公開されると、公開後イメージが生成され、DDL メタデータロックが解放されます。	false
BackToDesign	boolean	チケットをスキーマ設計ノードに戻せるかどうかを示します。有効な値は次のとおりです。 1: チケットをスキーマ設計ノードに戻すことができます。 0: チケットをスキーマ設計ノードに戻すことはできません。この値は PUBLISH ノードに対してのみ返されます。	1
CanSkip	boolean	現在のノードをスキップできるかどうかを示します。有効な値は次のとおりです。 1: 現在のノードをスキップできます。 0: 現在のノードをスキップできません。この値は PUBLISH ノードに対してのみ返されます。	0
PublishStrategies	array	利用可能な公開戦略。
	string	公開戦略。 IMMEDIATELY: スキーマを即時公開します。 REGULARLY: スケジュール時刻にスキーマを公開します。	IMMEDIATELY
CurrentPosition	integer	プロセスにおける現在のノードの位置。	2
RuleName	string	スキーマ設計チケットに適用されるセキュリティルールセットの名前。	mysql default
RuleComment	string	スキーマ設計チケットに適用されるセキュリティルールセットの説明。	mysql缺省规则集

例

成功レスポンス

JSONJSON

{
  "RequestId": "B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "ProjectFlow": {
    "FlowNodeArray": [
      {
        "NodeRole": "DESIGN",
        "NodeTitle": "设计阶段",
        "Position": 1,
        "PublishAnchor": false,
        "BackToDesign": true,
        "CanSkip": true,
        "PublishStrategies": [
          "IMMEDIATELY"
        ]
      }
    ],
    "CurrentPosition": 2,
    "RuleName": "mysql default",
    "RuleComment": "mysql缺省规则集"
  }
}

エラーコード

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

変更履歴

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