MENU
      カテゴリ情報の照会

        カテゴリ情報の照会


        記事の要約

        VOD Stationはカテゴリの詳細情報を照会するための APIを提供します。

        リクエスト

        GET https://vodstation.apigw.ntruss.com/api/v2/category/{categoryId}
        HTTP

        リクエストヘッダ

        ヘッダ名説明
        x-ncp-region_codeNAVERクラウドプラットフォームの region code
        x-ncp_region_code:{Region Code}
        x-ncp-apigw-timestamp1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表す
        API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyNAVERクラウドプラットフォームポータルで発行された Access Key ID値
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2Access Key ID値と Secret Keyで暗号化した署名
        x-ncp-apigw-signature-v2:{API Gateway Signature}

        レスポンス

        フィールド名タイプ説明備考
        errorObjectリクエスト失敗時のレスポンス
        エラーレスポンスコードとメッセージ
        error.codeIntegerエラーレスポンスコード
        error.messageStringエラーレスポンスメッセージ
        contentObjectVOD Station OPEN APIレスポンスオブジェクト
        content.idString作成されたカテゴリの ID
        content.nameStringカテゴリ名
        content.encodingOptions[]Array(Integer)エンコードオプション ID
        content.encodingOptionTemplateIdIntegerエンコードテンプレート ID
        content.thumbnailBooleanサムネイル抽出設定
        content.notificationUrlStringCallback URL設定
        content.outputObject出力設定
        content.output.bucketNameString出力バケット名
        content.output.filePathString出力ファイルをアップロードする詳細パス
        content.output.thumbnailBucketNameStringサムネイル出力バケット名
        content.output.thumbnailFilePathStringサムネイル出力出力ファイルのアップロードの詳細パス
        content.output.accessControlString出力ファイルの公開範囲
        content.output.thumbnailAccessControlString出力サムネイルの公開範囲
        content.statusStringカテゴリの状態CREATED, DELETED, RUNNING
        content.createTimeIntegerカテゴリの作成時間
        content.updateTimeIntegerカテゴリの修正時間
        content.disabledBooleanSub Accountで提供されるフィールド
        当該リソースの subaccountでの有効有無
        content.inputTotalInteger入力ファイルの総数
        content.lastWorkStartInteger最後の作業時間
        content.outputTotalInteger出力ファイルの総数
        content.outputTotalSizeInteger出力ファイルの総容量(単位: byte)
        content.outputTypeInteger設定されたエンコード設定に応じた出力タイプ数
        content.advancedOptionsObject高度な設定
        content.advancedOptions.trimmingObject出力ファイルのトリミング設定
        content.advancedOptions.trimming.startTimeCodeStringトリミングの開始時点
        content.advancedOptions.trimming.endTimeCodeStringトリミングの終了時点
        content.advancedOptions.imageOverlayObject画像オーバーレイ設定
        content.advancedOptions.imageOverlay.inputObject入力画像
        content.advancedOptions.imageOverlay.input.bucketNameString入力画像がアップロードされているバケット名
        content.advancedOptions.imageOverlay.input.filePathString入力画像の詳細パス
        content.advancedOptions.imageOverlay.positionObject挿入する画像位置の設定
        content.advancedOptions.imageOverlay.position.xIntegerx軸の位置
        content.advancedOptions.imageOverlay.position.yIntegery軸の位置
        content.advancedOptions.imageOverlay.sizeObejct挿入する画像サイズの設定
        content.advancedOptions.imageOverlay.size.widthInteger画像の幅
        content.advancedOptions.imageOverlay.size.heightInteger画像の高さ

        リクエスト例

        GET https://vodstation.apigw.ntruss.com/api/v2/category/10095
        
        GET /api/v2/category/10095
        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==
        HTTP

        レスポンス例

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

        この記事は役に立ちましたか?

        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.