検索アセット Presigned URLの発行

Prev Next

VPC環境で利用できます。

検索に活用する画像をアップロードするための Presigned URLを発行します。

参考
  • 発行された Presigned URLは15分間有効で、1回に限り使用できます。
  • 一度にアップロード可能な画像ファイルは1個までです。
  • ファイル規格は次の通りです。
    • 形式: jpg、png、webp、heic
    • 最大サイズ: 5MB
    • 最小解像度: 224px以上
  • 1分当たり50回まで呼び出すことができます。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
assetType String Required アセットタイプ
  • IMAGE
    • IMAGE: 画像
assetFileName String Required アップロードする画像ファイル名
  • <例> search_image.jpg

リクエスト例

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

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/query-assets/uploads/presigned-url' \
--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 '{
  "assetType": "IMAGE",
  "assetFileName": "search_image.png"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String Required API処理結果コード
message String Required API処理結果メッセージ
result Object Required Presigned URL発行結果オブジェクト
result.assetFileKey String Required Object Storageに保存される画像ファイルのパス
result.presignedUploadUrl String Required アップロード用 Presigned URL
  • 15分間有効
  • 1回に限り使用可能
result.expirationSeconds Integer Required URLの有効時間(単位: 秒)
  • デフォルト: 900

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

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

レスポンス例

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

{
  "code": "0",
  "message": "success",
  "result": {
    "assetFileKey": "images/.../abc.jpg",
    "presignedUploadUrl": "https://kr.object.ncloudstorage.com/.../abc.jpg?...",
    "expirationSeconds": 900
  }
}