NAKATAKU ENGINE Docsv1.0https://stg.api.engine.nakataku.ai/v1.0Consoleへ戻る
ドキュメントメニュー

getRun

非同期 run を取得する

GET/v1.0/runs/{runId}
Schema preview / 現在は一般提供されていません

1 operationはOpenAPIでschema-onlyとして公開されています。このReferenceからAPI requestは送信できません。

Authentication

すべてのrequestはX-Api-Key headerを使用します。schema-onlyのため、このページにcredential入力やlive requestはありません。

Parameters

NameInTypeDescription
runIdrequiredpathstringrun_id は取得する stable な durable run ID である。
X-Request-Idheaderstring要求相関 ID。省略時は Gateway が生成する。

Request body

Schemaは定義されていません。

Responses and errors

200公開 run snapshot を返す。
v1PublicLifecycleServiceGetRunResponse

PublicGetRunResponse は現在の公開 run snapshot を返す。

FieldTypeDescription
runv1PublicRunrun は node や SecurityContext を含まない公開 projection である。
400公開 request の形式、必須項目、または範囲が不正である。
v1PublicError

PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。

FieldTypeDescription
codestringcode は公開 API で安定した machine-readable error code である。
messagestringmessage は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。
requestIdstringrequest_id は response header の X-Request-Id と同じ要求相関 ID である。
docsUrlstringdocs_url は関連する公開文書が存在する場合だけ設定する URL である。
quotaExceededv1PublicQuotaExceededquota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。
401API key を検証できない。
v1PublicError

PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。

FieldTypeDescription
codestringcode は公開 API で安定した machine-readable error code である。
messagestringmessage は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。
requestIdstringrequest_id は response header の X-Request-Id と同じ要求相関 ID である。
docsUrlstringdocs_url は関連する公開文書が存在する場合だけ設定する URL である。
quotaExceededv1PublicQuotaExceededquota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。
404run が存在しない、または security workspace から参照できない。
v1PublicError

PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。

FieldTypeDescription
codestringcode は公開 API で安定した machine-readable error code である。
messagestringmessage は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。
requestIdstringrequest_id は response header の X-Request-Id と同じ要求相関 ID である。
docsUrlstringdocs_url は関連する公開文書が存在する場合だけ設定する URL である。
quotaExceededv1PublicQuotaExceededquota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。
429rate limit または quota を超過した。
v1PublicError

PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。

FieldTypeDescription
codestringcode は公開 API で安定した machine-readable error code である。
messagestringmessage は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。
requestIdstringrequest_id は response header の X-Request-Id と同じ要求相関 ID である。
docsUrlstringdocs_url は関連する公開文書が存在する場合だけ設定する URL である。
quotaExceededv1PublicQuotaExceededquota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。
500予期しない内部失敗が発生した。
v1PublicError

PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。

FieldTypeDescription
codestringcode は公開 API で安定した machine-readable error code である。
messagestringmessage は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。
requestIdstringrequest_id は response header の X-Request-Id と同じ要求相関 ID である。
docsUrlstringdocs_url は関連する公開文書が存在する場合だけ設定する URL である。
quotaExceededv1PublicQuotaExceededquota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。
503credential provider が一時的に利用できない。
v1PublicError

PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。

FieldTypeDescription
codestringcode は公開 API で安定した machine-readable error code である。
messagestringmessage は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。
requestIdstringrequest_id は response header の X-Request-Id と同じ要求相関 ID である。
docsUrlstringdocs_url は関連する公開文書が存在する場合だけ設定する URL である。
quotaExceededv1PublicQuotaExceededquota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。