メディアアセットリストの照会

VPC環境で利用できます。

プロジェクトのメディアアセットリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`pageNum`	Integer	Required	ページ番号 1以上
`pageSize`	Integer	Optional	ページごとの項目数 1~1,000 (デフォルト: 1,000)

リクエスト例

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

curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets?pageNum=1&pageSize=100' \
--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	-	APIリターン情報
`result.content`	Array	-	メディアアセットリスト: content
`result.totalCount`	Integer	-	メディアアセットの総数
`result.totalPage`	Integer	-	ページの総数
`result.pageNo`	Integer	-	ページ番号
`result.pageSize`	Integer	-	ページごとの項目数

`content`

contentの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`assetId`	Integer	-	メディアアセット ID
`fileName`	String	-	メディアファイル名
`projectId`	Integer	-	プロジェクト ID
`metaData`	Object	-	メタデータの詳細情報
`metaData.resolution`	String	-	解像度 <例>`1920x1080`
`metaData.durationMs`	Integer	-	ビデオの長さ(ミリ秒)
`metaData.size`	Integer	-	アセットのファイルサイズ(Byte)
`metaData.format`	String	-	ファイル形式 `mp4` \| `mkv` \| `mov` \| `webm` \| `png` \|`jpg` \| `heic`
`key`	String	-	Object Storageにアップロードしたファイルのフルネーム
`createUserName`	String	-	メディアアセットを登録したユーザー名
`createdTime`	String	-	メディアアセットの登録日時 ISO 8601形式
`updateUserName`	String	-	メディアアセットを最後に更新したユーザー名
`updatedTime`	String	-	メディアアセットの最終更新日時 ISO 8601形式

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

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

レスポンス例

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

{
    "code": "0",
    "message": "success",
    "result": {
        "content": [
            {
                "assetId": 1001,
                "fileName": "sample-video-one.mp4",
                "projectId": 1234,
                "metaData": {
                    "resolution": "1280x720",
                    "durationMs": 91565,
                    "size": 101176289,
                    "format": "mp4"
                },
                "key": "sample-video-one.mp4",
                "createUserName": "user1",
                "createdTime": "2025-04-23T16:49:24",
                "updateUserName": "user1",
                "updatedTime": "2025-04-23T16:49:25"
            },
            {
                "assetId": 1002,
                "fileName": "sample-video-two.mp4",
                "projectId": 1234,
                "metaData": {
                    "resolution": "1920x1080",
                    "durationMs": 253702,
                    "size": 120333399,
                    "format": "mp4"
                },
                "key": "sample-video-two.mp4",
                "createUserName": "user2",
                "createdTime": "2025-04-23T17:13:37",
                "updateUserName": "user2",
                "updatedTime": "2025-04-23T17:13:38"
            },
            {
                "assetId": 1003,
                "fileName": "sample-video-three.mp4",
                "projectId": 1234,
                "metaData": {
                    "resolution": "1920x1080",
                    "durationMs": 293849,
                    "size": 76597066,
                    "format": "mp4"
                },
                "key": "sample-video-three.mp4",
                "createUserName": "user3",
                "createdTime": "2025-04-23T17:13:48",
                "updateUserName": "user3",
                "updatedTime": "2025-04-23T17:13:49"
            }
        ],
        "totalCount": 3,
        "totalPage": 1,
        "pageNo": 1,
        "pageSize": 100
    }
}