メディアアセット分析のキャンセル

VPC環境で利用できます。

待機中または実行中のメディアアセット分析をキャンセルします。キャンセルすると、中間成果物はすべて削除されます。

参考

待機中(WAIT_ANALYZE)または実行中(ANALYZING)状態でのみキャンセルできます。それ以外の場合にリクエストを行うと、409エラーが返されます。
進行中の分析の中断はキャンセル(/index/cancel)で処理し、完了したインデックスの削除はインデックスの削除で処理します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v1/workspaces/{workspace_name}/projects/{project_id}/assets/{asset_id}/index/cancel

リクエストヘッダ

Media Intelligence APIで共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`workspace_name`	String	Required	ワークスペース名
`project_id`	String	Required	プロジェクト ID プロジェクトリストの照会を参照
`asset_id`	String	Required	メディアアセット ID メディアアセットリストの照会を参照

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/index/cancel' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	String	-	API処理結果コード
`message`	String	-	API処理結果メッセージ

レスポンスステータスコード

Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。

エラーコード	メッセージ	説明
409	Cannot cancel analysis in the current state	待機中または実行中ではない分析のキャンセルをリクエスト

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "0",
    "message": "success"
}

Documentation Index