OpenSearch:Video snapshot

サービス

• 認証情報が取得されていること。

  API を使用して AI Search オープンプラットフォームサービスを呼び出す際には、呼び出し元の ID を認証する必要があります。

• サービスアクセスアドレスが取得されていること。

  サービスは、インターネットまたは Virtual Private Cloud (VPC) 経由で呼び出すことができます。詳細については、「サービス登録アドレスの取得」をご参照ください。

非同期タスクの作成

リクエストメソッド：POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/video-snapshot/{service_id}/async

• host：サービスのエンドポイント。API サービスはインターネットまたは VPC 経由で呼び出すことができます。詳細については、「サービスアクセスアドレスの取得」をご参照ください。

• workspace_name：ワークスペースの名前。例：default。

• service_id：組み込みのサービス ID。例：ops-video-snapshot-001。

リクエストパラメーター

レスポンスパラメーター

cURL リクエストの例

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Your API-KEY>" \
  "http://***-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/video-snapshot/ops-video-snapshot-001/async"
  --data '{
    "input":{
        "oss" : "oss://<BUCKET_NAME>/test.mp4"
    },
    "parameters" : {
    },
    "output": {
        "type":"oss",
        "oss" :"oss://<BUCKET_NAME>/result/path"
    }
  }' \ 

レスポンスの例

{
  "request_id":"de81e152284a2d3b1f4315d*******",
  "latency":21,
  "usage":{},
  "result":{
        "task_id":"snapshot-20250617102142-110841*******-*******",
        "status":"PENDING"
            }
 }

非同期タスクのステータス取得

リクエストメソッド：GET

URL

{host}/v3/openapi/workspaces/{workspace_name}/video-snapshot/{service_id}/async/task-status?task_id={task_id}

• host：サービスのエンドポイント。API サービスはインターネットまたは VPC 経由で呼び出すことができます。詳細については、「サービスアクセスアドレスの取得」をご参照ください。

• workspace_name：ワークスペースの名前。例：default。

• service_id：組み込みのサービス ID。例：ops-video-snapshot-001。

リクエストパラメーター

レスポンスパラメーター

SnapshotResult

cURL リクエストの例

curl -X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <Your API-KEY>" \
"http://***-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/video-snapshot/ops-video-snapshot-001/async/task-status?task_id=snapshot-20250617102142-1108418170738252-******" \

レスポンスの例

{
  "request_id":"83b423e2e63613a878c369c20******",
  "latency":11,
  "usage":{
      "image":64
          },
  "result":{
      "task_id":"snapshot-20250617102142-1108418170738252-******",
      "status":"SUCCESS",
       "data":[
                {
                  "frame_index": 0,
                  "path": "oss://bucket-name/result/path/snapshot-xxxx-abc-123-xxx/snapshot_0.jpg",
                  "frame_time": 0.0
                },
                ......
                {
                  "frame_index": 1890,
                  "path": "oss://bucket-name/result/path/snapshot-xxxx-abc-123-xxx/snapshot_63.jpg",
                  "frame_time": 63.0
                }                
              ]
            }
}

同期ビデオスナップショットタスクの作成

URL

{host}/v3/openapi/workspaces/{workspace_name}/video-snapshot/{service_id}/sync

• host：サービスのエンドポイント。API サービスはインターネットまたは VPC 経由で呼び出すことができます。詳細については、「サービスアクセスアドレスの取得」をご参照ください。

• workspace_name：ワークスペースの名前。例：default。

• service_id：組み込みのサービス ID。例：ops-video-snapshot-001。

リクエストパラメーター

レスポンスパラメーター

cURL リクエストの例

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Your API-KEY>" \
  "http://***-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/video-snapshot/ops-video-snapshot-001/sync"
  --data '{
    "input":{
        "oss" : "oss://<BUCKET_NAME>/test.mp4"
    },
    "parameters" : {
    },
    "output": {
        "type":"oss",
        "oss" :"oss://<BUCKET_NAME>/result/path"
    }
  }' \ 

レスポンスの例

{
  "request_id":"83b423e2e63613a878c369c20******",
  "latency":11,
  "usage":{
      "image":64
          },
  "result":{
      "task_id":"snapshot-20250617102142-1108418170738252-b******",
      "status":"SUCCESS",
       "data":[
                {
                  "frame_index": 0,
                  "path": "oss://bucket-name/result/path/snapshot-xxxx-abc-123-xxx/snapshot_0.jpg",
                  "frame_time": 0.0
                },
                ......
                {
                  "frame_index": 1890,
                  "path": "oss://bucket-name/result/path/snapshot-xxxx-abc-123-xxx/snapshot_63.jpg",
                  "frame_time": 63.0
                }                
              ]
            }
}

ステータスコードの説明

リクエストが失敗した場合、レスポンスにはエラーの原因を示す `code` と `message` が含まれます。

{
    "request_id": "6F33AFB6-A35C-4DA7-AFD2-9EA16CCF****",
    "latency": 2.0,
    "code": "InvalidParameter",
    "http_code": 400,
    "message": "JSON parse error: Cannot deserialize value of type `ImageStorage` from String \"xxx\"
}

ステータスコードの詳細については、「ステータスコードの説明」をご参照ください。