アクティブ・タスク

/_active_tasks エンドポイントは、サーバーで実行されているタスクのリストを提供します。これは、システムのパフォーマンスのモニタリングに役立ちます。

圧縮、複製、索引作成タスクなど、アクティブ・タスクのリストが表示されます。 /_active_tasks エンドポイントの他の使用例については、タスクの管理ガイドを参照してください。

アクティブ・タスクのリストの取得

メソッド
GET
パス
/_active_tasks
応答
実行中のタスクのリスト(タスク・タイプ、名前、状況、およびプロセス ID を含む)。
許可される役割
_admin

/_active_tasks URL を使用して、アクティブ・タスクのリストを取得できます。 結果は、現在実行されているタスクの JSON 配列です。タスクごとに 1 つのオブジェクトで記述されています。

HTTP コマンドを使用してアクティブ・タスクを取得する要求の例を示します。

GET /_active_tasks HTTP/1.1

コマンド・ラインを使用してアクティブ・タスクを取得する要求の例を示します。

curl "https://$ACCOUNT.cloudant.com/_active_tasks" \
	-u $ACCOUNT

返される構造体には、タスクごとに以下のフィールドが含まれています。

返された構造体のフィールド
名前 説明
database 操作が行われているデータベースおよびシャード。
pid Erlang プロセス ID
started_on タスクが開始された時刻。 値はUNIX™時刻UTCを含む整数である。
total_changes タスクで処理される文書の総数。 正確な意味は、タスクのタイプによって異なります。
type 操作タイプ
updated_on タスク状況が更新された時刻。 このフィールドは数秒おきに更新されます。 最後の更新時刻が返されます。

type フィールドの取り得る値を次に示します。

  • database_compaction
  • view_compaction
  • replication
  • indexer
  • search_indexer

JSON 応答に含まれる他のフィールドの意味は、タスクのタイプによって異なります。

現在実行中のタスクの詳細が含まれた JSON 応答の配列の例を以下に示します。

[
	{
		"user": null,
		"updated_on": 1363274088,
		"type": "replication",
		"target": "https://repl:*****@tsm.cloudant.com/user-3dglstqg8aq0uunzimv4uiimy/",
		"docs_read": 0,
		"doc_write_failures": 0,
		"doc_id": "tsm-admin__to__user-3dglstqg8aq0uunzimv4uiimy",
		"continuous": true,
		"checkpointed_source_seq": "403-g1AAAADfeJzLYWBgYMlgTmGQS0lKzi9KdUhJMjTRyyrNSS3QS87JL01JzCvRy0styQGqY0pkSLL___9_VmIymg5TXDqSHIBkUj1YUxyaJkNcmvJYgCRDA5AC6tuflZhGrPsgGg9ANAJtzMkCAPFSStc",
		"changes_pending": 134,
		"pid": "<0.1781.4101>",
		"node": "dbcore@db11.julep.cloudant.net",
		"docs_written": 0,
		"missing_revisions_found": 0,
		"replication_id": "d0cdbfee50a80fd43e83a9f62ea650ad+continuous",
		"revisions_checked": 0,
		"source": "https://repl:*****@tsm.cloudant.com/tsm-admin/",
		"source_seq": "537-g1AAAADfeJzLYWBgYMlgTmGQS0lKzi9KdUhJMjTUyyrNSS3QS87JL01JzCvRy0styQGqY0pkSLL___9_VmI9mg4jXDqSHIBkUj1WTTityWMBkgwNQAqob39WYhextkE0HoBoBNo4MQsAFuVLVQ",
		"started_on": 1363274083
	},
	{
		"user": "acceptly",
		"updated_on": 1363273779,
		"type": "indexer",
		"node": "dbcore@db11.julep.cloudant.net",
		"pid": "<0.20723.4070>",
		"changes_done": 189,
		"database": "shards/00000000-3fffffff/acceptly/acceptly_my_chances_logs_live.1321035717",
		"design_document": "_design/MyChancesLogCohortReport",
		"started_on": 1363273094,
		"total_changes": 26389
	},
	{
		"user": "username",
		"updated_on": 1371118433,
		"type": "search_indexer",
		"total_changes": 5466,
		"node": "dbcore@db7.meritage.cloudant.net",
		"pid": "<0.29569.7037>",
		"changes_done": 4611,
		"database": "shards/40000000-7fffffff/username/database_name",
		"design_document": "_design/lucene",
		"index": "search1",
		"started_on": 1371118426
	},
	{
		"view": 1,
		"user": "acceptly",
		"updated_on": 1363273504,
		"type": "view_compaction",
		"total_changes": 26095,
		"node": "dbcore@db11.julep.cloudant.net",
		"pid": "<0.21218.4070>",
		"changes_done": 20000,
		"database": "shards/80000000-bfffffff/acceptly/acceptly_my_chances_logs_live.1321035717",
		"design_document": "_design/MyChancesLogCohortReport",
		"phase": "view",
		"started_on": 1363273094
	},
	{
		"updated_on": 1363274040,
		"node": "dbcore@db11.julep.cloudant.net",
		"pid": "<0.29256.4053>",
		"changes_done": 272195,
		"database": "shards/00000000-3fffffff/heroku/app3245179/id_f21a08b7005e_logs.1346083461",
		"started_on": 1363272496,
		"total_changes": 272195,
		"type": "database_compaction"
	}
]

圧縮タスクに固有の応答フィールド

コンパクション・タスクのレスポンス・フィールド
名前 説明
changes_done 圧縮された文書の数。
phase 圧縮の段階を報告します。
total_changes データベース内の文書の数。

phase フィールドの値は、圧縮が到達した段階を示しています。

ids
文書の圧縮が進行中です。
views
圧縮の表示が進行中です。

複製タスクに固有の応答フィールド

レプリケーション・タスクのレスポンス・フィールド
名前 説明
changes_pending ターゲット・データベースで変更する必要がある文書の数。整数で表されます。
continuous 継続的な複製であるかどうかを示すブール値。
docs_read ソース・データベースから読み取られた文書の数。整数で表されます。
replication_id タスクのキャンセルに使用できる固有の複製 ID ストリング。
revisions_checked ターゲット・データベースに既に存在するかどうかを検査済みの文書リビジョンの数。
source タスクの複製元のデータベースを示す URL ストリングが難読化されたもの。
target タスクの複製先のデータベースを示す URL ストリングが難読化されたもの。
user 複製を開始したユーザー。ストリングで表されます。ユーザーによって開始された複製でない場合は null です。

索引作成タスクに固有の応答フィールド

インデックス作成タスクのレスポンス・フィールド
名前 説明
changes_done このタスクで処理された文書リビジョンの数。 1 つの文書に 1 つ以上のリビジョンがあります。
design_document ビュー関数または索引関数が入った設計文書。
total_changes 索引が作成されていないプロセスの変更の数。 この数には、削除された文書が含まれます。ただし、インデクサーはそれらの文書を自動的にスキップします。