タスク

更新しました

タスク

タスクは、外部サービスとのセッションの確立、データの取得および処理など、API上のすべての非同期ワークロードの実行を担当します。

タスクは通常、セッションリソースの作成の一部として、またはポーリングの実行中に作成されます。

タスクから返されたデータは、関連付けられた結果リソースによって記述されます。

主にシステムおよび組織の管理に関連する一部のタスクは、ユーザー、ソース、またはセッションをターゲットにしていないか、またはポーリングに関連付けられていない可能性があります。この種のタスクの例としては、storageタスクとwebhook configテストタスクがあります。

属性

タイプ説明
id タスクID リソース識別子
resource 文字列、常にtask リソースタイプ指定子
organisation 組織ID リソースが属する組織。
key キーID このタスクに関連付けられているキー。
user オプション、ユーザーID このタスクに関連付けられているユーザー。
source オプション、ソースID このタスクの対象となっているソース。
session オプション、セッションID このタスクによって使用されたセッション。
poll オプション、投票ID このタスクが関連付けられている投票。
source_type オプション、文字列このタスクがターゲットにしているソースのタイプ。
type ひもタスクのタスクタイプ。
target ひもタスクに対する最高レベルの引数。たとえば、 data型タスクは、それが取得しているデータ型をターゲットとして持っています(すなわちmessages.sms )。
state ひも pendingprocessingsuspendedsucceededfailed
results オプション、結果リソースのリストタスクの実行によって公開された結果。
error オプション、文字列エラーコードが発生した場合は、それを入力します。
date_created 日付時刻リソースが作成されたとき
date_started オプション、日時タスク処理が開始されたとき
date_completed オプション、日時タスクの歳差運動が終了したとき。

ソースタイプ

タスクがソースに関連付けられている場合、ソースのタイプはsource_typeタスク属性に非正規化されます。これにより、特定の種類のタスクに対するクエリが簡単になります。

タイプ

タスクタイプは、API内で実行されている基になるタスクを識別する短いスラグです。

タスクがリソースに対する活性に関連する場合、そのようなウェブフックの設定をテストするように、それは次のようにフォーマットされるwebhook_config.test

タスクが特定のソースをターゲットとする場合、 source_type属性はソース関連情報を保存しますが、 type属性はメインアクションのみを保存します。たとえば、セッションを作成すると、タイプicloud.accountソースに対してsession.initタスクが作成されます。

ターゲット

これは基になるタスクのターゲットを指定し、常に設定されるわけではありません。たとえば、 webhook_config.testのターゲットはテストされるwebhook設定のIDになります。 icloud.accountタイプのソースに対するdataタスクの場合は、 icloud.accountように取得されるデータタイプになりmessages.whatsapp

状態

  • pendingタスクは作成されましたが、現在キューで待機しています。
  • タスクのprocessingはAPIワーカーによって実行されています。
  • suspendedたタスクは、ブロックするタスクが完了するのを待ってから続行します。
  • succeededエラーなしで完了したタスクを。
  • failedたタスクでエラーが発生しました。

エラー

処理中にタスクが問題にぶつかった場合、このフィールドは発生したエラーのコードで設定されます。

取得する

GET /tasks/{task ID}

cURLを使う

curl https://ricloud-api.reincubate.com/tasks/<task ID> \
  -H 'Authorization: Token <your key_token>'

* ricloud-py * を使う

import ricloud

task = ricloud.Task.retrieve(<task ID>)

リスト

GET /tasks

パラメーター

タイプ説明
key キーID 関連付けられている組織でフィルタリングします。
user ユーザーID 関連付けられているユーザーでフィルタします。
source ソースID 関連付けられているソースでフィルタします。
session セッションID 関連付けられているセッションでフィルタリングします。
poll 投票ID 所有世論調査でフィルタリングします。
source_type ひもソースタイプでフィルタします。
type ひもタスクの種類でフィルタします。
state ひもタスクの状態で絞り込みます。
date_created 日時フィルターリソース作成日でフィルタします。
date_started 日時フィルタータスクがいつ処理を開始したかでフィルターします。
date_completed 日時フィルタータスクが処理を完了したときにフィルターします。

cURLを使う

curl https://ricloud-api.reincubate.com/tasks \
  -H 'Authorization: Token <your key_token>'

* ricloud-py * を使う

import ricloud

tasks = ricloud.Task.list()

どのように我々は助けることができます?

サポートチームがお手伝いします!

営業時間は月曜日から金曜日の午前9時から午後5時(GMT)です。 時間は現在 2:34 PM GMTです。

1営業日以内に、お返事を差し上げます。メールアドレスはこちら。

サポートセクションに移動 › エンタープライズチームに連絡する ›
私たちの素晴らしいサポートチーム

この記事を改善できますか?

ユーザーからの連絡をお待ちしています。電子メールを送信したり、コメントを残したり、ツイートしたりしないでください。 @reincubate?

© 2008 - 2019 Reincubate Ltd. 無断複写・転載を禁じます。 イングランドとウェールズに登録 #5189175, VAT GB151788978. Reincubate®は登録商標です。 プライバシーと利用規約. マルチファクタ認証をお勧めします。 ロンドンで愛と建てられた。