Search category status information
- Print
- PDF
Search category status information
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
VOD Station provides an API to search encoding status information of categories.
Requests
GET https://vodstation.apigw.ntruss.com/api/v2/status/{fileId}
Request headers
Header name | Description |
---|---|
x-ncp-apigw-timestamp | - It indicates the time elapsed in milliseconds since January 1, 1970 00:00:00 UTC. - If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. x-ncp-apigw-timestamp:{Timestamp} |
x-ncp-iam-access-key | - Value of access key ID issued in the NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
x-ncp-apigw-signature-v2 | Signature encrypted with the Access Key ID value and Secret Keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
Responses
Field name | Type | Description | Remarks |
---|---|---|---|
error | Object | Responds when a request fails Error response code and message | |
error.code | Integer | Error response code | |
error.message | String | Error response message | |
content | Object | VOD Station OPEN API response object | |
content.categoryId | String | Category ID | |
content.categoryName | String | Category name | |
content.input | Object | Input file object | |
content.input.fileId | Integer | Input file ID | |
content.input.bucketName | String | Input file bucket name | |
content.input.filePath | String | Input file path | |
content.input.metadata | Object | Input file metadata object | |
content.input.metadata.duration | Float | File playback time (unit: seconds) | |
content.input.metadata.videoCodec | String | Video codec | |
content.input.metadata.videoBitrate | Float | Video bitrate (unit: Kbps) | |
content.input.metadata.profile | String | Video profile | |
content.input.metadata.width | Integer | Video width | |
content.input.metadata.height | Integer | Video height | |
content.input.metadata.framerate | String | Video frame rate | |
content.input.metadata.audioCodec | String | Audio codec | |
content.input.metadata.audioBitrate | Float | Audio bitrate (unit: Kbps) | |
content.input.metadata.audioSamplingRate | Float | Audio sampling rate (unit: Hz) | |
content.input.metadata.audioChannel | Integer | Audio channel | |
content.output[] | Array(Object) | Output file information | |
content.output[].encodingOptionId | Integer | Encoding option ID | |
content.output[].outputType | String | Output type information | |
content.output[].objectStorageUrl | String | Object Storage download URL | |
content.output[].fileSizeByte | Long | Size of output file (unit: byte) | |
content.output[].status | String | Encoding result status | COMPLETE, WAITING, RUNNING, FAILURE, CANCELED |
content.output[].percentage | Integer | Encoding progress rate | |
content.output[].metadata | Object | Output file metadata | |
content.output[].metadata.duration | Float | File playback time (unit: seconds) | |
content.output[].metadata.videoCodec | String | Video codec | |
content.output[].metadata.videoBitrate | Float | Video bitrate (unit: Kbps) | |
content.output[].metadata.videoPass | String | Video profile | |
content.output[].metadata.width | Integer | Video width | |
content.output[].metadata.height | Integer | Video height | |
content.output[].metadata.framerate | String | Video frame rate | |
content.output[].metadata.audioCodec | String | Audio codec | |
content.output[].metadata.audioBitrate | Float | Audio bitrate (unit: Kbps) | |
content.output[].metadata.audioSamplingRate | Float | Audio sampling rate (unit: Hz) | |
content.output[].metadata.audioChannel | Integer | Audio channel |
Examples
Request examples
GET https://vodstation.apigw.ntruss.com/api/v2/status/10099
GET /api/v2/status/10099
HOST: vodstation.apigw.ntruss.com
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M==
Response examples
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
{
"content": {
"categoryId": 10221,
"categoryName": "openapi-guide",
"input": {
"fileId": 10099,
"bucketName": "vodstation",
"filePath": "openapi-guide.mov",
"metadata": {
"duration": 10.01,
"videoCodec": "MPEG Video",
"videoBitrate": 5871616,
"width": 1280,
"height": 720,
"framerate": 59.94,
"audioCodec": "PCM",
"audioBitrate": 786432,
"audioSamplingRate": 48000,
"audioChannel": 1
}
},
"output": [
{
"encodingOptionId": 3,
"outputType": "AVC_HD_1Pass_30fps",
"objectStorageUrl": "https://kr.object.ncloudstorage.com/test-vod/add-files-test/openapi-guide/openapi-guide_AVC_HD_1Pass_30fps.mp4",
"status": "COMPLETE",
"metadata": {
"duration": 10.057,
"videoCodec": "avc1",
"videoPass": "ONE_PASS",
"videoBitrate": 188416,
"width": 1280,
"height": 720,
"framerate": 30,
"audioCodec": "AAC",
"audioBitrate": 131072,
"audioSamplingRate": 44100,
"audioChannel": 2
}
},
{
"encodingOptionId": 1,
"outputType": "AVC_SD_1Pass_30fps",
"objectStorageUrl": "https://kr.object.ncloudstorage.com/test-vod/add-files-test/openapi-guide/openapi-guide_AVC_SD_1Pass_30fps.mp4",
"status": "COMPLETE",
"metadata": {
"duration": 10.057,
"videoCodec": "avc1",
"videoPass": "ONE_PASS",
"videoBitrate": 195584,
"width": 480,
"height": 270,
"framerate": 30,
"audioCodec": "AAC",
"audioBitrate": 131072,
"audioSamplingRate": 44100,
"audioChannel": 2
}
},
{
"encodingOptionId": 2,
"outputType": "AVC_SD_1Pass_30fps_1",
"objectStorageUrl": "https://kr.object.ncloudstorage.com/test-vod/add-files-test/openapi-guide/openapi-guide_AVC_SD_1Pass_30fps_1.mp4",
"status": "COMPLETE",
"metadata": {
"duration": 10.057,
"videoCodec": "avc1",
"videoPass": "ONE_PASS",
"videoBitrate": 253952,
"width": 854,
"height": 480,
"framerate": 30,
"audioCodec": "AAC",
"audioBitrate": 131072,
"audioSamplingRate": 44100,
"audioChannel": 2
}
}
]
}
}
Was this article helpful?