メインコンテンツへスキップ
GET
「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

ヘッダー

box-version
enum<string>
必須

Version header.

利用可能なオプション:
2026.0

パスパラメータ

shuttle_run_id
string
必須

Shuttle実行の一意の識別子 ({job_id}:{run_number}形式)。

レスポンス

Shuttle実行を返します。

Shuttleジョブの過去の実行インスタンス。ジョブが開始されるたびに実行が作成されます。実行IDの形式は{job_id}:{run_number}です。

id
string
必須

Shuttle実行の一意の識別子 ({job_id}:{run_number}形式)。

例:

"6a3ba68e810d9156194530a1:42"

type
enum<string>
必須

値は常にshuttle_runになります。

利用可能なオプション:
shuttle_run
例:

"shuttle_run"

job_id
string
必須

この実行が属しているShuttleジョブの一意の識別子。

例:

"6a3ba68e810d9156194530a1"

run_mode
string
必須

実行を開始したときのモード。これは取り得る値が固定されていない文字列で、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、transfer、simulation、analysis、scan、unknownがあります。クライアントは、認識できない値をすべてunknownとして扱う必要があります。

例:

"transfer"

state
string
必須

Shuttle実行の現在の状態。これは取り得る値が固定されていない文字列で、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、running、stopping、completed、completed_with_errors、stopped、failed、timed_out、unknownがあります。クライアントは、認識できない値をすべてunknownとして扱う必要があります。

例:

"completed"

started_at
string<date-time>

実行が開始された日時。

例:

"2026-03-15T02:00:00Z"

ended_at
string<date-time> | null

実行が終了した日時。実行中はnull。

例:

"2026-03-15T06:30:00Z"

duration_seconds
integer<int64> | null

実行の合計所要時間 (秒)。実行中はnull。

例:

16200

stats
object

実行中に収集された転送に関する統計情報。

created_by
ユーザー (Base) · object

実行を開始したユーザー。スケジュールまたはシステムによって開始された実行の場合はnull。

例:
available_report_sections
string[]

この実行についてリクエストできるレポートセクション。これは取り得る値が固定されていないリストで、今後新しい値が追加されることが想定されています。現在ドキュメント化されている値には、files_and_folders、event_log、transfer_overview、source_users、target_users、source_collaborators、target_collaborators、source_collaborations、target_collaborationsがあります。

この実行で利用可能なレポートセクション。

例:
最終更新日 2026年11月4日