MENU
      Search category status information

        Search category status information


        Article summary

        VOD Station provides an API to search encoding status information of categories.

        Requests

        GET https://vodstation.apigw.ntruss.com/api/v2/status/{fileId}
        HTTP

        Request headers

        Header nameDescription
        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 portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the Access Key ID value and Secret Key
        x-ncp-apigw-signature-v2:{API Gateway Signature}

        Responses

        Field nameTypeDescriptionRemarks
        errorObjectResponds when a request fails
        Error response code and message
        error.codeIntegerError response code
        error.messageStringError response message
        contentObjectVOD Station OPEN API response object
        content.categoryIdStringCategory ID
        content.categoryNameStringCategory name
        content.inputObjectInput file object
        content.input.fileIdIntegerInput file ID
        content.input.bucketNameStringInput file bucket name
        content.input.filePathStringInput file path
        content.input.metadataObjectInput file metadata object
        content.input.metadata.durationFloatFile playback time (unit: seconds)
        content.input.metadata.videoCodecStringVideo codec
        content.input.metadata.videoBitrateFloatVideo bitrate (unit: Kbps)
        content.input.metadata.profileStringVideo profile
        content.input.metadata.widthIntegerVideo width
        content.input.metadata.heightIntegerVideo height
        content.input.metadata.framerateStringVideo frame rate
        content.input.metadata.audioCodecStringAudio codec
        content.input.metadata.audioBitrateFloatAudio bitrate (unit: Kbps)
        content.input.metadata.audioSamplingRateFloatAudio sampling rate (unit: Hz)
        content.input.metadata.audioChannelIntegerAudio channel
        content.output[]Array(Object)Output file information
        content.output[].encodingOptionIdIntegerEncoding option ID
        content.output[].outputTypeStringOutput type information
        content.output[].objectStorageUrlStringObject Storage download URL
        content.output[].fileSizeByteLongSize of output file (unit: byte)
        content.output[].statusStringEncoding result statusCOMPLETE, WAITING, RUNNING, FAILURE, CANCELED
        content.output[].percentageIntegerEncoding progress rate
        content.output[].metadataObjectOutput file metadata
        content.output[].metadata.durationFloatFile playback time (unit: seconds)
        content.output[].metadata.videoCodecStringVideo codec
        content.output[].metadata.videoBitrateFloatVideo bitrate (unit: Kbps)
        content.output[].metadata.videoPassStringVideo profile
        content.output[].metadata.widthIntegerVideo width
        content.output[].metadata.heightIntegerVideo height
        content.output[].metadata.framerateStringVideo frame rate
        content.output[].metadata.audioCodecStringAudio codec
        content.output[].metadata.audioBitrateFloatAudio bitrate (unit: Kbps)
        content.output[].metadata.audioSamplingRateFloatAudio sampling rate (unit: Hz)
        content.output[].metadata.audioChannelIntegerAudio 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==
        HTTP

        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
                }
              }
            ]
          }
        }
        HTTP

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.