Viewing category list
- Print
- PDF
Viewing category list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
VOD Station provides an API for searching a list of categories.
Requests
GET https://vodstation.apigw.ntruss.com/api/v2/category
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 |
Search created categories by page
- Example: searching the category list to view 10 categories per page when 30 categories have been created
GET https://vodstation.apigw.ntruss.com/api/v2/category?pageNo=1&pageSizeNo=10
→ Request the first page from a total of 30 categories, separated by 10 per page
GET https://vodstation.apigw.ntruss.com/api/v2/category?pageNo=2&pageSizeNo=10
→ Request the second page from a total of 30 categories, separated by 10 per page
GET https://vodstation.apigw.ntruss.com/api/v2/category?pageNo=3&pageSizeNo=10
→ Request the third page from a total of 30 categories, separated by 10 per page
Request headers
| Header name | Description |
|---|---|
| x-ncp-region_code | NAVER Cloud Platform's region code x-ncp_region_code:{Region Code} |
| 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 | Access key ID value issued by 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[].id | String | ID of the created category | |
| content[].name | String | Category name | |
| content[].encodingOptions[] | Array(Integer) | Encoding option ID | |
| content[].encodingOptionTemplateId | Integer | Encoding template ID | |
| content[].thumbnail | Boolean | Thumbnail extraction settings | |
| content[].notificationUrl | String | Callback URL settings | |
| content[].output | Object | Output settings | |
| content[].output.bucketName | String | Output bucket name | |
| content[].output.filePath | String | Detailed path to upload the output file | |
| content[].output.thumbnailBucketName | String | Thumbnail output bucket name | |
| content[].output.thumbnailFilePath | String | Thumbnail output file upload detailed path | |
| content[].output.accessControl | String | Disclosure scope of the output file | |
| content[].output.thumbnailAccessControl | String | Disclosure scope of the output thumbnail | |
| content[].status | String | Category status | CREATED, DELETED, RUNNING |
| content[].createTime | Integer | Category creation time | |
| content[].updateTime | Integer | Category editing time | |
| content[].disabled | Boolean | Filed provided to sub accounts Resource activation status for the Sub Account | |
| content[].inputTotal | Integer | Total number of input files | |
| content[].lastWorkStart | Integer | Last working time | |
| content[].outputTotal | Integer | Total number of output files | |
| content[].outputTotalSize | Integer | Total size of output file (unit: byte) | |
| content[].outputType | Integer | Number of output types according to the encoding settings | |
| content[].advancedOptions | Object | Advanced settings | |
| content[].advancedOptions.trimming | Object | Output file trimming settings | |
| content[].advancedOptions.trimming.startTimeCode | String | Trimming start point | |
| content[].advancedOptions.trimming.endTimeCode | String | Trimming end point | |
| content[].advancedOptions.imageOverlay | Object | Image overlay settings | |
| content[].advancedOptions.imageOverlay.input | Object | Input image | |
| content[].advancedOptions.imageOverlay.input.bucketName | String | Name of the bucket where the input image has been uploaded | |
| content[].advancedOptions.imageOverlay.input.filePath | String | Detailed path of the input image | |
| content[].advancedOptions.imageOverlay.position | Object | Location settings of image to be inserted | |
| content[].advancedOptions.imageOverlay.position.x | Integer | Location of x-axis | |
| content[].advancedOptions.imageOverlay.position.y | Integer | Location of y-axis | |
| content[].advancedOptions.imageOverlay.size | Obejct | Size settings of image to be inserted | |
| content[].advancedOptions.imageOverlay.size.width | Integer | Image width | |
| content[].advancedOptions.imageOverlay.size.height | Integer | Image height | |
| total | Integer | Total number of categories |
Examples
Request examples
GET https://vodstation.apigw.ntruss.com/api/v2/category
GET /api/v2/category
HOST: vodstation.apigw.ntruss.com
x-ncp-region_code:KR
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": [
{
"disabled": false,
"id": 10095,
"name": "3type-basic-category",
"thumbnail": false,
"output": {
"bucketName": "vs-output",
"filePath": "/"
},
"createTime": 1631594152000,
"updateTime": 1631594152000,
"status": "CREATED",
"outputType": 3,
"encodingOptions": [
1,
2,
3
]
}
],
"total": 1
}
Was this article helpful?