検索アセットアップロード状態の照会

Prev Next

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

VPC環境で利用できます。

Presigned URLから検索用画像をアップロードし、その画像のアップロード完了状態を確認します。

参考
  • 呼び出し制限: 1分当たり1,000件

リクエスト

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

メソッド URI
POST /api/v1/query-assets/uploads/complete

リクエストヘッダ

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

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

リクエストパスパラメータはありません。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
assetKey String Required アップロードが完了したかどうかを確認する画像ファイルのキー値

リクエスト例

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

curl --location --request POST 'https://maiu.apigw.ntruss.com/api/v1/query-assets/uploads/complete' \
--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' \
--data '{
  "assetKey": "images/.../query_image.jpg"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String Required API処理結果コード
message String Required API処理結果メッセージ
result Object Required アップロード状態の結果

result

フィールド タイプ 必須の有無 説明
assetKey String Required アップロードされた画像ファイルのキー値
  • HEIC形式のファイルの場合、JPGに変換されたファイルのキー値が返されます。
uploadStatus String Required アップロード状態
  • COMPLETED: 画像が正常にアップロードされる
  • FAILED: アップロード失敗。失敗の理由はuploadMessageで確認
uploadMessage String Optional アップロード失敗時の詳細メッセージ
  • FILE_NOT_EXIST: アップロードされたファイルが見つからない
  • OVER_SIZE_LIMIT: 画像ファイルが5MBを超える
  • RESOLUTION_NOT_SUPPORT: 画像の解像度が224px未満

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

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

レスポンス例

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

{
  "code": "0",
  "message": "success",
  "result": {
    "assetKey": "images/.../query_image.jpg",
    "uploadStatus": "COMPLETED",
    "uploadMessage": null
  }
}
参考
  • 呼び出し制限: APIは、1分当たり1,000回まで呼び出すことができます。
  • お問い合わせ: 呼び出し数の調整が必要な場合、サポートにお問い合わせください。