Search category status list
- Print
- PDF
Search category status list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
VOD Station provides an API to search the encoding status list of categories.
Requests
GET https://vodstation.apigw.ntruss.com/api/v2/status
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| pageNo | No | Integer | - Page number to request Total page number is total/pageSizeNo | |
| pageSizeNo | No | Integer | Number of categories per page | |
| workStartTimeTo | No | Integer | - Encoding request search end time This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC | |
| workStartTimeFrom | No | Integer | - Encoding request search start time This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC |
Search category status by page
- Example: searching the category status to view 10 files per page when 30 files have been requested to be encoded
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=1&pageSizeNo=10
-> Request the first page from a total of 30 encoding files, separated by 10 per page
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=2&pageSizeNo=10
-> Request the second page from a total of 30 encoding files, separated by 10 per page
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=3&pageSizeNo=10
-> Request the third page from a total of 30 encoding files, separated by 10 per page
Search status of encoding file requested at a certain point in time
GET https://vodstation.apigw.ntruss.com/api/v2/status?workStartTimeTo=1631404800000&workStartTimeFrom=1631491200000
-> Search the requested encoding file status from September 12, 2021 00:00:00 AM GMT to September 13, 2021 00:00:00 AM GMT
Request headers
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | This is the number of milliseconds that have elapsed 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[] | Array(Object) | VOD Station OPEN API response object | |
| content[].categoryId | String | Category ID | |
| content[].categoryName | String | Category name | |
| content[].filePath | String | Input file name | |
| content[].outputType | Integer | Number of output types according to the encoding settings | |
| content[].link | Boolean | - URL to download output file If the output file's disclosure scope is set to "Do not disclose," it may not be accessible. | |
| content[].outputTotalSize | String | Total size of output file (unit: byte) | |
| content[].lastWorkTime | Object | Last working time | |
| content[].status | String | Encoding status | COMPLETE, WAITING, RUNNING, FAILURE, CANCELED |
| content[].percent | String | Encoding progress rate | |
| total | String | Total number of encodings performed |
Examples
Request examples
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=1&pageSizeNo=10
GET /api/v2/status?pageNo=1&pageSizeNo=10
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": 10019,
"categoryName": "test2",
"filePath": "SampleVideo_1280x720_5mb_auto_90fps_abr.mp4",
"outputType": "auto_90fps_abr",
"link": "https://kr.object.ncloudstorage.com/.../SampleVideo_1280x720_5mb_AVC_SD_1Pass_30fps.mp4",
"outputTotalSize": 81040256,
"lastWorkTime": "2021-09-14T15:49:12+0900",
"status": "COMPLETE",
"percent": 100
},
],
"total": 1
}
Was this article helpful?