カテゴリリストの照会

Classic/VPC環境で利用できます。

カテゴリリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

VOD Station APIで共通して使用されるヘッダの詳細は、VOD Stationのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/category' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

content

contentの説明は次の通りです。

レスポンスステータスコード

VOD Station APIで共通して使用されるレスポンスステータスコードの詳細は、VOD Stationのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "content": [
        {
            "disabled": false,
            "id": *****,
            "name": "VOD-Category",
            "thumbnail": true,
            "notificationUrl": "https://example.com/vodstation/callback",
            "output": {
                "bucketName": "station-000",
                "filePath": "/",
                "accessControl": "PUBLIC_READ",
                "thumbnailAccessControl": "PUBLIC_READ",
                "thumbnailBucketName": "station-000",
                "thumbnailFilePath": "/thumbnail"
            },
            "lastWorkStart": 1755576724000,
            "createTime": 1755569623000,
            "updateTime": 1755569623000,
            "status": "CREATED",
            "outputTotalSize": 3421908,
            "outputTotal": 3,
            "inputTotal": 1,
            "outputType": 3,
            "advancedOptions": {
                "trimming": {
                    "startTimeCode": "00:00:00.0",
                    "endTimeCode": "00:08:00.9"
                },
                "imageOverlay": {
                    "input": {
                        "bucketName": "station-000",
                        "filePath": "/VODStation.png"
                    },
                    "size": {
                        "width": 50,
                        "height": 50
                    },
                    "position": {
                        "x": 50,
                        "y": 50
                    }
                }
            },
            "encodingOptions": [
                1,
                2,
                3
            ],
            "encodingOptionTemplateId": 1
        }
    ],
    "total": 1
}