メディアアセット分析状態の照会

VPC環境で利用できます。

メディアアセットの最新の分析(インデクシング)の実行状況を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/index/status' \
--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処理結果メッセージ
`result`	Object	-	分析状態情報
`result.status`	String	-	分析の状態 `BEFORE_ANALYZE` \| `WAIT_ANALYZE` \| `ANALYZING` \| `ANALYZE_COMPLETED` \| `ANALYZE_FAIL` \| `ANALYZE_CANCEL` `BEFORE_ANALYZE`: 分析を行ったことのない初期状態 `WAIT_ANALYZE`: 分析リクエスト完了、実行待ちの状態 `ANALYZING`: 分析が実行中の状態 `ANALYZE_COMPLETED`: 分析がすべて無事完了した状態 `ANALYZE_FAIL`: 分析中にエラーが発生して失敗した状態 `ANALYZE_CANCEL`: ユーザーが分析をキャンセルした状態
`result.statusMessage`	String	-	分析失敗時の詳細なエラーメッセージ
`result.indexId`	Integer	-	インデックス ID 分析完了(`ANALYZE_COMPLETED`)時、返す

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

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

レスポンス例

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

{
    "code": "0",
    "message": "success",
    "result": {
        "status": "ANALYZE_COMPLETED",
        "statusMessage": null,
        "indexId": 23844
    }
}

Documentation Index