API 標準および多言語対応の SDK
本製品 (fnf/2019-03-15) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
リージョン
|
API |
タイトル |
説明 |
| DescribeFlow | DescribeFlow | フローに関する情報を取得します。 |
| フローエイリアス | フローエイリアス | |
| ListFlowAliases | ListFlowAliases | フローのエイリアスを一覧表示します。 |
| CreateFlowAlias | CreateFlowAlias | フローのエイリアスを作成します。その後、エイリアスを使用して実行を開始できます。 |
| DescribeFlowAlias | DescribeFlowAlias | フロー エイリアスの詳細を照会します。 |
| UpdateFlowAlias | UpdateFlowAlias | フローのエイリアス構成を更新します。 |
| DeleteFlowAlias | DeleteFlowAlias | フローのエイリアスを削除します。 |
フロー
|
API |
タイトル |
説明 |
| StartExecution | StartExecution | フローの実行を開始します。 |
| StopExecution | StopExecution | フローで実行中の実行を停止します。 |
| DescribeExecution | DescribeExecution | 実行のステータスをクエリします。この操作はロングポーリングをサポートしています。WaitTimeSeconds パラメーターは、最大待機時間を指定します。 |
| ListExecutions | ListExecutions | フローの実行履歴を一覧表示します。 |
| GetExecutionHistory | GetExecutionHistory | 実行プロセスにおける各ステップの詳細をクエリします。 |
| StartSyncExecution | StartSyncExecution | フローの実行を同期的に開始します。 |
| DescribeMapRun | DescribeMapRun | MapRun の詳細を取得します。 |
| UpdateMapRun | UpdateMapRun | MapRun の構成を更新します。 |
実行
|
API |
タイトル |
説明 |
| ReportTaskFailed | ReportTaskFailed | 失敗したタスクを報告します。 |
| ReportTaskSucceeded | ReportTaskSucceeded | 成功したタスクを報告します。 |
タスク
|
API |
タイトル |
説明 |
| CreateSchedule | CreateSchedule | 時間指定スケジュールを作成します。 |
| DeleteSchedule | DeleteSchedule | 時間ベースのスケジューリングタスクを削除します。 |
| UpdateSchedule | UpdateSchedule | 時間ベースのスケジュールを更新します。 |
| DescribeSchedule | DescribeSchedule | 時間ベースのスケジュールの詳細情報を照会します。 |
時間指定スケジューリング
|
API |
タイトル |
説明 |
| CreateFlow | CreateFlow | フローを作成します。 |
| DeleteFlow | DeleteFlow | 既存のフローを削除します。 |
| DeleteFlowVersion | DeleteFlowVersion | フローバージョンを削除します。 |
| DescribeRegions | DescribeRegions | CloudFlow がサポートするリージョンをクエリします。 |
| ListFlowVersions | ListFlowVersions | フローのバージョンを一覧表示します。 |
| ListFlows | ListFlows | 複数のフローに関する情報を取得します。 |
| ListSchedules | ListSchedules | フロー内の時間ベースのスケジュールを照会します。 |
| PublishFlowVersion | PublishFlowVersion | 現在の定義に基づいてフローの新しいバージョンを公開します。フローバージョンには、フローの定義、説明、環境変数設定、および実行ロールが含まれます。バージョン番号は 1 から始まり、新しいバージョンごとに増分します。 |
| UpdateFlow | UpdateFlow | フローのコンテンツを更新します。 |